Software / API Bindings / Ruby / API Reference and Examples / Bricklets (Discontinued) / Ambient Light Bricklet 2.0

Ruby - Ambient Light Bricklet 2.0¶

This is the description of the Ruby 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 Ruby API bindings is part of their general description.

Examples¶

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

Simple¶

Download (example_simple.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current illuminance
illuminance = al.get_illuminance
puts "Illuminance: #{illuminance/100.0} lx"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback¶

Download (example_callback.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register illuminance callback
al.register_callback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE) do |illuminance|
  puts "Illuminance: #{illuminance/100.0} lx"
end

# 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!
al.set_illuminance_callback_period 1000

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Threshold¶

Download (example_threshold.rb)

#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_ambient_light_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Ambient Light Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
al = BrickletAmbientLightV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
al.set_debounce_period 10000

# Register illuminance reached callback
al.register_callback(BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED) do |illuminance|
  puts "Illuminance: #{illuminance/100.0} lx"
  puts 'Too bright, close the curtains!'
end

# Configure threshold for illuminance "greater than 500 lx"
al.set_illuminance_callback_threshold '>', 500*100, 0

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API¶

All functions listed below are thread-safe.

Basic Functions¶

BrickletAmbientLightV2::new(uid, ipcon) → ambient_light_v2¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	ambient_light_v2 – Type: BrickletAmbientLightV2

Creates an object with the unique device ID uid:

ambient_light_v2 = BrickletAmbientLightV2.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected.

BrickletAmbientLightV2#get_illuminance → int¶

Returns:	illuminance – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1]

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop.

Changed in version 2.0.2 (Plugin): An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (#set_configuration) to better match the light conditions.

If you want to get the illuminance periodically, it is recommended to use the ::CALLBACK_ILLUMINANCE callback and set the period with #set_illuminance_callback_period.

Advanced Functions¶

BrickletAmbientLightV2#set_configuration(illuminance_range, integration_time) → nil¶

Parameters:	illuminance_range – Type: int, Range: See constants, Default: 3 integration_time – Type: int, Range: See constants, Default: 3

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.

New in version 2.0.2 (Plugin): The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

Changed in version 2.0.2 (Plugin): If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by #get_illuminance and the ::CALLBACK_ILLUMINANCE callback. For example, 800001 for the 0-8000lux range.

Changed in version 2.0.2 (Plugin): With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by #get_illuminance and the ::CALLBACK_ILLUMINANCE callback.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

The following constants are available for this function:

For illuminance_range:

BrickletAmbientLightV2::ILLUMINANCE_RANGE_UNLIMITED = 6
BrickletAmbientLightV2::ILLUMINANCE_RANGE_64000LUX = 0
BrickletAmbientLightV2::ILLUMINANCE_RANGE_32000LUX = 1
BrickletAmbientLightV2::ILLUMINANCE_RANGE_16000LUX = 2
BrickletAmbientLightV2::ILLUMINANCE_RANGE_8000LUX = 3
BrickletAmbientLightV2::ILLUMINANCE_RANGE_1300LUX = 4
BrickletAmbientLightV2::ILLUMINANCE_RANGE_600LUX = 5

For integration_time:

BrickletAmbientLightV2::INTEGRATION_TIME_50MS = 0
BrickletAmbientLightV2::INTEGRATION_TIME_100MS = 1
BrickletAmbientLightV2::INTEGRATION_TIME_150MS = 2
BrickletAmbientLightV2::INTEGRATION_TIME_200MS = 3
BrickletAmbientLightV2::INTEGRATION_TIME_250MS = 4
BrickletAmbientLightV2::INTEGRATION_TIME_300MS = 5
BrickletAmbientLightV2::INTEGRATION_TIME_350MS = 6
BrickletAmbientLightV2::INTEGRATION_TIME_400MS = 7

BrickletAmbientLightV2#get_configuration → [int, int]¶

Return Array:	0: illuminance_range – Type: int, Range: See constants, Default: 3 1: integration_time – Type: int, Range: See constants, Default: 3

Returns the configuration as set by #set_configuration.

The following constants are available for this function:

For illuminance_range:

BrickletAmbientLightV2::ILLUMINANCE_RANGE_UNLIMITED = 6
BrickletAmbientLightV2::ILLUMINANCE_RANGE_64000LUX = 0
BrickletAmbientLightV2::ILLUMINANCE_RANGE_32000LUX = 1
BrickletAmbientLightV2::ILLUMINANCE_RANGE_16000LUX = 2
BrickletAmbientLightV2::ILLUMINANCE_RANGE_8000LUX = 3
BrickletAmbientLightV2::ILLUMINANCE_RANGE_1300LUX = 4
BrickletAmbientLightV2::ILLUMINANCE_RANGE_600LUX = 5

For integration_time:

BrickletAmbientLightV2::INTEGRATION_TIME_50MS = 0
BrickletAmbientLightV2::INTEGRATION_TIME_100MS = 1
BrickletAmbientLightV2::INTEGRATION_TIME_150MS = 2
BrickletAmbientLightV2::INTEGRATION_TIME_200MS = 3
BrickletAmbientLightV2::INTEGRATION_TIME_250MS = 4
BrickletAmbientLightV2::INTEGRATION_TIME_300MS = 5
BrickletAmbientLightV2::INTEGRATION_TIME_350MS = 6
BrickletAmbientLightV2::INTEGRATION_TIME_400MS = 7

BrickletAmbientLightV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

Return Array:	0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

0: uid – Type: str, Length: up to 8
1: connected_uid – Type: str, Length: up to 8
2: position – Type: chr, Range: ['a' to 'h', 'z']
3: hardware_version – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

4: firmware_version – Type: [int, ...], Length: 3

0: major – Type: int, Range: [0 to 255]
1: minor – Type: int, Range: [0 to 255]
2: revision – Type: int, Range: [0 to 255]

5: device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]

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¶

BrickletAmbientLightV2#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletAmbientLightV2#set_illuminance_callback_period(period) → nil¶

Parameters:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

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

BrickletAmbientLightV2#get_illuminance_callback_period → int¶

Returns:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by #set_illuminance_callback_period.

BrickletAmbientLightV2#set_illuminance_callback_threshold(option, min, max) → nil¶

Parameters:	option – Type: chr, Range: See constants, Default: 'x' min – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 max – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

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

For option:

BrickletAmbientLightV2::THRESHOLD_OPTION_OFF = 'x'
BrickletAmbientLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletAmbientLightV2::THRESHOLD_OPTION_INSIDE = 'i'
BrickletAmbientLightV2::THRESHOLD_OPTION_SMALLER = '<'
BrickletAmbientLightV2::THRESHOLD_OPTION_GREATER = '>'

BrickletAmbientLightV2#get_illuminance_callback_threshold → [chr, int, int]¶

Return Array:	0: option – Type: chr, Range: See constants, Default: 'x' 1: min – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0 2: max – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1], Default: 0

Returns the threshold as set by #set_illuminance_callback_threshold.

The following constants are available for this function:

For option:

BrickletAmbientLightV2::THRESHOLD_OPTION_OFF = 'x'
BrickletAmbientLightV2::THRESHOLD_OPTION_OUTSIDE = 'o'
BrickletAmbientLightV2::THRESHOLD_OPTION_INSIDE = 'i'
BrickletAmbientLightV2::THRESHOLD_OPTION_SMALLER = '<'
BrickletAmbientLightV2::THRESHOLD_OPTION_GREATER = '>'

BrickletAmbientLightV2#set_debounce_period(debounce) → nil¶

Parameters:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callbacks

::CALLBACK_ILLUMINANCE_REACHED,

are triggered, if the thresholds

#set_illuminance_callback_threshold,

keep being reached.

BrickletAmbientLightV2#get_debounce_period → int¶

Returns:	debounce – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Returns the debounce period as set by #set_debounce_period.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

ambient_light_v2.register_callback BrickletAmbientLightV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters 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.

BrickletAmbientLightV2::CALLBACK_ILLUMINANCE¶

Callback Parameters:	illuminance – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1]

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.

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

BrickletAmbientLightV2::CALLBACK_ILLUMINANCE_REACHED¶

Callback Parameters:	illuminance – Type: int, Unit: 1/100 lx, Range: [0 to 2³² - 1]

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.

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.

BrickletAmbientLightV2#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255]

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.

BrickletAmbientLightV2#get_response_expected(function_id) → bool¶

Parameters:	function_id – Type: int, Range: See constants
Returns:	response_expected – Type: bool

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 #set_response_expected. 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 function_id:

BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
BrickletAmbientLightV2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletAmbientLightV2::FUNCTION_SET_CONFIGURATION = 8

BrickletAmbientLightV2#set_response_expected(function_id, response_expected) → nil¶

Parameters:	function_id – Type: int, Range: See constants response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 2
BrickletAmbientLightV2::FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD = 4
BrickletAmbientLightV2::FUNCTION_SET_DEBOUNCE_PERIOD = 6
BrickletAmbientLightV2::FUNCTION_SET_CONFIGURATION = 8

BrickletAmbientLightV2#set_response_expected_all(response_expected) → nil¶

Parameters:	response_expected – Type: bool

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

Constants¶

BrickletAmbientLightV2::DEVICE_IDENTIFIER¶

This constant is used to identify a Ambient Light Bricklet 2.0.

The #get_identity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletAmbientLightV2::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Ambient Light Bricklet 2.0.