Modbus - HAT Brick¶

Basic Functions¶

BrickHAT.set_sleep_mode¶

Function ID:	1
Request:	power_off_delay – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1] power_off_duration – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1] raspberry_pi_off – Type: bool bricklets_off – Type: bool enable_sleep_indicator – Type: bool
Response:	no response

Sets the sleep mode.

Note

Calling this function will cut the Raspberry Pi's power after Power Off Delay seconds. You have to shut down the operating system yourself, e.g. by calling 'sudo shutdown -h now'.

Parameters:

• Power Off Delay: Time before the RPi/Bricklets are powered off.
• Power Off Duration: Duration that the RPi/Bricklets stay powered off.
• Raspberry Pi Off: RPi is powered off if set to true.
• Bricklets Off: Bricklets are powered off if set to true.
• Enable Sleep Indicator: If set to true, the status LED will blink in a 1s interval during the whole power off duration. This will draw additional 0.3mA.

Example: To turn RPi and Bricklets off in 5 seconds for 10 minutes with sleep indicator enabled, call (5, 60*10, true, true, true).

This function can also be used to implement a watchdog. To do this you can write a program that calls this function once per second in a loop with (10, 2, true, false, false). If the RPi crashes or gets stuck the HAT will reset the RPi after 10 seconds.

BrickHAT.get_sleep_mode¶

Function ID:	2
Request:	empty payload
Response:	power_off_delay – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1] power_off_duration – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1] raspberry_pi_off – Type: bool bricklets_off – Type: bool enable_sleep_indicator – Type: bool

Returns the sleep mode settings as set by set_sleep_mode.

BrickHAT.set_bricklet_power¶

Function ID:	3
Request:	bricklet_power – Type: bool, Default: true
Response:	no response

Set to true/false to turn the power supply of the connected Bricklets on/off.

BrickHAT.get_bricklet_power¶

Function ID:	4
Request:	empty payload
Response:	bricklet_power – Type: bool, Default: true

Returns the power status of the connected Bricklets as set by set_bricklet_power.

BrickHAT.get_voltages¶

Function ID:	5
Request:	empty payload
Response:	voltage_usb – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1] voltage_dc – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the USB supply voltage and the DC input supply voltage.

There are three possible combinations:

• Only USB connected: The USB supply voltage will be fed back to the DC input connector. You will read the USB voltage and a slightly lower voltage on the DC input.
• Only DC input connected: The DC voltage will not be fed back to the USB connector. You will read the DC input voltage and the USB voltage will be 0.
• USB and DC input connected: You will read both voltages. In this case the USB supply will be without load, but it will work as backup if you disconnect the DC input (or if the DC input voltage falls below the USB voltage).

Advanced Functions¶

BrickHAT.set_rtc_driver¶

Function ID:	9
Request:	rtc_driver – Type: uint8, Range: See meanings
Response:	no response

Configures the RTC driver that is given to the Raspberry Pi to be used. Currently there are two different RTCs used:

• Hardware version <= 1.5: PCF8523
• Hardware version 1.6: DS1338

The correct driver will be set during factory flashing by Tinkerforge.

New in version 2.0.3 (Firmware).

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

For rtc_driver:

• 0 = PCF8523
• 1 = DS1338

BrickHAT.get_rtc_driver¶

Function ID:	10
Request:	empty payload
Response:	rtc_driver – Type: uint8, Range: See meanings

Returns the RTC driver as set by set_rtc_driver.

New in version 2.0.3 (Firmware).

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

For rtc_driver:

• 0 = PCF8523
• 1 = DS1338

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

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

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

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

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

BrickHAT.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['i'] 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 HAT is connected to (typically '0' as the HAT is the root device in the topology), the position, the hardware and firmware version as well as the device identifier.

The HAT (Zero) Brick is always at position 'i'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

BrickHAT.set_voltages_callback_configuration¶

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

New in version 2.0.1 (Firmware).

BrickHAT.get_voltages_callback_configuration¶

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

New in version 2.0.1 (Firmware).

Callbacks¶

BrickHAT.CALLBACK_VOLTAGES¶

Function ID:	8
Response:	voltage_usb – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1] voltage_dc – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

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

The response values are the same as get_voltages.

New in version 2.0.1 (Firmware).

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.

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

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

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

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

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

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