Class: Tinkerforge::BrickletXMC1400Breakout

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

Overview

Breakout for Infineon XMC1400 microcontroller

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

279
DEVICE_DISPLAY_NAME =

:nodoc:

'XMC1400 Breakout Bricklet'
CALLBACK_ADC_VALUES =

This callback is triggered periodically according to the configuration set by BrickletXMC1400Breakout#set_adc_values_callback_configuration.

The parameters are the same as BrickletXMC1400Breakout#get_adc_values.

9
CALLBACK_COUNT =

This callback is triggered periodically according to the configuration set by BrickletXMC1400Breakout#set_count_callback_configuration.

The parameter is the same as BrickletXMC1400Breakout#get_count.

13
FUNCTION_SET_GPIO_CONFIG =

:nodoc:

1
FUNCTION_GET_GPIO_INPUT =

:nodoc:

2
FUNCTION_SET_ADC_CHANNEL_CONFIG =

:nodoc:

3
FUNCTION_GET_ADC_CHANNEL_CONFIG =

:nodoc:

4
FUNCTION_GET_ADC_CHANNEL_VALUE =

:nodoc:

5
FUNCTION_GET_ADC_VALUES =

:nodoc:

6
FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_ADC_VALUES_CALLBACK_CONFIGURATION =

:nodoc:

8
FUNCTION_GET_COUNT =

:nodoc:

10
FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

11
FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

12
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
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'
GPIO_MODE_INPUT_TRISTATE =

:nodoc:

0
GPIO_MODE_INPUT_PULL_DOWN =

:nodoc:

1
GPIO_MODE_INPUT_PULL_UP =

:nodoc:

2
GPIO_MODE_INPUT_SAMPLING =

:nodoc:

3
GPIO_MODE_INPUT_INVERTED_TRISTATE =

:nodoc:

4
GPIO_MODE_INPUT_INVERTED_PULL_DOWN =

:nodoc:

5
GPIO_MODE_INPUT_INVERTED_PULL_UP =

:nodoc:

6
GPIO_MODE_INPUT_INVERTED_SAMPLING =

:nodoc:

7
GPIO_MODE_OUTPUT_PUSH_PULL =

:nodoc:

8
GPIO_MODE_OUTPUT_OPEN_DRAIN =

:nodoc:

9
GPIO_INPUT_HYSTERESIS_STANDARD =

:nodoc:

0
GPIO_INPUT_HYSTERESIS_LARGE =

:nodoc:

4
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) ⇒ BrickletXMC1400Breakout

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 91

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_SET_GPIO_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_GPIO_INPUT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ADC_CHANNEL_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_ADC_CHANNEL_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ADC_CHANNEL_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_ADC_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_ADC_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_ADC_VALUES_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_COUNT_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_ADC_VALUES] = [24, 'S8']
  @callback_formats[CALLBACK_COUNT] = [12, 'L']

  @ipcon.add_device self
end

Instance Method Details

#get_adc_channel_config(channel) ⇒ Object

Returns the config for the given channel as set by BrickletXMC1400Breakout#set_adc_channel_config.



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

def get_adc_channel_config(channel)
  check_validity

  send_request FUNCTION_GET_ADC_CHANNEL_CONFIG, [channel], 'C', 9, '?'
end

#get_adc_channel_value(channel) ⇒ Object

Returns the 12-bit value of the given ADC channel of the ADC driver example.



168
169
170
171
172
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 168

def get_adc_channel_value(channel)
  check_validity

  send_request FUNCTION_GET_ADC_CHANNEL_VALUE, [channel], 'C', 10, 'S'
end

#get_adc_values ⇒ Object

Returns the values for all 8 ADC channels of the adc driver example.

This example function also has a corresponding callback.

See BrickletXMC1400Breakout#set_adc_values_callback_configuration and CALLBACK_ADC_VALUES callback.



179
180
181
182
183
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 179

def get_adc_values
  check_validity

  send_request FUNCTION_GET_ADC_VALUES, [], '', 24, 'S8'
end

#get_adc_values_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletXMC1400Breakout#set_adc_values_callback_configuration.



202
203
204
205
206
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 202

def get_adc_values_callback_configuration
  check_validity

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

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletXMC1400Breakout#set_bootloader_mode.



295
296
297
298
299
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 295

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.



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

def get_chip_temperature
  check_validity

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

#get_count ⇒ Object

Returns the value of the example count (see example.c).

This example function uses the “add_callback_value_function”-helper in the generator. The getter as well as the callback and callback configuration functions are auto-generated for the API as well as the firmware.

If you want to get the value periodically, it is recommended to use the CALLBACK_COUNT callback. You can set the callback configuration with BrickletXMC1400Breakout#set_count_callback_configuration.



218
219
220
221
222
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 218

def get_count
  check_validity

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

#get_count_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletXMC1400Breakout#set_count_callback_configuration.



256
257
258
259
260
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 256

def get_count_callback_configuration
  check_validity

  send_request FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k L L'
end

#get_gpio_input(port, pin) ⇒ Object

Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.



136
137
138
139
140
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 136

def get_gpio_input(port, pin)
  check_validity

  send_request FUNCTION_GET_GPIO_INPUT, [port, pin], 'C C', 9, '?'
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|



400
401
402
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 400

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.



273
274
275
276
277
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 273

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



341
342
343
344
345
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 341

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.



384
385
386
387
388
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 384

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.



405
406
407
408
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 405

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!



365
366
367
368
369
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 365

def reset
  check_validity

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

#set_adc_channel_config(channel, enable) ⇒ Object

Enables a ADC channel for the ADC driver example (adc.c/adc.h).

There are 8 ADC channels and they correspond to the following pins:

  • Channel 0: P2_6

  • Channel 1: P2_8

  • Channel 2: P2_9

  • Channel 3: P2_10

  • Channel 4: P2_11

  • Channel 5: P2_0

  • Channel 6: P2_1

  • Channel 7: P2_2



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

def set_adc_channel_config(channel, enable)
  check_validity

  send_request FUNCTION_SET_ADC_CHANNEL_CONFIG, [channel, enable], 'C ?', 8, ''
end

#set_adc_values_callback_configuration(period, value_has_to_change) ⇒ Object

The period is the period with which the CALLBACK_ADC_VALUES 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.



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

def set_adc_values_callback_configuration(period, value_has_to_change)
  check_validity

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



288
289
290
291
292
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 288

def set_bootloader_mode(mode)
  check_validity

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

#set_count_callback_configuration(period, value_has_to_change, option, min, max) ⇒ Object

The period is the period with which the CALLBACK_COUNT 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.

It is furthermore possible to constrain the callback with thresholds.

The ‘option`-parameter together with min/max sets a threshold for the CALLBACK_COUNT callback.

The following options are possible:

"Option", "Description"

"'x'",    "Threshold is turned off"
"'o'",    "Threshold is triggered when the value is *outside* the min and max values"
"'i'",    "Threshold is triggered when the value is *inside* or equal to the min and max values"
"'<'",    "Threshold is triggered when the value is smaller than the min value (max is ignored)"
"'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"

If the option is set to ‘x’ (threshold turned off) the callback is triggered with the fixed period.



249
250
251
252
253
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 249

def set_count_callback_configuration(period, value_has_to_change, option, min, max)
  check_validity

  send_request FUNCTION_SET_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k L L', 8, ''
end

#set_gpio_config(port, pin, mode, input_hysteresis, output_level) ⇒ Object

Example for a setter function. The values are the values that can be given to the XMC_GPIO_Init function. See communication.c in the firmware.



128
129
130
131
132
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 128

def set_gpio_config(port, pin, mode, input_hysteresis, output_level)
  check_validity

  send_request FUNCTION_SET_GPIO_CONFIG, [port, pin, mode, input_hysteresis, output_level], 'C C C 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.



334
335
336
337
338
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 334

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



307
308
309
310
311
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 307

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



321
322
323
324
325
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 321

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.



376
377
378
379
380
 
# File 'lib/tinkerforge/bricklet_xmc1400_breakout.rb', line 376

def write_uid(uid)
  check_validity

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