Go - Temperature IR Bricklet

This is the description of the Go API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    tir, _ := temperature_ir_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current ambient temperature.
    ambientTemperature, _ := tir.GetAmbientTemperature()
    fmt.Printf("Ambient Temperature: %f °C\n", float64(ambientTemperature)/10.0)

    // Get current object temperature.
    objectTemperature, _ := tir.GetObjectTemperature()
    fmt.Printf("Object Temperature: %f °C\n", float64(objectTemperature)/10.0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    tir, _ := temperature_ir_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    tir.RegisterObjectTemperatureCallback(func(temperature int16) {
        fmt.Printf("Object Temperature: %f °C\n", float64(temperature)/10.0)
    })

    // Set period for object temperature receiver to 1s (1000ms).
    // Note: The object temperature callback is only called every second
    //       if the object temperature has changed since the last call!
    tir.SetObjectTemperatureCallbackPeriod(1000)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Water Boiling

Download (example_water_boiling.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Temperature IR Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    tir, _ := temperature_ir_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    tir.SetEmissivity(64224)

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    tir.SetDebouncePeriod(10000)

    tir.RegisterObjectTemperatureReachedCallback(func(temperature int16) {
        fmt.Printf("Object Temperature: %f °C\n", float64(temperature)/10.0)
        fmt.Println("The water is boiling!")
    })

    // Configure threshold for object temperature "greater than 100 °C".
    tir.SetObjectTemperatureCallbackThreshold('>', 100*10, 0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The Temperature IR Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/temperature_ir_bricklet

Nearly every function of the Go bindings can return an DeviceError, implementing the error interface. The error can have one of the following values:

  • DeviceErrorSuccess = 0
  • DeviceErrorInvalidParameter = 1
  • DeviceErrorFunctionNotSupported = 2
  • DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func NewTemperatureIRBricklet(uid string, ipcon *IPConnection) (device TemperatureIRBricklet, err error)

Creates a new TemperatureIRBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IPConnection has been connected (see examples above).

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

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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) 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 value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

The temperature of different materials is dependent on their 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().

Advanced Functions

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

Sets the emissivity that is used to calculate the surface temperature as returned by GetObjectTemperature().

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

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 default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

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

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

Returns the emissivity as set by SetEmissivity().

func (*TemperatureIRBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

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) GetResponseExpected(functionId uint8) (responseExpected bool, err 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 send 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) SetResponseExpected(functionId uint8, responseExpected bool) (err 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • FunctionSetEmissivity = 3
  • FunctionSetAmbientTemperatureCallbackPeriod = 5
  • FunctionSetObjectTemperatureCallbackPeriod = 7
  • FunctionSetAmbientTemperatureCallbackThreshold = 9
  • FunctionSetObjectTemperatureCallbackThreshold = 11
  • FunctionSetDebouncePeriod = 13
func (*TemperatureIRBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

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

Sets the period in ms 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.

The default value is 0.

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

Returns the period as set by SetAmbientTemperatureCallbackPeriod().

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

Sets the period in ms 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.

The default value is 0.

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

Returns the period as set by SetObjectTemperatureCallbackPeriod().

func (*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)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*TemperatureIRBricklet) GetAmbientTemperatureCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*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)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*TemperatureIRBricklet) GetObjectTemperatureCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetObjectTemperatureCallbackThreshold().

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*TemperatureIRBricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

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

Returns the debounce period as set by SetDebouncePeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

func (*TemperatureIRBricklet) RegisterAmbientTemperatureCallback(func(temperature int16)) (registrationId uint64)

A callback can be registered for this event with the RegisterAmbientTemperatureCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterAmbientTemperatureCallback(registrationId uint64) function.

This callback is triggered periodically with the period that is set by SetAmbientTemperatureCallbackPeriod(). The callback 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) RegisterObjectTemperatureCallback(func(temperature int16)) (registrationId uint64)

A callback can be registered for this event with the RegisterObjectTemperatureCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterObjectTemperatureCallback(registrationId uint64) function.

This callback is triggered periodically with the period that is set by SetObjectTemperatureCallbackPeriod(). The callback 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) RegisterAmbientTemperatureReachedCallback(func(temperature int16)) (registrationId uint64)

A callback can be registered for this event with the RegisterAmbientTemperatureReachedCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterAmbientTemperatureReachedCallback(registrationId uint64) function.

This callback is triggered when the threshold as set by SetAmbientTemperatureCallbackThreshold() is reached. The callback 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) RegisterObjectTemperatureReachedCallback(func(temperature int16)) (registrationId uint64)

A callback can be registered for this event with the RegisterObjectTemperatureReachedCallback() function. This function returns the ID of the registered callback. An added callback can be removed with the DeregisterObjectTemperatureReachedCallback(registrationId uint64) function.

This callback is triggered when the threshold as set by SetObjectTemperatureCallbackThreshold() is reached. The callback 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().

Constants

temperature_ir_bricklet.DeviceIdentifier

This constant is used to identify a Temperature IR Bricklet.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

temperature_ir_bricklet.DeviceDisplayName

This constant represents the human readable name of a Temperature IR Bricklet.