Deutsch
English
Menu
Specifications / TCP/IP Protocol / API / Bricks and Bricklets / Bricklets / Industrial Counter Bricklet

TCP/IP - Industrial Counter Bricklet

This is the description of the TCP/IP 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 TCP/IP protocol structure can be found here.

Basic Functions

BrickletIndustrialCounter.get_counter
Function ID:
  • 1
Request:
  • channel – Type: uint8, Range: See meanings
Response:
  • counter – Type: int64, Range: [-247 to 247 - 1]

Returns the current counter value for the given channel.

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

For channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_counter
Function ID:
  • 2
Request:
  • empty payload
Response:
  • counter – Type: int64[4], Range: [-247 to 247 - 1]

Returns the current counter values for all four channels.

BrickletIndustrialCounter.set_counter
Function ID:
  • 3
Request:
  • channel – Type: uint8, Range: See meanings
  • counter – Type: int64, Range: [-247 to 247 - 1]
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 elements of this function:

For channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.set_all_counter
Function ID:
  • 4
Request:
  • counter – Type: int64[4], Range: [-247 to 247 - 1]
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 – Type: uint8, Range: See meanings
Response:
  • duty_cycle – Type: uint16, Unit: 1/100 %, Range: [0 to 10000]
  • period – Type: uint64, Unit: 1 ns, Range: [0 to 264 - 1]
  • frequency – Type: uint32, Unit: 1/1000 Hz, Range: [0 to 232 - 1]
  • value – Type: bool

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

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

For channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_signal_data
Function ID:
  • 6
Request:
  • empty payload
Response:
  • duty_cycle – Type: uint16[4], Unit: 1/100 %, Range: [0 to 10000]
  • period – Type: uint64[4], Unit: 1 ns, Range: [0 to 264 - 1]
  • frequency – Type: uint32[4], Unit: 1/1000 Hz, Range: [0 to 232 - 1]
  • value – Type: bool[4]

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

BrickletIndustrialCounter.set_counter_active
Function ID:
  • 7
Request:
  • channel – Type: uint8, Range: See meanings
  • active – Type: bool, Default: true
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 elements of this function:

For channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.set_all_counter_active
Function ID:
  • 8
Request:
  • active – Type: bool[4], Default: [true, true, true, true]
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 – Type: uint8, Range: See meanings
Response:
  • active – Type: bool, Default: true

Returns the activation state of the given channel.

true = activated, false = deactivated.

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

For channel:

  • 0 = 0
  • 1 = 1
  • 2 = 2
  • 3 = 3
BrickletIndustrialCounter.get_all_counter_active
Function ID:
  • 10
Request:
  • empty payload
Response:
  • active – Type: bool[4], Default: [true, true, true, true]

Returns the activation state of all four channels.

true = activated, false = deactivated.

BrickletIndustrialCounter.set_counter_configuration
Function ID:
  • 11
Request:
  • channel – Type: uint8, Range: See meanings
  • count_edge – Type: uint8, Range: See meanings, Default: 0
  • count_direction – Type: uint8, Range: See meanings, Default: 0
  • duty_cycle_prescaler – Type: uint8, Range: See meanings, Default: 0
  • frequency_integration_time – Type: uint8, Range: See meanings, Default: 3
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 elements of this function:

For channel:

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

For count_edge:

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

For count_direction:

  • 0 = Up
  • 1 = Down
  • 2 = External Up
  • 3 = External Down

For duty_cycle_prescaler:

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

For frequency_integration_time:

  • 0 = 128 MS
  • 1 = 256 MS
  • 2 = 512 MS
  • 3 = 1024 MS
  • 4 = 2048 MS
  • 5 = 4096 MS
  • 6 = 8192 MS
  • 7 = 16384 MS
  • 8 = 32768 MS
BrickletIndustrialCounter.get_counter_configuration
Function ID:
  • 12
Request:
  • channel – Type: uint8, Range: See meanings
Response:
  • count_edge – Type: uint8, Range: See meanings, Default: 0
  • count_direction – Type: uint8, Range: See meanings, Default: 0
  • duty_cycle_prescaler – Type: uint8, Range: See meanings, Default: 0
  • frequency_integration_time – Type: uint8, Range: See meanings, Default: 3

Returns the counter configuration as set by set_counter_configuration.

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

For channel:

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

For count_edge:

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

For count_direction:

  • 0 = Up
  • 1 = Down
  • 2 = External Up
  • 3 = External Down

For duty_cycle_prescaler:

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

For frequency_integration_time:

  • 0 = 128 MS
  • 1 = 256 MS
  • 2 = 512 MS
  • 3 = 1024 MS
  • 4 = 2048 MS
  • 5 = 4096 MS
  • 6 = 8192 MS
  • 7 = 16384 MS
  • 8 = 32768 MS
BrickletIndustrialCounter.set_channel_led_config
Function ID:
  • 17
Request:
  • channel – Type: uint8, Range: See meanings
  • config – Type: uint8, Range: See meanings, Default: 3
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.

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

For channel:

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

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status
BrickletIndustrialCounter.get_channel_led_config
Function ID:
  • 18
Request:
  • channel – Type: uint8, Range: See meanings
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

Returns the channel LED configuration as set by set_channel_led_config

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

For channel:

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

For config:

  • 0 = Off
  • 1 = On
  • 2 = Show Heartbeat
  • 3 = Show Channel Status

Advanced Functions

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

BrickletIndustrialCounter.set_status_led_config
Function ID:
  • 239
Request:
  • config – Type: uint8, Range: See meanings, Default: 3
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
BrickletIndustrialCounter.get_status_led_config
Function ID:
  • 240
Request:
  • empty payload
Response:
  • config – Type: uint8, Range: See meanings, Default: 3

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
BrickletIndustrialCounter.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

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.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions

BrickletIndustrialCounter.set_all_counter_callback_configuration
Function ID:
  • 13
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_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.

BrickletIndustrialCounter.get_all_counter_callback_configuration
Function ID:
  • 14
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_all_counter_callback_configuration.

BrickletIndustrialCounter.set_all_signal_data_callback_configuration
Function ID:
  • 15
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_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.

BrickletIndustrialCounter.get_all_signal_data_callback_configuration
Function ID:
  • 16
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_all_signal_data_callback_configuration.

Callbacks

BrickletIndustrialCounter.CALLBACK_ALL_COUNTER
Function ID:
  • 19
Response:
  • counter – Type: int64[4], Range: [-247 to 247 - 1]

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 – Type: uint16[4], Unit: 1/100 %, Range: [0 to 10000]
  • period – Type: uint64[4], Unit: 1 ns, Range: [0 to 264 - 1]
  • frequency – Type: uint32[4], Unit: 1/1000 Hz, Range: [0 to 232 - 1]
  • value – Type: 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.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletIndustrialCounter.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
BrickletIndustrialCounter.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
BrickletIndustrialCounter.set_write_firmware_pointer
Function ID:
  • 237
Request:
  • pointer – Type: uint32, Unit: 1 B, 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.

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

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

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