public class BrickletIndustrialDualAnalogInV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIndustrialDualAnalogInV2.AllVoltagesCallbackConfiguration |
static interface |
BrickletIndustrialDualAnalogInV2.AllVoltagesListener
This listener is triggered periodically according to the configuration set by
setAllVoltagesCallbackConfiguration(long, boolean) . |
class |
BrickletIndustrialDualAnalogInV2.Calibration |
class |
BrickletIndustrialDualAnalogInV2.ChannelLEDStatusConfig |
class |
BrickletIndustrialDualAnalogInV2.SPITFPErrorCount |
class |
BrickletIndustrialDualAnalogInV2.VoltageCallbackConfiguration |
static interface |
BrickletIndustrialDualAnalogInV2.VoltageListener
This listener is triggered periodically according to the configuration set by
setVoltageCallbackConfiguration(int, long, boolean, char, int, int) . |
Device.Identity
Constructor and Description |
---|
BrickletIndustrialDualAnalogInV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAllVoltagesListener(BrickletIndustrialDualAnalogInV2.AllVoltagesListener listener)
Adds a AllVoltages listener.
|
void |
addVoltageListener(BrickletIndustrialDualAnalogInV2.VoltageListener listener)
Adds a Voltage listener.
|
int[] |
getADCValues()
Returns the ADC values as given by the MCP3911 IC.
|
int[] |
getAllVoltages()
Returns the voltages for all channels.
|
BrickletIndustrialDualAnalogInV2.AllVoltagesCallbackConfiguration |
getAllVoltagesCallbackConfiguration()
Returns the listener configuration as set by
setAllVoltagesCallbackConfiguration(long, boolean) . |
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
BrickletIndustrialDualAnalogInV2.Calibration |
getCalibration()
Returns the calibration as set by
setCalibration(int[], int[]) . |
int |
getChannelLEDConfig(int channel)
Returns the channel LED configuration as set by
setChannelLEDConfig(int, int) |
BrickletIndustrialDualAnalogInV2.ChannelLEDStatusConfig |
getChannelLEDStatusConfig(int channel)
Returns the channel LED status configuration as set by
setChannelLEDStatusConfig(int, int, int, int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
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 by
setSampleRate(int) . |
BrickletIndustrialDualAnalogInV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(int) |
int |
getVoltage(int channel)
Returns the voltage for the given channel.
|
BrickletIndustrialDualAnalogInV2.VoltageCallbackConfiguration |
getVoltageCallbackConfiguration(int channel)
Returns the listener configuration as set by
setVoltageCallbackConfiguration(int, long, boolean, char, int, int) . |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeAllVoltagesListener(BrickletIndustrialDualAnalogInV2.AllVoltagesListener listener)
Removes a AllVoltages listener.
|
void |
removeVoltageListener(BrickletIndustrialDualAnalogInV2.VoltageListener listener)
Removes a Voltage listener.
|
void |
reset()
Calling this function will reset the Bricklet.
|
void |
setAllVoltagesCallbackConfiguration(long period,
boolean valueHasToChange)
The period is the period with which the
BrickletIndustrialDualAnalogInV2.AllVoltagesListener
listener is triggered periodically. |
int |
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested
mode change was instigated.
|
void |
setCalibration(int[] offset,
int[] gain)
Sets offset and gain of MCP3911 internal calibration registers.
|
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 |
setSampleRate(int rate)
Sets the sample rate.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setVoltageCallbackConfiguration(int channel,
long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletIndustrialDualAnalogInV2.VoltageListener listener is triggered
periodically. |
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 String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_VOLTAGE
public static final byte FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_VOLTAGE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_SAMPLE_RATE
public static final byte FUNCTION_GET_SAMPLE_RATE
public static final byte FUNCTION_SET_CALIBRATION
public static final byte FUNCTION_GET_CALIBRATION
public static final byte FUNCTION_GET_ADC_VALUES
public static final byte FUNCTION_SET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_SET_CHANNEL_LED_STATUS_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_STATUS_CONFIG
public static final byte FUNCTION_GET_ALL_VOLTAGES
public static final byte FUNCTION_SET_ALL_VOLTAGES_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_ALL_VOLTAGES_CALLBACK_CONFIGURATION
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 char THRESHOLD_OPTION_OFF
public static final char THRESHOLD_OPTION_OUTSIDE
public static final char THRESHOLD_OPTION_INSIDE
public static final char THRESHOLD_OPTION_SMALLER
public static final char THRESHOLD_OPTION_GREATER
public static final int SAMPLE_RATE_976_SPS
public static final int SAMPLE_RATE_488_SPS
public static final int SAMPLE_RATE_244_SPS
public static final int SAMPLE_RATE_122_SPS
public static final int SAMPLE_RATE_61_SPS
public static final int SAMPLE_RATE_4_SPS
public static final int SAMPLE_RATE_2_SPS
public static final int SAMPLE_RATE_1_SPS
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 CHANNEL_LED_STATUS_CONFIG_THRESHOLD
public static final int CHANNEL_LED_STATUS_CONFIG_INTENSITY
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 BrickletIndustrialDualAnalogInV2(String uid, IPConnection ipcon)
public int getVoltage(int channel) throws TinkerforgeException
BrickletIndustrialDualAnalogInV2.VoltageListener
listener. You can set the listener configuration
with setVoltageCallbackConfiguration(int, long, boolean, char, int, int)
.TinkerforgeException
public void setVoltageCallbackConfiguration(int channel, long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletIndustrialDualAnalogInV2.VoltageListener
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 the BrickletIndustrialDualAnalogInV2.VoltageListener
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.TinkerforgeException
public BrickletIndustrialDualAnalogInV2.VoltageCallbackConfiguration getVoltageCallbackConfiguration(int channel) throws TinkerforgeException
setVoltageCallbackConfiguration(int, long, boolean, char, int, int)
.TinkerforgeException
public void setSampleRate(int rate) throws TinkerforgeException
TinkerforgeException
public int getSampleRate() throws TinkerforgeException
setSampleRate(int)
.TinkerforgeException
public void setCalibration(int[] offset, int[] gain) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialDualAnalogInV2.Calibration getCalibration() throws TinkerforgeException
setCalibration(int[], int[])
.TinkerforgeException
public int[] getADCValues() throws TinkerforgeException
setCalibration(int[], int[])
.TinkerforgeException
public void setChannelLEDConfig(int channel, int config) throws TinkerforgeException
setChannelLEDStatusConfig(int, int, int, int)
.
By default all channel LEDs are configured as "Channel Status".TinkerforgeException
public int getChannelLEDConfig(int channel) throws TinkerforgeException
setChannelLEDConfig(int, int)
TinkerforgeException
public void setChannelLEDStatusConfig(int channel, int min, int max, int config) throws TinkerforgeException
setChannelLEDConfig(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 mV
above which the LED should turn on and set the "max" parameter to 0. Example:
If you set a positive threshold of 10V, the LED will turn on as soon as the
voltage exceeds 10V and turn off again if it goes below 10V.
For a negative threshold set the "max" parameter to the threshold value in mV
below which the LED should turn on and set the "min" parameter to 0. Example:
If you set a negative threshold of 10V, the LED will turn on as soon as the
voltage goes below 10V and the LED will turn off when the voltage exceeds 10V.
In intensity mode you can define a range in mV that is used to scale the brightness
of the LED. Example with min=4V, max=20V: The LED is off at 4V, on at 20V
and the brightness is linearly scaled between the values 4V and 20V. If the
min value is greater than the max value, the LED brightness is scaled the other
way around.TinkerforgeException
public BrickletIndustrialDualAnalogInV2.ChannelLEDStatusConfig getChannelLEDStatusConfig(int channel) throws TinkerforgeException
setChannelLEDStatusConfig(int, int, int, int)
.TinkerforgeException
public int[] getAllVoltages() throws TinkerforgeException
BrickletIndustrialDualAnalogInV2.AllVoltagesListener
listener. You can set the listener configuration
with setAllVoltagesCallbackConfiguration(long, boolean)
.
.. versionadded:: 2.0.6$nbsp;(Plugin)TinkerforgeException
public void setAllVoltagesCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletIndustrialDualAnalogInV2.AllVoltagesListener
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 at least one of the values has changed. If the values 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.
.. versionadded:: 2.0.6$nbsp;(Plugin)TinkerforgeException
public BrickletIndustrialDualAnalogInV2.AllVoltagesCallbackConfiguration getAllVoltagesCallbackConfiguration() throws TinkerforgeException
setAllVoltagesCallbackConfiguration(long, boolean)
.
.. versionadded:: 2.0.6$nbsp;(Plugin)TinkerforgeException
public BrickletIndustrialDualAnalogInV2.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 addVoltageListener(BrickletIndustrialDualAnalogInV2.VoltageListener listener)
public void removeVoltageListener(BrickletIndustrialDualAnalogInV2.VoltageListener listener)
public void addAllVoltagesListener(BrickletIndustrialDualAnalogInV2.AllVoltagesListener listener)
public void removeAllVoltagesListener(BrickletIndustrialDualAnalogInV2.AllVoltagesListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.