public class BrickletRemoteSwitchV2 extends Device
Modifier and Type | Class and 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, see
getSwitchingState() . |
Device.Identity
Constructor and Description |
---|
BrickletRemoteSwitchV2(java.lang.String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and 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, see
setBootloaderMode(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 by
setRemoteConfiguration(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 by
setRepeats(int) . |
BrickletRemoteSwitchV2.SPITFPErrorCount |
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.
|
int |
getStatusLEDConfig()
Returns the configuration as set by
setStatusLEDConfig(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 for
writeFirmware(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 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 java.lang.String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_SWITCHING_STATE
public static final byte FUNCTION_SET_REPEATS
public static final byte FUNCTION_GET_REPEATS
public static final byte FUNCTION_SWITCH_SOCKET_A
public static final byte FUNCTION_SWITCH_SOCKET_B
public static final byte FUNCTION_DIM_SOCKET_B
public static final byte FUNCTION_SWITCH_SOCKET_C
public static final byte FUNCTION_SET_REMOTE_CONFIGURATION
public static final byte FUNCTION_GET_REMOTE_CONFIGURATION
public static final byte FUNCTION_GET_REMOTE_STATUS_A
public static final byte FUNCTION_GET_REMOTE_STATUS_B
public static final byte FUNCTION_GET_REMOTE_STATUS_C
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 SWITCHING_STATE_READY
public static final int SWITCHING_STATE_BUSY
public static final int SWITCH_TO_OFF
public static final int SWITCH_TO_ON
public static final int REMOTE_TYPE_A
public static final int REMOTE_TYPE_B
public static final int REMOTE_TYPE_C
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 BrickletRemoteSwitchV2(java.lang.String uid, IPConnection ipcon)
public int getSwitchingState() throws TinkerforgeException
setRepeats(int)
.TinkerforgeException
public void setRepeats(int repeats) throws TinkerforgeException
TinkerforgeException
public int getRepeats() throws TinkerforgeException
setRepeats(int)
.TinkerforgeException
public void switchSocketA(int houseCode, int receiverCode, int switchTo) throws TinkerforgeException
TinkerforgeException
public void switchSocketB(long address, int unit, int switchTo) throws TinkerforgeException
TinkerforgeException
public void dimSocketB(long address, int unit, int dimValue) throws TinkerforgeException
TinkerforgeException
public void switchSocketC(char systemCode, int deviceCode, int switchTo) throws TinkerforgeException
TinkerforgeException
public void setRemoteConfiguration(int remoteType, int minimumRepeats, boolean callbackEnabled) throws TinkerforgeException
BrickletRemoteSwitchV2.RemoteStatusAListener
listener,
BrickletRemoteSwitchV2.RemoteStatusBListener
listener and BrickletRemoteSwitchV2.RemoteStatusCListener
listener).TinkerforgeException
public BrickletRemoteSwitchV2.RemoteConfiguration getRemoteConfiguration() throws TinkerforgeException
setRemoteConfiguration(int, int, boolean)
TinkerforgeException
public BrickletRemoteSwitchV2.RemoteStatusA getRemoteStatusA() throws TinkerforgeException
setRemoteConfiguration(int, int, boolean)
and BrickletRemoteSwitchV2.RemoteStatusAListener
listener.TinkerforgeException
public BrickletRemoteSwitchV2.RemoteStatusB getRemoteStatusB() throws TinkerforgeException
setRemoteConfiguration(int, int, boolean)
and BrickletRemoteSwitchV2.RemoteStatusBListener
listener.TinkerforgeException
public BrickletRemoteSwitchV2.RemoteStatusC getRemoteStatusC() throws TinkerforgeException
setRemoteConfiguration(int, int, boolean)
and BrickletRemoteSwitchV2.RemoteStatusCListener
listener.TinkerforgeException
public BrickletRemoteSwitchV2.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
public void addSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
public void removeSwitchingDoneListener(BrickletRemoteSwitchV2.SwitchingDoneListener listener)
public void addRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
public void removeRemoteStatusAListener(BrickletRemoteSwitchV2.RemoteStatusAListener listener)
public void addRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
public void removeRemoteStatusBListener(BrickletRemoteSwitchV2.RemoteStatusBListener listener)
public void addRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
public void removeRemoteStatusCListener(BrickletRemoteSwitchV2.RemoteStatusCListener listener)
Copyright © 2020 Tinkerforge GmbH. All rights reserved.