Software / API Bindings / Shell / API Reference and Examples / Bricklets / Industrial Counter Bricklet

Shell - Industrial Counter Bricklet¶

This is the description of the Shell 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 Shell API bindings is part of their general description.

Examples¶

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

Simple¶

Download (example-simple.sh)

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Counter Bricklet

# Get current counter from channel 0
tinkerforge call industrial-counter-bricklet $uid get-counter channel-0

# Get current signal data from channel 0
tinkerforge call industrial-counter-bricklet $uid get-signal-data channel-0

Callback¶

Download (example-callback.sh)

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Industrial Counter Bricklet

# Handle incoming all counter callbacks
tinkerforge dispatch industrial-counter-bricklet $uid all-counter &

# Set period for all counter callback to 1s (1000ms)
tinkerforge call industrial-counter-bricklet $uid set-all-counter-callback-configuration 1000 true

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API¶

Possible exit codes for all tinkerforge commands are:

1: interrupted (ctrl+c)
2: syntax error
21: Python 2.5 or newer is required
22: Python argparse module is missing
23: socket error
24: other exception
25: invalid placeholder in format string
26: authentication error
201: timeout occurred
209: invalid argument value
210: function is not supported
211: unknown error

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call industrial-counter-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Industrial Counter Bricklet. It can take several options:

--help shows help for the specific call command and exits
--list-functions shows a list of known functions of the Industrial Counter Bricklet and exits

tinkerforge dispatch industrial-counter-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Industrial Counter Bricklet. It can take several options:

--help shows help for the specific dispatch command and exits
--list-callbacks shows a list of known callbacks of the Industrial Counter Bricklet and exits

tinkerforge call industrial-counter-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

--help shows help for the specific function and exits

Getter functions can take the following options:

--execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

--expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch industrial-counter-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

--help shows help for the specific callback and exits
--execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call industrial-counter-bricklet <uid> get-counter <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	counter – Type: Int, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter value for the given channel.

The following symbols are available for this function:

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

tinkerforge call industrial-counter-bricklet <uid> get-all-counter¶

Output:	counter – Type: Int Array, Length: 4, Range: [-2⁴⁷ to 2⁴⁷ - 1]

Returns the current counter values for all four channels.

tinkerforge call industrial-counter-bricklet <uid> set-counter <channel> <counter>¶

Parameters:	<channel> – Type: Int, Range: See symbols <counter> – Type: Int, Range: [-2⁴⁷ to 2⁴⁷ - 1]
Output:	no output

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>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

tinkerforge call industrial-counter-bricklet <uid> set-all-counter <counter>¶

Parameters:	<counter> – Type: Int Array, Length: 4, Range: [-2⁴⁷ to 2⁴⁷ - 1]
Output:	no output

Sets the counter values for all four channels.

The default value for the counters on startup is 0.

tinkerforge call industrial-counter-bricklet <uid> get-signal-data <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	duty-cycle – Type: Int, Unit: 1/100 %, Range: [0 to 10000] period – Type: Int, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: Int, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: Bool

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

The following symbols are available for this function:

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

tinkerforge call industrial-counter-bricklet <uid> get-all-signal-data¶

Output:	duty-cycle – Type: Int Array, Length: 4, Unit: 1/100 %, Range: [0 to 10000] period – Type: Int Array, Length: 4, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: Int Array, Length: 4, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: Bool Array, Length: 4

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

tinkerforge call industrial-counter-bricklet <uid> set-counter-active <channel> <active>¶

Parameters:	<channel> – Type: Int, Range: See symbols <active> – Type: Bool, Default: true
Output:	no output

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>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

tinkerforge call industrial-counter-bricklet <uid> set-all-counter-active <active>¶

Parameters:	<active> – Type: Bool Array, Length: 4, Default: true,true,true,true
Output:	no output

Activates/deactivates the counter of all four channels.

true = activate, false = deactivate.

By default all channels are activated.

tinkerforge call industrial-counter-bricklet <uid> get-counter-active <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	active – Type: Bool, Default: true

Returns the activation state of the given channel.

true = activated, false = deactivated.

The following symbols are available for this function:

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

tinkerforge call industrial-counter-bricklet <uid> get-all-counter-active¶

Output:	active – Type: Bool Array, Length: 4, Default: true,true,true,true

Returns the activation state of all four channels.

true = activated, false = deactivated.

tinkerforge call industrial-counter-bricklet <uid> set-counter-configuration <channel> <count-edge> <count-direction> <duty-cycle-prescaler> <frequency-integration-time>¶

Parameters:	<channel> – Type: Int, Range: See symbols <count-edge> – Type: Int, Range: See symbols, Default: 0 <count-direction> – Type: Int, Range: See symbols, Default: 0 <duty-cycle-prescaler> – Type: Int, Range: See symbols, Default: 0 <frequency-integration-time> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

For <count-edge>:

count-edge-rising = 0
count-edge-falling = 1
count-edge-both = 2

For <count-direction>:

count-direction-up = 0
count-direction-down = 1
count-direction-external-up = 2
count-direction-external-down = 3

For <duty-cycle-prescaler>:

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

For <frequency-integration-time>:

frequency-integration-time-128-ms = 0
frequency-integration-time-256-ms = 1
frequency-integration-time-512-ms = 2
frequency-integration-time-1024-ms = 3
frequency-integration-time-2048-ms = 4
frequency-integration-time-4096-ms = 5
frequency-integration-time-8192-ms = 6
frequency-integration-time-16384-ms = 7
frequency-integration-time-32768-ms = 8

tinkerforge call industrial-counter-bricklet <uid> get-counter-configuration <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	count-edge – Type: Int, Range: See symbols, Default: 0 count-direction – Type: Int, Range: See symbols, Default: 0 duty-cycle-prescaler – Type: Int, Range: See symbols, Default: 0 frequency-integration-time – Type: Int, Range: See symbols, Default: 3

Returns the counter configuration as set by set-counter-configuration.

The following symbols are available for this function:

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

For count-edge:

count-edge-rising = 0
count-edge-falling = 1
count-edge-both = 2

For count-direction:

count-direction-up = 0
count-direction-down = 1
count-direction-external-up = 2
count-direction-external-down = 3

For duty-cycle-prescaler:

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

For frequency-integration-time:

frequency-integration-time-128-ms = 0
frequency-integration-time-256-ms = 1
frequency-integration-time-512-ms = 2
frequency-integration-time-1024-ms = 3
frequency-integration-time-2048-ms = 4
frequency-integration-time-4096-ms = 5
frequency-integration-time-8192-ms = 6
frequency-integration-time-16384-ms = 7
frequency-integration-time-32768-ms = 8

tinkerforge call industrial-counter-bricklet <uid> set-channel-led-config <channel> <config>¶

Parameters:	<channel> – Type: Int, Range: See symbols <config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

For <config>:

channel-led-config-off = 0
channel-led-config-on = 1
channel-led-config-show-heartbeat = 2
channel-led-config-show-channel-status = 3

tinkerforge call industrial-counter-bricklet <uid> get-channel-led-config <channel>¶

Parameters:	<channel> – Type: Int, Range: See symbols
Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the channel LED configuration as set by set-channel-led-config

The following symbols are available for this function:

For <channel>:

channel-0 = 0
channel-1 = 1
channel-2 = 2
channel-3 = 3

For config:

channel-led-config-off = 0
channel-led-config-on = 1
channel-led-config-show-heartbeat = 2
channel-led-config-show-channel-status = 3

Advanced Functions¶

tinkerforge call industrial-counter-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 2³² - 1] error-count-message-checksum – Type: Int, Range: [0 to 2³² - 1] error-count-frame – Type: Int, Range: [0 to 2³² - 1] error-count-overflow – Type: Int, Range: [0 to 2³² - 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.

tinkerforge call industrial-counter-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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>:

status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3

tinkerforge call industrial-counter-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3

tinkerforge call industrial-counter-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

tinkerforge call industrial-counter-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call industrial-counter-bricklet <uid> get-identity¶

Output:

Output:	uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 2¹⁶ - 1]

uid – Type: String, Length: up to 8
connected-uid – Type: String, Length: up to 8
position – Type: Char, Range: [a to h, z]
hardware-version – Type: Int Array, Length: 3

0: major – Type: Int, Range: [0 to 255]
1: minor – Type: Int, Range: [0 to 255]
2: revision – Type: Int, Range: [0 to 255]

firmware-version – Type: Int Array, Length: 3

0: major – Type: Int, Range: [0 to 255]
1: minor – Type: Int, Range: [0 to 255]
2: revision – Type: Int, Range: [0 to 255]

device-identifier – Type: Int, Range: [0 to 2¹⁶ - 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¶

tinkerforge call industrial-counter-bricklet <uid> set-all-counter-callback-configuration <period> <value-has-to-change>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

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

tinkerforge call industrial-counter-bricklet <uid> get-all-counter-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 value-has-to-change – Type: Bool, Default: false

Returns the callback configuration as set by set-all-counter-callback-configuration.

tinkerforge call industrial-counter-bricklet <uid> set-all-signal-data-callback-configuration <period> <value-has-to-change>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false
Output:	no output

The period is the period with which the all-signal-data callback is triggered periodically. A value of 0 turns the callback off.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

tinkerforge call industrial-counter-bricklet <uid> get-all-signal-data-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 2³² - 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¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch industrial-counter-bricklet <uid> example

The available callbacks are described below.

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.

tinkerforge dispatch industrial-counter-bricklet <uid> all-counter¶

Output:	counter – Type: Int Array, Length: 4, Range: [-2⁴⁷ to 2⁴⁷ - 1]

This callback is triggered periodically according to the configuration set by set-all-counter-callback-configuration.

The parameters are the same as get-all-counter.

tinkerforge dispatch industrial-counter-bricklet <uid> all-signal-data¶

Output:	duty-cycle – Type: Int Array, Length: 4, Unit: 1/100 %, Range: [0 to 10000] period – Type: Int Array, Length: 4, Unit: 1 ns, Range: [0 to 2⁶⁴ - 1] frequency – Type: Int Array, Length: 4, Unit: 1/1000 Hz, Range: [0 to 2³² - 1] value – Type: Bool Array, Length: 4

This callback is triggered periodically according to the configuration set by set-all-signal-data-callback-configuration.

The parameters 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.

tinkerforge call industrial-counter-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See 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-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

bootloader-status-ok = 0
bootloader-status-invalid-mode = 1
bootloader-status-no-change = 2
bootloader-status-entry-function-not-present = 3
bootloader-status-device-identifier-incorrect = 4
bootloader-status-crc-mismatch = 5

tinkerforge call industrial-counter-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

bootloader-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call industrial-counter-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1]
Output:	no output

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.

tinkerforge call industrial-counter-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, 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.

tinkerforge call industrial-counter-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 2³² - 1]
Output:	no output

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.

tinkerforge call industrial-counter-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 2³² - 1]

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