public class BrickletAnalogInV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletAnalogInV2.AnalogValueCallbackThreshold |
static interface |
BrickletAnalogInV2.AnalogValueListener
This listener is triggered periodically with the period that is set by
setAnalogValueCallbackPeriod(long) . |
static interface |
BrickletAnalogInV2.AnalogValueReachedListener
This listener is triggered when the threshold as set by
setAnalogValueCallbackThreshold(char, int, int) is reached. |
class |
BrickletAnalogInV2.VoltageCallbackThreshold |
static interface |
BrickletAnalogInV2.VoltageListener
This listener is triggered periodically with the period that is set by
setVoltageCallbackPeriod(long) . |
static interface |
BrickletAnalogInV2.VoltageReachedListener
This listener is triggered when the threshold as set by
setVoltageCallbackThreshold(char, int, int) is reached. |
Device.Identity
Modifier and Type | Field and Description |
---|---|
static String |
DEVICE_DISPLAY_NAME |
static int |
DEVICE_IDENTIFIER |
static byte |
FUNCTION_GET_ANALOG_VALUE |
static byte |
FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD |
static byte |
FUNCTION_GET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_GET_IDENTITY |
static byte |
FUNCTION_GET_MOVING_AVERAGE |
static byte |
FUNCTION_GET_VOLTAGE |
static byte |
FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD |
static byte |
FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD |
static byte |
FUNCTION_SET_DEBOUNCE_PERIOD |
static byte |
FUNCTION_SET_MOVING_AVERAGE |
static byte |
FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD |
static byte |
FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD |
static char |
THRESHOLD_OPTION_GREATER |
static char |
THRESHOLD_OPTION_INSIDE |
static char |
THRESHOLD_OPTION_OFF |
static char |
THRESHOLD_OPTION_OUTSIDE |
static char |
THRESHOLD_OPTION_SMALLER |
Constructor and Description |
---|
BrickletAnalogInV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addAnalogValueListener(BrickletAnalogInV2.AnalogValueListener listener)
Adds a AnalogValue listener.
|
void |
addAnalogValueReachedListener(BrickletAnalogInV2.AnalogValueReachedListener listener)
Adds a AnalogValueReached listener.
|
void |
addVoltageListener(BrickletAnalogInV2.VoltageListener listener)
Adds a Voltage listener.
|
void |
addVoltageReachedListener(BrickletAnalogInV2.VoltageReachedListener listener)
Adds a VoltageReached listener.
|
int |
getAnalogValue()
Returns the value as read by a 12-bit analog-to-digital converter.
|
long |
getAnalogValueCallbackPeriod()
Returns the period as set by
setAnalogValueCallbackPeriod(long) . |
BrickletAnalogInV2.AnalogValueCallbackThreshold |
getAnalogValueCallbackThreshold()
Returns the threshold as set by
setAnalogValueCallbackThreshold(char, int, int) . |
long |
getDebouncePeriod()
Returns the debounce period as set by
setDebouncePeriod(long) . |
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.
|
short |
getMovingAverage()
Returns the length of the moving average as set by
setMovingAverage(short) . |
int |
getVoltage()
Returns the measured voltage.
|
long |
getVoltageCallbackPeriod()
Returns the period as set by
setVoltageCallbackPeriod(long) . |
BrickletAnalogInV2.VoltageCallbackThreshold |
getVoltageCallbackThreshold()
Returns the threshold as set by
setVoltageCallbackThreshold(char, int, int) . |
void |
removeAnalogValueListener(BrickletAnalogInV2.AnalogValueListener listener)
Removes a AnalogValue listener.
|
void |
removeAnalogValueReachedListener(BrickletAnalogInV2.AnalogValueReachedListener listener)
Removes a AnalogValueReached listener.
|
void |
removeVoltageListener(BrickletAnalogInV2.VoltageListener listener)
Removes a Voltage listener.
|
void |
removeVoltageReachedListener(BrickletAnalogInV2.VoltageReachedListener listener)
Removes a VoltageReached listener.
|
void |
setAnalogValueCallbackPeriod(long period)
Sets the period with which the
BrickletAnalogInV2.AnalogValueListener listener is triggered
periodically. |
void |
setAnalogValueCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickletAnalogInV2.AnalogValueReachedListener listener. |
void |
setDebouncePeriod(long debounce)
Sets the period with which the threshold listeners
*
BrickletAnalogInV2.VoltageReachedListener ,
* BrickletAnalogInV2.AnalogValueReachedListener
are triggered, if the thresholds
* setVoltageCallbackThreshold(char, int, int) ,
* setAnalogValueCallbackThreshold(char, int, int)
keep being reached. |
void |
setMovingAverage(short average)
Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
for the voltage.
|
void |
setVoltageCallbackPeriod(long period)
Sets the period with which the
BrickletAnalogInV2.VoltageListener listener is triggered
periodically. |
void |
setVoltageCallbackThreshold(char option,
int min,
int max)
Sets the thresholds for the
BrickletAnalogInV2.VoltageReachedListener listener. |
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_GET_ANALOG_VALUE
public static final byte FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_VOLTAGE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD
public static final byte FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD
public static final byte FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD
public static final byte FUNCTION_GET_ANALOG_VALUE_CALLBACK_THRESHOLD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_SET_MOVING_AVERAGE
public static final byte FUNCTION_GET_MOVING_AVERAGE
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 BrickletAnalogInV2(String uid, IPConnection ipcon)
public int getVoltage() throws TinkerforgeException
BrickletAnalogInV2.VoltageListener
listener and set the period with
setVoltageCallbackPeriod(long)
.TinkerforgeException
public int getAnalogValue() throws TinkerforgeException
BrickletAnalogInV2.AnalogValueListener
listener and set the period with
setAnalogValueCallbackPeriod(long)
.TinkerforgeException
public void setVoltageCallbackPeriod(long period) throws TinkerforgeException
BrickletAnalogInV2.VoltageListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletAnalogInV2.VoltageListener
listener is only triggered if the voltage has changed since
the last triggering.TinkerforgeException
public long getVoltageCallbackPeriod() throws TinkerforgeException
setVoltageCallbackPeriod(long)
.TinkerforgeException
public void setAnalogValueCallbackPeriod(long period) throws TinkerforgeException
BrickletAnalogInV2.AnalogValueListener
listener is triggered
periodically. A value of 0 turns the listener off.
The BrickletAnalogInV2.AnalogValueListener
listener is only triggered if the analog value has
changed since the last triggering.TinkerforgeException
public long getAnalogValueCallbackPeriod() throws TinkerforgeException
setAnalogValueCallbackPeriod(long)
.TinkerforgeException
public void setVoltageCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickletAnalogInV2.VoltageReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the voltage is *outside* the min and max values"
"'i'", "Listener is triggered when the voltage is *inside* the min and max values"
"'<'", "Listener is triggered when the voltage is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the voltage is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletAnalogInV2.VoltageCallbackThreshold getVoltageCallbackThreshold() throws TinkerforgeException
setVoltageCallbackThreshold(char, int, int)
.TinkerforgeException
public void setAnalogValueCallbackThreshold(char option, int min, int max) throws TinkerforgeException
BrickletAnalogInV2.AnalogValueReachedListener
listener.
The following options are possible:
\verbatim
"Option", "Description"
"'x'", "Listener is turned off"
"'o'", "Listener is triggered when the analog value is *outside* the min and max values"
"'i'", "Listener is triggered when the analog value is *inside* the min and max values"
"'<'", "Listener is triggered when the analog value is smaller than the min value (max is ignored)"
"'>'", "Listener is triggered when the analog value is greater than the min value (max is ignored)"
\endverbatimTinkerforgeException
public BrickletAnalogInV2.AnalogValueCallbackThreshold getAnalogValueCallbackThreshold() throws TinkerforgeException
setAnalogValueCallbackThreshold(char, int, int)
.TinkerforgeException
public void setDebouncePeriod(long debounce) throws TinkerforgeException
BrickletAnalogInV2.VoltageReachedListener
,
* BrickletAnalogInV2.AnalogValueReachedListener
are triggered, if the thresholds
* setVoltageCallbackThreshold(char, int, int)
,
* setAnalogValueCallbackThreshold(char, int, int)
keep being reached.TinkerforgeException
public long getDebouncePeriod() throws TinkerforgeException
setDebouncePeriod(long)
.TinkerforgeException
public void setMovingAverage(short average) throws TinkerforgeException
TinkerforgeException
public short getMovingAverage() throws TinkerforgeException
setMovingAverage(short)
.TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addVoltageListener(BrickletAnalogInV2.VoltageListener listener)
public void removeVoltageListener(BrickletAnalogInV2.VoltageListener listener)
public void addAnalogValueListener(BrickletAnalogInV2.AnalogValueListener listener)
public void removeAnalogValueListener(BrickletAnalogInV2.AnalogValueListener listener)
public void addVoltageReachedListener(BrickletAnalogInV2.VoltageReachedListener listener)
public void removeVoltageReachedListener(BrickletAnalogInV2.VoltageReachedListener listener)
public void addAnalogValueReachedListener(BrickletAnalogInV2.AnalogValueReachedListener listener)
public void removeAnalogValueReachedListener(BrickletAnalogInV2.AnalogValueReachedListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.