class Tinkerforge::BrickHAT

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

Constants

CALLBACK_VOLTAGES

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

The parameters are the same as BrickHAT#get_voltages.

.. versionadded

2.0.1$nbsp;(Firmware)

Public Class Methods

new(uid, ipcon) click to toggle source

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.

Calls superclass method
# File lib/tinkerforge/brick_hat.rb, line 65
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_SET_SLEEP_MODE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SLEEP_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BRICKLET_POWER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_BRICKLET_POWER] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_VOLTAGES] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_VOLTAGES] = [12, 'S S']

  @ipcon.add_device self
end

Public Instance Methods

get_bootloader_mode() click to toggle source

Returns the current bootloader mode, see BrickHAT#set_bootloader_mode.

# File lib/tinkerforge/brick_hat.rb, line 224
def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end
get_bricklet_power() click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 138
def get_bricklet_power
  check_validity

  send_request FUNCTION_GET_BRICKLET_POWER, [], '', 9, '?'
end
get_chip_temperature() click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 282
def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end
get_identity() click to toggle source

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 :ref:`here <device_identifier>`. |device_identifier_constant|

# File lib/tinkerforge/brick_hat.rb, line 328
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_sleep_mode() click to toggle source

Returns the sleep mode settings as set by BrickHAT#set_sleep_mode.

# File lib/tinkerforge/brick_hat.rb, line 124
def get_sleep_mode
  check_validity

  send_request FUNCTION_GET_SLEEP_MODE, [], '', 19, 'L L ? ? ?'
end
get_spitfp_error_count() click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 202
def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end
get_status_led_config() click to toggle source

Returns the configuration as set by BrickHAT#set_status_led_config

# File lib/tinkerforge/brick_hat.rb, line 270
def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end
get_voltages() click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 158
def get_voltages
  check_validity

  send_request FUNCTION_GET_VOLTAGES, [], '', 12, 'S S'
end
get_voltages_callback_configuration() click to toggle source

Returns the callback configuration as set by BrickHAT#set_voltages_callback_configuration.

.. versionadded

2.0.1$nbsp;(Firmware)

# File lib/tinkerforge/brick_hat.rb, line 185
def get_voltages_callback_configuration
  check_validity

  send_request FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end
read_uid() click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 313
def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/brick_hat.rb, line 333
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end
reset() click to toggle source

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!

# File lib/tinkerforge/brick_hat.rb, line 294
def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end
set_bootloader_mode(mode) click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 217
def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end
set_bricklet_power(bricklet_power) click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 131
def set_bricklet_power(bricklet_power)
  check_validity

  send_request FUNCTION_SET_BRICKLET_POWER, [bricklet_power], '?', 8, ''
end
set_sleep_mode(power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator) click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 117
def set_sleep_mode(power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator)
  check_validity

  send_request FUNCTION_SET_SLEEP_MODE, [power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator], 'L L ? ? ?', 8, ''
end
set_status_led_config(config) click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 263
def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end
set_voltages_callback_configuration(period, value_has_to_change) click to toggle source

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.

.. versionadded

2.0.1$nbsp;(Firmware)

# File lib/tinkerforge/brick_hat.rb, line 175
def set_voltages_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
end
set_write_firmware_pointer(pointer) click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 236
def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end
write_firmware(data) click to toggle source

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

# File lib/tinkerforge/brick_hat.rb, line 250
def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end
write_uid(uid) click to toggle source

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.

# File lib/tinkerforge/brick_hat.rb, line 305
def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end