Package com.tinkerforge
Class BrickletAnalogInV3
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletAnalogInV3
-
public class BrickletAnalogInV3 extends Device
Measures DC voltage between 0V and 42V
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletAnalogInV3.Calibration
class
BrickletAnalogInV3.SPITFPErrorCount
class
BrickletAnalogInV3.VoltageCallbackConfiguration
static interface
BrickletAnalogInV3.VoltageListener
This listener is triggered periodically according to the configuration set bysetVoltageCallbackConfiguration(long, boolean, char, int, int)
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletAnalogInV3(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
addVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Adds a Voltage listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.BrickletAnalogInV3.Calibration
getCalibration()
Returns the calibration as set bysetCalibration(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 bysetOversampling(int)
.BrickletAnalogInV3.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getVoltage()
Returns the measured voltage.BrickletAnalogInV3.VoltageCallbackConfiguration
getVoltageCallbackConfiguration()
Returns the listener configuration as set bysetVoltageCallbackConfiguration(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 theBrickletAnalogInV3.VoltageListener
listener is triggered periodically.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_VOLTAGE
public static final byte FUNCTION_GET_VOLTAGE
- See Also:
- Constant Field Values
-
FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_VOLTAGE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_VOLTAGE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_VOLTAGE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_OVERSAMPLING
public static final byte FUNCTION_SET_OVERSAMPLING
- See Also:
- Constant Field Values
-
FUNCTION_GET_OVERSAMPLING
public static final byte FUNCTION_GET_OVERSAMPLING
- See Also:
- Constant Field Values
-
FUNCTION_SET_CALIBRATION
public static final byte FUNCTION_SET_CALIBRATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CALIBRATION
public static final byte FUNCTION_GET_CALIBRATION
- 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
-
OVERSAMPLING_32
public static final int OVERSAMPLING_32
- See Also:
- Constant Field Values
-
OVERSAMPLING_64
public static final int OVERSAMPLING_64
- See Also:
- Constant Field Values
-
OVERSAMPLING_128
public static final int OVERSAMPLING_128
- See Also:
- Constant Field Values
-
OVERSAMPLING_256
public static final int OVERSAMPLING_256
- See Also:
- Constant Field Values
-
OVERSAMPLING_512
public static final int OVERSAMPLING_512
- See Also:
- Constant Field Values
-
OVERSAMPLING_1024
public static final int OVERSAMPLING_1024
- See Also:
- Constant Field Values
-
OVERSAMPLING_2048
public static final int OVERSAMPLING_2048
- See Also:
- Constant Field Values
-
OVERSAMPLING_4096
public static final int OVERSAMPLING_4096
- See Also:
- Constant Field Values
-
OVERSAMPLING_8192
public static final int OVERSAMPLING_8192
- See Also:
- Constant Field Values
-
OVERSAMPLING_16384
public static final int OVERSAMPLING_16384
- 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
-
BrickletAnalogInV3
public BrickletAnalogInV3(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
-
getVoltage
public int getVoltage() throws TinkerforgeException
Returns the measured voltage. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (setOversampling(int)
). If you want to get the value periodically, it is recommended to use theBrickletAnalogInV3.VoltageListener
listener. You can set the listener configuration withsetVoltageCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setVoltageCallbackConfiguration
public void setVoltageCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max) throws TinkerforgeException
The period is the period with which theBrickletAnalogInV3.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 theBrickletAnalogInV3.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.- Throws:
TinkerforgeException
-
getVoltageCallbackConfiguration
public BrickletAnalogInV3.VoltageCallbackConfiguration getVoltageCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetVoltageCallbackConfiguration(long, boolean, char, int, int)
.- Throws:
TinkerforgeException
-
setOversampling
public void setOversampling(int oversampling) throws TinkerforgeException
Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms. The oversampling uses the moving average principle. A new value is always calculated once per millisecond. With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).- Throws:
TinkerforgeException
-
getOversampling
public int getOversampling() throws TinkerforgeException
Returns the oversampling value as set bysetOversampling(int)
.- Throws:
TinkerforgeException
-
setCalibration
public void setCalibration(int offset, int multiplier, int divisor) throws TinkerforgeException
Sets a calibration for the measured voltage value. The formula for the calibration is as follows:: Calibrated Value = (Value + Offset) * Multiplier / Divisor We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.- Throws:
TinkerforgeException
-
getCalibration
public BrickletAnalogInV3.Calibration getCalibration() throws TinkerforgeException
Returns the calibration as set bysetCalibration(int, int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletAnalogInV3.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
-
addVoltageListener
public void addVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Adds a Voltage listener.
-
removeVoltageListener
public void removeVoltageListener(BrickletAnalogInV3.VoltageListener listener)
Removes a Voltage listener.
-
-