Class: Tinkerforge::BrickletAmbientLight

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_ambient_light.rb

Overview

Measures ambient light up to 900lux

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

21
DEVICE_DISPLAY_NAME =

:nodoc:

'Ambient Light Bricklet'
CALLBACK_ILLUMINANCE =

This callback is triggered periodically with the period that is set by BrickletAmbientLight#set_illuminance_callback_period. The parameter is the illuminance of the ambient light sensor.

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

13
CALLBACK_ANALOG_VALUE =

This callback is triggered periodically with the period that is set by BrickletAmbientLight#set_analog_value_callback_period. The parameter is the analog value of the ambient light sensor.

CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.

14
CALLBACK_ILLUMINANCE_REACHED =

This callback is triggered when the threshold as set by BrickletAmbientLight#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 BrickletAmbientLight#set_debounce_period.

15
CALLBACK_ANALOG_VALUE_REACHED =

This callback is triggered when the threshold as set by BrickletAmbientLight#set_analog_value_callback_threshold is reached. The 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 BrickletAmbientLight#set_debounce_period.

16
FUNCTION_GET_ILLUMINANCE =

:nodoc:

1
FUNCTION_GET_ANALOG_VALUE =

:nodoc:

2
FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD =

:nodoc:

3
FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD =

:nodoc:

4
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

5
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD =

:nodoc:

6
FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD =

:nodoc:

7
FUNCTION_GET_ILLUMINANCE_CALLBACK_THRESHOLD =

:nodoc:

8
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

9
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD =

:nodoc:

10
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

11
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

12
FUNCTION_GET_IDENTITY =

:nodoc:

255
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'

Constants inherited from Device

Device::RESPONSE_EXPECTED_ALWAYS_FALSE, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #registered_callbacks, #uid

Instance Method Summary collapse

Methods inherited from Device

#dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletAmbientLight

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 72

def initialize(uid, ipcon)
  super uid, ipcon

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_ILLUMINANCE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ILLUMINANCE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[CALLBACK_ILLUMINANCE] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ILLUMINANCE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[CALLBACK_ANALOG_VALUE_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_ILLUMINANCE] = 'S'
  @callback_formats[CALLBACK_ANALOG_VALUE] = 'S'
  @callback_formats[CALLBACK_ILLUMINANCE_REACHED] = 'S'
  @callback_formats[CALLBACK_ANALOG_VALUE_REACHED] = 'S'
end

Instance Method Details

#get_analog_value ⇒ Object

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

.. note

The value returned by BrickletAmbientLight#get_illuminance is averaged over several samples to yield less noise, while BrickletAmbientLight#get_analog_value gives back raw unfiltered analog values. The only reason to use BrickletAmbientLight#get_analog_value 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 callback CALLBACK_ANALOG_VALUE and set the period with BrickletAmbientLight#set_analog_value_callback_period.



128
129
130
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 128

def get_analog_value
  send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
end

#get_analog_value_callback_period ⇒ Object

Returns the period as set by BrickletAmbientLight#set_analog_value_callback_period.



160
161
162
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 160

def get_analog_value_callback_period
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_analog_value_callback_threshold ⇒ Object

Returns the threshold as set by BrickletAmbientLight#set_analog_value_callback_threshold.



204
205
206
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 204

def get_analog_value_callback_threshold
  send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletAmbientLight#set_debounce_period.



226
227
228
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 226

def get_debounce_period
  send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
end

#get_identity ⇒ Object

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 :ref:‘here <device_identifier>`. |device_identifier_constant|



238
239
240
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 238

def get_identity
  send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
end

#get_illuminance ⇒ Object

Returns the illuminance of the ambient light sensor. The value has a range of 0 to 9000 and is given in lux/10, i.e. a value of 4500 means that an illuminance of 450lux is measured.

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



108
109
110
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 108

def get_illuminance
  send_request(FUNCTION_GET_ILLUMINANCE, [], '', 2, 'S')
end

#get_illuminance_callback_period ⇒ Object

Returns the period as set by BrickletAmbientLight#set_illuminance_callback_period.



144
145
146
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 144

def get_illuminance_callback_period
  send_request(FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD, [], '', 4, 'L')
end

#get_illuminance_callback_threshold ⇒ Object

Returns the threshold as set by BrickletAmbientLight#set_illuminance_callback_threshold.



182
183
184
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 182

def get_illuminance_callback_threshold
  send_request(FUNCTION_GET_ILLUMINANCE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



243
244
245
246
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 243

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#set_analog_value_callback_period(period) ⇒ Object

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

CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the last triggering.

The default value is 0.



155
156
157
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 155

def set_analog_value_callback_period(period)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_analog_value_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED 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 default value is (‘x’, 0, 0).



199
200
201
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 199

def set_analog_value_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
end

#set_debounce_period(debounce) ⇒ Object

Sets the period in ms with which the threshold callbacks

  • CALLBACK_ILLUMINANCE_REACHED,

  • CALLBACK_ANALOG_VALUE_REACHED

are triggered, if the thresholds

  • BrickletAmbientLight#set_illuminance_callback_threshold,

  • BrickletAmbientLight#set_analog_value_callback_threshold

keep being reached.

The default value is 100.



221
222
223
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 221

def set_debounce_period(debounce)
  send_request(FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, '')
end

#set_illuminance_callback_period(period) ⇒ Object

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.



139
140
141
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 139

def set_illuminance_callback_period(period)
  send_request(FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD, [period], 'L', 0, '')
end

#set_illuminance_callback_threshold(option, min, max) ⇒ Object

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



177
178
179
 
# File 'lib/tinkerforge/bricklet_ambient_light.rb', line 177

def set_illuminance_callback_threshold(option, min, max)
  send_request(FUNCTION_SET_ILLUMINANCE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, '')
end