Modbus - Industrial Counter Bricklet

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

API

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

Basic Functions

BrickletIndustrialCounter.get_counter
Function ID:

1

Request:
  • channel -- uint8
Response:
  • counter -- int64

Returns the current counter value for the given channel.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
BrickletIndustrialCounter.get_all_counter
Function ID:

2

Request:

empty payload

Response:
  • counter -- int64[4]

Returns the current counter values for all four channels.

BrickletIndustrialCounter.set_counter
Function ID:

3

Request:
  • channel -- uint8
  • counter -- int64
Response:

no response

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
BrickletIndustrialCounter.set_all_counter
Function ID:

4

Request:
  • counter -- int64[4]
Response:

no response

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

BrickletIndustrialCounter.get_signal_data
Function ID:

5

Request:
  • channel -- uint8
Response:
  • duty_cycle -- uint16
  • period -- uint64
  • frequency -- uint32
  • value -- bool

Returns the signal data (duty cycle, period, frequency and value) for the given channel.

The units are:

  • Duty Cycle: 1/100 %
  • Period: ns
  • Frequency: mHz (1/1000 Hz)
  • Value: true = high, false = low

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
BrickletIndustrialCounter.get_all_signal_data
Function ID:

6

Request:

empty payload

Response:
  • duty_cycle -- uint16[4]
  • period -- uint64[4]
  • frequency -- uint32[4]
  • value -- bool[4]

Returns the signal data (duty cycle, period, frequency and value) for all four channels.

The units are:

  • Duty Cycle: 1/100 %
  • Period: ns
  • Frequency: mHz (1/1000 Hz)
  • Value: true = high, false = low
BrickletIndustrialCounter.set_counter_active
Function ID:

7

Request:
  • channel -- uint8
  • active -- bool
Response:

no response

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
BrickletIndustrialCounter.set_all_counter_active
Function ID:

8

Request:
  • active -- bool[4]
Response:

no response

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

BrickletIndustrialCounter.get_counter_active
Function ID:

9

Request:
  • channel -- uint8
Response:
  • active -- bool

Returns the activation state of the given channel.

true = activated, false = deactivated.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
BrickletIndustrialCounter.get_all_counter_active
Function ID:

10

Request:

empty payload

Response:
  • active -- bool[4]

Returns the activation state of all four channels.

true = activated, false = deactivated.

BrickletIndustrialCounter.set_counter_configuration
Function ID:

11

Request:
  • channel -- uint8
  • count_edge -- uint8
  • count_direction -- uint8
  • duty_cycle_prescaler -- uint8
  • frequency_integration_time -- uint8
Response:

no response

Sets the counter configuration for the given channel.

  • Count Edge: Counter can count on rising, falling or both edges.
  • Count Direction: Counter can count up or down. You can also use another channel as direction input, see here for details.
  • Duty Cycle Prescaler: Sets a divider for the internal clock. See here for details.
  • Frequency Integration Time: Sets the integration time for the frequency measurement. See here for details.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
  • 0: rising, for count_edge
  • 1: falling, for count_edge
  • 2: both, for count_edge
  • 0: up, for count_direction
  • 1: down, for count_direction
  • 2: external up, for count_direction
  • 3: external down, for count_direction
  • 0: 1, for duty_cycle_prescaler
  • 1: 2, for duty_cycle_prescaler
  • 2: 4, for duty_cycle_prescaler
  • 3: 8, for duty_cycle_prescaler
  • 4: 16, for duty_cycle_prescaler
  • 5: 32, for duty_cycle_prescaler
  • 6: 64, for duty_cycle_prescaler
  • 7: 128, for duty_cycle_prescaler
  • 8: 256, for duty_cycle_prescaler
  • 9: 512, for duty_cycle_prescaler
  • 10: 1024, for duty_cycle_prescaler
  • 11: 2048, for duty_cycle_prescaler
  • 12: 4096, for duty_cycle_prescaler
  • 13: 8192, for duty_cycle_prescaler
  • 14: 16384, for duty_cycle_prescaler
  • 15: 32768, for duty_cycle_prescaler
  • 0: 128 ms, for frequency_integration_time
  • 1: 256 ms, for frequency_integration_time
  • 2: 512 ms, for frequency_integration_time
  • 3: 1024 ms, for frequency_integration_time
  • 4: 2048 ms, for frequency_integration_time
  • 5: 4096 ms, for frequency_integration_time
  • 6: 8192 ms, for frequency_integration_time
  • 7: 16384 ms, for frequency_integration_time
  • 8: 32768 ms, for frequency_integration_time
BrickletIndustrialCounter.get_counter_configuration
Function ID:

12

Request:
  • channel -- uint8
Response:
  • count_edge -- uint8
  • count_direction -- uint8
  • duty_cycle_prescaler -- uint8
  • frequency_integration_time -- uint8

Returns the counter configuration as set by set_counter_configuration.

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
  • 0: rising, for count_edge
  • 1: falling, for count_edge
  • 2: both, for count_edge
  • 0: up, for count_direction
  • 1: down, for count_direction
  • 2: external up, for count_direction
  • 3: external down, for count_direction
  • 0: 1, for duty_cycle_prescaler
  • 1: 2, for duty_cycle_prescaler
  • 2: 4, for duty_cycle_prescaler
  • 3: 8, for duty_cycle_prescaler
  • 4: 16, for duty_cycle_prescaler
  • 5: 32, for duty_cycle_prescaler
  • 6: 64, for duty_cycle_prescaler
  • 7: 128, for duty_cycle_prescaler
  • 8: 256, for duty_cycle_prescaler
  • 9: 512, for duty_cycle_prescaler
  • 10: 1024, for duty_cycle_prescaler
  • 11: 2048, for duty_cycle_prescaler
  • 12: 4096, for duty_cycle_prescaler
  • 13: 8192, for duty_cycle_prescaler
  • 14: 16384, for duty_cycle_prescaler
  • 15: 32768, for duty_cycle_prescaler
  • 0: 128 ms, for frequency_integration_time
  • 1: 256 ms, for frequency_integration_time
  • 2: 512 ms, for frequency_integration_time
  • 3: 1024 ms, for frequency_integration_time
  • 4: 2048 ms, for frequency_integration_time
  • 5: 4096 ms, for frequency_integration_time
  • 6: 8192 ms, for frequency_integration_time
  • 7: 16384 ms, for frequency_integration_time
  • 8: 32768 ms, for frequency_integration_time
BrickletIndustrialCounter.set_channel_led_config
Function ID:

17

Request:
  • channel -- uint8
  • config -- uint8
Response:

no response

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show channel status, for config
BrickletIndustrialCounter.get_channel_led_config
Function ID:

18

Request:
  • channel -- uint8
Response:
  • config -- uint8

Returns the channel LED configuration as set by set_channel_led_config

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

  • 0: 0, for channel
  • 1: 1, for channel
  • 2: 2, for channel
  • 3: 3, for channel
  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show channel status, for config

Advanced Functions

BrickletIndustrialCounter.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletIndustrialCounter.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletIndustrialCounter.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

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

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletIndustrialCounter.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
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.

BrickletIndustrialCounter.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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.

BrickletIndustrialCounter.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
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 parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletIndustrialCounter.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

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

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletIndustrialCounter.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

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.

BrickletIndustrialCounter.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!

BrickletIndustrialCounter.write_uid
Function ID:

248

Request:
  • uid -- uint32
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.

BrickletIndustrialCounter.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletIndustrialCounter.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletIndustrialCounter.set_all_counter_callback_configuration
Function ID:

13

Request:
  • period -- uint32
  • value_has_to_change -- bool
Response:

no response

The period in ms is the period with which the CALLBACK_ALL_COUNTER 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.

The default value is (0, false).

BrickletIndustrialCounter.get_all_counter_callback_configuration
Function ID:

14

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool

Returns the callback configuration as set by set_all_counter_callback_configuration.

BrickletIndustrialCounter.set_all_signal_data_callback_configuration
Function ID:

15

Request:
  • period -- uint32
  • value_has_to_change -- bool
Response:

no response

The period in ms is the period with which the CALLBACK_ALL_SIGNAL_DATA 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.

The default value is (0, false).

BrickletIndustrialCounter.get_all_signal_data_callback_configuration
Function ID:

16

Request:

empty payload

Response:
  • period -- uint32
  • value_has_to_change -- bool

Returns the callback configuration as set by set_all_signal_data_callback_configuration.

Callbacks

BrickletIndustrialCounter.CALLBACK_ALL_COUNTER
Function ID:

19

Response:
  • counter -- int64[4]

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

The response values are the same as get_all_counter.

BrickletIndustrialCounter.CALLBACK_ALL_SIGNAL_DATA
Function ID:

20

Response:
  • duty_cycle -- uint16[4]
  • period -- uint64[4]
  • frequency -- uint32[4]
  • value -- bool[4]

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

The response values are the same as get_all_signal_data.