PHP - Segment Display 4x7 Bricklet 2.0

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

Examples

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

Numeric Value

Download (ExampleNumericValue.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSegmentDisplay4x7V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

$ipcon = new IPConnection(); // Create IP connection
$sd = new BrickletSegmentDisplay4x7V2(UID, $ipcon); // Create device object

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

$sd->setBrightness(7); // Set to full brightness

// Show "- 42" on the Display
$sd->setNumericValue(array(-2, -1, 4, 2));

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

?>

Set Segments

Download (ExampleSetSegments.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
<?php

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

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletSegmentDisplay4x7V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

$ipcon = new IPConnection(); // Create IP connection
$sd = new BrickletSegmentDisplay4x7V2(UID, $ipcon); // Create device object

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

$sd->setBrightness(7); // Set to full brightness

// Activate all segments
$sd->setSegments(array(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
                 array(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
                 array(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE),
                 array(TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE, TRUE), array(TRUE, TRUE),
                 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 BrickletSegmentDisplay4x7V2(string $uid, IPConnection $ipcon)

Creates an object with the unique device ID $uid:

<?php   $segment_display_4x7_v2 = new BrickletSegmentDisplay4x7V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

void BrickletSegmentDisplay4x7V2::setSegments(array $digit0, array $digit1, array $digit2, array $digit3, array $colon, bool $tick)

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
array BrickletSegmentDisplay4x7V2::getSegments()

Returns the segment data as set by setSegments().

The returned array has the keys digit0, digit1, digit2, digit3, colon and tick.

void BrickletSegmentDisplay4x7V2::setBrightness(int $brightness)

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

The default value is 7.

int BrickletSegmentDisplay4x7V2::getBrightness()

Returns the brightness as set by setBrightness().

void BrickletSegmentDisplay4x7V2::setNumericValue(array $value)

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

void BrickletSegmentDisplay4x7V2::setSelectedSegment(int $segment, bool $value)

Turns one specified segment on or off.

The indices of the segments are as follows:

Indices of selected segments
bool BrickletSegmentDisplay4x7V2::getSelectedSegment(int $segment)

Returns the value of a single segment.

Advanced Functions

void BrickletSegmentDisplay4x7V2::startCounter(int $value_from, int $value_to, int $increment, int $length)

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 setSegments() or setNumericValue().

int BrickletSegmentDisplay4x7V2::getCounterValue()

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

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

array BrickletSegmentDisplay4x7V2::getAPIVersion()

Returns the version of the API definition (major, minor, revision) 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 BrickletSegmentDisplay4x7V2::getResponseExpected(int $function_id)

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.

See setResponseExpected() for the list of function ID constants available for this function.

void BrickletSegmentDisplay4x7V2::setResponseExpected(int $function_id, bool $response_expected)

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 function ID constants are available for this function:

  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_BRIGHTNESS = 3
  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_NUMERIC_VALUE = 5
  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_SELECTED_SEGMENT = 6
  • BrickletSegmentDisplay4x7V2::FUNCTION_START_COUNTER = 8
  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletSegmentDisplay4x7V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletSegmentDisplay4x7V2::FUNCTION_RESET = 243
  • BrickletSegmentDisplay4x7V2::FUNCTION_WRITE_UID = 248
void BrickletSegmentDisplay4x7V2::setResponseExpectedAll(bool $response_expected)

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

array BrickletSegmentDisplay4x7V2::getSPITFPErrorCount()

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.

The returned array has the keys error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

int BrickletSegmentDisplay4x7V2::setBootloaderMode(int $mode)

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 constants are available for this function:

  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_OK = 0
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletSegmentDisplay4x7V2::getBootloaderMode()

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletSegmentDisplay4x7V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletSegmentDisplay4x7V2::setWriteFirmwarePointer(int $pointer)

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

int BrickletSegmentDisplay4x7V2::writeFirmware(array $data)

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

void BrickletSegmentDisplay4x7V2::setStatusLEDConfig(int $config)

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 constants are available for this function:

  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_ON = 1
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletSegmentDisplay4x7V2::getStatusLEDConfig()

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_OFF = 0
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_ON = 1
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletSegmentDisplay4x7V2::STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletSegmentDisplay4x7V2::getChipTemperature()

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.

void BrickletSegmentDisplay4x7V2::reset()

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!

void BrickletSegmentDisplay4x7V2::writeUID(int $uid)

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.

int BrickletSegmentDisplay4x7V2::readUID()

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

array BrickletSegmentDisplay4x7V2::getIdentity()

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. There is also a constant for the device identifier of this Bricklet.

The returned array has the keys uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

void BrickletSegmentDisplay4x7V2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)

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_v2->registerCallback(BrickletSegmentDisplay4x7V2::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 BrickletSegmentDisplay4x7V2::CALLBACK_COUNTER_FINISHED
<?php   void callback([mixed $user_data])   ?>

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

Constants

int BrickletSegmentDisplay4x7V2::DEVICE_IDENTIFIER

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

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 BrickletSegmentDisplay4x7V2::DEVICE_DISPLAY_NAME

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