Package com.tinkerforge
Class BrickletIndustrialDual020mAV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIndustrialDual020mAV2
-
public class BrickletIndustrialDual020mAV2 extends Device
Measures two DC currents between 0mA and 20mA (IEC 60381-1)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIndustrialDual020mAV2.ChannelLEDStatusConfig
class
BrickletIndustrialDual020mAV2.CurrentCallbackConfiguration
static interface
BrickletIndustrialDual020mAV2.CurrentListener
This listener is triggered periodically according to the configuration set bysetCurrentCallbackConfiguration(int, long, boolean, char, int, int)
.class
BrickletIndustrialDual020mAV2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletIndustrialDual020mAV2(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCurrentListener(BrickletIndustrialDual020mAV2.CurrentListener listener)
Adds a Current listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChannelLEDConfig(int channel)
Returns the channel LED configuration as set bysetChannelLEDConfig(int, int)
BrickletIndustrialDual020mAV2.ChannelLEDStatusConfig
getChannelLEDStatusConfig(int channel)
Returns the channel LED status configuration as set bysetChannelLEDStatusConfig(int, int, int, int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.int
getCurrent(int channel)
Returns the current of the specified channel.BrickletIndustrialDual020mAV2.CurrentCallbackConfiguration
getCurrentCallbackConfiguration(int channel)
Returns the listener configuration as set bysetCurrentCallbackConfiguration(int, long, boolean, char, int, int)
.int
getGain()
Returns the gain as set bysetGain(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.int
getSampleRate()
Returns the sample rate as set bysetSampleRate(int)
.BrickletIndustrialDual020mAV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeCurrentListener(BrickletIndustrialDual020mAV2.CurrentListener listener)
Removes a Current listener.void
reset()
Calling this function will reset the Bricklet.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
setChannelLEDStatusConfig(int channel, int min, int max, int config)
Sets the channel LED status config.void
setCurrentCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max)
The period is the period with which theBrickletIndustrialDual020mAV2.CurrentListener
listener is triggered periodically.void
setGain(int gain)
Sets a gain between 1x and 8x.void
setSampleRate(int rate)
Sets the sample rate to either 240, 60, 15 or 4 samples per second.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_GET_CURRENT
public static final byte FUNCTION_GET_CURRENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_CURRENT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CURRENT_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_CURRENT_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_SAMPLE_RATE
public static final byte FUNCTION_SET_SAMPLE_RATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_SAMPLE_RATE
public static final byte FUNCTION_GET_SAMPLE_RATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_GAIN
public static final byte FUNCTION_SET_GAIN
- See Also:
- Constant Field Values
-
FUNCTION_GET_GAIN
public static final byte FUNCTION_GET_GAIN
- 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_SET_CHANNEL_LED_STATUS_CONFIG
public static final byte FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHANNEL_LED_STATUS_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_STATUS_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
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OFF
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_OUTSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_INSIDE
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_SMALLER
- See Also:
- Constant Field Values
-
THRESHOLD_OPTION_GREATER
public static final char THRESHOLD_OPTION_GREATER
- See Also:
- Constant Field Values
-
SAMPLE_RATE_240_SPS
public static final int SAMPLE_RATE_240_SPS
- See Also:
- Constant Field Values
-
SAMPLE_RATE_60_SPS
public static final int SAMPLE_RATE_60_SPS
- See Also:
- Constant Field Values
-
SAMPLE_RATE_15_SPS
public static final int SAMPLE_RATE_15_SPS
- See Also:
- Constant Field Values
-
SAMPLE_RATE_4_SPS
public static final int SAMPLE_RATE_4_SPS
- See Also:
- Constant Field Values
-
GAIN_1X
public static final int GAIN_1X
- See Also:
- Constant Field Values
-
GAIN_2X
public static final int GAIN_2X
- See Also:
- Constant Field Values
-
GAIN_4X
public static final int GAIN_4X
- See Also:
- Constant Field Values
-
GAIN_8X
public static final int GAIN_8X
- See Also:
- Constant Field Values
-
CHANNEL_LED_CONFIG_OFF
public static final int CHANNEL_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
CHANNEL_LED_CONFIG_ON
public static final int CHANNEL_LED_CONFIG_ON
- 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
-
CHANNEL_LED_STATUS_CONFIG_THRESHOLD
public static final int CHANNEL_LED_STATUS_CONFIG_THRESHOLD
- See Also:
- Constant Field Values
-
CHANNEL_LED_STATUS_CONFIG_INTENSITY
public static final int CHANNEL_LED_STATUS_CONFIG_INTENSITY
- 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_OK
public static final int BOOTLOADER_STATUS_OK
- 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_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- 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
-
BrickletIndustrialDual020mAV2
public BrickletIndustrialDual020mAV2(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
-
getCurrent
public int getCurrent(int channel) throws TinkerforgeException
Returns the current of the specified channel. It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably. If the returned current is below 4mA, there is likely no sensor connected or the connected sensor is defective. If the returned current is over 20mA, there might be a short circuit or the sensor is defective. If you want to get the value periodically, it is recommended to use theBrickletIndustrialDual020mAV2.CurrentListener
listener. You can set the listener configuration withsetCurrentCallbackConfiguration(int, long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setCurrentCallbackConfiguration
public void setCurrentCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletIndustrialDual020mAV2.CurrentListener
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. It is furthermore possible to constrain the listener with thresholds. The `option`-parameter together with min/max sets a threshold for theBrickletIndustrialDual020mAV2.CurrentListener
listener. The following options are possible: \verbatim "Option", "Description" "'x'", "Threshold is turned off" "'o'", "Threshold is triggered when the value is *outside* the min and max values" "'i'", "Threshold is triggered when the value is *inside* or equal to the min and max values" "'<'", "Threshold is triggered when the value is smaller than the min value (max is ignored)" "'>'", "Threshold is triggered when the value is greater than the min value (max is ignored)" \endverbatim If the option is set to 'x' (threshold turned off) the listener is triggered with the fixed period.- Throws:
TinkerforgeException
-
getCurrentCallbackConfiguration
public BrickletIndustrialDual020mAV2.CurrentCallbackConfiguration getCurrentCallbackConfiguration(int channel) throws TinkerforgeException
Returns the listener configuration as set bysetCurrentCallbackConfiguration(int, long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setSampleRate
public void setSampleRate(int rate) throws TinkerforgeException
Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively. \verbatim "Value", "Description" "0", "240 samples per second, 12 bit resolution" "1", "60 samples per second, 14 bit resolution" "2", "15 samples per second, 16 bit resolution" "3", "4 samples per second, 18 bit resolution" \endverbatim- Throws:
TinkerforgeException
-
getSampleRate
public int getSampleRate() throws TinkerforgeException
Returns the sample rate as set bysetSampleRate(int)
.- Throws:
TinkerforgeException
-
setGain
public void setGain(int gain) throws TinkerforgeException
Sets a gain between 1x and 8x. If you want to measure a very small current, you can increase the gain to get some more resolution. Example: If you measure 0.5mA with a gain of 8x the return value will be 4mA.- Throws:
TinkerforgeException
-
getGain
public int getGain() throws TinkerforgeException
Returns the gain as set bysetGain(int)
.- 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 can either be turned on with a pre-defined threshold or the intensity of the LED can change with the measured value. You can configure the channel status behavior withsetChannelLEDStatusConfig(int, int, int, int)
.- Throws:
TinkerforgeException
-
getChannelLEDConfig
public int getChannelLEDConfig(int channel) throws TinkerforgeException
Returns the channel LED configuration as set bysetChannelLEDConfig(int, int)
- Throws:
TinkerforgeException
-
setChannelLEDStatusConfig
public void setChannelLEDStatusConfig(int channel, int min, int max, int config) throws TinkerforgeException
Sets the channel LED status config. This config is used if the channel LED is configured as "Channel Status", seesetChannelLEDConfig(int, int)
. For each channel you can choose between threshold and intensity mode. In threshold mode you can define a positive or a negative threshold. For a positive threshold set the "min" parameter to the threshold value in nA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 10mA, the LED will turn on as soon as the current exceeds 10mA and turn off again if it goes below 10mA. For a negative threshold set the "max" parameter to the threshold value in nA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 10mA, the LED will turn on as soon as the current goes below 10mA and the LED will turn off when the current exceeds 10mA. In intensity mode you can define a range in nA that is used to scale the brightness of the LED. Example with min=4mA and max=20mA: The LED is off at 4mA and below, on at 20mA and above and the brightness is linearly scaled between the values 4mA and 20mA. If the min value is greater than the max value, the LED brightness is scaled the other way around.- Throws:
TinkerforgeException
-
getChannelLEDStatusConfig
public BrickletIndustrialDual020mAV2.ChannelLEDStatusConfig getChannelLEDStatusConfig(int channel) throws TinkerforgeException
Returns the channel LED status configuration as set bysetChannelLEDStatusConfig(int, int, int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletIndustrialDual020mAV2.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
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(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 bysetWriteFirmwarePointer(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
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- 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
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- 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 classDevice
- Throws:
TinkerforgeException
-
addCurrentListener
public void addCurrentListener(BrickletIndustrialDual020mAV2.CurrentListener listener)
Adds a Current listener.
-
removeCurrentListener
public void removeCurrentListener(BrickletIndustrialDual020mAV2.CurrentListener listener)
Removes a Current listener.
-
-