MQTT - Industrial Counter Bricklet

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

An installation guide for the MQTT API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Industrial Counter Bricklet

setup:
    # Get current counter from channel 0
    subscribe to tinkerforge/response/industrial_counter_bricklet/XYZ/get_counter
    publish '{ "channel": "0"}' to tinkerforge/request/industrial_counter_bricklet/XYZ/get_counter 
    
    # Get current signal data from channel 0
    subscribe to tinkerforge/response/industrial_counter_bricklet/XYZ/get_signal_data
    publish '{ "channel": "0"}' to tinkerforge/request/industrial_counter_bricklet/XYZ/get_signal_data 

API

All published payload to an from the MQTT bindings is in the JSON format.

If an error occures, the bindings publish a JSON object containing the error message as attribute "_ERROR". It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions

request/industrial_counter_bricklet/<UID>/get_counter
Request payload:
 
  • channel -- int (has symbols)
Response payload:
 
  • counter -- int

Returns the current counter value for the given channel.

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_counter
Response payload:
 
  • counter -- [int,int,int,int]

Returns the current counter values for all four channels.

request/industrial_counter_bricklet/<UID>/set_counter
Request payload:
 
  • channel -- int (has symbols)
  • counter -- int

Sets the counter value for the given channel.

The default value for the counters on startup is 0.

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/set_all_counter
Request payload:
 
  • counter -- [int,int,int,int]

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

request/industrial_counter_bricklet/<UID>/get_signal_data
Request payload:
 
  • channel -- int (has symbols)
Response payload:
 
  • duty_cycle -- int
  • period -- int
  • frequency -- int
  • 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 symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_signal_data
Response payload:
 
  • duty_cycle -- [int,int,int,int]
  • period -- [int,int,int,int]
  • frequency -- [int,int,int,int]
  • value -- [bool,bool,bool,bool]

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
request/industrial_counter_bricklet/<UID>/set_counter_active
Request payload:
 
  • channel -- int (has symbols)
  • active -- bool

Activates/deactivates the counter of the given channel.

true = activate, false = deactivate.

By default all channels are activated.

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/set_all_counter_active
Request payload:
 
  • active -- [bool,bool,bool,bool]

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

request/industrial_counter_bricklet/<UID>/get_counter_active
Request payload:
 
  • channel -- int (has symbols)
Response payload:
 
  • active -- bool

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3
request/industrial_counter_bricklet/<UID>/get_all_counter_active
Response payload:
 
  • active -- [bool,bool,bool,bool]

Returns the activation state of all four channels.

true = activated, false = deactivated.

request/industrial_counter_bricklet/<UID>/set_counter_configuration
Request payload:
 
  • channel -- int (has symbols)
  • count_edge -- int (has symbols)
  • count_direction -- int (has symbols)
  • duty_cycle_prescaler -- int (has symbols)
  • frequency_integration_time -- int (has symbols)

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 symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3

for count_edge:

  • "Rising" = 0
  • "Falling" = 1
  • "Both" = 2

for count_direction:

  • "Up" = 0
  • "Down" = 1
  • "ExternalUp" = 2
  • "ExternalDown" = 3

for duty_cycle_prescaler:

  • "1" = 0
  • "2" = 1
  • "4" = 2
  • "8" = 3
  • "16" = 4
  • "32" = 5
  • "64" = 6
  • "128" = 7
  • "256" = 8
  • "512" = 9
  • "1024" = 10
  • "2048" = 11
  • "4096" = 12
  • "8192" = 13
  • "16384" = 14
  • "32768" = 15

for frequency_integration_time:

  • "128MS" = 0
  • "256MS" = 1
  • "512MS" = 2
  • "1024MS" = 3
  • "2048MS" = 4
  • "4096MS" = 5
  • "8192MS" = 6
  • "16384MS" = 7
  • "32768MS" = 8
request/industrial_counter_bricklet/<UID>/get_counter_configuration
Request payload:
 
  • channel -- int (has symbols)
Response payload:
 
  • count_edge -- int (has symbols)
  • count_direction -- int (has symbols)
  • duty_cycle_prescaler -- int (has symbols)
  • frequency_integration_time -- int (has symbols)

Returns the counter configuration as set by request/industrial_counter_bricklet/<UID>/set_counter_configuration.

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3

for count_edge:

  • "Rising" = 0
  • "Falling" = 1
  • "Both" = 2

for count_direction:

  • "Up" = 0
  • "Down" = 1
  • "ExternalUp" = 2
  • "ExternalDown" = 3

for duty_cycle_prescaler:

  • "1" = 0
  • "2" = 1
  • "4" = 2
  • "8" = 3
  • "16" = 4
  • "32" = 5
  • "64" = 6
  • "128" = 7
  • "256" = 8
  • "512" = 9
  • "1024" = 10
  • "2048" = 11
  • "4096" = 12
  • "8192" = 13
  • "16384" = 14
  • "32768" = 15

for frequency_integration_time:

  • "128MS" = 0
  • "256MS" = 1
  • "512MS" = 2
  • "1024MS" = 3
  • "2048MS" = 4
  • "4096MS" = 5
  • "8192MS" = 6
  • "16384MS" = 7
  • "32768MS" = 8
request/industrial_counter_bricklet/<UID>/set_channel_led_config
Request payload:
 
  • channel -- int (has symbols)
  • config -- int (has symbols)

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 symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowChannelStatus" = 3
request/industrial_counter_bricklet/<UID>/get_channel_led_config
Request payload:
 
  • channel -- int (has symbols)
Response payload:
 
  • config -- int (has symbols)

Returns the channel LED configuration as set by request/industrial_counter_bricklet/<UID>/set_channel_led_config

The following symbols are available for this function:

for channel:

  • "0" = 0
  • "1" = 1
  • "2" = 2
  • "3" = 3

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowChannelStatus" = 3

Advanced Functions

request/industrial_counter_bricklet/<UID>/get_spitfp_error_count
Response payload:
 
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

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.

request/industrial_counter_bricklet/<UID>/set_bootloader_mode
Request payload:
 
  • mode -- int (has symbols)
Response payload:
 
  • status -- int (has symbols)

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 symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

for status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/industrial_counter_bricklet/<UID>/get_bootloader_mode
Response payload:
 
  • mode -- int (has symbols)

Returns the current bootloader mode, see request/industrial_counter_bricklet/<UID>/set_bootloader_mode.

The following symbols are available for this function:

for mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/industrial_counter_bricklet/<UID>/set_write_firmware_pointer
Request payload:
 
  • pointer -- int

Sets the firmware pointer for request/industrial_counter_bricklet/<UID>/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.

request/industrial_counter_bricklet/<UID>/write_firmware
Request payload:
 
  • data -- [int,... (x64)]
Response payload:
 
  • status -- int

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

request/industrial_counter_bricklet/<UID>/set_status_led_config
Request payload:
 
  • config -- int (has symbols)

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 symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/industrial_counter_bricklet/<UID>/get_status_led_config
Response payload:
 
  • config -- int (has symbols)

Returns the configuration as set by request/industrial_counter_bricklet/<UID>/set_status_led_config

The following symbols are available for this function:

for config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/industrial_counter_bricklet/<UID>/get_chip_temperature
Response payload:
 
  • temperature -- int

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.

request/industrial_counter_bricklet/<UID>/reset

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!

request/industrial_counter_bricklet/<UID>/write_uid
Request payload:
 
  • uid -- int

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.

request/industrial_counter_bricklet/<UID>/read_uid
Response payload:
 
  • uid -- int

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

request/industrial_counter_bricklet/<UID>/get_identity
Response payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (has symbols)
  • _display_name -- string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Industrial Counter's name in a human readable form.

Callback Configuration Functions

request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration
Request payload:
 
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the register/industrial_counter_bricklet/<UID>/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).

request/industrial_counter_bricklet/<UID>/get_all_counter_callback_configuration
Response payload:
 
  • period -- int
  • value_has_to_change -- bool

Returns the callback configuration as set by request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration.

request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration
Request payload:
 
  • period -- int
  • value_has_to_change -- bool

The period in ms is the period with which the register/industrial_counter_bricklet/<UID>/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).

request/industrial_counter_bricklet/<UID>/get_all_signal_data_callback_configuration
Response payload:
 
  • period -- int
  • value_has_to_change -- bool

Returns the callback configuration as set by request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

register/industrial_counter_bricklet/<UID>/all_counter
Request payload:
 
  • register -- bool
Response payload:
 
  • counter -- [int,int,int,int]

A callback can be registered for this event by publishing to the .../register/industrial_counter_bricklet/<UID>/all_counter[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/industrial_counter_bricklet/<UID>/all_counter[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/industrial_counter_bricklet/<UID>/set_all_counter_callback_configuration.

The callback payload members are the same as request/industrial_counter_bricklet/<UID>/get_all_counter.

register/industrial_counter_bricklet/<UID>/all_signal_data
Request payload:
 
  • register -- bool
Response payload:
 
  • duty_cycle -- [int,int,int,int]
  • period -- [int,int,int,int]
  • frequency -- [int,int,int,int]
  • value -- [bool,bool,bool,bool]

A callback can be registered for this event by publishing to the .../register/industrial_counter_bricklet/<UID>/all_signal_data[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/industrial_counter_bricklet/<UID>/all_signal_data[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically according to the configuration set by request/industrial_counter_bricklet/<UID>/set_all_signal_data_callback_configuration.

The callback payload members are the same as request/industrial_counter_bricklet/<UID>/get_all_signal_data.