Go - Ambient Light 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/ambient_light_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    al, _ := ambient_light_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 illuminance.
    illuminance, _ := al.GetIlluminance()
    fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/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/ambient_light_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

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

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

    al.RegisterIlluminanceCallback(func(illuminance uint16) {
        fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/10.0)
    })

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

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

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

    al.RegisterIlluminanceReachedCallback(func(illuminance uint16) {
        fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/10.0)
        fmt.Println("Too bright, close the curtains!")
    })

    // Configure threshold for illuminance "greater than 200 lx".
    al.SetIlluminanceCallbackThreshold('>', 200*10, 0)

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

Basic Functions¶

func ambient_light_bricklet.New(uid string, ipcon *IPConnection) (device AmbientLightBricklet, err error)¶

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

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

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

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

func (*AmbientLightBricklet) GetIlluminance() (illuminance uint16, err error)¶

Returns:	illuminance – Type: uint16, Unit: 1/10 lx, Range: [0 to 9000] err – Type: error

Returns the illuminance of the ambient light sensor.

If you want to get the illuminance periodically, it is recommended to use the IlluminanceCallback callback and set the period with SetIlluminanceCallbackPeriod().

Advanced Functions¶

func (*AmbientLightBricklet) GetAnalogValue() (value uint16, err error)¶

Returns:	value – Type: uint16, Range: [0 to 212 - 1] err – Type: error

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by GetIlluminance() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use GetAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

Also, the analog-to-digital converter covers three different ranges that are set dynamically depending on the light intensity. It is impossible to distinguish between these ranges with the analog value.

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

func (*AmbientLightBricklet) 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 (*AmbientLightBricklet) SetIlluminanceCallbackPeriod(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 IlluminanceCallback callback is triggered periodically. A value of 0 turns the callback off.

The IlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

func (*AmbientLightBricklet) GetIlluminanceCallbackPeriod() (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 SetIlluminanceCallbackPeriod().

func (*AmbientLightBricklet) SetAnalogValueCallbackPeriod(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 AnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.

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

func (*AmbientLightBricklet) GetAnalogValueCallbackPeriod() (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 SetAnalogValueCallbackPeriod().

func (*AmbientLightBricklet) SetIlluminanceCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Unit: 1/10 lx, Range: [0 to 216 - 1], Default: 0 max – Type: uint16, Unit: 1/10 lx, Range: [0 to 216 - 1], Default: 0
Returns:	err – Type: error

Sets the thresholds for the IlluminanceReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

func (*AmbientLightBricklet) GetIlluminanceCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Unit: 1/10 lx, Range: [0 to 216 - 1], Default: 0 max – Type: uint16, Unit: 1/10 lx, Range: [0 to 216 - 1], Default: 0 err – Type: error

Returns the threshold as set by SetIlluminanceCallbackThreshold().

The following constants are available for this function:

For option:

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

func (*AmbientLightBricklet) SetAnalogValueCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameters:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Range: [0 to 216 - 1], Default: 0 max – Type: uint16, Range: [0 to 216 - 1], Default: 0
Returns:	err – Type: error

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

For option:

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

func (*AmbientLightBricklet) GetAnalogValueCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Returns:	option – Type: rune, Range: See constants, Default: 'x' min – Type: uint16, Range: [0 to 216 - 1], Default: 0 max – Type: uint16, Range: [0 to 216 - 1], Default: 0 err – Type: error

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

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

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

• IlluminanceReachedCallback,
• AnalogValueReachedCallback

are triggered, if the thresholds

• SetIlluminanceCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

keep being reached.

func (*AmbientLightBricklet) 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 (*AmbientLightBricklet) RegisterIlluminanceCallback(func(illuminance uint16)) (registrationId uint64)¶

Callback Parameters:	illuminance – Type: uint16, Unit: 1/10 lx, Range: [0 to 9000]
Returns:	registrationId – Type: uint64

This callback is triggered periodically with the period that is set by SetIlluminanceCallbackPeriod(). The callback parameter is the illuminance of the ambient light sensor.

The IlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

func (*AmbientLightBricklet) RegisterAnalogValueCallback(func(value uint16)) (registrationId uint64)¶

Callback Parameters:	value – Type: uint16, Range: [0 to 212 - 1]
Returns:	registrationId – Type: uint64

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

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

func (*AmbientLightBricklet) RegisterIlluminanceReachedCallback(func(illuminance uint16)) (registrationId uint64)¶

Callback Parameters:	illuminance – Type: uint16, Unit: 1/10 lx, Range: [0 to 9000]
Returns:	registrationId – Type: uint64

This callback is triggered when the threshold as set by SetIlluminanceCallbackThreshold() is reached. The callback parameter is the illuminance of the ambient light sensor.

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

func (*AmbientLightBricklet) RegisterAnalogValueReachedCallback(func(value uint16)) (registrationId uint64)¶

Callback Parameters:	value – Type: uint16, Range: [0 to 212 - 1]
Returns:	registrationId – Type: uint64

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The callback parameter is the analog value of the ambient light 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 (*AmbientLightBricklet) 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 (*AmbientLightBricklet) 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:

• ambient_light_bricklet.FunctionSetIlluminanceCallbackPeriod = 3
• ambient_light_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
• ambient_light_bricklet.FunctionSetIlluminanceCallbackThreshold = 7
• ambient_light_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
• ambient_light_bricklet.FunctionSetDebouncePeriod = 11

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

• ambient_light_bricklet.FunctionSetIlluminanceCallbackPeriod = 3
• ambient_light_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
• ambient_light_bricklet.FunctionSetIlluminanceCallbackThreshold = 7
• ambient_light_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
• ambient_light_bricklet.FunctionSetDebouncePeriod = 11

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

ambient_light_bricklet.DeviceIdentifier¶

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

ambient_light_bricklet.DeviceDisplayName¶

This constant represents the human readable name of a Ambient Light Bricklet.