Class: Tinkerforge::BrickHAT

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/brick_hat.rb

Overview

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

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

111
DEVICE_DISPLAY_NAME =

:nodoc:

'HAT Brick'
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)

8
FUNCTION_SET_SLEEP_MODE =

:nodoc:

1
FUNCTION_GET_SLEEP_MODE =

:nodoc:

2
FUNCTION_SET_BRICKLET_POWER =

:nodoc:

3
FUNCTION_GET_BRICKLET_POWER =

:nodoc:

4
FUNCTION_GET_VOLTAGES =

:nodoc:

5
FUNCTION_SET_VOLTAGES_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_RTC_DRIVER =

:nodoc:

9
FUNCTION_GET_RTC_DRIVER =

:nodoc:

10
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
RTC_DRIVER_PCF8523 =

:nodoc:

0
RTC_DRIVER_DS1338 =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickHAT

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/tinkerforge/brick_hat.rb', line 70

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 2]

  @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_SET_RTC_DRIVER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_RTC_DRIVER] = 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

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickHAT#set_bootloader_mode.



255
256
257
258
259
 
# File 'lib/tinkerforge/brick_hat.rb', line 255

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_bricklet_power ⇒ Object

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



145
146
147
148
149
 
# File 'lib/tinkerforge/brick_hat.rb', line 145

def get_bricklet_power
  check_validity

  send_request FUNCTION_GET_BRICKLET_POWER, [], '', 9, '?'
end

#get_chip_temperature ⇒ Object

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.



313
314
315
316
317
 
# File 'lib/tinkerforge/brick_hat.rb', line 313

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_identity ⇒ Object

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|



359
360
361
 
# File 'lib/tinkerforge/brick_hat.rb', line 359

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_rtc_driver ⇒ Object

Returns the RTC driver as set by BrickHAT#set_rtc_driver.

.. versionadded

2.0.3$nbsp;(Firmware)



216
217
218
219
220
 
# File 'lib/tinkerforge/brick_hat.rb', line 216

def get_rtc_driver
  check_validity

  send_request FUNCTION_GET_RTC_DRIVER, [], '', 9, 'C'
end

#get_sleep_mode ⇒ Object

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



131
132
133
134
135
 
# File 'lib/tinkerforge/brick_hat.rb', line 131

def get_sleep_mode
  check_validity

  send_request FUNCTION_GET_SLEEP_MODE, [], '', 19, 'L L ? ? ?'
end

#get_spitfp_error_count ⇒ Object

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.



233
234
235
236
237
 
# File 'lib/tinkerforge/brick_hat.rb', line 233

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickHAT#set_status_led_config



301
302
303
304
305
 
# File 'lib/tinkerforge/brick_hat.rb', line 301

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#get_voltages ⇒ Object

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



165
166
167
168
169
 
# File 'lib/tinkerforge/brick_hat.rb', line 165

def get_voltages
  check_validity

  send_request FUNCTION_GET_VOLTAGES, [], '', 12, 'S S'
end

#get_voltages_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickHAT#set_voltages_callback_configuration.

.. versionadded

2.0.1$nbsp;(Firmware)



192
193
194
195
196
 
# File 'lib/tinkerforge/brick_hat.rb', line 192

def get_voltages_callback_configuration
  check_validity

  send_request FUNCTION_GET_VOLTAGES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#read_uid ⇒ Object

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



344
345
346
347
348
 
# File 'lib/tinkerforge/brick_hat.rb', line 344

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



364
365
366
367
 
# File 'lib/tinkerforge/brick_hat.rb', line 364

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

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!



325
326
327
328
329
 
# File 'lib/tinkerforge/brick_hat.rb', line 325

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



248
249
250
251
252
 
# File 'lib/tinkerforge/brick_hat.rb', line 248

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_bricklet_power(bricklet_power) ⇒ Object

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



138
139
140
141
142
 
# File 'lib/tinkerforge/brick_hat.rb', line 138

def set_bricklet_power(bricklet_power)
  check_validity

  send_request FUNCTION_SET_BRICKLET_POWER, [bricklet_power], '?', 8, ''
end

#set_rtc_driver(rtc_driver) ⇒ Object

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)



207
208
209
210
211
 
# File 'lib/tinkerforge/brick_hat.rb', line 207

def set_rtc_driver(rtc_driver)
  check_validity

  send_request FUNCTION_SET_RTC_DRIVER, [rtc_driver], 'C', 8, ''
end

#set_sleep_mode(power_off_delay, power_off_duration, raspberry_pi_off, bricklets_off, enable_sleep_indicator) ⇒ Object

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.



124
125
126
127
128
 
# File 'lib/tinkerforge/brick_hat.rb', line 124

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) ⇒ Object

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.



294
295
296
297
298
 
# File 'lib/tinkerforge/brick_hat.rb', line 294

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) ⇒ Object

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)



182
183
184
185
186
 
# File 'lib/tinkerforge/brick_hat.rb', line 182

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) ⇒ Object

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.



267
268
269
270
271
 
# File 'lib/tinkerforge/brick_hat.rb', line 267

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

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.



281
282
283
284
285
 
# File 'lib/tinkerforge/brick_hat.rb', line 281

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



336
337
338
339
340
 
# File 'lib/tinkerforge/brick_hat.rb', line 336

def write_uid(uid)
  check_validity

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