Shell - Ambient Light Bricklet 2.0 – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Shell - Ambient Light Bricklet 2.0

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.

## Examples

The example code below is Public Domain (CC0 1.0).

### Simple

Download (example-simple.sh)

    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

### Callback

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

### Threshold

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!"

## API

Possible exit codes for all `tinkerforge` commands are:

- 1: interrupted (ctrl+c)
- 2: syntax error
- 21: Python 2.5 or newer is required
- 22: Python `argparse` module is missing
- 23: socket error
- 24: other exception
- 25: invalid placeholder in format string
- 26: authentication error
- 201: timeout occurred
- 209: invalid argument value
- 210: function is not supported
- 211: unknown error

### Command Structure

The common options of the `call` and `dispatch` commands are documented here. The specific command structure is shown below.

tinkerforge `call` `ambient-light-v2-bricklet` [<option>..] <uid> <function> [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `call` command is used to call a function of the Ambient Light Bricklet 2.0. It can take several options:

  - `--help` shows help for the specific `call` command and exits
  - `--list-functions` shows a list of known functions of the Ambient Light Bricklet 2.0 and exits

tinkerforge `dispatch` `ambient-light-v2-bricklet` [<option>..] <uid> <callback>

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `dispatch` command is used to dispatch a callback of the Ambient Light Bricklet 2.0. It can take several options:

  - `--help` shows help for the specific `dispatch` command and exits
  - `--list-callbacks` shows a list of known callbacks of the Ambient Light Bricklet 2.0 and exits

tinkerforge call `ambient-light-v2-bricklet` <uid> `<function>` [<option>..] [<argument>..]

  Parameters:

  - <uid> -- string
  - <function> -- string

  The `<function>` to be called can take different options depending of its kind. All functions can take the following options:

  - `--help` shows help for the specific function and exits

  Getter functions can take the following options:

  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

  Setter functions can take the following options:

  - `--expect-response` requests response and waits for it

  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.

tinkerforge dispatch `ambient-light-v2-bricklet` <uid> `<callback>` [<option>..]

  Parameters:

  - <uid> -- string
  - <callback> -- string

  The `<callback>` to be dispatched can take several options:

  - `--help` shows help for the specific callback and exits
  - `--execute <command>` shell command line to execute for each incoming response (see section about output formatting for details)

### Basic Functions

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-illuminance`

  Output:

  - illuminance -- int

  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`.

### Advanced Functions

tinkerforge call `ambient-light-v2-bricklet` <uid> `set-configuration` <illuminance-range> <integration-time>

  Parameters:

  - <illuminance-range> -- int (has symbols)
  - <integration-time> -- int (has symbols)

  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:

  - `64000lux` = 0, for <illuminance-range>
  - `32000lux` = 1, for <illuminance-range>
  - `16000lux` = 2, for <illuminance-range>
  - `8000lux` = 3, for <illuminance-range>
  - `1300lux` = 4, for <illuminance-range>
  - `600lux` = 5, for <illuminance-range>
  - `50ms` = 0, for <integration-time>
  - `100ms` = 1, for <integration-time>
  - `150ms` = 2, for <integration-time>
  - `200ms` = 3, for <integration-time>
  - `250ms` = 4, for <integration-time>
  - `300ms` = 5, for <integration-time>
  - `350ms` = 6, for <integration-time>
  - `400ms` = 7, for <integration-time>

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-configuration`

  Output:

  - illuminance-range -- int (has symbols)
  - integration-time -- int (has symbols)

  Returns the configuration as set by `set-configuration`.

  The following symbols are available for this function:

  - `64000lux` = 0, for illuminance-range
  - `32000lux` = 1, for illuminance-range
  - `16000lux` = 2, for illuminance-range
  - `8000lux` = 3, for illuminance-range
  - `1300lux` = 4, for illuminance-range
  - `600lux` = 5, for illuminance-range
  - `50ms` = 0, for integration-time
  - `100ms` = 1, for integration-time
  - `150ms` = 2, for integration-time
  - `200ms` = 3, for integration-time
  - `250ms` = 4, for integration-time
  - `300ms` = 5, for integration-time
  - `350ms` = 6, for integration-time
  - `400ms` = 7, for integration-time

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-identity`

  Output:

  - uid -- string
  - connected-uid -- string
  - position -- char
  - hardware-version -- int,int,int
  - firmware-version -- int,int,int
  - device-identifier -- int (has symbols)

  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.

### Callback Configuration Functions

tinkerforge call `ambient-light-v2-bricklet` <uid> `set-illuminance-callback-period` <period>

  Parameters:

  - <period> -- int

  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.

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-illuminance-callback-period`

  Output:

  - period -- int

  Returns the period as set by `set-illuminance-callback-period`.

tinkerforge call `ambient-light-v2-bricklet` <uid> `set-illuminance-callback-threshold` <option> <min> <max>

  Parameters:

  - <option> -- char (has symbols)
  - <min> -- int
  - <max> -- int

  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:

  - `off` = x, for <option>
  - `outside` = o, for <option>
  - `inside` = i, for <option>
  - `smaller` = <, for <option>
  - `greater` = >, for <option>

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-illuminance-callback-threshold`

  Output:

  - option -- char (has symbols)
  - min -- int
  - max -- int

  Returns the threshold as set by `set-illuminance-callback-threshold`.

  The following symbols are available for this function:

  - `off` = x, for option
  - `outside` = o, for option
  - `inside` = i, for option
  - `smaller` = <, for option
  - `greater` = >, for option

tinkerforge call `ambient-light-v2-bricklet` <uid> `set-debounce-period` <debounce>

  Parameters:

  - <debounce> -- int

  Output: | no output

  Sets the period in ms with which the threshold callbacks

  - `illuminance-reached`,

  are triggered, if the thresholds

  - `set-illuminance-callback-threshold`,

  keep being reached.

  The default value is 100.

tinkerforge call `ambient-light-v2-bricklet` <uid> `get-debounce-period`

  Output:

  - debounce -- int

  Returns the debounce period as set by `set-debounce-period`.

### Callbacks

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.

tinkerforge dispatch `ambient-light-v2-bricklet` <uid> `illuminance`

  Output:

  - illuminance -- int

  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.

tinkerforge dispatch `ambient-light-v2-bricklet` <uid> `illuminance-reached`

  Output:

  - illuminance -- int

  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`.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.