Struct tinkerforge::hat_brick::HatBrick

pub struct HatBrick { /* private fields */ }

HAT for Raspberry Pi with 8 Bricklets ports and real-time clock

Implementations

impl HatBrick

pub const DEVICE_IDENTIFIER: u16 = 111u16

pub const DEVICE_DISPLAY_NAME: &'static str = "HAT Brick"

pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> HatBrick

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: HatBrickFunction ) -> Result<bool, GetResponseExpectedError>

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

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: HatBrickFunction, response_expected: bool ) -> Result<(), SetResponseExpectedError>

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

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) 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.

pub fn get_voltages_callback_receiver( &self ) -> ConvertingCallbackReceiver<VoltagesEvent>

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

The parameters are the same as get_voltages.

.. versionadded:: 2.0.1$nbsp;(Firmware)

pub fn set_sleep_mode( &self, power_off_delay: u32, power_off_duration: u32, raspberry_pi_off: bool, bricklets_off: bool, enable_sleep_indicator: bool ) -> ConvertingReceiver<()>

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.

pub fn get_sleep_mode(&self) -> ConvertingReceiver<SleepMode>

Returns the sleep mode settings as set by [set_sleep_mode].

pub fn set_bricklet_power(&self, bricklet_power: bool) -> ConvertingReceiver<()>

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

pub fn get_bricklet_power(&self) -> ConvertingReceiver<bool>

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

pub fn get_voltages(&self) -> ConvertingReceiver<Voltages>

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

pub fn set_voltages_callback_configuration( &self, period: u32, value_has_to_change: bool ) -> ConvertingReceiver<()>

The period is the period with which the [get_voltages_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

.. versionadded:: 2.0.1$nbsp;(Firmware)

pub fn get_voltages_callback_configuration( &self ) -> ConvertingReceiver<VoltagesCallbackConfiguration>

Returns the receiver configuration as set by [set_voltages_callback_configuration].

.. versionadded:: 2.0.1$nbsp;(Firmware)

pub fn set_rtc_driver(&self, rtc_driver: u8) -> ConvertingReceiver<()>

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.

.. versionadded:: 2.0.3$nbsp;(Firmware)

Associated constants:

• HAT_BRICK_RTC_DRIVER_PCF8523
• HAT_BRICK_RTC_DRIVER_DS1338

pub fn get_rtc_driver(&self) -> ConvertingReceiver<u8>

Returns the RTC driver as set by [set_rtc_driver].

.. versionadded:: 2.0.3$nbsp;(Firmware)

Associated constants:

• HAT_BRICK_RTC_DRIVER_PCF8523
• HAT_BRICK_RTC_DRIVER_DS1338

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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.

Associated constants:

• HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE
• HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• HAT_BRICK_BOOTLOADER_STATUS_OK
• HAT_BRICK_BOOTLOADER_STATUS_INVALID_MODE
• HAT_BRICK_BOOTLOADER_STATUS_NO_CHANGE
• HAT_BRICK_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• HAT_BRICK_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• HAT_BRICK_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE
• HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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.

Associated constants:

• HAT_BRICK_STATUS_LED_CONFIG_OFF
• HAT_BRICK_STATUS_LED_CONFIG_ON
• HAT_BRICK_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• HAT_BRICK_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• HAT_BRICK_STATUS_LED_CONFIG_OFF
• HAT_BRICK_STATUS_LED_CONFIG_ON
• HAT_BRICK_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• HAT_BRICK_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

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.

pub fn reset(&self) -> ConvertingReceiver<()>

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!

pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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.

pub fn read_uid(&self) -> ConvertingReceiver<u32>

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

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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

Trait Implementations

impl Clone for HatBrick

fn clone(&self) -> HatBrick

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.