public class BrickletAnalogInV3 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletAnalogInV3.Calibration |
class |
BrickletAnalogInV3.SPITFPErrorCount |
class |
BrickletAnalogInV3.VoltageCallbackConfiguration |
static interface |
BrickletAnalogInV3.VoltageListener
This listener is triggered periodically according to the configuration set by
setVoltageCallbackConfiguration(long, boolean, char, int, int) . |
Device.Identity
Constructor and Description |
---|
BrickletAnalogInV3(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Adds a Voltage listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
BrickletAnalogInV3.Calibration |
getCalibration()
Returns the calibration as set by
setCalibration(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 |
getOversampling()
Returns the oversampling value as set by
setOversampling(int) . |
BrickletAnalogInV3.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()
Returns the measured voltage.
|
BrickletAnalogInV3.VoltageCallbackConfiguration |
getVoltageCallbackConfiguration()
Returns the listener configuration as set by
setVoltageCallbackConfiguration(long, boolean, char, int, int) . |
long |
readUID()
Returns the current UID as an integer.
|
void |
removeVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Removes a Voltage 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 |
setCalibration(int offset,
int multiplier,
int divisor)
Sets a calibration for the measured voltage value.
|
void |
setOversampling(int oversampling)
Sets the oversampling between 32x and 16384x.
|
void |
setStatusLEDConfig(int config)
Sets the status LED configuration.
|
void |
setVoltageCallbackConfiguration(long period,
boolean valueHasToChange,
char option,
int min,
int max)
The period is the period with which the
BrickletAnalogInV3.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_OVERSAMPLING
public static final byte FUNCTION_GET_OVERSAMPLING
public static final byte FUNCTION_SET_CALIBRATION
public static final byte FUNCTION_GET_CALIBRATION
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 OVERSAMPLING_32
public static final int OVERSAMPLING_64
public static final int OVERSAMPLING_128
public static final int OVERSAMPLING_256
public static final int OVERSAMPLING_512
public static final int OVERSAMPLING_1024
public static final int OVERSAMPLING_2048
public static final int OVERSAMPLING_4096
public static final int OVERSAMPLING_8192
public static final int OVERSAMPLING_16384
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 BrickletAnalogInV3(String uid, IPConnection ipcon)
public int getVoltage() throws TinkerforgeException
setOversampling(int)
).
If you want to get the value periodically, it is recommended to use the
BrickletAnalogInV3.VoltageListener
listener. You can set the listener configuration
with setVoltageCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setVoltageCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
BrickletAnalogInV3.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 BrickletAnalogInV3.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 BrickletAnalogInV3.VoltageCallbackConfiguration getVoltageCallbackConfiguration() throws TinkerforgeException
setVoltageCallbackConfiguration(long, boolean, char, int, int)
.TinkerforgeException
public void setOversampling(int oversampling) throws TinkerforgeException
TinkerforgeException
public int getOversampling() throws TinkerforgeException
setOversampling(int)
.TinkerforgeException
public void setCalibration(int offset, int multiplier, int divisor) throws TinkerforgeException
TinkerforgeException
public BrickletAnalogInV3.Calibration getCalibration() throws TinkerforgeException
setCalibration(int, int, int)
.TinkerforgeException
public BrickletAnalogInV3.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(BrickletAnalogInV3.VoltageListener listener)
public void removeVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Copyright © 2022 Tinkerforge GmbH. All rights reserved.