Go - Humidity Bricklet

This is the description of the Go API bindings for the Humidity Bricklet. General information and technical specifications for the Humidity 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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    h, _ := humidity_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 humidity.
    humidity, _ := h.GetHumidity()
    fmt.Printf("Humidity: %f %RH\n", float64(humidity)/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/humidity_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

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

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

    h.RegisterHumidityCallback(func(humidity uint16) {
        fmt.Printf("Humidity: %f %RH\n", float64(humidity)/10.0)
    })

    // Set period for humidity receiver to 1s (1000ms).
    // Note: The humidity callback is only called every second
    //       if the humidity has changed since the last call!
    h.SetHumidityCallbackPeriod(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/humidity_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    h, _ := humidity_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).
    h.SetDebouncePeriod(10000)

    h.RegisterHumidityReachedCallback(func(humidity uint16) {
        fmt.Printf("Humidity: %f %RH\n", float64(humidity)/10.0)
        fmt.Println("Recommended humidity for human comfort is 30 to 60 %RH.")
    })

    // Configure threshold for humidity "outside of 30 to 60 %RH".
    h.SetHumidityCallbackThreshold('o', 30*10, 60*10)

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

API

The Humidity Bricklet API is defined in the package github.com/Tinkerforge/go-api-bindings/humidity_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 NewHumidityBricklet(uid string, ipcon *IPConnection) (device HumidityBricklet, err error)

Creates a new HumidityBricklet 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 (*HumidityBricklet) GetHumidity() (humidity uint16, err error)

Returns the humidity of the sensor. The value has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), i.e. a value of 421 means that a humidity of 42.1 %RH is measured.

If you want to get the humidity periodically, it is recommended to use the RegisterHumidityCallback callback and set the period with SetHumidityCallbackPeriod().

Advanced Functions

func (*HumidityBricklet) GetAnalogValue() (value uint16, err error)

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by GetHumidity() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

If you want the analog value periodically, it is recommended to use the RegisterAnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

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

  • FunctionSetHumidityCallbackPeriod = 3
  • FunctionSetAnalogValueCallbackPeriod = 5
  • FunctionSetHumidityCallbackThreshold = 7
  • FunctionSetAnalogValueCallbackThreshold = 9
  • FunctionSetDebouncePeriod = 11
func (*HumidityBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*HumidityBricklet) 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 (*HumidityBricklet) SetHumidityCallbackPeriod(period uint32) (err error)

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

The RegisterHumidityCallback callback is only triggered if the humidity has changed since the last triggering.

The default value is 0.

func (*HumidityBricklet) GetHumidityCallbackPeriod() (period uint32, err error)

Returns the period as set by SetHumidityCallbackPeriod().

func (*HumidityBricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)

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

The RegisterAnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

The default value is 0.

func (*HumidityBricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)

Returns the period as set by SetAnalogValueCallbackPeriod().

func (*HumidityBricklet) SetHumidityCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterHumidityReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the humidity is outside the min and max values
'i' Callback is triggered when the humidity is inside the min and max values
'<' Callback is triggered when the humidity is smaller than the min value (max is ignored)
'>' Callback is triggered when the humidity 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 (*HumidityBricklet) GetHumidityCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetHumidityCallbackThreshold().

The following constants are available for this function:

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

Sets the thresholds for the RegisterAnalogValueReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the analog value is outside the min and max values
'i' Callback is triggered when the analog value is inside the min and max values
'<' Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>' Callback is triggered when the analog value 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 (*HumidityBricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*HumidityBricklet) 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 (*HumidityBricklet) 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 (*HumidityBricklet) RegisterHumidityCallback(func(humidity uint16)) (registrationId uint64)

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

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

The RegisterHumidityCallback callback is only triggered if the humidity has changed since the last triggering.

func (*HumidityBricklet) RegisterAnalogValueCallback(func(value uint16)) (registrationId uint64)

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

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The callback parameter is the analog value of the sensor.

The RegisterAnalogValueCallback callback is only triggered if the humidity has changed since the last triggering.

func (*HumidityBricklet) RegisterHumidityReachedCallback(func(humidity uint16)) (registrationId uint64)

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

This callback is triggered when the threshold as set by SetHumidityCallbackThreshold() is reached. The callback parameter is the humidity of the sensor.

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

func (*HumidityBricklet) RegisterAnalogValueReachedCallback(func(value uint16)) (registrationId uint64)

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

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The callback parameter is the analog value of the sensor.

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

Constants

humidity_bricklet.DeviceIdentifier

This constant is used to identify a Humidity 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.

humidity_bricklet.DeviceDisplayName

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