Go - Temperature Bricklet¶

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

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    t, _ := temperature_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 temperature.
    temperature, _ := t.GetTemperature()
    fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.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_bricklet"
)

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

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

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

    t.RegisterTemperatureCallback(func(temperature int16) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    })

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

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

Threshold¶

Download (example_threshold.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

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    t, _ := temperature_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 threshold receivers with a debounce time of 10 seconds (10000ms).
    t.SetDebouncePeriod(10000)

    t.RegisterTemperatureReachedCallback(func(temperature int16) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
        fmt.Println("It is too hot, we need air conditioning!")
    })

    // Configure threshold for temperature "greater than 30 °C".
    t.SetTemperatureCallbackThreshold('>', 30*100, 0)

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

Basic Functions¶

func temperature_bricklet.New(uid string, ipcon *IPConnection) (device TemperatureBricklet, err error)¶

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

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

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

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

func (*TemperatureBricklet) GetTemperature() (temperature int16, err error)¶

Returns:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500] err – Type: error

Returns the temperature of the sensor.

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

Advanced Functions¶

func (*TemperatureBricklet) SetI2CMode(mode uint8) (err error)¶

Parameters:	mode – Type: uint8, Range: See constants, Default: 0
Returns:	err – Type: error

Sets the I2C mode. Possible modes are:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following constants are available for this function:

For mode:

• temperature_bricklet.I2CModeFast = 0
• temperature_bricklet.I2CModeSlow = 1

New in version 2.0.1 (Plugin).

func (*TemperatureBricklet) GetI2CMode() (mode uint8, err error)¶

Returns:	mode – Type: uint8, Range: See constants, Default: 0 err – Type: error

Returns the I2C mode as set by SetI2CMode().

The following constants are available for this function:

For mode:

• temperature_bricklet.I2CModeFast = 0
• temperature_bricklet.I2CModeSlow = 1

New in version 2.0.1 (Plugin).

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

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 216 - 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 (*TemperatureBricklet) SetTemperatureCallbackPeriod(period uint32) (err error)¶

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

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

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

func (*TemperatureBricklet) GetTemperatureCallbackPeriod() (period uint32, err error)¶

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

Returns the period as set by SetTemperatureCallbackPeriod().

func (*TemperatureBricklet) SetTemperatureCallbackThreshold(option rune, min int16, max int16) (err error)¶

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

Sets the thresholds for the TemperatureReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

func (*TemperatureBricklet) GetTemperatureCallbackThreshold() (option rune, min int16, max int16, err error)¶

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

Returns the threshold as set by SetTemperatureCallbackThreshold().

The following constants are available for this function:

For option:

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

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

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

Sets the period with which the threshold callback

• TemperatureReachedCallback

is triggered, if the threshold

• SetTemperatureCallbackThreshold()

keeps being reached.

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

Returns:	debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 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.

func (*TemperatureBricklet) RegisterTemperatureCallback(func(temperature int16)) (registrationId uint64)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500]
Returns:	registrationId – Type: uint64

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

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

func (*TemperatureBricklet) RegisterTemperatureReachedCallback(func(temperature int16)) (registrationId uint64)¶

Callback Parameters:	temperature – Type: int16, Unit: 1/100 °C, Range: [-2500 to 8500]
Returns:	registrationId – Type: uint64

This callback is triggered when the threshold as set by SetTemperatureCallbackThreshold() is reached. The callback parameter is the 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 (*TemperatureBricklet) 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 (*TemperatureBricklet) 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_bricklet.FunctionSetTemperatureCallbackPeriod = 2
• temperature_bricklet.FunctionSetTemperatureCallbackThreshold = 4
• temperature_bricklet.FunctionSetDebouncePeriod = 6
• temperature_bricklet.FunctionSetI2CMode = 10

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

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_bricklet.FunctionSetTemperatureCallbackPeriod = 2
• temperature_bricklet.FunctionSetTemperatureCallbackThreshold = 4
• temperature_bricklet.FunctionSetDebouncePeriod = 6
• temperature_bricklet.FunctionSetI2CMode = 10

func (*TemperatureBricklet) 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_bricklet.DeviceIdentifier¶

This constant is used to identify a Temperature 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_bricklet.DeviceDisplayName¶

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