Package com.tinkerforge
Class BrickletIndustrialAnalogOutV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIndustrialAnalogOutV2
-
public class BrickletIndustrialAnalogOutV2 extends Device
Generates configurable DC voltage and current, 0V to 10V and 4mA to 20mA
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIndustrialAnalogOutV2.Configuration
class
BrickletIndustrialAnalogOutV2.OutLEDStatusConfig
class
BrickletIndustrialAnalogOutV2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletIndustrialAnalogOutV2(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 int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.BrickletIndustrialAnalogOutV2.Configuration
getConfiguration()
Returns the configuration as set bysetConfiguration(int, int)
.int
getCurrent()
Returns the current as set bysetCurrent(int)
.boolean
getEnabled()
Returns *true* if output of voltage and current is enabled, *false* otherwise.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
getOutLEDConfig()
Returns the Out LED configuration as set bysetOutLEDConfig(int)
BrickletIndustrialAnalogOutV2.OutLEDStatusConfig
getOutLEDStatusConfig()
Returns the Out LED status configuration as set bysetOutLEDStatusConfig(int, int, int)
.BrickletIndustrialAnalogOutV2.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 voltage as set bysetVoltage(int)
.long
readUID()
Returns the current UID as an integer.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
setConfiguration(int voltageRange, int currentRange)
Configures the voltage and current range.void
setCurrent(int current)
Sets the output current.void
setEnabled(boolean enabled)
Enables/disables the output of voltage and current.void
setOutLEDConfig(int config)
You can turn the Out LED off, on or show a heartbeat.void
setOutLEDStatusConfig(int min, int max, int config)
Sets the Out LED status config.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setVoltage(int voltage)
Sets the output voltage.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_SET_ENABLED
public static final byte FUNCTION_SET_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_GET_ENABLED
public static final byte FUNCTION_GET_ENABLED
- See Also:
- Constant Field Values
-
FUNCTION_SET_VOLTAGE
public static final byte FUNCTION_SET_VOLTAGE
- See Also:
- Constant Field Values
-
FUNCTION_GET_VOLTAGE
public static final byte FUNCTION_GET_VOLTAGE
- See Also:
- Constant Field Values
-
FUNCTION_SET_CURRENT
public static final byte FUNCTION_SET_CURRENT
- See Also:
- Constant Field Values
-
FUNCTION_GET_CURRENT
public static final byte FUNCTION_GET_CURRENT
- See Also:
- Constant Field Values
-
FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_OUT_LED_CONFIG
public static final byte FUNCTION_SET_OUT_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_OUT_LED_CONFIG
public static final byte FUNCTION_GET_OUT_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_SET_OUT_LED_STATUS_CONFIG
public static final byte FUNCTION_SET_OUT_LED_STATUS_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_OUT_LED_STATUS_CONFIG
public static final byte FUNCTION_GET_OUT_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
-
VOLTAGE_RANGE_0_TO_5V
public static final int VOLTAGE_RANGE_0_TO_5V
- See Also:
- Constant Field Values
-
VOLTAGE_RANGE_0_TO_10V
public static final int VOLTAGE_RANGE_0_TO_10V
- See Also:
- Constant Field Values
-
CURRENT_RANGE_4_TO_20MA
public static final int CURRENT_RANGE_4_TO_20MA
- See Also:
- Constant Field Values
-
CURRENT_RANGE_0_TO_20MA
public static final int CURRENT_RANGE_0_TO_20MA
- See Also:
- Constant Field Values
-
CURRENT_RANGE_0_TO_24MA
public static final int CURRENT_RANGE_0_TO_24MA
- See Also:
- Constant Field Values
-
OUT_LED_CONFIG_OFF
public static final int OUT_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
OUT_LED_CONFIG_ON
public static final int OUT_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
OUT_LED_CONFIG_SHOW_HEARTBEAT
public static final int OUT_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
OUT_LED_CONFIG_SHOW_OUT_STATUS
public static final int OUT_LED_CONFIG_SHOW_OUT_STATUS
- See Also:
- Constant Field Values
-
OUT_LED_STATUS_CONFIG_THRESHOLD
public static final int OUT_LED_STATUS_CONFIG_THRESHOLD
- See Also:
- Constant Field Values
-
OUT_LED_STATUS_CONFIG_INTENSITY
public static final int OUT_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
-
BrickletIndustrialAnalogOutV2
public BrickletIndustrialAnalogOutV2(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
-
setEnabled
public void setEnabled(boolean enabled) throws TinkerforgeException
Enables/disables the output of voltage and current.- Throws:
TinkerforgeException
-
getEnabled
public boolean getEnabled() throws TinkerforgeException
Returns *true* if output of voltage and current is enabled, *false* otherwise.- Throws:
TinkerforgeException
-
setVoltage
public void setVoltage(int voltage) throws TinkerforgeException
Sets the output voltage. The output voltage and output current are linked. Changing the output voltage also changes the output current.- Throws:
TinkerforgeException
-
getVoltage
public int getVoltage() throws TinkerforgeException
Returns the voltage as set bysetVoltage(int)
.- Throws:
TinkerforgeException
-
setCurrent
public void setCurrent(int current) throws TinkerforgeException
Sets the output current. The output current and output voltage are linked. Changing the output current also changes the output voltage.- Throws:
TinkerforgeException
-
getCurrent
public int getCurrent() throws TinkerforgeException
Returns the current as set bysetCurrent(int)
.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(int voltageRange, int currentRange) throws TinkerforgeException
Configures the voltage and current range. Possible voltage ranges are: * 0V to 5V * 0V to 10V Possible current ranges are: * 4mA to 20mA * 0mA to 20mA * 0mA to 24mA The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.- Throws:
TinkerforgeException
-
getConfiguration
public BrickletIndustrialAnalogOutV2.Configuration getConfiguration() throws TinkerforgeException
Returns the configuration as set bysetConfiguration(int, int)
.- Throws:
TinkerforgeException
-
setOutLEDConfig
public void setOutLEDConfig(int config) throws TinkerforgeException
You can turn the Out LED off, on or show a heartbeat. You can also set the LED to "Out 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 output value (voltage or current). You can configure the channel status behavior withsetOutLEDStatusConfig(int, int, int)
.- Throws:
TinkerforgeException
-
getOutLEDConfig
public int getOutLEDConfig() throws TinkerforgeException
Returns the Out LED configuration as set bysetOutLEDConfig(int)
- Throws:
TinkerforgeException
-
setOutLEDStatusConfig
public void setOutLEDStatusConfig(int min, int max, int config) throws TinkerforgeException
Sets the Out LED status config. This config is used if the Out LED is configured as "Out Status", seesetOutLEDConfig(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 or µA above which the LED should turn on and set the "max" parameter to 0. Example: If you set a positive threshold of 5V, the LED will turn on as soon as the output value exceeds 5V and turn off again if it goes below 5V. For a negative threshold set the "max" parameter to the threshold value in mV or µA below which the LED should turn on and set the "min" parameter to 0. Example: If you set a negative threshold of 5V, the LED will turn on as soon as the output value goes below 5V and the LED will turn off when the output value exceeds 5V. In intensity mode you can define a range mV or µA that is used to scale the brightness of the LED. Example with min=2V, max=8V: The LED is off at 2V and below, on at 8V and above and the brightness is linearly scaled between the values 2V and 8V. If the min value is greater than the max value, the LED brightness is scaled the other way around.- Throws:
TinkerforgeException
-
getOutLEDStatusConfig
public BrickletIndustrialAnalogOutV2.OutLEDStatusConfig getOutLEDStatusConfig() throws TinkerforgeException
Returns the Out LED status configuration as set bysetOutLEDStatusConfig(int, int, int)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletIndustrialAnalogOutV2.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
-
-