class Tinkerforge::BrickletXMC1400Breakout
Breakout for Infineon XMC1400 microcontroller
Constants
- 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
.- 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
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 90 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
Public Instance Methods
Returns the config for the given channel as set by BrickletXMC1400Breakout#set_adc_channel_config
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 160 def get_adc_channel_config(channel) check_validity send_request FUNCTION_GET_ADC_CHANNEL_CONFIG, [channel], 'C', 9, '?' end
Returns the 12-bit value of the given ADC channel of the ADC driver example.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 167 def get_adc_channel_value(channel) check_validity send_request FUNCTION_GET_ADC_CHANNEL_VALUE, [channel], 'C', 10, 'S' end
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 178 def get_adc_values check_validity send_request FUNCTION_GET_ADC_VALUES, [], '', 24, 'S8' end
Returns the callback configuration as set by BrickletXMC1400Breakout#set_adc_values_callback_configuration
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 201 def get_adc_values_callback_configuration check_validity send_request FUNCTION_GET_ADC_VALUES_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
Returns the current bootloader mode, see BrickletXMC1400Breakout#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 294 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
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/bricklet_xmc1400_breakout.rb, line 352 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
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
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 217 def get_count check_validity send_request FUNCTION_GET_COUNT, [], '', 12, 'L' end
Returns the callback configuration as set by BrickletXMC1400Breakout#set_count_callback_configuration
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 255 def get_count_callback_configuration check_validity send_request FUNCTION_GET_COUNT_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k L L' end
Example for a getter function. Returns the result of a XMC_GPIO_GetInput call for the given port/pin.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 135 def get_gpio_input(port, pin) check_validity send_request FUNCTION_GET_GPIO_INPUT, [port, pin], 'C C', 9, '?' end
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|
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 399 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
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/bricklet_xmc1400_breakout.rb, line 272 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletXMC1400Breakout#set_status_led_config
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 340 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 383 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 404 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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/bricklet_xmc1400_breakout.rb, line 364 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
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
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 153 def set_adc_channel_config(channel, enable) check_validity send_request FUNCTION_SET_ADC_CHANNEL_CONFIG, [channel, enable], 'C ?', 8, '' end
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 193 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
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/bricklet_xmc1400_breakout.rb, line 287 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 248 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
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 127 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
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/bricklet_xmc1400_breakout.rb, line 333 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 306 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
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.
# File lib/tinkerforge/bricklet_xmc1400_breakout.rb, line 320 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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/bricklet_xmc1400_breakout.rb, line 375 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end