Class: Tinkerforge::BrickletSegmentDisplay4x7V2

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

Overview

Four 7-segment displays with switchable dots

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2137
DEVICE_DISPLAY_NAME =

:nodoc:

'Segment Display 4x7 Bricklet 2.0'
CALLBACK_COUNTER_FINISHED =

This callback is triggered when the counter (see BrickletSegmentDisplay4x7V2#start_counter) is finished.

10
FUNCTION_SET_SEGMENTS =

:nodoc:

1
FUNCTION_GET_SEGMENTS =

:nodoc:

2
FUNCTION_SET_BRIGHTNESS =

:nodoc:

3
FUNCTION_GET_BRIGHTNESS =

:nodoc:

4
FUNCTION_SET_NUMERIC_VALUE =

:nodoc:

5
FUNCTION_SET_SELECTED_SEGMENT =

:nodoc:

6
FUNCTION_GET_SELECTED_SEGMENT =

:nodoc:

7
FUNCTION_START_COUNTER =

:nodoc:

8
FUNCTION_GET_COUNTER_VALUE =

:nodoc:

9
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, 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, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

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

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletSegmentDisplay4x7V2

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 64

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

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletSegmentDisplay4x7V2#set_bootloader_mode.



233
234
235
236
237
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 233

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_brightness ⇒ Object

Returns the brightness as set by BrickletSegmentDisplay4x7V2#set_brightness.



127
128
129
130
131
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 127

def get_brightness
  check_validity

  send_request FUNCTION_GET_BRIGHTNESS, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

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.



291
292
293
294
295
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 291

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_counter_value ⇒ Object

Returns the counter value that is currently shown on the display.

If there is no counter running a 0 will be returned.



194
195
196
197
198
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 194

def get_counter_value
  check_validity

  send_request FUNCTION_GET_COUNTER_VALUE, [], '', 10, 'S'
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’, ‘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|



338
339
340
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 338

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_segments ⇒ Object

Returns the segment data as set by BrickletSegmentDisplay4x7V2#set_segments.



113
114
115
116
117
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 113

def get_segments
  check_validity

  send_request FUNCTION_GET_SEGMENTS, [], '', 14, '?8 ?8 ?8 ?8 ?2 ?'
end

#get_selected_segment(segment) ⇒ Object

Returns the value of a single segment.



167
168
169
170
171
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 167

def get_selected_segment(segment)
  check_validity

  send_request FUNCTION_GET_SELECTED_SEGMENT, [segment], 'C', 9, '?'
end

#get_spitfp_error_count ⇒ Object

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.



211
212
213
214
215
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 211

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletSegmentDisplay4x7V2#set_status_led_config



279
280
281
282
283
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 279

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#read_uid ⇒ Object

Returns the current UID as an integer. Encode as Base58 to get the usual string version.



322
323
324
325
326
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 322

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



343
344
345
346
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 343

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

#reset ⇒ Object

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!



303
304
305
306
307
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 303

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



226
227
228
229
230
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 226

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_brightness(brightness) ⇒ Object

The brightness can be set between 0 (dark) and 7 (bright).



120
121
122
123
124
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 120

def set_brightness(brightness)
  check_validity

  send_request FUNCTION_SET_BRIGHTNESS, [brightness], 'C', 8, ''
end

#set_numeric_value(value) ⇒ Object

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



146
147
148
149
150
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 146

def set_numeric_value(value)
  check_validity

  send_request FUNCTION_SET_NUMERIC_VALUE, [value], 'c4', 8, ''
end

#set_segments(digit0, digit1, digit2, digit3, colon, tick) ⇒ Object

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



106
107
108
109
110
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 106

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

#set_selected_segment(segment, value) ⇒ Object

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



160
161
162
163
164
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 160

def set_selected_segment(segment, value)
  check_validity

  send_request FUNCTION_SET_SELECTED_SEGMENT, [segment, value], 'C ?', 8, ''
end

#set_status_led_config(config) ⇒ Object

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.



272
273
274
275
276
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 272

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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.



245
246
247
248
249
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 245

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#start_counter(value_from, value_to, increment, length) ⇒ Object

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.



185
186
187
188
189
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 185

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

#write_firmware(data) ⇒ Object

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.



259
260
261
262
263
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 259

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



314
315
316
317
318
 
# File 'lib/tinkerforge/bricklet_segment_display_4x7_v2.rb', line 314

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end