Specifications / Modbus Protocol / API / Bricklets / Industrial Quad Relay Bricklet 2.0

Modbus - Industrial Quad Relay Bricklet 2.0¶

This is the description of the Modbus protocol for the Industrial Quad Relay Bricklet 2.0. General information and technical specifications for the Industrial Quad Relay Bricklet 2.0 are summarized in its hardware description.

API¶

A general description of the Modbus protocol structure can be found here.

Basic Functions¶

BrickletIndustrialQuadRelayV2.set_value¶

Function ID:	1
Request:	value – Type: bool[4]
Response:	no response

Sets the value of all four relays. A value of true closes the relay and a value of false opens the relay.

Use set_selected_value to only change one relay.

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

BrickletIndustrialQuadRelayV2.get_value¶

Function ID:	2
Request:	empty payload
Response:	value – Type: bool[4]

Returns the values as set by set_value.

BrickletIndustrialQuadRelayV2.set_channel_led_config¶

Function ID:	6
Request:	channel – Type: uint8, Range: [0 to 3] config – Type: uint8, Range: See meanings, Default: 3
Response:	no response

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.

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Channel Status

BrickletIndustrialQuadRelayV2.get_channel_led_config¶

Function ID:	7
Request:	channel – Type: uint8, Range: [0 to 3]
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the channel LED configuration as set by set_channel_led_config

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

For config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Channel Status

Advanced Functions¶

BrickletIndustrialQuadRelayV2.set_monoflop¶

Function ID:	3
Request:	channel – Type: uint8, Range: [0 to 3] value – Type: bool time – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1]
Response:	no response

Configures a monoflop of the specified channel.

The second parameter is the desired value of the specified channel. A true means relay closed and a false means relay open.

The third parameter indicates the time that the channels should hold the value.

If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Quad Relay Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.

BrickletIndustrialQuadRelayV2.get_monoflop¶

Function ID:	4
Request:	channel – Type: uint8, Range: [0 to 3]
Response:	value – Type: bool time – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1] time_remaining – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 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.

BrickletIndustrialQuadRelayV2.set_selected_value¶

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

Sets the output value of the specified channel without affecting the other channels.

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

BrickletIndustrialQuadRelayV2.get_spitfp_error_count¶

Function ID:	234
Request:	empty payload
Response:	error_count_ack_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: uint32, Range: [0 to 2³² - 1] error_count_frame – Type: uint32, Range: [0 to 2³² - 1] error_count_overflow – Type: uint32, Range: [0 to 2³² - 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.

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

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

BrickletIndustrialQuadRelayV2.get_chip_temperature¶

Function ID:	242
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

BrickletIndustrialQuadRelayV2.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!

BrickletIndustrialQuadRelayV2.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 2¹⁶ - 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.

Callbacks¶

BrickletIndustrialQuadRelayV2.CALLBACK_MONOFLOP_DONE¶

Function ID:	8
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.

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

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

BrickletIndustrialQuadRelayV2.set_write_firmware_pointer¶

Function ID:	237
Request:	pointer – Type: uint32, Unit: 1 B, Range: [0 to 2³² - 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.

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

BrickletIndustrialQuadRelayV2.write_uid¶

Function ID:	248
Request:	uid – Type: uint32, Range: [0 to 2³² - 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.

BrickletIndustrialQuadRelayV2.read_uid¶

Function ID:	249
Request:	empty payload
Response:	uid – Type: uint32, Range: [0 to 2³² - 1]

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