LabVIEW - Industrial Counter Bricklet
This is the description of the LabVIEW 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 LabVIEW API
bindings is part of their general description.
API
Generally, every method of the LabVIEW bindings that outputs a value can
report a Tinkerforge.TimeoutException. This error gets reported if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody plugs the
device out). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.
The namespace for all Brick/Bricklet bindings and the IPConnection is
Tinkerforge.*.
Basic Functions
-
BrickletIndustrialCounter(uid, ipcon) → industrialCounter
Input: | - uid – Type: String
- ipcon – Type: .NET Refnum (IPConnection)
|
Output: | - industrialCounter – Type: .NET Refnum (BrickletIndustrialCounter)
|
Creates an object with the unique device ID uid.
This object can then be used after the IP Connection is connected
(see examples above).
-
BrickletIndustrialCounter.GetCounter(channel) → counter
Input: | - channel – Type: Byte, Range: See constants
|
Output: | - counter – Type: Int64, Range: [-263 to 263 - 1]
|
Returns the current counter value for the given channel.
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
-
BrickletIndustrialCounter.GetAllCounter() → counter
Output: | - counter – Type: Int64[4], Range: [-263 to 263 - 1]
|
Returns the current counter values for all four channels.
-
BrickletIndustrialCounter.SetCounter(channel, counter)
Input: | - channel – Type: Byte, Range: See constants
- counter – Type: Int64, Range: [-263 to 263 - 1]
|
Sets the counter value for the given channel.
The default value for the counters on startup is 0.
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
-
BrickletIndustrialCounter.SetAllCounter(counter)
Input: | - counter – Type: Int64[4], Range: [-263 to 263 - 1]
|
Sets the counter values for all four channels.
The default value for the counters on startup is 0.
-
BrickletIndustrialCounter.GetSignalData(channel) → dutyCycle, period, frequency, value
Input: | - channel – Type: Byte, Range: See constants
|
Output: | - dutyCycle – Type: Int32, Unit: 1/100 %, Range: [0 to 10000]
- period – Type: Int64, Unit: 1 ns, Range: [0 to 264 - 1]
- frequency – Type: Int64, Unit: 1/1000 Hz, Range: [0 to 232 - 1]
- value – Type: Boolean
|
Returns the signal data (duty cycle, period, frequency and value) for the
given channel.
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
-
BrickletIndustrialCounter.GetAllSignalData() → dutyCycle, period, frequency, value
Output: | - dutyCycle – Type: Int32[4], Unit: 1/100 %, Range: [0 to 10000]
- period – Type: Int64[4], Unit: 1 ns, Range: [0 to 264 - 1]
- frequency – Type: Int64[4], Unit: 1/1000 Hz, Range: [0 to 232 - 1]
- value – Type: Boolean[4]
|
Returns the signal data (duty cycle, period, frequency and value) for all four
channels.
-
BrickletIndustrialCounter.SetCounterActive(channel, active)
Input: | - channel – Type: Byte, Range: See constants
- active – Type: Boolean, Default: T
|
Activates/deactivates the counter of the given channel.
true = activate, false = deactivate.
By default all channels are activated.
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
-
BrickletIndustrialCounter.SetAllCounterActive(active)
Input: | - active – Type: Boolean[4], Default: {T, T, T, T}
|
Activates/deactivates the counter of all four channels.
true = activate, false = deactivate.
By default all channels are activated.
-
BrickletIndustrialCounter.GetCounterActive(channel) → active
Input: | - channel – Type: Byte, Range: See constants
|
Output: | - active – Type: Boolean, Default: T
|
Returns the activation state of the given channel.
true = activated, false = deactivated.
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
-
BrickletIndustrialCounter.GetAllCounterActive() → active
Output: | - active – Type: Boolean[4], Default: {T, T, T, T}
|
Returns the activation state of all four channels.
true = activated, false = deactivated.
-
BrickletIndustrialCounter.SetCounterConfiguration(channel, countEdge, countDirection, dutyCyclePrescaler, frequencyIntegrationTime)
Input: | - channel – Type: Byte, Range: See constants
- countEdge – Type: Byte, Range: See constants, Default: 0
- countDirection – Type: Byte, Range: See constants, Default: 0
- dutyCyclePrescaler – Type: Byte, Range: See constants, Default: 0
- frequencyIntegrationTime – Type: Byte, Range: See constants, Default: 3
|
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 constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
For countEdge:
- BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
- BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
- BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2
For countDirection:
- BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
- BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
- BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
- BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3
For dutyCyclePrescaler:
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15
For frequencyIntegrationTime:
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8
-
BrickletIndustrialCounter.GetCounterConfiguration(channel) → countEdge, countDirection, dutyCyclePrescaler, frequencyIntegrationTime
Input: | - channel – Type: Byte, Range: See constants
|
Output: | - countEdge – Type: Byte, Range: See constants, Default: 0
- countDirection – Type: Byte, Range: See constants, Default: 0
- dutyCyclePrescaler – Type: Byte, Range: See constants, Default: 0
- frequencyIntegrationTime – Type: Byte, Range: See constants, Default: 3
|
Returns the counter configuration as set by SetCounterConfiguration().
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
For countEdge:
- BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
- BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
- BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2
For countDirection:
- BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
- BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
- BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
- BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3
For dutyCyclePrescaler:
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
- BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15
For frequencyIntegrationTime:
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
- BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8
-
BrickletIndustrialCounter.SetChannelLEDConfig(channel, config)
Input: | - channel – Type: Byte, Range: See constants
- config – Type: Byte, Range: See constants, Default: 3
|
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 constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
For config:
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
-
BrickletIndustrialCounter.GetChannelLEDConfig(channel) → config
Input: | - channel – Type: Byte, Range: See constants
|
Output: | - config – Type: Byte, Range: See constants, Default: 3
|
Returns the channel LED configuration as set by SetChannelLEDConfig()
The following constants are available for this function:
For channel:
- BrickletIndustrialCounter.CHANNEL_0 = 0
- BrickletIndustrialCounter.CHANNEL_1 = 1
- BrickletIndustrialCounter.CHANNEL_2 = 2
- BrickletIndustrialCounter.CHANNEL_3 = 3
For config:
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
Advanced Functions
-
BrickletIndustrialCounter.GetAPIVersion() → apiVersion
Output: | - apiVersion – Type: Byte[3]
- 0: major – Type: Byte, Range: [0 to 255]
- 1: minor – Type: Byte, Range: [0 to 255]
- 2: revision – Type: Byte, Range: [0 to 255]
|
Returns the version of the API definition implemented
by this API bindings. This is neither the release version of this API bindings
nor does it tell you anything about the represented Brick or Bricklet.
-
BrickletIndustrialCounter.GetResponseExpected(functionId) → responseExpected
Input: | - functionId – Type: Byte, Range: See constants
|
Output: | - responseExpected – Type: Boolean
|
Returns the response expected flag for the function specified by the function
ID parameter. It is true if the function is expected to send a response,
false otherwise.
For getter functions this is enabled by default and cannot be disabled,
because those functions will always send a response. For callback configuration
functions it is enabled by default too, but can be disabled by
SetResponseExpected(). For setter functions it is disabled by default
and can be enabled.
Enabling the response expected flag for a setter function allows to detect
timeouts and other error conditions calls of this setter as well. The
device will then send a response for this purpose. If this flag is disabled for
a setter function then no response is send and errors are silently ignored,
because they cannot be detected.
The following constants are available for this function:
For functionId:
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
- BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
- BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
- BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
- BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
- BrickletIndustrialCounter.FUNCTION_RESET = 243
- BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248
-
BrickletIndustrialCounter.SetResponseExpected(functionId, responseExpected)
Input: | - functionId – Type: Byte, Range: See constants
- responseExpected – Type: Boolean
|
Changes the response expected flag of the function specified by the
function ID parameter. This flag can only be changed for setter (default value:
false) and callback configuration functions (default value: true). For
getter functions it is always enabled.
Enabling the response expected flag for a setter function allows to detect
timeouts and other error conditions calls of this setter as well. The
device will then send a response for this purpose. If this flag is disabled for
a setter function then no response is send and errors are silently ignored,
because they cannot be detected.
The following constants are available for this function:
For functionId:
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
- BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
- BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
- BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
- BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
- BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
- BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
- BrickletIndustrialCounter.FUNCTION_RESET = 243
- BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248
-
BrickletIndustrialCounter.SetResponseExpectedAll(responseExpected)
Input: | - responseExpected – Type: Boolean
|
Changes the response expected flag for all setter and callback configuration
functions of this device at once.
-
BrickletIndustrialCounter.GetSPITFPErrorCount() → errorCountAckChecksum, errorCountMessageChecksum, errorCountFrame, errorCountOverflow
Output: | - errorCountAckChecksum – Type: Int64, Range: [0 to 232 - 1]
- errorCountMessageChecksum – Type: Int64, Range: [0 to 232 - 1]
- errorCountFrame – Type: Int64, Range: [0 to 232 - 1]
- errorCountOverflow – Type: Int64, 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.SetBootloaderMode(mode) → status
Input: | - mode – Type: Byte, Range: See constants
|
Output: | - status – Type: Byte, Range: See constants
|
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 constants are available for this function:
For mode:
- BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER = 0
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE = 1
- BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
For status:
- BrickletIndustrialCounter.BOOTLOADER_STATUS_OK = 0
- BrickletIndustrialCounter.BOOTLOADER_STATUS_INVALID_MODE = 1
- BrickletIndustrialCounter.BOOTLOADER_STATUS_NO_CHANGE = 2
- BrickletIndustrialCounter.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
- BrickletIndustrialCounter.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
- BrickletIndustrialCounter.BOOTLOADER_STATUS_CRC_MISMATCH = 5
-
BrickletIndustrialCounter.GetBootloaderMode() → mode
Output: | - mode – Type: Byte, Range: See constants
|
Returns the current bootloader mode, see SetBootloaderMode().
The following constants are available for this function:
For mode:
- BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER = 0
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE = 1
- BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
- BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
-
BrickletIndustrialCounter.SetWriteFirmwarePointer(pointer)
Input: | - pointer – Type: Int64, Unit: 1 B, Range: [0 to 232 - 1]
|
Sets the firmware pointer for WriteFirmware(). 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.WriteFirmware(data) → status
Input: | - data – Type: Byte[64], Range: [0 to 255]
|
Output: | - status – Type: Byte, Range: [0 to 255]
|
Writes 64 Bytes of firmware at the position as written by
SetWriteFirmwarePointer() 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.SetStatusLEDConfig(config)
Input: | - config – Type: Byte, Range: See constants, Default: 3
|
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 constants are available for this function:
For config:
- BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
- BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
- BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3
-
BrickletIndustrialCounter.GetStatusLEDConfig() → config
Output: | - config – Type: Byte, Range: See constants, Default: 3
|
Returns the configuration as set by SetStatusLEDConfig()
The following constants are available for this function:
For config:
- BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
- BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
- BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
- BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3
-
BrickletIndustrialCounter.GetChipTemperature() → temperature
Output: | - 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()
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.WriteUID(uid)
Input: | - uid – Type: Int64, Range: [0 to 232 - 1]
|
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.ReadUID() → uid
Output: | - uid – Type: Int64, Range: [0 to 232 - 1]
|
Returns the current UID as an integer. Encode as
Base58 to get the usual string version.
-
BrickletIndustrialCounter.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output: | - uid – Type: String, Length: up to 8
- connectedUid – Type: String, Length: up to 8
- position – Type: Char, Range: ["a" to "h", "i", "z"]
- hardwareVersion – Type: Byte[3]
- 0: major – Type: Byte, Range: [0 to 255]
- 1: minor – Type: Byte, Range: [0 to 255]
- 2: revision – Type: Byte, Range: [0 to 255]
- firmwareVersion – Type: Byte[3]
- 0: major – Type: Byte, Range: [0 to 255]
- 1: minor – Type: Byte, Range: [0 to 255]
- 2: revision – Type: Byte, Range: [0 to 255]
- deviceIdentifier – Type: Int32, 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).
The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet
connected to an Isolator Bricklet is always as
position 'z'.
The device identifier numbers can be found here.
There is also a constant for the device identifier of this Bricklet.
Callback Configuration Functions
-
BrickletIndustrialCounter.SetAllCounterCallbackConfiguration(period, valueHasToChange)
Input: | - period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
- valueHasToChange – Type: Boolean, Default: F
|
The period is the period with which the AllCounterCallback
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.GetAllCounterCallbackConfiguration() → period, valueHasToChange
Output: | - period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
- valueHasToChange – Type: Boolean, Default: F
|
Returns the callback configuration as set by
SetAllCounterCallbackConfiguration().
-
BrickletIndustrialCounter.SetAllSignalDataCallbackConfiguration(period, valueHasToChange)
Input: | - period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
- valueHasToChange – Type: Boolean, Default: F
|
The period is the period with which the AllSignalDataCallback
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.GetAllSignalDataCallbackConfiguration() → period, valueHasToChange
Output: | - period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
- valueHasToChange – Type: Boolean, Default: F
|
Returns the callback configuration as set by
SetAllSignalDataCallbackConfiguration().
Callbacks
Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done by assigning a function to a callback
property of the device object. The available callback property and their type
of parameters 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.
-
event BrickletIndustrialCounter.AllCounterCallback → sender, counter
Callback Output: | - sender – Type: .NET Refnum (BrickletIndustrialCounter)
- counter – Type: Int64[4], Range: [-263 to 263 - 1]
|
This callback is triggered periodically according to the configuration set by
SetAllCounterCallbackConfiguration().
The parameters are the same as GetAllCounter().
-
event BrickletIndustrialCounter.AllSignalDataCallback → sender, dutyCycle, period, frequency, value
Callback Output: | - sender – Type: .NET Refnum (BrickletIndustrialCounter)
- dutyCycle – Type: Int32[4], Unit: 1/100 %, Range: [0 to 10000]
- period – Type: Int64[4], Unit: 1 ns, Range: [0 to 264 - 1]
- frequency – Type: Int64[4], Unit: 1/1000 Hz, Range: [0 to 232 - 1]
- value – Type: Boolean[4]
|
This callback is triggered periodically according to the configuration set by
SetAllSignalDataCallbackConfiguration().
The parameters are the same as GetAllSignalData().
Constants
-
BrickletIndustrialCounter.DEVICE_IDENTIFIER
This constant is used to identify a Industrial Counter Bricklet.
The GetIdentity() function and the
IPConnection.EnumerateCallback
callback of the IP Connection have a deviceIdentifier parameter to specify
the Brick's or Bricklet's type.
-
BrickletIndustrialCounter.DEVICE_DISPLAY_NAME
This constant represents the human readable name of a Industrial Counter Bricklet.