Class: Tinkerforge::BrickletIsolator

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

Overview

Galvanically isolates any Bricklet from any Brick

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2122
DEVICE_DISPLAY_NAME =

:nodoc:

'Isolator Bricklet'
CALLBACK_STATISTICS =

This callback is triggered periodically according to the configuration set by BrickletIsolator#set_statistics_callback_configuration.

The parameters are the same as BrickletIsolator#get_statistics.

.. versionadded

2.0.2$nbsp;(Plugin)

9
FUNCTION_GET_STATISTICS =

:nodoc:

1
FUNCTION_SET_SPITFP_BAUDRATE_CONFIG =

:nodoc:

2
FUNCTION_GET_SPITFP_BAUDRATE_CONFIG =

:nodoc:

3
FUNCTION_SET_SPITFP_BAUDRATE =

:nodoc:

4
FUNCTION_GET_SPITFP_BAUDRATE =

:nodoc:

5
FUNCTION_GET_ISOLATOR_SPITFP_ERROR_COUNT =

:nodoc:

6
FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_STATISTICS_CALLBACK_CONFIGURATION =

:nodoc:

8
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
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) ⇒ BrickletIsolator

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



67
68
69
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
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 67

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

  @api_version = [2, 0, 1]

  @response_expected[FUNCTION_GET_STATISTICS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SPITFP_BAUDRATE_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SPITFP_BAUDRATE_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SPITFP_BAUDRATE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SPITFP_BAUDRATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ISOLATOR_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_STATISTICS_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_STATISTICS] = [26, 'L L S Z8']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletIsolator#set_bootloader_mode.



243
244
245
246
247
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 243

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
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.



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

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 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 :ref:‘Isolator Bricklet <isolator_bricklet>` is always at position ’z’.

The device identifier numbers can be found :ref:‘here <device_identifier>`. |device_identifier_constant|



348
349
350
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 348

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

#get_isolator_spitfp_error_count ⇒ Object

Returns the error count for the communication between Isolator Bricklet and the connected Bricklet. Call BrickletIsolator#get_spitfp_error_count to get the error count between Isolator Bricklet and Brick.

The errors are divided into

  • ACK checksum errors,

  • message checksum errors,

  • framing errors and

  • overflow errors.



177
178
179
180
181
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 177

def get_isolator_spitfp_error_count
  check_validity

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

#get_spitfp_baudrate ⇒ Object

Returns the baudrate, see BrickletIsolator#set_spitfp_baudrate.



161
162
163
164
165
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 161

def get_spitfp_baudrate
  check_validity

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

#get_spitfp_baudrate_config ⇒ Object

Returns the baudrate config, see BrickletIsolator#set_spitfp_baudrate_config.



133
134
135
136
137
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 133

def get_spitfp_baudrate_config
  check_validity

  send_request FUNCTION_GET_SPITFP_BAUDRATE_CONFIG, [], '', 13, '? 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.



221
222
223
224
225
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 221

def get_spitfp_error_count
  check_validity

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

#get_statistics ⇒ Object

Returns statistics for the Isolator Bricklet.



99
100
101
102
103
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 99

def get_statistics
  check_validity

  send_request FUNCTION_GET_STATISTICS, [], '', 26, 'L L S Z8'
end

#get_statistics_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletIsolator#set_statistics_callback_configuration.

.. versionadded

2.0.2$nbsp;(Plugin)



204
205
206
207
208
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 204

def get_statistics_callback_configuration
  check_validity

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

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletIsolator#set_status_led_config



289
290
291
292
293
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 289

def get_status_led_config
  check_validity

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

#read_uid ⇒ Object

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



332
333
334
335
336
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 332

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.



353
354
355
356
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 353

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!



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

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.



236
237
238
239
240
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 236

def set_bootloader_mode(mode)
  check_validity

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

#set_spitfp_baudrate(baudrate) ⇒ Object

Sets the baudrate for a the communication between Isolator Bricklet and the connected Bricklet. The baudrate for communication between Brick and Isolator Bricklet can be set through the API of the Brick.

If you want to increase the throughput of Bricklets you can increase the baudrate. If you get a high error count because of high interference (see BrickletIsolator#get_spitfp_error_count) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see BrickletIsolator#set_spitfp_baudrate_config).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.



154
155
156
157
158
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 154

def set_spitfp_baudrate(baudrate)
  check_validity

  send_request FUNCTION_SET_SPITFP_BAUDRATE, [baudrate], 'L', 8, ''
end

#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) ⇒ Object

The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is enabled, the Isolator Bricklet will try to adapt the baudrate for the communication between Bricks and Bricklets according to the amount of data that is transferred.

The baudrate for communication config between Brick and Isolator Bricklet can be set through the API of the Brick.

The baudrate will be increased exponentially if lots of data is sent/received and decreased linearly if little data is sent/received.

This lowers the baudrate in applications where little data is transferred (e.g. a weather station) and increases the robustness. If there is lots of data to transfer (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.

In cases where some data has to transferred as fast as possible every few seconds (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn the dynamic baudrate off to get the highest possible performance.

The maximum value of the baudrate can be set per port with the function BrickletIsolator#set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate as set by BrickletIsolator#set_spitfp_baudrate will be used statically.



126
127
128
129
130
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 126

def set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate)
  check_validity

  send_request FUNCTION_SET_SPITFP_BAUDRATE_CONFIG, [enable_dynamic_baudrate, minimum_dynamic_baudrate], '? L', 8, ''
end

#set_statistics_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_STATISTICS 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.2$nbsp;(Plugin)



194
195
196
197
198
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 194

def set_statistics_callback_configuration(period, value_has_to_change)
  check_validity

  send_request FUNCTION_SET_STATISTICS_CALLBACK_CONFIGURATION, [period, value_has_to_change], '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.



282
283
284
285
286
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 282

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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



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

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 BrickletIsolator#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.



269
270
271
272
273
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 269

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.



324
325
326
327
328
 
# File 'lib/tinkerforge/bricklet_isolator.rb', line 324

def write_uid(uid)
  check_validity

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