PHP - Segment Display 4x7 Bricklet

This is the description of the PHP 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 PHP API bindings is part of their general description.

Examples

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

Simple

Download (ExampleSimple.php)

 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
30
31
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletSegmentDisplay4x7.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSegmentDisplay4x7;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet
$DIGITS = array(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 = new IPConnection(); // Create IP connection
$sd = new BrickletSegmentDisplay4x7(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 = array($DIGITS[4], $DIGITS[2], $DIGITS[2], $DIGITS[3]);
$sd->setSegments($segments, 7, false);

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

Temperature

Download (ExampleTemperature.php)

 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
30
31
32
33
34
35
36
37
38
39
40
41
<?php

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletSegmentDisplay4x7.php');
require_once('Tinkerforge/BrickletTemperature.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSegmentDisplay4x7;
use Tinkerforge\BrickletTemperature;

const HOST = 'localhost';
const PORT = 4223;
const UID_DISP = 'XYZ1'; // Change to your Segment Display 4x7 Bricklet UID
const UID_TEMP = 'XYZ2'; // Change to your Temperature Bricklet UID
$DIGITS = array(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 = new IPConnection(); // Create IP connection
$sd = new BrickletSegmentDisplay4x7(UID_DISP, $ipcon); // Create device object
$t = new BrickletTemperature(UID_TEMP, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Get current temperature (unit is °C/100)
$temperature = $t->getTemperature();

// Write temperature to the display with full brightness with colon
$segments = array($DIGITS[($temperature / 1000) % 10],
                  $DIGITS[($temperature / 100) % 10],
                  $DIGITS[($temperature / 10) % 10],
                  $DIGITS[$temperature % 10]);
$sd->setSegments($segments, 7, true);

echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();

?>

API

Functions that return multiple values return them in an associative array.

Basic Functions

class BrickletSegmentDisplay4x7(string $uid, IPConnection $ipcon)
Parameters:
  • $uid – Type: string
  • $ipcon – Type: IPConnection
Returns:
  • $segment_display_4x7 – Type: BrickletSegmentDisplay4x7

Creates an object with the unique device ID $uid:

<?php   $segment_display_4x7 = new BrickletSegmentDisplay4x7('YOUR_DEVICE_UID', $ipcon);   ?>

This object can then be used after the IP Connection is connected (see examples above).

void BrickletSegmentDisplay4x7::setSegments(array $segments, int $brightness, bool $colon)
Parameters:
  • $segments – Type: array(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:

Bit order of 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.

array BrickletSegmentDisplay4x7::getSegments()
Return Array:
  • 'segments' – Type: array(int, ...), Length: 4, Range: [0 to 127]
  • 'brightness' – Type: int, Range: [0 to 7]
  • 'colon' – Type: bool

Returns the segment, brightness and color data as set by setSegments().

Advanced Functions

void BrickletSegmentDisplay4x7::startCounter(int $value_from, int $value_to, int $increment, int $length)
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 setSegments().

int BrickletSegmentDisplay4x7::getCounterValue()
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.

array BrickletSegmentDisplay4x7::getIdentity()
Return Array:
  • 'uid' – Type: string, Length: up to 8
  • 'connected_uid' – Type: string, Length: up to 8
  • 'position' – Type: string, Range: ['a' to 'i', 'z']
  • 'hardware_version' – Type: array(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]
  • 'firmware_version' – Type: array(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]
  • '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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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

void BrickletSegmentDisplay4x7::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)
Parameters:
  • $callback_id – Type: int
  • $callback – Type: callable
  • $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

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 registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$segment_display_4x7->registerCallback(BrickletSegmentDisplay4x7::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletSegmentDisplay4x7::CALLBACK_COUNTER_FINISHED
<?php   void callback([mixed $user_data])   ?>
Callback Parameters:
  • $user_data – Type: mixed

This callback is triggered when the counter (see startCounter()) 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.

array BrickletSegmentDisplay4x7::getAPIVersion()
Return Array:
  • $api_version – Type: array(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.

bool BrickletSegmentDisplay4x7::getResponseExpected(int $function_id)
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 setResponseExpected(). 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 send 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
void BrickletSegmentDisplay4x7::setResponseExpected(int $function_id, bool $response_expected)
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 send 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
void BrickletSegmentDisplay4x7::setResponseExpectedAll(bool $response_expected)
Parameters:
  • $response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

int BrickletSegmentDisplay4x7::DEVICE_IDENTIFIER

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

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletSegmentDisplay4x7::DEVICE_DISPLAY_NAME

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