Package com.tinkerforge
Class BrickletIndustrialQuadRelayV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIndustrialQuadRelayV2
-
public class BrickletIndustrialQuadRelayV2 extends Device
4 galvanically isolated solid state relays
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIndustrialQuadRelayV2.Monoflop
static interface
BrickletIndustrialQuadRelayV2.MonoflopDoneListener
This listener is triggered whenever a monoflop timer reaches 0.class
BrickletIndustrialQuadRelayV2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletIndustrialQuadRelayV2(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
addMonoflopDoneListener(BrickletIndustrialQuadRelayV2.MonoflopDoneListener listener)
Adds a MonoflopDone listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChannelLEDConfig(int channel)
Returns the channel LED configuration as set bysetChannelLEDConfig(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.BrickletIndustrialQuadRelayV2.Monoflop
getMonoflop(int channel)
Returns (for the given channel) the current value and the time as set bysetMonoflop(int, boolean, long)
as well as the remaining time until the value flips.BrickletIndustrialQuadRelayV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
boolean[]
getValue()
Returns the values as set bysetValue(boolean[])
.long
readUID()
Returns the current UID as an integer.void
removeMonoflopDoneListener(BrickletIndustrialQuadRelayV2.MonoflopDoneListener listener)
Removes a MonoflopDone 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
setChannelLEDConfig(int channel, int config)
Each channel has a corresponding LED.void
setMonoflop(int channel, boolean value, long time)
Configures a monoflop of the specified channel.void
setSelectedValue(int channel, boolean value)
Sets the output value of the specified channel without affecting the other channels.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setValue(boolean[] value)
Sets the value of all four relays.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_VALUE
public static final byte FUNCTION_SET_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_GET_VALUE
public static final byte FUNCTION_GET_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_MONOFLOP
public static final byte FUNCTION_SET_MONOFLOP
- See Also:
- Constant Field Values
-
FUNCTION_GET_MONOFLOP
public static final byte FUNCTION_GET_MONOFLOP
- See Also:
- Constant Field Values
-
FUNCTION_SET_SELECTED_VALUE
public static final byte FUNCTION_SET_SELECTED_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_SET_CHANNEL_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHANNEL_LED_CONFIG
public static final byte FUNCTION_GET_CHANNEL_LED_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
-
CHANNEL_LED_CONFIG_OFF
public static final int CHANNEL_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
CHANNEL_LED_CONFIG_ON
public static final int CHANNEL_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
public static final int CHANNEL_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS
public static final int CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS
- 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
-
BrickletIndustrialQuadRelayV2
public BrickletIndustrialQuadRelayV2(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
-
setValue
public void setValue(boolean[] value) throws TinkerforgeException
Sets the value of all four relays. A value of *true* closes the relay and a value of *false* opens the relay. UsesetSelectedValue(int, boolean)
to only change one relay. All running monoflop timers will be aborted if this function is called.- Throws:
TinkerforgeException
-
getValue
public boolean[] getValue() throws TinkerforgeException
Returns the values as set bysetValue(boolean[])
.- Throws:
TinkerforgeException
-
setMonoflop
public void setMonoflop(int channel, boolean value, long time) throws TinkerforgeException
Configures a monoflop of the specified channel. The second parameter is the desired value of the specified channel. A *true* means relay closed and a *false* means relay open. The third parameter indicates the time that the channels should hold the value. If this function is called with the parameters (0, 1, 1500) channel 0 will close and in 1.5s channel 0 will open again A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Industrial Quad Relay Bricklet 2.0 connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and channel 0 closed. Channel 0 will be closed all the time. If now the RS485 connection is lost, then channel 0 will be opened in at most two seconds.- Throws:
TinkerforgeException
-
getMonoflop
public BrickletIndustrialQuadRelayV2.Monoflop getMonoflop(int channel) throws TinkerforgeException
Returns (for the given channel) the current value and the time as set bysetMonoflop(int, boolean, long)
as well as the remaining time until the value flips. If the timer is not running currently, the remaining time will be returned as 0.- Throws:
TinkerforgeException
-
setSelectedValue
public void setSelectedValue(int channel, boolean value) throws TinkerforgeException
Sets the output value of the specified channel without affecting the other channels. A running monoflop timer for the specified channel will be aborted if this function is called.- Throws:
TinkerforgeException
-
setChannelLEDConfig
public void setChannelLEDConfig(int channel, int config) throws TinkerforgeException
Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.- Throws:
TinkerforgeException
-
getChannelLEDConfig
public int getChannelLEDConfig(int channel) throws TinkerforgeException
Returns the channel LED configuration as set bysetChannelLEDConfig(int, int)
- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletIndustrialQuadRelayV2.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
-
addMonoflopDoneListener
public void addMonoflopDoneListener(BrickletIndustrialQuadRelayV2.MonoflopDoneListener listener)
Adds a MonoflopDone listener.
-
removeMonoflopDoneListener
public void removeMonoflopDoneListener(BrickletIndustrialQuadRelayV2.MonoflopDoneListener listener)
Removes a MonoflopDone listener.
-
-