Modbus - XMC1400 Breakout Bricklet

This is the description of the Modbus protocol for the XMC1400 Breakout Bricklet. General information and technical specifications for the XMC1400 Breakout Bricklet are summarized in its hardware description.

API

A general description of the Modbus protocol structure can be found here.

Basic Functions

BrickletXMC1400Breakout.set_gpio_config
Function ID:
  • 1
Request:
  • port – Type: uint8, Range: [0 to 255]
  • pin – Type: uint8, Range: [0 to 255]
  • mode – Type: uint8, Range: See meanings
  • input_hysteresis – Type: uint8, Range: See meanings
  • output_level – Type: bool
Response:
  • no response

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.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Input Tristate
  • 1 = Input Pull Down
  • 2 = Input Pull Up
  • 3 = Input Sampling
  • 4 = Input Inverted Tristate
  • 5 = Input Inverted Pull Down
  • 6 = Input Inverted Pull Up
  • 7 = Input Inverted Sampling
  • 8 = Output Push Pull
  • 9 = Output Open Drain

For input_hysteresis:

  • 0 = Standard
  • 4 = Large
BrickletXMC1400Breakout.get_gpio_input
Function ID:
  • 2
Request:
  • port – Type: uint8, Range: [0 to 255]
  • pin – Type: uint8, Range: [0 to 255]
Response:
  • value – Type: bool

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

BrickletXMC1400Breakout.set_adc_channel_config
Function ID:
  • 3
Request:
  • channel – Type: uint8, Range: [0 to 255]
  • enable – Type: bool
Response:
  • no response

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
BrickletXMC1400Breakout.get_adc_channel_config
Function ID:
  • 4
Request:
  • channel – Type: uint8, Range: [0 to 255]
Response:
  • enable – Type: bool

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

BrickletXMC1400Breakout.get_adc_channel_value
Function ID:
  • 5
Request:
  • channel – Type: uint8, Range: [0 to 255]
Response:
  • value – Type: uint16, Range: [0 to 216 - 1]

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

BrickletXMC1400Breakout.get_adc_values
Function ID:
  • 6
Request:
  • empty payload
Response:
  • values – Type: uint16[8], Range: [0 to 216 - 1]

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

This example function also has a corresponding callback.

See set_adc_values_callback_configuration and CALLBACK_ADC_VALUES callback.

BrickletXMC1400Breakout.get_count
Function ID:
  • 10
Request:
  • empty payload
Response:
  • count – Type: uint32, Range: [0 to 232 - 1]

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

Advanced Functions

BrickletXMC1400Breakout.get_spitfp_error_count
Function ID:
  • 234
Request:
  • empty payload
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

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.

BrickletXMC1400Breakout.set_bootloader_mode
Function ID:
  • 235
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • status – Type: uint8, Range: See meanings

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.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot

For status:

  • 0 = OK
  • 1 = Invalid Mode
  • 2 = No Change
  • 3 = Entry Function Not Present
  • 4 = Device Identifier Incorrect
  • 5 = CRC Mismatch
BrickletXMC1400Breakout.get_bootloader_mode
Function ID:
  • 236
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

  • 0 = Bootloader
  • 1 = Firmware
  • 2 = Bootloader Wait For Reboot
  • 3 = Firmware Wait For Reboot
  • 4 = Firmware Wait For Erase And Reboot
BrickletXMC1400Breakout.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

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

BrickletXMC1400Breakout.write_firmware
Function ID:
  • 238
Request:
  • data – Type: uint8[64], Range: [0 to 255]
Response:
  • status – Type: uint8, Range: [0 to 255]

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

BrickletXMC1400Breakout.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings
Response:
  • no response

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.

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletXMC1400Breakout.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Status
BrickletXMC1400Breakout.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Range: [-215 to 215 - 1]

Returns the temperature in °C 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.

BrickletXMC1400Breakout.reset
Function ID:
  • 243
Request:
  • empty payload
Response:
  • no response

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!

BrickletXMC1400Breakout.write_uid
Function ID:
  • 248
Request:
  • uid – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

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.

BrickletXMC1400Breakout.read_uid
Function ID:
  • 249
Request:
  • empty payload
Response:
  • uid – Type: uint32, Range: [0 to 232 - 1]

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

BrickletXMC1400Breakout.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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' or 'd'.

The device identifier numbers can be found here

Callback Configuration Functions

BrickletXMC1400Breakout.set_adc_values_callback_configuration
Function ID:
  • 7
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Response:
  • no response

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.

BrickletXMC1400Breakout.get_adc_values_callback_configuration
Function ID:
  • 8
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false

Returns the callback configuration as set by set_adc_values_callback_configuration.

BrickletXMC1400Breakout.set_count_callback_configuration
Function ID:
  • 11
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint32, Range: [0 to 232 - 1]
  • max – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

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.

The default value is (0, false, 'x', 0, 0).

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletXMC1400Breakout.get_count_callback_configuration
Function ID:
  • 12
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See meanings, Default: 'x'
  • min – Type: uint32, Range: [0 to 232 - 1]
  • max – Type: uint32, Range: [0 to 232 - 1]

Returns the callback configuration as set by set_count_callback_configuration.

The following meanings are defined for the elements of this function:

For option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater

Callbacks

BrickletXMC1400Breakout.CALLBACK_ADC_VALUES
Function ID:
  • 9
Response:
  • values – Type: uint16[8], Range: [0 to 216 - 1]

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

The response values are the same as get_adc_values.

BrickletXMC1400Breakout.CALLBACK_COUNT
Function ID:
  • 13
Response:
  • count – Type: uint32, Range: [0 to 232 - 1]

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

The response value is the same as get_count.