Software / API Bindings / Go / API Reference and Examples / Bricklets (Discontinued) / Temperature IR Bricklet

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)

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)

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)

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 ipconnection.DeviceError, implementing the error interface. The error can have one of the following values:

ipconnection.DeviceErrorSuccess = 0
ipconnection.DeviceErrorInvalidParameter = 1
ipconnection.DeviceErrorFunctionNotSupported = 2
ipconnection.DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions¶

func temperature_ir_bricklet.New(uid string, ipcon *IPConnection) (device TemperatureIRBricklet, err error)¶

Parameters:	uid – Type: string ipcon – Type: *IPConnection
Returns:	device – Type: TemperatureIRBricklet err – Type: error

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

device, err := temperature_ir_bricklet.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected.

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

Returns:	temperature – Type: int16, Unit: 1/10 °C, Range: [-400 to 1250] err – Type: error

Returns the ambient temperature of the sensor.

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

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

Returns:	temperature – Type: int16, Unit: 1/10 °C, Range: [-700 to 3800] err – Type: 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. 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 ObjectTemperatureCallback callback and set the period with SetObjectTemperatureCallbackPeriod().

Advanced Functions¶

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

Parameters:	emissivity – Type: uint16, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1
Returns:	err – Type: 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 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:	emissivity – Type: uint16, Unit: 1/65535, Range: [6553 to 2¹⁶ - 1], Default: 2¹⁶ - 1 err – Type: error

Returns the emissivity as set by SetEmissivity().

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

Returns:

Returns:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: rune, Range: ['a' to 'h', 'z'] hardwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmwareVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] deviceIdentifier – Type: uint16, Range: [0 to 2¹⁶ - 1] err – Type: error

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: rune, Range: ['a' to 'h', 'z']
hardwareVersion – Type: [3]uint8

0: major – Type: uint8, Range: [0 to 255]
1: minor – Type: uint8, Range: [0 to 255]
2: revision – Type: uint8, Range: [0 to 255]

firmwareVersion – Type: [3]uint8

0: major – Type: uint8, Range: [0 to 255]
1: minor – Type: uint8, Range: [0 to 255]
2: revision – Type: uint8, Range: [0 to 255]

deviceIdentifier – Type: uint16, Range: [0 to 2¹⁶ - 1]
err – Type: 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 is always at position 'z'.

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)¶

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	err – Type: error

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

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

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

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 err – Type: error

Returns the period as set by SetAmbientTemperatureCallbackPeriod().

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

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	err – Type: error

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

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

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

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 err – Type: error

Returns the period as set by SetObjectTemperatureCallbackPeriod().

func (*TemperatureIRBricklet) SetAmbientTemperatureCallbackThreshold(option rune, min int16, max int16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Returns:	err – Type: error

Sets the thresholds for the AmbientTemperatureReachedCallback 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 following constants are available for this function:

For option:

temperature_ir_bricklet.ThresholdOptionOff = 'x'
temperature_ir_bricklet.ThresholdOptionOutside = 'o'
temperature_ir_bricklet.ThresholdOptionInside = 'i'
temperature_ir_bricklet.ThresholdOptionSmaller = '<'
temperature_ir_bricklet.ThresholdOptionGreater = '>'

func (*TemperatureIRBricklet) GetAmbientTemperatureCallbackThreshold() (option rune, min int16, max int16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 err – Type: error

Returns the threshold as set by SetAmbientTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

temperature_ir_bricklet.ThresholdOptionOff = 'x'
temperature_ir_bricklet.ThresholdOptionOutside = 'o'
temperature_ir_bricklet.ThresholdOptionInside = 'i'
temperature_ir_bricklet.ThresholdOptionSmaller = '<'
temperature_ir_bricklet.ThresholdOptionGreater = '>'

func (*TemperatureIRBricklet) SetObjectTemperatureCallbackThreshold(option rune, min int16, max int16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0
Returns:	err – Type: error

Sets the thresholds for the ObjectTemperatureReachedCallback 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 following constants are available for this function:

For option:

temperature_ir_bricklet.ThresholdOptionOff = 'x'
temperature_ir_bricklet.ThresholdOptionOutside = 'o'
temperature_ir_bricklet.ThresholdOptionInside = 'i'
temperature_ir_bricklet.ThresholdOptionSmaller = '<'
temperature_ir_bricklet.ThresholdOptionGreater = '>'

func (*TemperatureIRBricklet) GetObjectTemperatureCallbackThreshold() (option rune, min int16, max int16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 max – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1], Default: 0 err – Type: error

Returns the threshold as set by SetObjectTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

temperature_ir_bricklet.ThresholdOptionOff = 'x'
temperature_ir_bricklet.ThresholdOptionOutside = 'o'
temperature_ir_bricklet.ThresholdOptionInside = 'i'
temperature_ir_bricklet.ThresholdOptionSmaller = '<'
temperature_ir_bricklet.ThresholdOptionGreater = '>'

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

Parameters:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100
Returns:	err – Type: error

Sets the period with which the threshold callbacks

AmbientTemperatureReachedCallback,
ObjectTemperatureReachedCallback

are triggered, if the thresholds

SetAmbientTemperatureCallbackThreshold(),
SetObjectTemperatureCallbackThreshold()

keep being reached.

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

Returns:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100 err – Type: 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 with the corresponding Deregister*Callback function.

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)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/10 °C, Range: [-400 to 1250]
Returns:	registrationId – Type: uint64

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

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

func (*TemperatureIRBricklet) RegisterObjectTemperatureCallback(func(temperature int16)) (registrationId uint64)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/10 °C, Range: [-700 to 3800]
Returns:	registrationId – Type: uint64

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

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

func (*TemperatureIRBricklet) RegisterAmbientTemperatureReachedCallback(func(temperature int16)) (registrationId uint64)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/10 °C, Range: [-400 to 1250]
Returns:	registrationId – Type: uint64

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)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/10 °C, Range: [-700 to 3800]
Returns:	registrationId – Type: uint64

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().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

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

Returns:	apiVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] err – Type: error

Returns the version of the API definition 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)¶

Parameters:	functionId – Type: uint8, Range: See constants
Returns:	responseExpected – Type: bool err – Type: 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.

The following constants are available for this function:

For functionId:

temperature_ir_bricklet.FunctionSetEmissivity = 3
temperature_ir_bricklet.FunctionSetAmbientTemperatureCallbackPeriod = 5
temperature_ir_bricklet.FunctionSetObjectTemperatureCallbackPeriod = 7
temperature_ir_bricklet.FunctionSetAmbientTemperatureCallbackThreshold = 9
temperature_ir_bricklet.FunctionSetObjectTemperatureCallbackThreshold = 11
temperature_ir_bricklet.FunctionSetDebouncePeriod = 13

func (*TemperatureIRBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameters:	functionId – Type: uint8, Range: See constants responseExpected – Type: bool
Returns:	err – Type: 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.

The following constants are available for this function:

For functionId:

temperature_ir_bricklet.FunctionSetEmissivity = 3
temperature_ir_bricklet.FunctionSetAmbientTemperatureCallbackPeriod = 5
temperature_ir_bricklet.FunctionSetObjectTemperatureCallbackPeriod = 7
temperature_ir_bricklet.FunctionSetAmbientTemperatureCallbackThreshold = 9
temperature_ir_bricklet.FunctionSetObjectTemperatureCallbackThreshold = 11
temperature_ir_bricklet.FunctionSetDebouncePeriod = 13

func (*TemperatureIRBricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameters:	responseExpected – Type: bool
Returns:	err – Type: error

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

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.