public class BrickletIndustrialAnalogOutV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletIndustrialAnalogOutV2.Configuration |
class |
BrickletIndustrialAnalogOutV2.OutLEDStatusConfig |
class |
BrickletIndustrialAnalogOutV2.SPITFPErrorCount |
Device.Identity
Constructor and Description |
---|
BrickletIndustrialAnalogOutV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
BrickletIndustrialAnalogOutV2.Configuration |
getConfiguration()
Returns the configuration as set by
setConfiguration(int, int) . |
int |
getCurrent()
Returns the current as set by
setCurrent(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 by
setOutLEDConfig(int) |
BrickletIndustrialAnalogOutV2.OutLEDStatusConfig |
getOutLEDStatusConfig()
Returns the Out LED status configuration as set by
setOutLEDStatusConfig(int, int, int) . |
BrickletIndustrialAnalogOutV2.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 voltage as set by
setVoltage(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 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_SET_ENABLED
public static final byte FUNCTION_GET_ENABLED
public static final byte FUNCTION_SET_VOLTAGE
public static final byte FUNCTION_GET_VOLTAGE
public static final byte FUNCTION_SET_CURRENT
public static final byte FUNCTION_GET_CURRENT
public static final byte FUNCTION_SET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_SET_OUT_LED_CONFIG
public static final byte FUNCTION_GET_OUT_LED_CONFIG
public static final byte FUNCTION_SET_OUT_LED_STATUS_CONFIG
public static final byte FUNCTION_GET_OUT_LED_STATUS_CONFIG
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 int VOLTAGE_RANGE_0_TO_5V
public static final int VOLTAGE_RANGE_0_TO_10V
public static final int CURRENT_RANGE_4_TO_20MA
public static final int CURRENT_RANGE_0_TO_20MA
public static final int CURRENT_RANGE_0_TO_24MA
public static final int OUT_LED_CONFIG_OFF
public static final int OUT_LED_CONFIG_ON
public static final int OUT_LED_CONFIG_SHOW_HEARTBEAT
public static final int OUT_LED_CONFIG_SHOW_OUT_STATUS
public static final int OUT_LED_STATUS_CONFIG_THRESHOLD
public static final int OUT_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 BrickletIndustrialAnalogOutV2(String uid, IPConnection ipcon)
public void setEnabled(boolean enabled) throws TinkerforgeException
TinkerforgeException
public boolean getEnabled() throws TinkerforgeException
TinkerforgeException
public void setVoltage(int voltage) throws TinkerforgeException
TinkerforgeException
public int getVoltage() throws TinkerforgeException
setVoltage(int)
.TinkerforgeException
public void setCurrent(int current) throws TinkerforgeException
TinkerforgeException
public int getCurrent() throws TinkerforgeException
setCurrent(int)
.TinkerforgeException
public void setConfiguration(int voltageRange, int currentRange) throws TinkerforgeException
TinkerforgeException
public BrickletIndustrialAnalogOutV2.Configuration getConfiguration() throws TinkerforgeException
setConfiguration(int, int)
.TinkerforgeException
public void setOutLEDConfig(int config) throws TinkerforgeException
setOutLEDStatusConfig(int, int, int)
.TinkerforgeException
public int getOutLEDConfig() throws TinkerforgeException
setOutLEDConfig(int)
TinkerforgeException
public void setOutLEDStatusConfig(int min, int max, int config) throws TinkerforgeException
setOutLEDConfig(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.TinkerforgeException
public BrickletIndustrialAnalogOutV2.OutLEDStatusConfig getOutLEDStatusConfig() throws TinkerforgeException
setOutLEDStatusConfig(int, int, int)
.TinkerforgeException
public BrickletIndustrialAnalogOutV2.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
Copyright © 2022 Tinkerforge GmbH. All rights reserved.