Class BrickletIndustrialCounter


  • public class BrickletIndustrialCounter
    extends Device
    4 channel counter up to 4MHz
    • Field Detail

      • DEVICE_DISPLAY_NAME

        public static final java.lang.String DEVICE_DISPLAY_NAME
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_COUNTER

        public static final byte FUNCTION_GET_ALL_COUNTER
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_COUNTER

        public static final byte FUNCTION_SET_ALL_COUNTER
        See Also:
        Constant Field Values
      • FUNCTION_GET_SIGNAL_DATA

        public static final byte FUNCTION_GET_SIGNAL_DATA
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_SIGNAL_DATA

        public static final byte FUNCTION_GET_ALL_SIGNAL_DATA
        See Also:
        Constant Field Values
      • FUNCTION_SET_COUNTER_ACTIVE

        public static final byte FUNCTION_SET_COUNTER_ACTIVE
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_COUNTER_ACTIVE

        public static final byte FUNCTION_SET_ALL_COUNTER_ACTIVE
        See Also:
        Constant Field Values
      • FUNCTION_GET_COUNTER_ACTIVE

        public static final byte FUNCTION_GET_COUNTER_ACTIVE
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_COUNTER_ACTIVE

        public static final byte FUNCTION_GET_ALL_COUNTER_ACTIVE
        See Also:
        Constant Field Values
      • FUNCTION_SET_COUNTER_CONFIGURATION

        public static final byte FUNCTION_SET_COUNTER_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_COUNTER_CONFIGURATION

        public static final byte FUNCTION_GET_COUNTER_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_GET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION

        public static final byte FUNCTION_GET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION
        See Also:
        Constant Field Values
      • FUNCTION_SET_CHANNEL_LED_CONFIG

        public static final byte FUNCTION_SET_CHANNEL_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_CHANNEL_LED_CONFIG

        public static final byte FUNCTION_GET_CHANNEL_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_SPITFP_ERROR_COUNT

        public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
        See Also:
        Constant Field Values
      • FUNCTION_SET_BOOTLOADER_MODE

        public static final byte FUNCTION_SET_BOOTLOADER_MODE
        See Also:
        Constant Field Values
      • FUNCTION_GET_BOOTLOADER_MODE

        public static final byte FUNCTION_GET_BOOTLOADER_MODE
        See Also:
        Constant Field Values
      • FUNCTION_SET_WRITE_FIRMWARE_POINTER

        public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
        See Also:
        Constant Field Values
      • FUNCTION_WRITE_FIRMWARE

        public static final byte FUNCTION_WRITE_FIRMWARE
        See Also:
        Constant Field Values
      • FUNCTION_SET_STATUS_LED_CONFIG

        public static final byte FUNCTION_SET_STATUS_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_STATUS_LED_CONFIG

        public static final byte FUNCTION_GET_STATUS_LED_CONFIG
        See Also:
        Constant Field Values
      • FUNCTION_GET_CHIP_TEMPERATURE

        public static final byte FUNCTION_GET_CHIP_TEMPERATURE
        See Also:
        Constant Field Values
      • COUNT_DIRECTION_EXTERNAL_UP

        public static final int COUNT_DIRECTION_EXTERNAL_UP
        See Also:
        Constant Field Values
      • COUNT_DIRECTION_EXTERNAL_DOWN

        public static final int COUNT_DIRECTION_EXTERNAL_DOWN
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_16

        public static final int DUTY_CYCLE_PRESCALER_16
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_32

        public static final int DUTY_CYCLE_PRESCALER_32
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_64

        public static final int DUTY_CYCLE_PRESCALER_64
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_128

        public static final int DUTY_CYCLE_PRESCALER_128
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_256

        public static final int DUTY_CYCLE_PRESCALER_256
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_512

        public static final int DUTY_CYCLE_PRESCALER_512
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_1024

        public static final int DUTY_CYCLE_PRESCALER_1024
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_2048

        public static final int DUTY_CYCLE_PRESCALER_2048
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_4096

        public static final int DUTY_CYCLE_PRESCALER_4096
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_8192

        public static final int DUTY_CYCLE_PRESCALER_8192
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_16384

        public static final int DUTY_CYCLE_PRESCALER_16384
        See Also:
        Constant Field Values
      • DUTY_CYCLE_PRESCALER_32768

        public static final int DUTY_CYCLE_PRESCALER_32768
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_128_MS

        public static final int FREQUENCY_INTEGRATION_TIME_128_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_256_MS

        public static final int FREQUENCY_INTEGRATION_TIME_256_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_512_MS

        public static final int FREQUENCY_INTEGRATION_TIME_512_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_1024_MS

        public static final int FREQUENCY_INTEGRATION_TIME_1024_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_2048_MS

        public static final int FREQUENCY_INTEGRATION_TIME_2048_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_4096_MS

        public static final int FREQUENCY_INTEGRATION_TIME_4096_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_8192_MS

        public static final int FREQUENCY_INTEGRATION_TIME_8192_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_16384_MS

        public static final int FREQUENCY_INTEGRATION_TIME_16384_MS
        See Also:
        Constant Field Values
      • FREQUENCY_INTEGRATION_TIME_32768_MS

        public static final int FREQUENCY_INTEGRATION_TIME_32768_MS
        See Also:
        Constant Field Values
      • CHANNEL_LED_CONFIG_SHOW_HEARTBEAT

        public static final int CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
        See Also:
        Constant Field Values
      • CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS

        public static final int CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_BOOTLOADER

        public static final int BOOTLOADER_MODE_BOOTLOADER
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE

        public static final int BOOTLOADER_MODE_FIRMWARE
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT

        public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT

        public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

        public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_INVALID_MODE

        public static final int BOOTLOADER_STATUS_INVALID_MODE
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_NO_CHANGE

        public static final int BOOTLOADER_STATUS_NO_CHANGE
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT

        public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT

        public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
        See Also:
        Constant Field Values
      • BOOTLOADER_STATUS_CRC_MISMATCH

        public static final int BOOTLOADER_STATUS_CRC_MISMATCH
        See Also:
        Constant Field Values
      • STATUS_LED_CONFIG_SHOW_HEARTBEAT

        public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
        See Also:
        Constant Field Values
      • STATUS_LED_CONFIG_SHOW_STATUS

        public static final int STATUS_LED_CONFIG_SHOW_STATUS
        See Also:
        Constant Field Values
    • Constructor Detail

      • BrickletIndustrialCounter

        public BrickletIndustrialCounter​(java.lang.String uid,
                                         IPConnection ipcon)
        Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
    • Method Detail

      • setCounter

        public void setCounter​(int channel,
                               long counter)
                        throws TinkerforgeException
        Sets the counter value for the given channel. The default value for the counters on startup is 0.
        Throws:
        TinkerforgeException
      • setAllCounter

        public void setAllCounter​(long[] counter)
                           throws TinkerforgeException
        Sets the counter values for all four channels. The default value for the counters on startup is 0.
        Throws:
        TinkerforgeException
      • setCounterActive

        public void setCounterActive​(int channel,
                                     boolean active)
                              throws TinkerforgeException
        Activates/deactivates the counter of the given channel. true = activate, false = deactivate. By default all channels are activated.
        Throws:
        TinkerforgeException
      • setAllCounterActive

        public void setAllCounterActive​(boolean[] active)
                                 throws TinkerforgeException
        Activates/deactivates the counter of all four channels. true = activate, false = deactivate. By default all channels are activated.
        Throws:
        TinkerforgeException
      • getCounterActive

        public boolean getCounterActive​(int channel)
                                 throws TinkerforgeException
        Returns the activation state of the given channel. true = activated, false = deactivated.
        Throws:
        TinkerforgeException
      • getAllCounterActive

        public boolean[] getAllCounterActive()
                                      throws TinkerforgeException
        Returns the activation state of all four channels. true = activated, false = deactivated.
        Throws:
        TinkerforgeException
      • setCounterConfiguration

        public void setCounterConfiguration​(int channel,
                                            int countEdge,
                                            int countDirection,
                                            int dutyCyclePrescaler,
                                            int frequencyIntegrationTime)
                                     throws TinkerforgeException
        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 <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Counter.html#external-count-direction>`__ for details. * Duty Cycle Prescaler: Sets a divider for the internal clock. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Counter.html#duty-cycle-prescaler-and-frequency-integration-time>`__ for details. * Frequency Integration Time: Sets the integration time for the frequency measurement. See `here <https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Counter.html#duty-cycle-prescaler-and-frequency-integration-time>`__ for details.
        Throws:
        TinkerforgeException
      • setAllCounterCallbackConfiguration

        public void setAllCounterCallbackConfiguration​(long period,
                                                       boolean valueHasToChange)
                                                throws TinkerforgeException
        The period is the period with which the BrickletIndustrialCounter.AllCounterListener listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.
        Throws:
        TinkerforgeException
      • setAllSignalDataCallbackConfiguration

        public void setAllSignalDataCallbackConfiguration​(long period,
                                                          boolean valueHasToChange)
                                                   throws TinkerforgeException
        The period is the period with which the BrickletIndustrialCounter.AllSignalDataListener listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.
        Throws:
        TinkerforgeException
      • setChannelLEDConfig

        public void setChannelLEDConfig​(int channel,
                                        int config)
                                 throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • getSPITFPErrorCount

        public BrickletIndustrialCounter.SPITFPErrorCount getSPITFPErrorCount()
                                                                       throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • setBootloaderMode

        public int setBootloaderMode​(int mode)
                              throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • setWriteFirmwarePointer

        public void setWriteFirmwarePointer​(long pointer)
                                     throws TinkerforgeException
        Sets the firmware pointer for writeFirmware(int[]). 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.
        Throws:
        TinkerforgeException
      • writeFirmware

        public int writeFirmware​(int[] data)
                          throws TinkerforgeException
        Writes 64 Bytes of firmware at the position as written by setWriteFirmwarePointer(long) 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.
        Throws:
        TinkerforgeException
      • setStatusLEDConfig

        public void setStatusLEDConfig​(int config)
                                throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • getChipTemperature

        public int getChipTemperature()
                               throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • reset

        public void reset()
                   throws TinkerforgeException
        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!
        Throws:
        TinkerforgeException
      • writeUID

        public void writeUID​(long uid)
                      throws TinkerforgeException
        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.
        Throws:
        TinkerforgeException
      • getIdentity

        public Device.Identity getIdentity()
                                    throws TinkerforgeException
        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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
        Specified by:
        getIdentity in class Device
        Throws:
        TinkerforgeException