class Tinkerforge::BrickletIndustrialCounter
4 channel counter up to 4MHz
Constants
- CALLBACK_ALL_COUNTER
This callback is triggered periodically according to the configuration set by
BrickletIndustrialCounter#set_all_counter_callback_configuration
.The parameters are the same as
BrickletIndustrialCounter#get_all_counter
.- CALLBACK_ALL_SIGNAL_DATA
This callback is triggered periodically according to the configuration set by
BrickletIndustrialCounter#set_all_signal_data_callback_configuration
.The parameters are the same as
BrickletIndustrialCounter#get_all_signal_data
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 120 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_GET_COUNTER] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_ALL_COUNTER] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_COUNTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_SET_ALL_COUNTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_SIGNAL_DATA] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_ALL_SIGNAL_DATA] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_COUNTER_ACTIVE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_SET_ALL_COUNTER_ACTIVE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_COUNTER_ACTIVE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_ALL_COUNTER_ACTIVE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_COUNTER_CONFIGURATION] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_COUNTER_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_CHANNEL_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_ALL_COUNTER] = [40, 'q4'] @callback_formats[CALLBACK_ALL_SIGNAL_DATA] = [65, 'S4 Q4 L4 ?4'] @ipcon.add_device self end
Public Instance Methods
Returns the current counter values for all four channels.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 170 def get_all_counter check_validity send_request FUNCTION_GET_ALL_COUNTER, [], '', 40, 'q4' end
Returns the activation state of all four channels.
true = activated, false = deactivated.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 244 def get_all_counter_active check_validity send_request FUNCTION_GET_ALL_COUNTER_ACTIVE, [], '', 9, '?4' end
Returns the callback configuration as set by BrickletIndustrialCounter#set_all_counter_callback_configuration
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 294 def get_all_counter_callback_configuration check_validity send_request FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
Returns the signal data (duty cycle, period, frequency and value) for all four channels.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 204 def get_all_signal_data check_validity send_request FUNCTION_GET_ALL_SIGNAL_DATA, [], '', 65, 'S4 Q4 L4 ?4' end
Returns the callback configuration as set by BrickletIndustrialCounter#set_all_signal_data_callback_configuration
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 317 def get_all_signal_data_callback_configuration check_validity send_request FUNCTION_GET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
Returns the current bootloader mode, see BrickletIndustrialCounter#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 372 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
Returns the channel LED configuration as set by BrickletIndustrialCounter#set_channel_led_config
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 333 def get_channel_led_config(channel) check_validity send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 9, 'C' end
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 430 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the current counter value for the given channel.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 163 def get_counter(channel) check_validity send_request FUNCTION_GET_COUNTER, [channel], 'C', 16, 'q' end
Returns the activation state of the given channel.
true = activated, false = deactivated.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 235 def get_counter_active(channel) check_validity send_request FUNCTION_GET_COUNTER_ACTIVE, [channel], 'C', 9, '?' end
Returns the counter configuration as set by BrickletIndustrialCounter#set_counter_configuration
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 271 def get_counter_configuration(channel) check_validity send_request FUNCTION_GET_COUNTER_CONFIGURATION, [channel], 'C', 12, 'C C C C' end
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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 477 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the signal data (duty cycle, period, frequency and value) for the given channel.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 196 def get_signal_data(channel) check_validity send_request FUNCTION_GET_SIGNAL_DATA, [channel], 'C', 23, 'S Q L ?' end
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
-
ACK checksum errors,
-
message checksum errors,
-
framing errors and
-
overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 350 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletIndustrialCounter#set_status_led_config
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 418 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 461 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 482 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 442 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
Sets the counter values for all four channels.
The default value for the counters on startup is 0.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 188 def set_all_counter(counter) check_validity send_request FUNCTION_SET_ALL_COUNTER, [counter], 'q4', 8, '' end
Activates/deactivates the counter of all four channels.
true = activate, false = deactivate.
By default all channels are activated.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 226 def set_all_counter_active(active) check_validity send_request FUNCTION_SET_ALL_COUNTER_ACTIVE, [active], '?4', 8, '' end
The period is the period with which the CALLBACK_ALL_COUNTER
callback is triggered periodically. A value of 0 turns the callback off.
If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 286 def set_all_counter_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
The period is the period with which the CALLBACK_ALL_SIGNAL_DATA
callback is triggered periodically. A value of 0 turns the callback off.
If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.
If it is set to false, the callback is continuously triggered with the period, independent of the value.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 309 def set_all_signal_data_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 365 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to “Channel Status”. In this mode the LED is on if the channel is high and off otherwise.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 326 def set_channel_led_config(channel, config) check_validity send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, '' end
Sets the counter value for the given channel.
The default value for the counters on startup is 0.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 179 def set_counter(channel, counter) check_validity send_request FUNCTION_SET_COUNTER, [channel, counter], 'C q', 8, '' end
Activates/deactivates the counter of the given channel.
true = activate, false = deactivate.
By default all channels are activated.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 215 def set_counter_active(channel, active) check_validity send_request FUNCTION_SET_COUNTER_ACTIVE, [channel, active], 'C ?', 8, '' end
Sets the counter configuration for the given channel.
-
Count Edge: Counter can count on rising, falling or both edges.
-
Count Direction: Counter can count up or down. You can also use another channel as direction input, see `here <`__“>www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Counter.html#duty-cycle-prescaler-and-frequency-integration-time>`__ for details.
-
Frequency Integration Time: Sets the integration time for the frequency measurement. See `here <
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 264 def set_counter_configuration(channel, count_edge, count_direction, duty_cycle_prescaler, frequency_integration_time) check_validity send_request FUNCTION_SET_COUNTER_CONFIGURATION, [channel, count_edge, count_direction, duty_cycle_prescaler, frequency_integration_time], 'C C C C C', 8, '' end
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 411 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
Sets the firmware pointer for BrickletIndustrialCounter#write_firmware
. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 384 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletIndustrialCounter#set_write_firmware_pointer
before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 398 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58
encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
# File lib/tinkerforge/bricklet_industrial_counter.rb, line 453 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end