This is the description of the Shell API bindings for the Segment Display 4x7 Bricklet. General information and technical specifications for the Segment Display 4x7 Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
digits=(63 6 91 79 102 109 125 7 127 111 119 124 57 94 121 113)
# write "4223" to the display with full brightness without colon
segments=${digits[4]},${digits[2]},${digits[2]},${digits[3]}
tinkerforge call segment-display-4x7-bricklet $uid set-segments $segments 7 false
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Segment Display 4x7 Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Segment Display 4x7 Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: | no output |
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.
Output: |
|
---|
Returns the segment, brightness and color data as set by set-segments.
Parameters: |
|
---|---|
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.
Output: |
|
---|
Returns the counter value that is currently shown on the display.
If there is no counter running a 0 will be returned.
Output: |
|
---|
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 can be used to receive time critical or recurring data from the device:
tinkerforge dispatch segment-display-4x7-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.
Output: | no output |
---|
This callback is triggered when the counter (see start-counter) is finished.