|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.udi.insteon.client.InsteonOps
public class InsteonOps
Utility class for all permissible Insteon Operations
Field Summary | |
---|---|
static double[] |
rampRates
A 32 element array of all possible ramp rates as follows (all in seconds): 540 ,480 ,420 ,360, 300 ,270 ,240 ,210, 180 ,150 ,120 ,90 , 60 ,47 ,43 ,38.5, 34 ,32 ,30 ,28 , 26 ,23.5,21.5,19 , 8.5 ,6.5 ,4.5 ,2 , 0.5 ,0.3 ,0.2 ,0.1 The index to the array should be used in the calls to perform a ramp rate operation on ISY |
Constructor Summary | |
---|---|
InsteonOps()
|
Method Summary | |
---|---|
static int |
convertOnLevelToPercent(int onlevel)
Converts an On-Level integer to a percentage |
static int |
convertOnLevelToPercent(java.lang.String onlevel)
Converts an On-Level String to a percentage |
static short |
convertPercentToOnLevel(int percent)
Converts an On Level percentage to Insteon format (short) |
static java.lang.String |
convertPercentToOnLevelString(int percent)
Converts an On Level percentage to Insteon format (String) |
static java.lang.String |
formatNodeAddress(java.lang.String address,
java.lang.String deviceType)
|
static java.util.ArrayList<UDNode> |
getAssociatedDevices(UDNode node,
UDProxyDevice device)
Returns an ArrayList [sorted] of all the associated UDNode s
for a given UDNode |
static java.lang.String |
getFormattedInsteonAddress(java.lang.String address)
|
static java.lang.String |
getFormattedInsteonAddress(java.lang.String address,
boolean format_x10)
Returns a formatted version of the node address, for display in the GUI. |
static java.lang.String |
getInsteonAddress(java.lang.String address,
boolean extended)
Returns an UDI formatted address as it's Insteon counterpart format |
static java.lang.String |
getInsteonGroup(java.lang.String address)
Returns the Insteon representation of the UDNode |
static int |
getNumIOInputs(UDNode node)
Returns the number of inputs for an I/O device |
static int |
getNumIOOutputs(UDNode node)
Returns the number of outputs for an I/O device |
static UDNode |
getPrimaryNode(UDNode node)
Return the node that represents the device itself. |
static boolean |
hasAssociatedDevices(UDNode node)
Checks to see whether or not a node as associated nodes. |
static boolean |
hasSense(UDNode node)
Checks to see whether or not a device has load sensing capabilities |
static boolean |
isBatteryPoweredDevice(char type,
char subType)
|
static boolean |
isBatteryPoweredDevice(UDNode node)
|
static boolean |
isClimateControlDevice(UDNode node)
Checks for thermostats (i.e. |
static boolean |
isClimateControllerNode(UDNode node)
Returns true if the given thermostat node may be used as a controller in a scene. |
static boolean |
isCompanion(UDNode node)
|
static boolean |
isControLinc(UDNode node)
Checks for ControLinc |
static boolean |
isControllerOnly(UDNode node)
Return true if the node may be used as a group controller, but not a group responder. |
static boolean |
isDimmable(UDNode node)
Whether or not a node is dimmable |
static boolean |
isDualBandOutletLinc(UDNode node)
Checks to see whether or not a device is a dual band OutletLinc |
static boolean |
isEnergyDisplay(char type,
char subType)
Checks for Energy Display |
static boolean |
isEnergyDisplay(UDNode node)
Checks for Energy Display |
static boolean |
isEZBridge(UDNode node)
|
static boolean |
isEZIO2(UDNode node)
Checks for EZIO-2x4 device |
static boolean |
isEZIO4O(UDNode node)
Checks for EZIO4O device |
static boolean |
isEZIO6I(UDNode node)
Checks for EZIO6I device |
static boolean |
isEZIO8(UDNode node)
Checks for EZIO-7x8 (8SA) device |
static boolean |
isEZIO8T(UDNode node)
Checks for EZIO-8T (8x30 device |
static boolean |
isEZSwitch(UDNode node)
|
static boolean |
isFanLinc_Fan(UDNode node)
Checks for FanLinc Fan node |
static boolean |
isFanLinc(UDNode node)
Checks for FanLinc |
static boolean |
isIconOnOffSwitch(UDNode node)
Checks for IconOnOffSwitch |
static boolean |
isIconSwitchDimmer(UDNode node)
Checks for IconSwitchDimmer |
static boolean |
isIconSwitchRelay(UDNode node)
Checks for IconSwitchRelay |
static boolean |
isIMeterSolo(UDNode node)
|
static boolean |
isInLineLincRelayDualBand(UDNode node)
|
static boolean |
isInlineLincWSense(UDNode node)
Checks for InlineLinc with Sense |
static boolean |
isInsteonBridge(UDNode node)
|
static boolean |
isInsteonController(UDNode node)
Checks to see whether or not a device is a controller |
static boolean |
isIOAnalogInput(UDNode node)
Checks to see whether or not a node is an I/O "analog" input |
static boolean |
isIOController(UDNode node)
Checks to see whether or not this node is the main controller for an I/O device. |
static boolean |
isIODevice(UDNode node)
Checks for I/O (i.e. |
static boolean |
isIOInput(UDNode node)
Checks to see whether or not a node is an I/O input |
static boolean |
isIOLinc(UDNode node)
|
static boolean |
isIOLincSensor(UDNode node)
Returns true if the node is an IOLinc sensor node |
static boolean |
isIOOutput(UDNode node)
Checks to see whether or not a node is an I/O output |
static boolean |
isIRLincReceiver(UDNode node)
|
static boolean |
isIRLincTx(UDNode node)
|
static boolean |
isIrrigationController(UDNode node)
Checks to see whether or not this node is the main controller for an Irrigation device. |
static boolean |
isIrrigationDevice(UDNode node)
Checks for Irrigation (i.e. |
static boolean |
isIrrigationValves(UDNode node)
Checks to see whether or not this node is a valve. |
static boolean |
isKeypadLinc(UDNode node)
Checks for KeypadLinc |
static boolean |
isKeypadLincButton(UDNode node)
Checks to see whether or not a node is a KeypadLinc button |
static boolean |
isKeypadLincRelay(UDNode node)
|
static boolean |
isKeypadLincV2(UDNode node)
Checks for KeypadLinc v2 |
static boolean |
isKPLTimer(UDNode node)
Checks for Countdown Timer |
static boolean |
isLampLinc(UDNode node)
checks for LampLinc |
static boolean |
isLampLincBiPhy(UDNode node)
checks for LampLinc BiPhy |
static boolean |
isLightDevice(UDNode node)
Checks for any Insteon Light controller/responder device |
static boolean |
isLLV2(UDNode node)
Checks for LampLinc v2 |
static boolean |
isLoadController(UDNode node)
|
static boolean |
isMorningLinc(UDNode node)
|
static boolean |
isMotionSensor(UDNode node)
|
static boolean |
isPrimaryNode(UDNode node)
Whether or not a node is the primary node for a device such as KPL load button |
static boolean |
isRemoteLinc(UDNode node)
Checks for RemoteLinc |
static boolean |
isRemoteLinc2(char type,
char subType)
Checks for RemoteLinc2 |
static boolean |
isRemoteLinc2(UDNode node)
Checks for RemoteLinc2 |
static boolean |
isRemoteLinc2Switch(UDNode node)
Checks for RemoteLinc2Switch |
static boolean |
isResponderOnly(UDNode node)
Return true if the node may be used as a group responder, but not a group controller. |
static boolean |
isSameDevice(UDNode n1,
UDNode n2)
Checks to see whether or not two nodes are actually referring to the same device |
static boolean |
isSwitchedDevice(UDNode node)
Checks to see whether or not a device is switched |
static boolean |
isSwitchLinc(UDNode node)
Checks for SwitchLinc |
static boolean |
isSwitchLincTimer(UDNode node)
Checks for 2476ST - SwitchLincTimer |
static boolean |
isSwitchLincV3(UDNode node)
|
static boolean |
isSwitchLincWSense(UDNode node)
Checks for 2476S |
static boolean |
isSynchroLinc(UDNode node)
|
static boolean |
isTimerLinc(UDNode node)
|
static boolean |
isToggleLinc(UDNode node)
Checks for ToggleLinc |
static boolean |
isTriggerLinc(UDNode node)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static double[] rampRates
Constructor Detail |
---|
public InsteonOps()
Method Detail |
---|
public static int convertOnLevelToPercent(int onlevel)
onlevel
- - the on level
public static int convertOnLevelToPercent(java.lang.String onlevel)
onlevel
- - the on level
public static short convertPercentToOnLevel(int percent)
percent
- - the on level percentage
public static java.lang.String convertPercentToOnLevelString(int percent)
percent
- - the on level percentage
public static boolean isIOLincSensor(UDNode node)
node
-
public static boolean isControllerOnly(UDNode node)
node
- the UDNode
to be checked
public static boolean isResponderOnly(UDNode node)
node
- the UDNode
to be checked
public static boolean isToggleLinc(UDNode node)
node
- - the UDNode
to be checked
UDNode
public static boolean isLampLinc(UDNode node)
node
- - the UDNode
to be checked
UDNode
public static boolean isIrrigationDevice(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isIODevice(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isClimateControllerNode(UDNode node)
node
- A thermostat node
public static boolean isClimateControlDevice(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isFanLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isFanLinc_Fan(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isLightDevice(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isCompanion(UDNode node)
public static boolean isSwitchLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isSwitchLincV3(UDNode node)
public static boolean isSwitchLincWSense(UDNode node)
node
-
public static boolean isSwitchLincTimer(UDNode node)
node
-
public static boolean isKPLTimer(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isIconSwitchDimmer(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isIconSwitchRelay(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isIconOnOffSwitch(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isKeypadLincRelay(UDNode node)
public static boolean isKeypadLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isKeypadLincV2(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isLLV2(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isLampLincBiPhy(UDNode node)
node
- - the UDNode
to be checked
UDNode
public static boolean isInlineLincWSense(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isInLineLincRelayDualBand(UDNode node)
public static boolean isDualBandOutletLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean hasSense(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isSwitchedDevice(UDNode node)
Switched devices are not dimmable such as relays, ApplianceLincs, etc.
node
- - the UDNode
in question
UDNode
public static boolean isControLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isRemoteLinc2Switch(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isRemoteLinc2(char type, char subType)
node
- - the UDNode
in question
UDNode
public static boolean isRemoteLinc2(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isEnergyDisplay(char type, char subType)
type
- - The device type in questionsubtype
- - The device subtype in question
UDNode
public static boolean isEnergyDisplay(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isRemoteLinc(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isIRLincReceiver(UDNode node)
public static boolean isInsteonBridge(UDNode node)
public static boolean isEZBridge(UDNode node)
public static boolean isEZSwitch(UDNode node)
public static boolean isMotionSensor(UDNode node)
public static boolean isTriggerLinc(UDNode node)
public static boolean isIOLinc(UDNode node)
public static boolean isTimerLinc(UDNode node)
public static boolean isBatteryPoweredDevice(UDNode node)
public static boolean isBatteryPoweredDevice(char type, char subType)
public static boolean isLoadController(UDNode node)
public static boolean isMorningLinc(UDNode node)
public static boolean isSynchroLinc(UDNode node)
public static boolean isIMeterSolo(UDNode node)
public static boolean isInsteonController(UDNode node)
Controllers are such devices as KeypadLinc, SwitchLinc, ControLinc, etc.
node
- - the UDNode
in question
UDNode
public static boolean isKeypadLincButton(UDNode node)
A KeypadLinc button is one which is not the main (loaded) button such as A, B, C, D, ... H
node
- - the UDNode
in question
UDNode
public static boolean hasAssociatedDevices(UDNode node)
Example:
For a KeypadLinc 8 button, this method returns true since there are
7 more associated buttons (nodes).
For a SwitchLinc, on the other hand,
this method returns false
node
- - the UDNode
in question
UDNode
public static boolean isIrrigationController(UDNode node)
Main controller is usually the first node with the same address and without which all the other associated nodes would also have to be removed
node
- - the UDNode
in question
UDNode
public static boolean isIrrigationValves(UDNode node)
Being an Irrigation valves which means that it's not an IrrigationController
node
- - the UDNode
in question
UDNode
public static boolean isIOController(UDNode node)
Main controller is usually the first node with the same address and without which all the other associated nodes would also have to be removed
node
- - the UDNode
in question
UDNode
public static boolean isEZIO2(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isEZIO8(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isEZIO8T(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isEZIO6I(UDNode node)
node
- - the UDNode
in question
UDNode
public static boolean isEZIO4O(UDNode node)
node
- - the UDNode
in question
UDNode
public static int getNumIOInputs(UDNode node)
node
- - the UDNode
to be checked
UDNode
public static int getNumIOOutputs(UDNode node)
node
- - the UDNode
to be checked
UDNode
public static boolean isIOOutput(UDNode node)
node
- - the UDNode
in questions
UDNode
public static boolean isIOInput(UDNode node)
node
- - the UDNode
in questions
UDNode
public static boolean isIOAnalogInput(UDNode node)
node
- - the UDNode
in questions
UDNode
public static boolean isIRLincTx(UDNode node)
public static java.lang.String getFormattedInsteonAddress(java.lang.String address, boolean format_x10)
address
- Address of the nodeformat_x10
- whether or not we format the X10 codes
public static java.lang.String getFormattedInsteonAddress(java.lang.String address)
public static java.lang.String formatNodeAddress(java.lang.String address, java.lang.String deviceType)
public static java.lang.String getInsteonAddress(java.lang.String address, boolean extended)
address
- - the UDI formatted addressextended
- - whether or not the UDI group should also be included
public static boolean isSameDevice(UDNode n1, UDNode n2)
n1
- - first noden2
- - second node
public static java.lang.String getInsteonGroup(java.lang.String address)
UDNode
address
- - the address for which we want the Insteon format
UDNode
UDI represents node address (device addresses) in the following manner:
X X X G, where
Xs are hexadecimal Insteon address bytes
G represents the button number for that specific device. ,br/>
As an example, a 6 button KeypadLinc with address 4 E8 52, would have the
following UDNode
s associated with it
UDNode
public static java.util.ArrayList<UDNode> getAssociatedDevices(UDNode node, UDProxyDevice device)
ArrayList
[sorted] of all the associated UDNode
s
for a given UDNode
node
- - the UDNode
for which we want associated nodesdevice
- - the UDProxyDevice
to which this node belongs to
ArrayList
of all the associated UDNode
spublic static UDNode getPrimaryNode(UDNode node)
public static boolean isPrimaryNode(UDNode node)
node
- - the node in question
public static boolean isDimmable(UDNode node)
node
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |