Package com.tinkerforge
Class BrickletRemoteSwitchV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletRemoteSwitchV2
-
public class BrickletRemoteSwitchV2 extends Device
Controls remote mains switches and receives signals from remotes
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletRemoteSwitchV2.RemoteConfiguration
class
BrickletRemoteSwitchV2.RemoteStatusA
static interface
BrickletRemoteSwitchV2.RemoteStatusAListener
Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.class
BrickletRemoteSwitchV2.RemoteStatusB
static interface
BrickletRemoteSwitchV2.RemoteStatusBListener
Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.class
BrickletRemoteSwitchV2.RemoteStatusC
static interface
BrickletRemoteSwitchV2.RemoteStatusCListener
Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.class
BrickletRemoteSwitchV2.SPITFPErrorCount
static interface
BrickletRemoteSwitchV2.SwitchingDoneListener
This listener is triggered whenever the switching state changes from busy to ready, seegetSwitchingState()
.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletRemoteSwitchV2(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
addRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
Adds a RemoteStatusA listener.void
addRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
Adds a RemoteStatusB listener.void
addRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
Adds a RemoteStatusC listener.void
addSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
Adds a SwitchingDone listener.void
dimSocketB(long address, int unit, int dimValue)
To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(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.BrickletRemoteSwitchV2.RemoteConfiguration
getRemoteConfiguration()
Returns the remote configuration as set bysetRemoteConfiguration(int, int, boolean)
BrickletRemoteSwitchV2.RemoteStatusA
getRemoteStatusA()
Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.BrickletRemoteSwitchV2.RemoteStatusB
getRemoteStatusB()
Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.BrickletRemoteSwitchV2.RemoteStatusC
getRemoteStatusC()
Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.int
getRepeats()
Returns the number of repeats as set bysetRepeats(int)
.BrickletRemoteSwitchV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getSwitchingState()
Returns the current switching state.long
readUID()
Returns the current UID as an integer.void
removeRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
Removes a RemoteStatusA listener.void
removeRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
Removes a RemoteStatusB listener.void
removeRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
Removes a RemoteStatusC listener.void
removeSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
Removes a SwitchingDone 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
setRemoteConfiguration(int remoteType, int minimumRepeats, boolean callbackEnabled)
Sets the configuration for **receiving** data from a remote of type A, B or C.void
setRepeats(int repeats)
Sets the number of times the code is sent when one of the Switch Socket functions is called.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.void
switchSocketA(int houseCode, int receiverCode, int switchTo)
To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.void
switchSocketB(long address, int unit, int switchTo)
To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.void
switchSocketC(char systemCode, int deviceCode, int switchTo)
To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.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_SWITCHING_STATE
public static final byte FUNCTION_GET_SWITCHING_STATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_REPEATS
public static final byte FUNCTION_SET_REPEATS
- See Also:
- Constant Field Values
-
FUNCTION_GET_REPEATS
public static final byte FUNCTION_GET_REPEATS
- See Also:
- Constant Field Values
-
FUNCTION_SWITCH_SOCKET_A
public static final byte FUNCTION_SWITCH_SOCKET_A
- See Also:
- Constant Field Values
-
FUNCTION_SWITCH_SOCKET_B
public static final byte FUNCTION_SWITCH_SOCKET_B
- See Also:
- Constant Field Values
-
FUNCTION_DIM_SOCKET_B
public static final byte FUNCTION_DIM_SOCKET_B
- See Also:
- Constant Field Values
-
FUNCTION_SWITCH_SOCKET_C
public static final byte FUNCTION_SWITCH_SOCKET_C
- See Also:
- Constant Field Values
-
FUNCTION_SET_REMOTE_CONFIGURATION
public static final byte FUNCTION_SET_REMOTE_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_REMOTE_CONFIGURATION
public static final byte FUNCTION_GET_REMOTE_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_REMOTE_STATUS_A
public static final byte FUNCTION_GET_REMOTE_STATUS_A
- See Also:
- Constant Field Values
-
FUNCTION_GET_REMOTE_STATUS_B
public static final byte FUNCTION_GET_REMOTE_STATUS_B
- See Also:
- Constant Field Values
-
FUNCTION_GET_REMOTE_STATUS_C
public static final byte FUNCTION_GET_REMOTE_STATUS_C
- 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
-
SWITCHING_STATE_READY
public static final int SWITCHING_STATE_READY
- See Also:
- Constant Field Values
-
SWITCHING_STATE_BUSY
public static final int SWITCHING_STATE_BUSY
- See Also:
- Constant Field Values
-
SWITCH_TO_OFF
public static final int SWITCH_TO_OFF
- See Also:
- Constant Field Values
-
SWITCH_TO_ON
public static final int SWITCH_TO_ON
- See Also:
- Constant Field Values
-
REMOTE_TYPE_A
public static final int REMOTE_TYPE_A
- See Also:
- Constant Field Values
-
REMOTE_TYPE_B
public static final int REMOTE_TYPE_B
- See Also:
- Constant Field Values
-
REMOTE_TYPE_C
public static final int REMOTE_TYPE_C
- 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
-
BrickletRemoteSwitchV2
public BrickletRemoteSwitchV2(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
-
getSwitchingState
public int getSwitchingState() throws TinkerforgeException
Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready. How long the switching takes is dependent on the number of repeats, seesetRepeats(int)
.- Throws:
TinkerforgeException
-
setRepeats
public void setRepeats(int repeats) throws TinkerforgeException
Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed. Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.- Throws:
TinkerforgeException
-
getRepeats
public int getRepeats() throws TinkerforgeException
Returns the number of repeats as set bysetRepeats(int)
.- Throws:
TinkerforgeException
-
switchSocketA
public void switchSocketA(int houseCode, int receiverCode, int switchTo) throws TinkerforgeException
To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to. A detailed description on how you can figure out the house and receiver code can be found :ref:`here <remote_switch_bricklet_type_a_house_and_receiver_code>`.- Throws:
TinkerforgeException
-
switchSocketB
public void switchSocketB(long address, int unit, int switchTo) throws TinkerforgeException
To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to. To switch all devices with the same address use 255 for the unit. A detailed description on how you can teach a socket the address and unit can be found :ref:`here <remote_switch_bricklet_type_b_address_and_unit>`.- Throws:
TinkerforgeException
-
dimSocketB
public void dimSocketB(long address, int unit, int dimValue) throws TinkerforgeException
To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to. A detailed description on how you can teach a dimmer the address and unit can be found :ref:`here <remote_switch_bricklet_type_b_address_and_unit>`.- Throws:
TinkerforgeException
-
switchSocketC
public void switchSocketC(char systemCode, int deviceCode, int switchTo) throws TinkerforgeException
To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to. A detailed description on how you can figure out the system and device code can be found :ref:`here <remote_switch_bricklet_type_c_system_and_device_code>`.- Throws:
TinkerforgeException
-
setRemoteConfiguration
public void setRemoteConfiguration(int remoteType, int minimumRepeats, boolean callbackEnabled) throws TinkerforgeException
Sets the configuration for **receiving** data from a remote of type A, B or C. * Remote Type: A, B or C depending on the type of remote you want to receive. * Minimum Repeats: The minimum number of repeated data packets until the listener is triggered (if enabled). * Listener Enabled: Enable or disable listener (seeBrickletRemoteSwitchV2.RemoteStatusAListener
listener,BrickletRemoteSwitchV2.RemoteStatusBListener
listener andBrickletRemoteSwitchV2.RemoteStatusCListener
listener).- Throws:
TinkerforgeException
-
getRemoteConfiguration
public BrickletRemoteSwitchV2.RemoteConfiguration getRemoteConfiguration() throws TinkerforgeException
Returns the remote configuration as set bysetRemoteConfiguration(int, int, boolean)
- Throws:
TinkerforgeException
-
getRemoteStatusA
public BrickletRemoteSwitchV2.RemoteStatusA getRemoteStatusA() throws TinkerforgeException
Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A. Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. Use the listener to get this data automatically when a button is pressed, seesetRemoteConfiguration(int, int, boolean)
andBrickletRemoteSwitchV2.RemoteStatusAListener
listener.- Throws:
TinkerforgeException
-
getRemoteStatusB
public BrickletRemoteSwitchV2.RemoteStatusB getRemoteStatusB() throws TinkerforgeException
Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B. If the remote supports dimming the dim value is used instead of the switch state. If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. Use the listener to get this data automatically when a button is pressed, seesetRemoteConfiguration(int, int, boolean)
andBrickletRemoteSwitchV2.RemoteStatusBListener
listener.- Throws:
TinkerforgeException
-
getRemoteStatusC
public BrickletRemoteSwitchV2.RemoteStatusC getRemoteStatusC() throws TinkerforgeException
Returns the system code, device code, switch state (on/off) and number of repeats for remote type C. If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. Use the listener to get this data automatically when a button is pressed, seesetRemoteConfiguration(int, int, boolean)
andBrickletRemoteSwitchV2.RemoteStatusCListener
listener.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletRemoteSwitchV2.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
-
addSwitchingDoneListener
public void addSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
Adds a SwitchingDone listener.
-
removeSwitchingDoneListener
public void removeSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
Removes a SwitchingDone listener.
-
addRemoteStatusAListener
public void addRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
Adds a RemoteStatusA listener.
-
removeRemoteStatusAListener
public void removeRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
Removes a RemoteStatusA listener.
-
addRemoteStatusBListener
public void addRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
Adds a RemoteStatusB listener.
-
removeRemoteStatusBListener
public void removeRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
Removes a RemoteStatusB listener.
-
addRemoteStatusCListener
public void addRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
Adds a RemoteStatusC listener.
-
removeRemoteStatusCListener
public void removeRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
Removes a RemoteStatusC listener.
-
-