Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the Shell API bindings for the Ambient Light Bricklet 2.0. General information and technical specifications for the Ambient Light Bricklet 2.0 are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get current illuminance (unit is Lux/100)
tinkerforge call ambient-light-v2-bricklet $uid get-illuminance
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# set period for illuminance callback to 1s (1000ms)
# note: the illuminance callback is only called every second if the
# illuminance has changed since the last call!
tinkerforge call ambient-light-v2-bricklet $uid set-illuminance-callback-period 1000
# handle incoming illuminance callbacks (unit is Lux/100)
tinkerforge dispatch ambient-light-v2-bricklet $uid illuminance
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call ambient-light-v2-bricklet $uid set-debounce-period 10000
# configure threshold for "greater than 200 Lux" (unit is Lux/100)
tinkerforge call ambient-light-v2-bricklet $uid set-illuminance-callback-threshold greater 20000 0
# handle incoming illuminance-reached callbacks (unit is Lux/100)
tinkerforge dispatch ambient-light-v2-bricklet $uid illuminance-reached\
--execute "echo We have {illuminance} Lux/100. Too bright, close the curtains!"
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Ambient Light Bricklet 2.0. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Ambient Light Bricklet 2.0. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
Returns the illuminance of the ambient light sensor. The value has a range of 0 to 6400000 and is given in 1/100 Lux, i.e. a value of 45000 means that an illuminance of 450 Lux is measured.
If you want to get the illuminance periodically, it is recommended to use the callback illuminance and set the period with set-illuminance-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.
A smaller illuminance range increases the resolution of the data. An increase in integration time will result in less noise on the data.
The default values are 0-8000lux illuminance range and 200ms integration time.
The following symbols are available for this function:
Output: |
|
---|
Returns the configuration as set by set-configuration.
The following symbols are available for this function:
Output: |
|
---|
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the illuminance callback is triggered periodically. A value of 0 turns the callback off.
illuminance is only triggered if the illuminance has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-illuminance-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the illuminance-reached 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 default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-illuminance-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch ambient-light-v2-bricklet <uid> example
The available callbacks are described below.
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.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-illuminance-callback-period. The parameter is the illuminance of the ambient light sensor.
illuminance is only triggered if the illuminance has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-illuminance-callback-threshold is reached. The 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 set-debounce-period.