Class: Tinkerforge::BrickletOneWire

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

Overview

Communicates with up 64 1-Wire devices

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2123
DEVICE_DISPLAY_NAME =

:nodoc:

'One Wire Bricklet'
FUNCTION_SEARCH_BUS_LOW_LEVEL =

:nodoc:

1
FUNCTION_RESET_BUS =

:nodoc:

2
FUNCTION_WRITE =

:nodoc:

3
FUNCTION_READ =

:nodoc:

4
FUNCTION_WRITE_COMMAND =

:nodoc:

5
FUNCTION_SET_COMMUNICATION_LED_CONFIG =

:nodoc:

6
FUNCTION_GET_COMMUNICATION_LED_CONFIG =

:nodoc:

7
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
STATUS_OK =

:nodoc:

0
STATUS_BUSY =

:nodoc:

1
STATUS_NO_PRESENCE =

:nodoc:

2
STATUS_TIMEOUT =

:nodoc:

3
STATUS_ERROR =

:nodoc:

4
COMMUNICATION_LED_CONFIG_OFF =

:nodoc:

0
COMMUNICATION_LED_CONFIG_ON =

:nodoc:

1
COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION =

:nodoc:

3
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) ⇒ BrickletOneWire

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

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SEARCH_BUS_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET_BUS] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_WRITE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_READ] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_WRITE_COMMAND] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COMMUNICATION_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_COMMUNICATION_LED_CONFIG] = 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


  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletOneWire#set_bootloader_mode.



195
196
197
198
199
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 195

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.



253
254
255
256
257
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 253

def get_chip_temperature
  check_validity

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

#get_communication_led_config ⇒ Object

Returns the configuration as set by BrickletOneWire#set_communication_led_config



156
157
158
159
160
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 156

def get_communication_led_config
  check_validity

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



300
301
302
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 300

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
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.



173
174
175
176
177
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 173

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 BrickletOneWire#set_status_led_config



241
242
243
244
245
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 241

def get_status_led_config
  check_validity

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

#read ⇒ Object

Reads a byte of data from the 1-Wire bus.



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

def read
  check_validity

  send_request FUNCTION_READ, [], '', 10, 'C C'
end

#read_uid ⇒ Object

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



284
285
286
287
288
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 284

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
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!



265
266
267
268
269
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 265

def reset
  check_validity

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

#reset_bus ⇒ Object

Resets the bus with the 1-Wire reset operation.



110
111
112
113
114
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 110

def reset_bus
  check_validity

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

#search_bus ⇒ Object

Returns a list of up to 64 identifiers of the connected 1-Wire devices. Each identifier is 64-bit and consists of 8-bit family code, 48-bit ID and 8-bit CRC.

To get these identifiers the Bricklet runs the ‘SEARCH ROM algorithm <www.maximintegrated.com/en/app-notes/index.mvp/id/187>`__, as defined by Maxim.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 311

def search_bus
  ret = nil # assigned in block
  identifier_length = nil # assigned in block
  identifier_data = nil # assigned in block

  @stream_mutex.synchronize {
    ret = search_bus_low_level
    identifier_length = ret[0]
    identifier_chunk_offset = ret[1]
    identifier_out_of_sync = identifier_chunk_offset != 0
    identifier_data = ret[2]

    while not identifier_out_of_sync and identifier_data.length < identifier_length
      ret = search_bus_low_level
      identifier_length = ret[0]
      identifier_chunk_offset = ret[1]
      identifier_out_of_sync = identifier_chunk_offset != identifier_data.length
      identifier_data += ret[2]
    end

    if identifier_out_of_sync # discard remaining stream to bring it back in-sync
      while identifier_chunk_offset + 7 < identifier_length
        ret = search_bus_low_level
        identifier_length = ret[0]
        identifier_chunk_offset = ret[1]
      end

      raise StreamOutOfSyncException, 'Identifier stream is out-of-sync'
    end
  }

  [identifier_data[0, identifier_length], ret[3]]
end

#search_bus_low_level ⇒ Object

Returns a list of up to 64 identifiers of the connected 1-Wire devices. Each identifier is 64-bit and consists of 8-bit family code, 48-bit ID and 8-bit CRC.

To get these identifiers the Bricklet runs the ‘SEARCH ROM algorithm <www.maximintegrated.com/en/app-notes/index.mvp/id/187>`__, as defined by Maxim.



103
104
105
106
107
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 103

def search_bus_low_level
  check_validity

  send_request FUNCTION_SEARCH_BUS_LOW_LEVEL, [], '', 69, 'S S Q7 C'
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.



188
189
190
191
192
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 188

def set_bootloader_mode(mode)
  check_validity

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

#set_communication_led_config(config) ⇒ Object

Sets the communication LED configuration. By default the LED shows 1-wire communication traffic by flickering.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is off.



149
150
151
152
153
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 149

def set_communication_led_config(config)
  check_validity

  send_request FUNCTION_SET_COMMUNICATION_LED_CONFIG, [config], 'C', 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.



234
235
236
237
238
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 234

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



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

def set_write_firmware_pointer(pointer)
  check_validity

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

#write(data) ⇒ Object

Writes a byte of data to the 1-Wire bus.



117
118
119
120
121
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 117

def write(data)
  check_validity

  send_request FUNCTION_WRITE, [data], 'C', 9, 'C'
end

#write_command(identifier, command) ⇒ Object

Writes a command to the 1-Wire device with the given identifier. You can obtain the identifier by calling BrickletOneWire#search_bus. The MATCH ROM operation is used to write the command.

If you only have one device connected or want to broadcast to all devices you can set the identifier to 0. In this case the SKIP ROM operation is used to write the command.



137
138
139
140
141
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 137

def write_command(identifier, command)
  check_validity

  send_request FUNCTION_WRITE_COMMAND, [identifier, command], 'Q C', 9, 'C'
end

#write_firmware(data) ⇒ Object

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



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

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.



276
277
278
279
280
 
# File 'lib/tinkerforge/bricklet_one_wire.rb', line 276

def write_uid(uid)
  check_validity

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