Ruby - Segment Display 4x7 Bricklet¶

Simple¶

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_segment_display_4x7'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Segment Display 4x7 Bricklet
DIGITS = [0x3f,0x06,0x5b,0x4f,
          0x66,0x6d,0x7d,0x07,
          0x7f,0x6f,0x77,0x7c,
          0x39,0x5e,0x79,0x71] # // 0~9,A,b,C,d,E,F

ipcon = IPConnection.new # Create IP connection
sd = BrickletSegmentDisplay4x7.new UID, ipcon # Create device object

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

# Write "4223" to the display with full brightness without colon
segments = [DIGITS[4], DIGITS[2], DIGITS[2], DIGITS[3]]
sd.set_segments segments, 7, false

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

Basic Functions¶

BrickletSegmentDisplay4x7::new(uid, ipcon) → segment_display_4x7¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	segment_display_4x7 – Type: BrickletSegmentDisplay4x7

Creates an object with the unique device ID uid:

segment_display_4x7 = BrickletSegmentDisplay4x7.new 'YOUR_DEVICE_UID', ipcon

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

BrickletSegmentDisplay4x7#set_segments(segments, brightness, colon) → nil¶

Parameters:	segments – Type: [int, ...], Length: 4, Range: [0 to 127] brightness – Type: int, Range: [0 to 7] colon – Type: bool

The 7-segment display can be set with bitmaps. Every bit controls one segment:

For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6. This is represented by the number 0b01101101 = 0x6d = 109.

The brightness can be set between 0 (dark) and 7 (bright). The colon parameter turns the colon of the display on or off.

BrickletSegmentDisplay4x7#get_segments → [[int, ...], int, bool]¶

Return Array:	0: segments – Type: [int, ...], Length: 4, Range: [0 to 127] 1: brightness – Type: int, Range: [0 to 7] 2: colon – Type: bool

Returns the segment, brightness and color data as set by #set_segments.

Advanced Functions¶

BrickletSegmentDisplay4x7#start_counter(value_from, value_to, increment, length) → nil¶

Parameters:	value_from – Type: int, Range: [-999 to 9999] value_to – Type: int, Range: [-999 to 9999] increment – Type: int, Range: [-999 to 9999] length – Type: int, Unit: 1 ms, Range: [0 to 232 - 1]

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 #set_segments.

BrickletSegmentDisplay4x7#get_counter_value → int¶

Returns:	value – Type: int, Range: [-999 to 9999]

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

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

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

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 216 - 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¶

BrickletSegmentDisplay4x7#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.

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:

segment_display_4x7.register_callback BrickletSegmentDisplay4x7::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

BrickletSegmentDisplay4x7::CALLBACK_COUNTER_FINISHED¶

Callback Parameters:	no parameters

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

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.

BrickletSegmentDisplay4x7#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.

BrickletSegmentDisplay4x7#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:

• BrickletSegmentDisplay4x7::FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7::FUNCTION_START_COUNTER = 3

BrickletSegmentDisplay4x7#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.

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:

• BrickletSegmentDisplay4x7::FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7::FUNCTION_START_COUNTER = 3

BrickletSegmentDisplay4x7#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¶

BrickletSegmentDisplay4x7::DEVICE_IDENTIFIER¶

This constant is used to identify a Segment Display 4x7 Bricklet.

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.

BrickletSegmentDisplay4x7::DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Segment Display 4x7 Bricklet.