class Tinkerforge::BrickletSegmentDisplay4x7V2
Four 7-segment displays with switchable dots
Constants
- CALLBACK_COUNTER_FINISHED
This callback is triggered when the counter (see
BrickletSegmentDisplay4x7V2#start_counter
) is finished.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 63 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_SET_SEGMENTS] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_SEGMENTS] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BRIGHTNESS] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_BRIGHTNESS] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_NUMERIC_VALUE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_SET_SELECTED_SEGMENT] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_SELECTED_SEGMENT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_START_COUNTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_COUNTER_VALUE] = 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_COUNTER_FINISHED] = [8, ''] @ipcon.add_device self end
Public Instance Methods
Returns the current bootloader mode, see BrickletSegmentDisplay4x7V2#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 232 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
Returns the brightness as set by BrickletSegmentDisplay4x7V2#set_brightness
.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 126 def get_brightness check_validity send_request FUNCTION_GET_BRIGHTNESS, [], '', 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_segment_display_4x7_v2.rb, line 290 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the counter value that is currently shown on the display.
If there is no counter running a 0 will be returned.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 193 def get_counter_value check_validity send_request FUNCTION_GET_COUNTER_VALUE, [], '', 10, 'S' 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_segment_display_4x7_v2.rb, line 337 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the segment data as set by BrickletSegmentDisplay4x7V2#set_segments
.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 112 def get_segments check_validity send_request FUNCTION_GET_SEGMENTS, [], '', 14, '?8 ?8 ?8 ?8 ?2 ?' end
Returns the value of a single segment.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 166 def get_selected_segment(segment) check_validity send_request FUNCTION_GET_SELECTED_SEGMENT, [segment], 'C', 9, '?' 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_segment_display_4x7_v2.rb, line 210 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 BrickletSegmentDisplay4x7V2#set_status_led_config
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 278 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_segment_display_4x7_v2.rb, line 321 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_segment_display_4x7_v2.rb, line 342 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_segment_display_4x7_v2.rb, line 302 def reset check_validity send_request FUNCTION_RESET, [], '', 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_segment_display_4x7_v2.rb, line 225 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
The brightness can be set between 0 (dark) and 7 (bright).
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 119 def set_brightness(brightness) check_validity send_request FUNCTION_SET_BRIGHTNESS, [brightness], 'C', 8, '' end
Sets a numeric value for each of the digits. They represent:
-
-2: minus sign
-
-1: blank
-
0-9: 0-9
-
10: A
-
11: b
-
12: C
-
13: d
-
14: E
-
15: F
Example: A call with [-2, -1, 4, 2] will result in a display of “- 42”.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 145 def set_numeric_value(value) check_validity send_request FUNCTION_SET_NUMERIC_VALUE, [value], 'c4', 8, '' end
Sets the segments of the Segment Display 4x7 Bricklet 2.0 segment-by-segment.
The data is split into the four digits, two colon dots and the tick mark.
The indices of the segments in the digit and colon parameters are as follows:
- .. image
-
/Images/Bricklets/bricklet_segment_display_4x7_v2_segment_index.png
:scale: 100 % :alt: Indices of segments :align: center
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 105 def set_segments(digit0, digit1, digit2, digit3, colon, tick) check_validity send_request FUNCTION_SET_SEGMENTS, [digit0, digit1, digit2, digit3, colon, tick], '?8 ?8 ?8 ?8 ?2 ?', 8, '' end
Turns one specified segment on or off.
The indices of the segments are as follows:
- .. image
-
/Images/Bricklets/bricklet_segment_display_4x7_v2_selected_segment_index.png
:scale: 100 % :alt: Indices of selected segments :align: center
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 159 def set_selected_segment(segment, value) check_validity send_request FUNCTION_SET_SELECTED_SEGMENT, [segment, value], '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_segment_display_4x7_v2.rb, line 271 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
Sets the firmware pointer for BrickletSegmentDisplay4x7V2#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_segment_display_4x7_v2.rb, line 244 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Starts a counter with the from value that counts to the to value with the each step incremented by increment. length is the pause between each increment.
Example: If you set from to 0, to to 100, increment to 1 and length to 1000, a counter that goes from 0 to 100 with one second pause between each increment will be started.
Using a negative increment allows to count backwards.
You can stop the counter at every time by calling BrickletSegmentDisplay4x7V2#set_segments
or BrickletSegmentDisplay4x7V2#set_numeric_value
.
# File lib/tinkerforge/bricklet_segment_display_4x7_v2.rb, line 184 def start_counter(value_from, value_to, increment, length) check_validity send_request FUNCTION_START_COUNTER, [value_from, value_to, increment, length], 's s s L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletSegmentDisplay4x7V2#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_segment_display_4x7_v2.rb, line 258 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_segment_display_4x7_v2.rb, line 313 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end