Deutsch
English
Menu
Specifications / TCP/IP Protocol / API / Bricks and Bricklets / Bricklets / IO-4 Bricklet 2.0

TCP/IP - IO-4 Bricklet 2.0

This is the description of the TCP/IP protocol for the IO-4 Bricklet 2.0. General information and technical specifications for the IO-4 Bricklet 2.0 are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletIO4V2.set_value
Function ID:
  • 1
Request:
  • value – Type: bool[4]
Response:
  • no response

Sets the output value of all four channels. A value of true or false outputs logic 1 or logic 0 respectively on the corresponding channel.

Use set_selected_value to change only one output channel state.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.

All running monoflop timers and PWMs will be aborted if this function is called.

Note

This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with set_configuration.

BrickletIO4V2.get_value
Function ID:
  • 2
Request:
  • empty payload
Response:
  • value – Type: bool[4]

Returns the logic levels that are currently measured on the channels. This function works if the channel is configured as input as well as if it is configured as output.

BrickletIO4V2.set_selected_value
Function ID:
  • 3
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • value – Type: bool
Response:
  • no response

Sets the output value of a specific channel without affecting the other channels.

A running monoflop timer or PWM for the specific channel will be aborted if this function is called.

Note

This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with set_configuration.

BrickletIO4V2.set_configuration
Function ID:
  • 4
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • direction – Type: char, Range: See meanings, Default: 'i'
  • value – Type: bool, Default: true
Response:
  • no response

Configures the value and direction of a specific channel. Possible directions are 'i' and 'o' for input and output.

If the direction is configured as output, the value is either high or low (set as true or false).

If the direction is configured as input, the value is either pull-up or default (set as true or false).

For example:

  • (0, 'i', true) will set channel 0 as input pull-up.
  • (1, 'i', false) will set channel 1 as input default (floating if nothing is connected).
  • (2, 'o', true) will set channel 2 as output high.
  • (3, 'o', false) will set channel 3 as output low.

A running monoflop timer or PWM for the specific channel will be aborted if this function is called.

The following meanings are defined for the elements of this function:

For direction:

  • 'i' = In
  • 'o' = Out
BrickletIO4V2.get_configuration
Function ID:
  • 5
Request:
  • channel – Type: uint8, Range: [0 to 3]
Response:
  • direction – Type: char, Range: See meanings, Default: 'i'
  • value – Type: bool, Default: true

Returns the channel configuration as set by set_configuration.

The following meanings are defined for the elements of this function:

For direction:

  • 'i' = In
  • 'o' = Out

Advanced Functions

BrickletIO4V2.set_monoflop
Function ID:
  • 10
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • value – Type: bool
  • time – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]
Response:
  • no response

The first parameter is the desired state of the channel (true means output high and false means output low). The second parameter indicates the time that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A PWM for the selected channel will be aborted if this function is called.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet 2.0 is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be high all the time. If now the RS485 connection is lost, the channel will turn low in at most two seconds.

BrickletIO4V2.get_monoflop
Function ID:
  • 11
Request:
  • channel – Type: uint8, Range: [0 to 3]
Response:
  • value – Type: bool
  • time – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]
  • time_remaining – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1]

Returns (for the given channel) the current value and the time as set by set_monoflop as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

BrickletIO4V2.get_edge_count
Function ID:
  • 12
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • reset_counter – Type: bool
Response:
  • count – Type: uint32, Range: [0 to 232 - 1]

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

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

Note

Calling this function is only allowed for channels configured as input.

BrickletIO4V2.set_edge_count_configuration
Function ID:
  • 13
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • edge_type – Type: uint8, Range: See meanings, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100
Response:
  • no response

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted if the channel is configured for input. 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.

Note

Calling this function is only allowed for channels configured as input.

The following meanings are defined for the elements of this function:

For edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both
BrickletIO4V2.get_edge_count_configuration
Function ID:
  • 14
Request:
  • channel – Type: uint8, Range: [0 to 3]
Response:
  • edge_type – Type: uint8, Range: See meanings, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected channel as set by set_edge_count_configuration.

Note

Calling this function is only allowed for channels configured as input.

The following meanings are defined for the elements of this function:

For edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both
BrickletIO4V2.set_pwm_configuration
Function ID:
  • 15
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • frequency – Type: uint32, Unit: 1/10 Hz, Range: [0 to 320000000], Default: 0
  • duty_cycle – Type: uint16, Unit: 1/100 %, Range: [0 to 10000], Default: 0
Response:
  • no response

Activates a PWM for the given channel.

You need to set the channel to output before you call this function, otherwise it will report an invalid parameter error. To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. set_selected_value).

A running monoflop timer for the given channel will be aborted if this function is called.

BrickletIO4V2.get_pwm_configuration
Function ID:
  • 16
Request:
  • channel – Type: uint8, Range: [0 to 3]
Response:
  • frequency – Type: uint32, Unit: 1/10 Hz, Range: [0 to 320000000], Default: 0
  • duty_cycle – Type: uint16, Unit: 1/100 %, Range: [0 to 10000], Default: 0

Returns the PWM configuration as set by set_pwm_configuration.

BrickletIO4V2.get_spitfp_error_count
Function ID:
  • 234
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

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.

BrickletIO4V2.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings, Default: 3
Response:
  • no response

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 meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletIO4V2.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletIO4V2.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletIO4V2.reset
Function ID:
  • 243
Request:
  • empty payload
Response:
  • no response

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!

BrickletIO4V2.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • device_identifier – Type: uint16, 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). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions

BrickletIO4V2.set_input_value_callback_configuration
Function ID:
  • 6
Request:
  • channel – Type: uint8, Range: [0 to 3]
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Response:
  • no response

This callback can be configured per channel.

The period is the period with which the CALLBACK_INPUT_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.

BrickletIO4V2.get_input_value_callback_configuration
Function ID:
  • 7
Request:
  • channel – Type: uint8, Range: [0 to 3]
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false

Returns the callback configuration for the given channel as set by set_input_value_callback_configuration.

BrickletIO4V2.set_all_input_value_callback_configuration
Function ID:
  • 8
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Response:
  • no response

The period is the period with which the CALLBACK_ALL_INPUT_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.

BrickletIO4V2.get_all_input_value_callback_configuration
Function ID:
  • 9
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by set_all_input_value_callback_configuration.

Callbacks

BrickletIO4V2.CALLBACK_INPUT_VALUE
Function ID:
  • 17
Response:
  • channel – Type: uint8, Range: [0 to 3]
  • changed – Type: bool
  • value – Type: bool

This callback is triggered periodically according to the configuration set by set_input_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.

BrickletIO4V2.CALLBACK_ALL_INPUT_VALUE
Function ID:
  • 18
Response:
  • changed – Type: bool[4]
  • value – Type: bool[4]

This callback is triggered periodically according to the configuration set by set_all_input_value_callback_configuration.

The response values are the same as get_value. Additional the changed parameter is true if the value has changed since the last callback.

BrickletIO4V2.CALLBACK_MONOFLOP_DONE
Function ID:
  • 19
Response:
  • channel – Type: uint8, Range: [0 to 3]
  • value – Type: bool

This callback is triggered whenever a monoflop timer reaches 0. The response values contain the channel and the current value of the channel (the value after the monoflop).

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletIO4V2.set_bootloader_mode
Function ID:
  • 235
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • status – Type: uint8, Range: See meanings

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 meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

For status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletIO4V2.get_bootloader_mode
Function ID:
  • 236
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletIO4V2.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
Response:
  • no response

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

BrickletIO4V2.write_firmware
Function ID:
  • 238
Request:
  • data – Type: uint8[64], Range: [0 to 255]
Response:
  • status – Type: uint8, Range: [0 to 255]

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

BrickletIO4V2.write_uid
Function ID:
  • 248
Request:
  • uid – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

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.

BrickletIO4V2.read_uid
Function ID:
  • 249
Request:
  • empty payload
Response:
  • uid – Type: uint32, Range: [0 to 232 - 1]

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