TCP/IP - 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 TCP/IP protocol 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.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletAmbientLightV2.get_illuminance
Function ID:

1

Request:

empty payload

Response:
  • illuminance -- uint32

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 CALLBACK_ILLUMINANCE and set the period with set_illuminance_callback_period.

Advanced Functions

BrickletAmbientLightV2.set_configuration
Function ID:

8

Request:
  • illuminance_range -- uint8
  • integration_time -- uint8
Response:

no response

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.

BrickletAmbientLightV2.get_configuration
Function ID:

9

Request:

empty payload

Response:
  • illuminance_range -- uint8
  • integration_time -- uint8

Returns the configuration as set by set_configuration.

BrickletAmbientLightV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletAmbientLightV2.set_illuminance_callback_period
Function ID:

2

Request:
  • period -- uint32
Response:

no response

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

CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

BrickletAmbientLightV2.get_illuminance_callback_period
Function ID:

3

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_illuminance_callback_period.

BrickletAmbientLightV2.set_illuminance_callback_threshold
Function ID:

4

Request:
  • option -- char
  • min -- uint32
  • max -- uint32
Response:

no response

Sets the thresholds for the CALLBACK_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).

BrickletAmbientLightV2.get_illuminance_callback_threshold
Function ID:

5

Request:

empty payload

Response:
  • option -- char
  • min -- uint32
  • max -- uint32

Returns the threshold as set by set_illuminance_callback_threshold.

BrickletAmbientLightV2.set_debounce_period
Function ID:

6

Request:
  • debounce -- uint32
Response:

no response

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletAmbientLightV2.get_debounce_period
Function ID:

7

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE
Function ID:

10

Response:
  • illuminance -- uint32

This callback is triggered periodically with the period that is set by set_illuminance_callback_period. The response value is the illuminance of the ambient light sensor.

CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the last triggering.

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE_REACHED
Function ID:

11

Response:
  • illuminance -- uint32

This callback is triggered when the threshold as set by set_illuminance_callback_threshold is reached. The response value 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.

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