Shell - Segment Display 4x7 Bricklet 2.0

This is the description of the Shell API bindings for the Segment Display 4x7 Bricklet 2.0. General information and technical specifications for the Segment Display 4x7 Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Numeric Value

Download (example-numeric-value.sh)

1
2
3
4
5
6
7
8
9
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

tinkerforge call segment-display-4x7-v2-bricklet $uid set-brightness 7 # Set to full brightness

# Show "- 42" on the Display
tinkerforge call segment-display-4x7-v2-bricklet $uid set-numeric-value -- -- -2,-1,4,2

Set Segments

Download (example-set-segments.sh)

1
2
3
4
5
6
7
8
9
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

tinkerforge call segment-display-4x7-v2-bricklet $uid set-brightness 7 # Set to full brightness

# Activate all segments
tinkerforge call segment-display-4x7-v2-bricklet $uid set-segments true,true,true,true,true,true,true,true true,true,true,true,true,true,true,true true,true,true,true,true,true,true,true true,true,true,true,true,true,true,true true,true true

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call segment-display-4x7-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Segment Display 4x7 Bricklet 2.0. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Segment Display 4x7 Bricklet 2.0 and exits
tinkerforge dispatch segment-display-4x7-v2-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Segment Display 4x7 Bricklet 2.0. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Segment Display 4x7 Bricklet 2.0 and exits
tinkerforge call segment-display-4x7-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch segment-display-4x7-v2-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-segments <digit0> <digit1> <digit2> <digit3> <colon> <tick>
Parameters:
  • <digit0> -- bool,bool,..5x..,bool
  • <digit1> -- bool,bool,..5x..,bool
  • <digit2> -- bool,bool,..5x..,bool
  • <digit3> -- bool,bool,..5x..,bool
  • <colon> -- bool,bool
  • <tick> -- bool
Output:

no output

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:

Indices of segments
tinkerforge call segment-display-4x7-v2-bricklet <uid> get-segments
Output:
  • digit0 -- bool,bool,..5x..,bool
  • digit1 -- bool,bool,..5x..,bool
  • digit2 -- bool,bool,..5x..,bool
  • digit3 -- bool,bool,..5x..,bool
  • colon -- bool,bool
  • tick -- bool

Returns the segment data as set by set-segments.

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-brightness <brightness>
Parameters:
  • <brightness> -- int
Output:

no output

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

The default value is 7.

tinkerforge call segment-display-4x7-v2-bricklet <uid> get-brightness
Output:
  • brightness -- int

Returns the brightness as set by set-brightness.

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-numeric-value <value>
Parameters:
  • <value> -- int,int,int,int
Output:

no output

Sets a numeric value for each of the digits. The values can be between -2 and 15. 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".

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-selected-segment <segment> <value>
Parameters:
  • <segment> -- int
  • <value> -- bool
Output:

no output

Turns one specified segment on or off.

The indices of the segments are as follows:

Indices of selected segments
tinkerforge call segment-display-4x7-v2-bricklet <uid> get-selected-segment <segment>
Parameters:
  • <segment> -- int
Output:
  • value -- bool

Returns the value of a single segment.

Advanced Functions

tinkerforge call segment-display-4x7-v2-bricklet <uid> start-counter <value-from> <value-to> <increment> <length>
Parameters:
  • <value-from> -- int
  • <value-to> -- int
  • <increment> -- int
  • <length> -- int
Output:

no output

Starts a counter with the from value that counts to the to value with the each step incremented by increment. The length of the increment is given in ms.

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.

The maximum values for from, to and increment is 9999, the minimum value is -999.

Using a negative increment allows to count backwards.

You can stop the counter at every time by calling set-segments or set-numeric-value.

tinkerforge call segment-display-4x7-v2-bricklet <uid> get-counter-value
Output:
  • value -- int

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

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

tinkerforge call segment-display-4x7-v2-bricklet <uid> get-spitfp-error-count
Output:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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.

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-bootloader-mode <mode>
Parameters:
  • <mode> -- int (has symbols)
Output:
  • status -- int (has symbols)

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.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for <mode>
  • bootloader-mode-firmware = 1, for <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, for <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, for <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for <mode>
  • bootloader-status-ok = 0, for status
  • bootloader-status-invalid-mode = 1, for status
  • bootloader-status-no-change = 2, for status
  • bootloader-status-entry-function-not-present = 3, for status
  • bootloader-status-device-identifier-incorrect = 4, for status
  • bootloader-status-crc-mismatch = 5, for status
tinkerforge call segment-display-4x7-v2-bricklet <uid> get-bootloader-mode
Output:
  • mode -- int (has symbols)

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

  • bootloader-mode-bootloader = 0, for mode
  • bootloader-mode-firmware = 1, for mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, for mode
  • bootloader-mode-firmware-wait-for-reboot = 3, for mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, for mode
tinkerforge call segment-display-4x7-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameters:
  • <pointer> -- int
Output:

no output

Sets the firmware pointer for 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.

tinkerforge call segment-display-4x7-v2-bricklet <uid> write-firmware <data>
Parameters:
  • <data> -- int,int,..61x..,int
Output:
  • status -- int

Writes 64 Bytes of firmware at the position as written by 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.

tinkerforge call segment-display-4x7-v2-bricklet <uid> set-status-led-config <config>
Parameters:
  • <config> -- int (has symbols)
Output:

no output

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.

The following symbols are available for this function:

  • status-led-config-off = 0, for <config>
  • status-led-config-on = 1, for <config>
  • status-led-config-show-heartbeat = 2, for <config>
  • status-led-config-show-status = 3, for <config>
tinkerforge call segment-display-4x7-v2-bricklet <uid> get-status-led-config
Output:
  • config -- int (has symbols)

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

  • status-led-config-off = 0, for config
  • status-led-config-on = 1, for config
  • status-led-config-show-heartbeat = 2, for config
  • status-led-config-show-status = 3, for config
tinkerforge call segment-display-4x7-v2-bricklet <uid> get-chip-temperature
Output:
  • temperature -- int

Returns the temperature in °C 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.

tinkerforge call segment-display-4x7-v2-bricklet <uid> reset
Output:no output

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!

tinkerforge call segment-display-4x7-v2-bricklet <uid> write-uid <uid>
Parameters:
  • <uid> -- int
Output:

no output

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.

tinkerforge call segment-display-4x7-v2-bricklet <uid> read-uid
Output:
  • uid -- int

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

tinkerforge call segment-display-4x7-v2-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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 here

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch segment-display-4x7-v2-bricklet <uid> example

The available callbacks are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

tinkerforge dispatch segment-display-4x7-v2-bricklet <uid> counter-finished
Output:no output

This callback is triggered when the counter (see start-counter) is finished.