temperature_ir_bricklet

package
Version: v0.0.0-...-d0a6af2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 8, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Measures contactless object temperature between -70°C and +380°C‍.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/TemperatureIR_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "Temperature IR Bricklet"
View Source
const DeviceIdentifier = 217

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetAmbientTemperature                  Function = 1
	FunctionGetObjectTemperature                   Function = 2
	FunctionSetEmissivity                          Function = 3
	FunctionGetEmissivity                          Function = 4
	FunctionSetAmbientTemperatureCallbackPeriod    Function = 5
	FunctionGetAmbientTemperatureCallbackPeriod    Function = 6
	FunctionSetObjectTemperatureCallbackPeriod     Function = 7
	FunctionGetObjectTemperatureCallbackPeriod     Function = 8
	FunctionSetAmbientTemperatureCallbackThreshold Function = 9
	FunctionGetAmbientTemperatureCallbackThreshold Function = 10
	FunctionSetObjectTemperatureCallbackThreshold  Function = 11
	FunctionGetObjectTemperatureCallbackThreshold  Function = 12
	FunctionSetDebouncePeriod                      Function = 13
	FunctionGetDebouncePeriod                      Function = 14
	FunctionGetIdentity                            Function = 255
	FunctionCallbackAmbientTemperature             Function = 15
	FunctionCallbackObjectTemperature              Function = 16
	FunctionCallbackAmbientTemperatureReached      Function = 17
	FunctionCallbackObjectTemperatureReached       Function = 18
)

type TemperatureIRBricklet

type TemperatureIRBricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*TemperatureIRBricklet) DeregisterAmbientTemperatureCallback

func (device *TemperatureIRBricklet) DeregisterAmbientTemperatureCallback(registrationId uint64)

Remove a registered Ambient Temperature callback.

func (*TemperatureIRBricklet) DeregisterAmbientTemperatureReachedCallback

func (device *TemperatureIRBricklet) DeregisterAmbientTemperatureReachedCallback(registrationId uint64)

Remove a registered Ambient Temperature Reached callback.

func (*TemperatureIRBricklet) DeregisterObjectTemperatureCallback

func (device *TemperatureIRBricklet) DeregisterObjectTemperatureCallback(registrationId uint64)

Remove a registered Object Temperature callback.

func (*TemperatureIRBricklet) DeregisterObjectTemperatureReachedCallback

func (device *TemperatureIRBricklet) DeregisterObjectTemperatureReachedCallback(registrationId uint64)

Remove a registered Object Temperature Reached callback.

func (*TemperatureIRBricklet) GetAPIVersion

func (device *TemperatureIRBricklet) GetAPIVersion() [3]uint8

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*TemperatureIRBricklet) GetAmbientTemperature

func (device *TemperatureIRBricklet) GetAmbientTemperature() (temperature int16, err error)

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the RegisterAmbientTemperatureCallback callback and set the period with SetAmbientTemperatureCallbackPeriod.

func (*TemperatureIRBricklet) GetAmbientTemperatureCallbackPeriod

func (device *TemperatureIRBricklet) GetAmbientTemperatureCallbackPeriod() (period uint32, err error)

Returns the period as set by SetAmbientTemperatureCallbackPeriod.

func (*TemperatureIRBricklet) GetAmbientTemperatureCallbackThreshold

func (device *TemperatureIRBricklet) GetAmbientTemperatureCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*TemperatureIRBricklet) GetDebouncePeriod

func (device *TemperatureIRBricklet) GetDebouncePeriod() (debounce uint32, err error)

Returns the debounce period as set by SetDebouncePeriod.

func (*TemperatureIRBricklet) GetEmissivity

func (device *TemperatureIRBricklet) GetEmissivity() (emissivity uint16, err error)

Returns the emissivity as set by SetEmissivity.

func (*TemperatureIRBricklet) GetIdentity

func (device *TemperatureIRBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*TemperatureIRBricklet) GetObjectTemperature

func (device *TemperatureIRBricklet) GetObjectTemperature() (temperature int16, err error)

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their `emissivity <https://en.wikipedia.org/wiki/Emissivity>`__. The emissivity of the material can be set with SetEmissivity.

If you want to get the object temperature periodically, it is recommended to use the RegisterObjectTemperatureCallback callback and set the period with SetObjectTemperatureCallbackPeriod.

func (*TemperatureIRBricklet) GetObjectTemperatureCallbackPeriod

func (device *TemperatureIRBricklet) GetObjectTemperatureCallbackPeriod() (period uint32, err error)

Returns the period as set by SetObjectTemperatureCallbackPeriod.

func (*TemperatureIRBricklet) GetObjectTemperatureCallbackThreshold

func (device *TemperatureIRBricklet) GetObjectTemperatureCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetObjectTemperatureCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*TemperatureIRBricklet) GetResponseExpected

func (device *TemperatureIRBricklet) GetResponseExpected(functionID Function) (bool, error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*TemperatureIRBricklet) RegisterAmbientTemperatureCallback

func (device *TemperatureIRBricklet) RegisterAmbientTemperatureCallback(fn func(int16)) uint64

This callback is triggered periodically with the period that is set by SetAmbientTemperatureCallbackPeriod. The parameter is the ambient temperature of the sensor.

The RegisterAmbientTemperatureCallback callback is only triggered if the ambient temperature has changed since the last triggering.

func (*TemperatureIRBricklet) RegisterAmbientTemperatureReachedCallback

func (device *TemperatureIRBricklet) RegisterAmbientTemperatureReachedCallback(fn func(int16)) uint64

This callback is triggered when the threshold as set by SetAmbientTemperatureCallbackThreshold is reached. The parameter is the ambient temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

func (*TemperatureIRBricklet) RegisterObjectTemperatureCallback

func (device *TemperatureIRBricklet) RegisterObjectTemperatureCallback(fn func(int16)) uint64

This callback is triggered periodically with the period that is set by SetObjectTemperatureCallbackPeriod. The parameter is the object temperature of the sensor.

The RegisterObjectTemperatureCallback callback is only triggered if the object temperature has changed since the last triggering.

func (*TemperatureIRBricklet) RegisterObjectTemperatureReachedCallback

func (device *TemperatureIRBricklet) RegisterObjectTemperatureReachedCallback(fn func(int16)) uint64

This callback is triggered when the threshold as set by SetObjectTemperatureCallbackThreshold is reached. The parameter is the object temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

func (*TemperatureIRBricklet) SetAmbientTemperatureCallbackPeriod

func (device *TemperatureIRBricklet) SetAmbientTemperatureCallbackPeriod(period uint32) (err error)

Sets the period with which the RegisterAmbientTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

The RegisterAmbientTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

func (*TemperatureIRBricklet) SetAmbientTemperatureCallbackThreshold

func (device *TemperatureIRBricklet) SetAmbientTemperatureCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)

Sets the thresholds for the RegisterAmbientTemperatureReachedCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Callback is turned off
'o'|    Callback is triggered when the ambient temperature is *outside* the min and max values
'i'|    Callback is triggered when the ambient temperature is *inside* the min and max values
'<'|    Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)
'>'|    Callback is triggered when the ambient temperature is greater than the min value (max is ignored)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*TemperatureIRBricklet) SetDebouncePeriod

func (device *TemperatureIRBricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period with which the threshold callbacks

* RegisterAmbientTemperatureReachedCallback, * RegisterObjectTemperatureReachedCallback

are triggered, if the thresholds

* SetAmbientTemperatureCallbackThreshold, * SetObjectTemperatureCallbackThreshold

keep being reached.

func (*TemperatureIRBricklet) SetEmissivity

func (device *TemperatureIRBricklet) SetEmissivity(emissivity uint16) (err error)

Sets the https://en.wikipedia.org/wiki/Emissivity that is used to calculate the surface temperature as returned by :func:https://www.infrared-thermography.com/material.htm.

The parameter of SetEmissivity has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is
absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

func (*TemperatureIRBricklet) SetObjectTemperatureCallbackPeriod

func (device *TemperatureIRBricklet) SetObjectTemperatureCallbackPeriod(period uint32) (err error)

Sets the period with which the RegisterObjectTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

The RegisterObjectTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

func (*TemperatureIRBricklet) SetObjectTemperatureCallbackThreshold

func (device *TemperatureIRBricklet) SetObjectTemperatureCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)

Sets the thresholds for the RegisterObjectTemperatureReachedCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Callback is turned off
'o'|    Callback is triggered when the object temperature is *outside* the min and max values
'i'|    Callback is triggered when the object temperature is *inside* the min and max values
'<'|    Callback is triggered when the object temperature is smaller than the min value (max is ignored)
'>'|    Callback is triggered when the object temperature is greater than the min value (max is ignored)

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*TemperatureIRBricklet) SetResponseExpected

func (device *TemperatureIRBricklet) SetResponseExpected(functionID Function, responseExpected bool) error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

func (*TemperatureIRBricklet) SetResponseExpectedAll

func (device *TemperatureIRBricklet) SetResponseExpectedAll(responseExpected bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

type ThresholdOption

type ThresholdOption = rune
const (
	ThresholdOptionOff     ThresholdOption = 'x'
	ThresholdOptionOutside ThresholdOption = 'o'
	ThresholdOptionInside  ThresholdOption = 'i'
	ThresholdOptionSmaller ThresholdOption = '<'
	ThresholdOptionGreater ThresholdOption = '>'
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL