C/C++ - Segment Display 4x7 Bricklet 2.0

This is the description of the C/C++ 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 C/C++ 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.c)

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_segment_display_4x7_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    SegmentDisplay4x7V2 sd;
    segment_display_4x7_v2_create(&sd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    segment_display_4x7_v2_set_brightness(&sd, 7); // Set to full brightness

    // Show "- 42" on the Display
    int8_t value[4] = {-2, -1, 4, 2};
    segment_display_4x7_v2_set_numeric_value(&sd, value);

    printf("Press key to exit\n");
    getchar();
    segment_display_4x7_v2_destroy(&sd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Set Segments

Download (example_set_segments.c)

 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
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_segment_display_4x7_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Segment Display 4x7 Bricklet 2.0

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    SegmentDisplay4x7V2 sd;
    segment_display_4x7_v2_create(&sd, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    segment_display_4x7_v2_set_brightness(&sd, 7); // Set to full brightness

    // Activate all segments
    bool digit0[8] = {true, true, true, true, true, true, true, true};
    bool digit1[8] = {true, true, true, true, true, true, true, true};
    bool digit2[8] = {true, true, true, true, true, true, true, true};
    bool digit3[8] = {true, true, true, true, true, true, true, true};
    bool colon[2] = {true, true};
    segment_display_4x7_v2_set_segments(&sd, digit0, digit1, digit2, digit3, colon, true);

    printf("Press key to exit\n");
    getchar();
    segment_display_4x7_v2_destroy(&sd);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix.

Possible error codes are:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (unused since C/C++ bindings version 2.0.0)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void segment_display_4x7_v2_create(SegmentDisplay4x7V2 *segment_display_4x7_v2, const char *uid, IPConnection *ipcon)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

Creates the device object segment_display_4x7_v2 with the unique device ID uid and adds it to the IPConnection ipcon:

SegmentDisplay4x7V2 segment_display_4x7_v2;
segment_display_4x7_v2_create(&segment_display_4x7_v2, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void segment_display_4x7_v2_destroy(SegmentDisplay4x7V2 *segment_display_4x7_v2)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *

Removes the device object segment_display_4x7_v2 from its IPConnection and destroys it. The device object cannot be used anymore afterwards.

int segment_display_4x7_v2_set_segments(SegmentDisplay4x7V2 *segment_display_4x7_v2, bool digit0[8], bool digit1[8], bool digit2[8], bool digit3[8], bool colon[2], bool tick)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • digit0 – Type: bool[8]
  • digit1 – Type: bool[8]
  • digit2 – Type: bool[8]
  • digit3 – Type: bool[8]
  • colon – Type: bool[2]
  • tick – Type: bool
Returns:
  • error_code – Type: int

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
int segment_display_4x7_v2_get_segments(SegmentDisplay4x7V2 *segment_display_4x7_v2, bool ret_digit0[8], bool ret_digit1[8], bool ret_digit2[8], bool ret_digit3[8], bool ret_colon[2], bool *ret_tick)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_digit0 – Type: bool[8]
  • ret_digit1 – Type: bool[8]
  • ret_digit2 – Type: bool[8]
  • ret_digit3 – Type: bool[8]
  • ret_colon – Type: bool[2]
  • ret_tick – Type: bool
Returns:
  • error_code – Type: int

Returns the segment data as set by segment_display_4x7_v2_set_segments().

int segment_display_4x7_v2_set_brightness(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t brightness)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • brightness – Type: uint8_t, Range: [0 to 7], Default: 7
Returns:
  • error_code – Type: int

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

int segment_display_4x7_v2_get_brightness(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_brightness)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_brightness – Type: uint8_t, Range: [0 to 7], Default: 7
Returns:
  • error_code – Type: int

Returns the brightness as set by segment_display_4x7_v2_set_brightness().

int segment_display_4x7_v2_set_numeric_value(SegmentDisplay4x7V2 *segment_display_4x7_v2, int8_t value[4])
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • value – Type: int8_t[4], Range: [-2 to 15]
Returns:
  • error_code – Type: int

Sets a numeric value for each of the digits. 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".

int segment_display_4x7_v2_set_selected_segment(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t segment, bool value)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • segment – Type: uint8_t, Range: [0 to 31]
  • value – Type: bool
Returns:
  • error_code – Type: int

Turns one specified segment on or off.

The indices of the segments are as follows:

Indices of selected segments
int segment_display_4x7_v2_get_selected_segment(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t segment, bool *ret_value)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • segment – Type: uint8_t, Range: [0 to 31]
Output Parameters:
  • ret_value – Type: bool
Returns:
  • error_code – Type: int

Returns the value of a single segment.

Advanced Functions

int segment_display_4x7_v2_start_counter(SegmentDisplay4x7V2 *segment_display_4x7_v2, int16_t value_from, int16_t value_to, int16_t increment, uint32_t length)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • value_from – Type: int16_t, Range: [-999 to 9999]
  • value_to – Type: int16_t, Range: [-999 to 9999]
  • increment – Type: int16_t, Range: [-999 to 9999]
  • length – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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 segment_display_4x7_v2_set_segments() or segment_display_4x7_v2_set_numeric_value().

int segment_display_4x7_v2_get_counter_value(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint16_t *ret_value)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_value – Type: uint16_t, Range: [-999 to 9999]
Returns:
  • error_code – Type: int

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

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

int segment_display_4x7_v2_get_spitfp_error_count(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: 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.

int segment_display_4x7_v2_set_bootloader_mode(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

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:

For mode:

  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_OK = 0
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int segment_display_4x7_v2_get_bootloader_mode(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_mode)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

Returns the current bootloader mode, see segment_display_4x7_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • SEGMENT_DISPLAY_4X7_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int segment_display_4x7_v2_set_write_firmware_pointer(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t pointer)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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

int segment_display_4x7_v2_write_firmware(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t data[64], uint8_t *ret_status)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • data – Type: uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

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

int segment_display_4x7_v2_set_status_led_config(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t config)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

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:

For config:

  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_OFF = 0
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_ON = 1
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int segment_display_4x7_v2_get_status_led_config(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t *ret_config)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Returns the configuration as set by segment_display_4x7_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_OFF = 0
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_ON = 1
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • SEGMENT_DISPLAY_4X7_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int segment_display_4x7_v2_get_chip_temperature(SegmentDisplay4x7V2 *segment_display_4x7_v2, int16_t *ret_temperature)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • error_code – Type: int

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

int segment_display_4x7_v2_reset(SegmentDisplay4x7V2 *segment_display_4x7_v2)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Returns:
  • error_code – Type: int

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!

int segment_display_4x7_v2_write_uid(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t uid)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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 segment_display_4x7_v2_read_uid(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint32_t *ret_uid)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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

int segment_display_4x7_v2_get_identity(SegmentDisplay4x7V2 *segment_display_4x7_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • ret_hardware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_firmware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_device_identifier – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • error_code – Type: int

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 segment_display_4x7_v2_register_callback(SegmentDisplay4x7V2 *segment_display_4x7_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • callback_id – Type: int16_t
  • function – Type: void (*)(void)
  • user_data – Type: void *

Registers the given function with the given callback_id. The 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 segment_display_4x7_v2_register_callback() function:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

segment_display_4x7_v2_register_callback(&segment_display_4x7_v2,
                                         SEGMENT_DISPLAY_4X7_V2_CALLBACK_EXAMPLE,
                                         (void (*)(void))my_callback,
                                         NULL);

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.

SEGMENT_DISPLAY_4X7_V2_CALLBACK_COUNTER_FINISHED
void callback(void *user_data)
Callback Parameters:
  • user_data – Type: void *

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

int segment_display_4x7_v2_get_api_version(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t ret_api_version[3])
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
Output Parameters:
  • ret_api_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

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.

int segment_display_4x7_v2_get_response_expected(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • error_code – Type: int

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 segment_display_4x7_v2_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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SEGMENTS = 1
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_BRIGHTNESS = 3
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_NUMERIC_VALUE = 5
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SELECTED_SEGMENT = 6
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_START_COUNTER = 8
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_RESET = 243
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_WRITE_UID = 248
int segment_display_4x7_v2_set_response_expected(SegmentDisplay4x7V2 *segment_display_4x7_v2, uint8_t function_id, bool response_expected)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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:

  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SEGMENTS = 1
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_BRIGHTNESS = 3
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_NUMERIC_VALUE = 5
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_SELECTED_SEGMENT = 6
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_START_COUNTER = 8
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_RESET = 243
  • SEGMENT_DISPLAY_4X7_V2_FUNCTION_WRITE_UID = 248
int segment_display_4x7_v2_set_response_expected_all(SegmentDisplay4x7V2 *segment_display_4x7_v2, bool response_expected)
Parameters:
  • segment_display_4x7_v2 – Type: SegmentDisplay4x7V2 *
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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

Constants

SEGMENT_DISPLAY_4X7_V2_DEVICE_IDENTIFIER

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

The segment_display_4x7_v2_get_identity() function and the IPCON_CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

SEGMENT_DISPLAY_4X7_V2_DEVICE_DISPLAY_NAME

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