public class BrickletIndustrialCounter extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIndustrialCounter.AllCounterCallbackConfiguration |
static interface |
BrickletIndustrialCounter.AllCounterListener
This listener is triggered periodically according to the configuration set by
setAllCounterCallbackConfiguration(long, boolean) . |
class |
BrickletIndustrialCounter.AllSignalData |
class |
BrickletIndustrialCounter.AllSignalDataCallbackConfiguration |
static interface |
BrickletIndustrialCounter.AllSignalDataListener
This listener is triggered periodically according to the configuration set by
setAllSignalDataCallbackConfiguration(long, boolean) . |
class |
BrickletIndustrialCounter.CounterConfiguration |
class |
BrickletIndustrialCounter.SignalData |
class |
BrickletIndustrialCounter.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletIndustrialCounter(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAllCounterListener(BrickletIndustrialCounter.AllCounterListener listener)
Adds a AllCounter listener.
|
void |
addAllSignalDataListener(BrickletIndustrialCounter.AllSignalDataListener listener)
Adds a AllSignalData listener.
|
long[] |
getAllCounter()
Returns the current counter values for all four channels.
|
boolean[] |
getAllCounterActive()
Returns the activation state of all four channels.
|
BrickletIndustrialCounter.AllCounterCallbackConfiguration |
getAllCounterCallbackConfiguration()
Returns the listener configuration as set by
setAllCounterCallbackConfiguration(long, boolean) . |
BrickletIndustrialCounter.AllSignalData |
getAllSignalData()
Returns the signal data (duty cycle, period, frequency and value) for all four
channels.
|
BrickletIndustrialCounter.AllSignalDataCallbackConfiguration |
getAllSignalDataCallbackConfiguration()
Returns the listener configuration as set by
setAllSignalDataCallbackConfiguration(long, boolean) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChannelLEDConfig(int channel)
Returns the channel LED configuration as set by
setChannelLEDConfig(int, int) |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
long |
getCounter(int channel)
Returns the current counter value for the given channel.
|
boolean |
getCounterActive(int channel)
Returns the activation state of the given channel.
|
BrickletIndustrialCounter.CounterConfiguration |
getCounterConfiguration(int channel)
Returns the counter configuration as set by
setCounterConfiguration(int, int, int, int, int) . |
Device.Identity |
getIdentity()
Returns the UID, the UID where the Bricklet is connected to,
the position, the hardware and firmware version as well as the
device identifier.
|
BrickletIndustrialCounter.SignalData |
getSignalData(int channel)
Returns the signal data (duty cycle, period, frequency and value) for the
given channel.
|
BrickletIndustrialCounter.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAllCounterListener(BrickletIndustrialCounter.AllCounterListener listener)
Removes a AllCounter listener.
|
void |
removeAllSignalDataListener(BrickletIndustrialCounter.AllSignalDataListener listener)
Removes a AllSignalData listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAllCounter(long[] counter)
Sets the counter values for all four channels.
|
void |
setAllCounterActive(boolean[] active)
Activates/deactivates the counter of all four channels.
|
void |
setAllCounterCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletIndustrialCounter.AllCounterListener
listener is triggered periodically. |
void |
setAllSignalDataCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletIndustrialCounter.AllSignalDataListener
listener is triggered periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setChannelLEDConfig(int channel,
int config)
Each channel has a corresponding LED.
|
void |
setCounter(int channel,
long counter)
Sets the counter value for the given channel.
|
void |
setCounterActive(int channel,
boolean active)
Activates/deactivates the counter of the given channel.
|
void |
setCounterConfiguration(int channel,
int countEdge,
int countDirection,
int dutyCyclePrescaler,
int frequencyIntegrationTime)
Sets the counter configuration for the given channel.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_COUNTER
public static final byte FUNCTION_GET_ALL_COUNTER
public static final byte FUNCTION_SET_COUNTER
public static final byte FUNCTION_SET_ALL_COUNTER
public static final byte FUNCTION_GET_SIGNAL_DATA
public static final byte FUNCTION_GET_ALL_SIGNAL_DATA
public static final byte FUNCTION_SET_COUNTER_ACTIVE
public static final byte FUNCTION_SET_ALL_COUNTER_ACTIVE
public static final byte FUNCTION_GET_COUNTER_ACTIVE
public static final byte FUNCTION_GET_ALL_COUNTER_ACTIVE
public static final byte FUNCTION_SET_COUNTER_CONFIGURATION
public static final byte FUNCTION_GET_COUNTER_CONFIGURATION
public static final byte FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_COUNTER_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int CHANNEL_0
public static final int CHANNEL_1
public static final int CHANNEL_2
public static final int CHANNEL_3
public static final int COUNT_EDGE_RISING
public static final int COUNT_EDGE_FALLING
public static final int COUNT_EDGE_BOTH
public static final int COUNT_DIRECTION_UP
public static final int COUNT_DIRECTION_DOWN
public static final int COUNT_DIRECTION_EXTERNAL_UP
public static final int COUNT_DIRECTION_EXTERNAL_DOWN
public static final int DUTY_CYCLE_PRESCALER_1
public static final int DUTY_CYCLE_PRESCALER_2
public static final int DUTY_CYCLE_PRESCALER_4
public static final int DUTY_CYCLE_PRESCALER_8
public static final int DUTY_CYCLE_PRESCALER_16
public static final int DUTY_CYCLE_PRESCALER_32
public static final int DUTY_CYCLE_PRESCALER_64
public static final int DUTY_CYCLE_PRESCALER_128
public static final int DUTY_CYCLE_PRESCALER_256
public static final int DUTY_CYCLE_PRESCALER_512
public static final int DUTY_CYCLE_PRESCALER_1024
public static final int DUTY_CYCLE_PRESCALER_2048
public static final int DUTY_CYCLE_PRESCALER_4096
public static final int DUTY_CYCLE_PRESCALER_8192
public static final int DUTY_CYCLE_PRESCALER_16384
public static final int DUTY_CYCLE_PRESCALER_32768
public static final int FREQUENCY_INTEGRATION_TIME_128_MS
public static final int FREQUENCY_INTEGRATION_TIME_256_MS
public static final int FREQUENCY_INTEGRATION_TIME_512_MS
public static final int FREQUENCY_INTEGRATION_TIME_1024_MS
public static final int FREQUENCY_INTEGRATION_TIME_2048_MS
public static final int FREQUENCY_INTEGRATION_TIME_4096_MS
public static final int FREQUENCY_INTEGRATION_TIME_8192_MS
public static final int FREQUENCY_INTEGRATION_TIME_16384_MS
public static final int FREQUENCY_INTEGRATION_TIME_32768_MS
public static final int CHANNEL_LED_CONFIG_OFF
public static final int CHANNEL_LED_CONFIG_ON
public static final int CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
public static final int CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletIndustrialCounter(java.lang.String uid, IPConnection ipcon)
public long getCounter(int channel) throws TinkerforgeException
TinkerforgeException
public long[] getAllCounter() throws TinkerforgeException
TinkerforgeException
public void setCounter(int channel, long counter) throws TinkerforgeException
TinkerforgeException
public void setAllCounter(long[] counter) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialCounter.SignalData getSignalData(int channel) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialCounter.AllSignalData getAllSignalData() throws TinkerforgeException
TinkerforgeException
public void setCounterActive(int channel, boolean active) throws TinkerforgeException
TinkerforgeException
public void setAllCounterActive(boolean[] active) throws TinkerforgeException
TinkerforgeException
public boolean getCounterActive(int channel) throws TinkerforgeException
TinkerforgeException
public boolean[] getAllCounterActive() throws TinkerforgeException
TinkerforgeException
public void setCounterConfiguration(int channel, int countEdge, int countDirection, int dutyCyclePrescaler, int frequencyIntegrationTime) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialCounter.CounterConfiguration getCounterConfiguration(int channel) throws TinkerforgeException
setCounterConfiguration(int, int, int, int, int)
.TinkerforgeException
public void setAllCounterCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
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.TinkerforgeException
public BrickletIndustrialCounter.AllCounterCallbackConfiguration getAllCounterCallbackConfiguration() throws TinkerforgeException
setAllCounterCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setAllSignalDataCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
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.TinkerforgeException
public BrickletIndustrialCounter.AllSignalDataCallbackConfiguration getAllSignalDataCallbackConfiguration() throws TinkerforgeException
setAllSignalDataCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setChannelLEDConfig(int channel, int config) throws TinkerforgeException
TinkerforgeException
public int getChannelLEDConfig(int channel) throws TinkerforgeException
setChannelLEDConfig(int, int)
TinkerforgeException
public BrickletIndustrialCounter.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addAllCounterListener(BrickletIndustrialCounter.AllCounterListener listener)
public void removeAllCounterListener(BrickletIndustrialCounter.AllCounterListener listener)
public void addAllSignalDataListener(BrickletIndustrialCounter.AllSignalDataListener listener)
public void removeAllSignalDataListener(BrickletIndustrialCounter.AllSignalDataListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.