C/C++ - Industrial Digital In 4 Bricklet 2.0

This is the description of the C/C++ API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 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).

Simple

Download (example_simple.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
42
43
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_create(&idi4, 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

    // Get current value
    bool value[4];
    if(industrial_digital_in_4_v2_get_value(&idi4, value) < 0) {
        fprintf(stderr, "Could not get value, probably timeout\n");
        return 1;
    }

    printf("Channel 0: %s\n", value[0] ? "true" : "false");
    printf("Channel 1: %s\n", value[1] ? "true" : "false");
    printf("Channel 2: %s\n", value[2] ? "true" : "false");
    printf("Channel 3: %s\n", value[3] ? "true" : "false");

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

Edge Count

Download (example_edge_count.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
42
43
44
45
46
47
48
49
50
51
#define IPCON_EXPOSE_MILLISLEEP

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_create(&idi4, 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

    // Configure rising edge count (channel 3) with 10ms debounce
    industrial_digital_in_4_v2_set_edge_count_configuration(&idi4, 3, 0, 10);

    // Get edge count 10 times with 1s delay
    int i;
    for(i = 0; i < 10; ++i) {
        millisleep(1000);

        // Get current edge count
        uint32_t count;
        if(industrial_digital_in_4_v2_get_edge_count(&idi4, 3, false, &count) < 0) {
            fprintf(stderr, "Could not get edge count, probably timeout\n");
            return 1;
        }

        printf("Count: %u\n", count);
    }

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

Callback

Download (example_callback.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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_industrial_digital_in_4_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

// Callback function for value callback
void cb_value(uint8_t channel, bool changed, bool value, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0) {
        printf("Channel: 0\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1) {
        printf("Channel: 1\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2) {
        printf("Channel: 2\n");
    } else if(channel == INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3) {
        printf("Channel: 3\n");
    }

    printf("Changed: %s\n", changed ? "true" : "false");
    printf("Value: %s\n", value ? "true" : "false");
    printf("\n");
}

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

    // Create device object
    IndustrialDigitalIn4V2 idi4;
    industrial_digital_in_4_v2_create(&idi4, 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

    // Register value callback to function cb_value
    industrial_digital_in_4_v2_register_callback(&idi4,
                                                 INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_VALUE,
                                                 (void (*)(void))cb_value,
                                                 NULL);

    // Set period for value (channel 1) callback to 0.1s (100ms)
    industrial_digital_in_4_v2_set_value_callback_configuration(&idi4, 1, 100, false);

    printf("Press key to exit\n");
    getchar();
    industrial_digital_in_4_v2_destroy(&idi4);
    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 industrial_digital_in_4_v2_create(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, const char *uid, IPConnection *ipcon)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

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

IndustrialDigitalIn4V2 industrial_digital_in_4_v2;
industrial_digital_in_4_v2_create(&industrial_digital_in_4_v2, "YOUR_DEVICE_UID", &ipcon);

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

void industrial_digital_in_4_v2_destroy(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *

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

int industrial_digital_in_4_v2_get_value(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool ret_value[4])
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
Output Parameters:
  • ret_value – Type: bool[4]
Returns:
  • error_code – Type: int

Returns the input value as bools, true refers to high and false refers to low.

int industrial_digital_in_4_v2_set_channel_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t config)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For config:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int industrial_digital_in_4_v2_get_channel_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_config)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Returns the channel LED configuration as set by industrial_digital_in_4_v2_set_channel_led_config()

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For ret_config:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_ON = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

int industrial_digital_in_4_v2_get_edge_count(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, bool reset_counter, uint32_t *ret_count)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
  • reset_counter – Type: bool
Output Parameters:
  • ret_count – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with industrial_digital_in_4_v2_set_edge_count_configuration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3
int industrial_digital_in_4_v2_set_edge_count_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t edge_type, uint8_t debounce)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
  • edge_type – Type: uint8_t, Range: See constants, Default: 0
  • debounce – Type: uint8_t, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:
  • error_code – Type: int

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising
  • 1 = falling
  • 2 = both

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For edge_type:

  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2
int industrial_digital_in_4_v2_get_edge_count_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint8_t *ret_edge_type, uint8_t *ret_debounce)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_edge_type – Type: uint8_t, Range: See constants, Default: 0
  • ret_debounce – Type: uint8_t, Unit: 1 ms, Range: [0 to 255], Default: 100
Returns:
  • error_code – Type: int

Returns the edge type and debounce time for the selected channel as set by industrial_digital_in_4_v2_set_edge_count_configuration().

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3

For ret_edge_type:

  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_RISING = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_FALLING = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_EDGE_TYPE_BOTH = 2
int industrial_digital_in_4_v2_get_spitfp_error_count(IndustrialDigitalIn4V2 *industrial_digital_in_4_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:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_set_bootloader_mode(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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:

  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_OK = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int industrial_digital_in_4_v2_get_bootloader_mode(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_mode)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

Returns the current bootloader mode, see industrial_digital_in_4_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • INDUSTRIAL_DIGITAL_IN_4_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int industrial_digital_in_4_v2_set_write_firmware_pointer(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t pointer)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Sets the firmware pointer for industrial_digital_in_4_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 industrial_digital_in_4_v2_write_firmware(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t data[64], uint8_t *ret_status)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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 industrial_digital_in_4_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 industrial_digital_in_4_v2_set_status_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t config)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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:

  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_digital_in_4_v2_get_status_led_config(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t *ret_config)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Returns the configuration as set by industrial_digital_in_4_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_OFF = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_ON = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int industrial_digital_in_4_v2_get_chip_temperature(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, int16_t *ret_temperature)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_reset(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_write_uid(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t uid)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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 industrial_digital_in_4_v2_read_uid(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_uid)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_get_identity(IndustrialDigitalIn4V2 *industrial_digital_in_4_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:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_register_callback(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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.

int industrial_digital_in_4_v2_set_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t period, bool value_has_to_change)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

This callback can be configured per channel.

The period is the period with which the INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_VALUE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3
int industrial_digital_in_4_v2_get_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t channel, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • channel – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

Returns the callback configuration for the given channel as set by industrial_digital_in_4_v2_set_value_callback_configuration().

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3
int industrial_digital_in_4_v2_set_all_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t period, bool value_has_to_change)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

The period is the period with which the INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_ALL_VALUE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

int industrial_digital_in_4_v2_get_all_value_callback_configuration(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

Returns the callback configuration as set by industrial_digital_in_4_v2_set_all_value_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the industrial_digital_in_4_v2_register_callback() function:

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

industrial_digital_in_4_v2_register_callback(&industrial_digital_in_4_v2,
                                             INDUSTRIAL_DIGITAL_IN_4_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.

INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_VALUE
void callback(uint8_t channel, bool changed, bool value, void *user_data)
Callback Parameters:
  • channel – Type: uint8_t, Range: See constants
  • changed – Type: bool
  • value – Type: bool
  • user_data – Type: void *

This callback is triggered periodically according to the configuration set by industrial_digital_in_4_v2_set_value_callback_configuration().

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

For channel:

  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_0 = 0
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_1 = 1
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_2 = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_CHANNEL_3 = 3
INDUSTRIAL_DIGITAL_IN_4_V2_CALLBACK_ALL_VALUE
void callback(bool changed[4], bool value[4], void *user_data)
Callback Parameters:
  • changed – Type: bool[4]
  • value – Type: bool[4]
  • user_data – Type: void *

This callback is triggered periodically according to the configuration set by industrial_digital_in_4_v2_set_all_value_callback_configuration().

The parameters are the same as industrial_digital_in_4_v2_get_value(). Additional the changed parameter is true if the value has changed since the last callback.

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 industrial_digital_in_4_v2_get_api_version(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t ret_api_version[3])
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
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 industrial_digital_in_4_v2_get_response_expected(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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 industrial_digital_in_4_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:

  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248
int industrial_digital_in_4_v2_set_response_expected(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, uint8_t function_id, bool response_expected)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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:

  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_RESET = 243
  • INDUSTRIAL_DIGITAL_IN_4_V2_FUNCTION_WRITE_UID = 248
int industrial_digital_in_4_v2_set_response_expected_all(IndustrialDigitalIn4V2 *industrial_digital_in_4_v2, bool response_expected)
Parameters:
  • industrial_digital_in_4_v2 – Type: IndustrialDigitalIn4V2 *
  • 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

INDUSTRIAL_DIGITAL_IN_4_V2_DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

The industrial_digital_in_4_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.

INDUSTRIAL_DIGITAL_IN_4_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.