com.jpeterson.x10
Class X10Util

java.lang.Object
  |
  +--com.jpeterson.x10.X10Util

public class X10Util
extends java.lang.Object

Utility classes to support X10 classes.


Field Summary
static int X10_DEVICE_CODE_1
           
static int X10_DEVICE_CODE_10
           
static int X10_DEVICE_CODE_11
           
static int X10_DEVICE_CODE_12
           
static int X10_DEVICE_CODE_13
           
static int X10_DEVICE_CODE_14
           
static int X10_DEVICE_CODE_15
           
static int X10_DEVICE_CODE_16
           
static int X10_DEVICE_CODE_2
           
static int X10_DEVICE_CODE_3
           
static int X10_DEVICE_CODE_4
           
static int X10_DEVICE_CODE_5
           
static int X10_DEVICE_CODE_6
           
static int X10_DEVICE_CODE_7
           
static int X10_DEVICE_CODE_8
           
static int X10_DEVICE_CODE_9
           
static byte X10_FUNCTION_ALL_LIGHTS_OFF
           
static byte X10_FUNCTION_ALL_LIGHTS_ON
           
static byte X10_FUNCTION_ALL_UNITS_OFF
           
static byte X10_FUNCTION_BRIGHT
           
static byte X10_FUNCTION_DIM
           
static byte X10_FUNCTION_EXTENDED_CODE
           
static byte X10_FUNCTION_EXTENDED_DATA_TRANSFER
           
static byte X10_FUNCTION_HAIL_ACKNOWLEDGE
           
static byte X10_FUNCTION_HAIL_REQUEST
           
static byte X10_FUNCTION_OFF
           
static byte X10_FUNCTION_ON
           
static byte X10_FUNCTION_PRESET_DIM_1
           
static byte X10_FUNCTION_PRESET_DIM_2
           
static byte X10_FUNCTION_STATUS_OFF
           
static byte X10_FUNCTION_STATUS_ON
           
static byte X10_FUNCTION_STATUS_REQUEST
           
static int X10_HOUSE_CODE_A
           
static int X10_HOUSE_CODE_B
           
static int X10_HOUSE_CODE_C
           
static int X10_HOUSE_CODE_D
           
static int X10_HOUSE_CODE_E
           
static int X10_HOUSE_CODE_F
           
static int X10_HOUSE_CODE_G
           
static int X10_HOUSE_CODE_H
           
static int X10_HOUSE_CODE_I
           
static int X10_HOUSE_CODE_J
           
static int X10_HOUSE_CODE_K
           
static int X10_HOUSE_CODE_L
           
static int X10_HOUSE_CODE_M
           
static int X10_HOUSE_CODE_N
           
static int X10_HOUSE_CODE_O
           
static int X10_HOUSE_CODE_P
           
 
Constructor Summary
X10Util()
           
 
Method Summary
static int byte2deviceCode(byte nibble)
          Convert a value to it's corresponding house code.
static char byte2houseCode(byte nibble)
          Convert a value to it's corresponding house code.
static byte deviceCode2byte(int deviceCode)
          Convert a device code to it's corresponding X10 value.
static byte houseCode2byte(char houseCode)
          Convert a house code to it's corresponding X10 value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

X10_DEVICE_CODE_1

public static final int X10_DEVICE_CODE_1

X10_DEVICE_CODE_2

public static final int X10_DEVICE_CODE_2

X10_DEVICE_CODE_3

public static final int X10_DEVICE_CODE_3

X10_DEVICE_CODE_4

public static final int X10_DEVICE_CODE_4

X10_DEVICE_CODE_5

public static final int X10_DEVICE_CODE_5

X10_DEVICE_CODE_6

public static final int X10_DEVICE_CODE_6

X10_DEVICE_CODE_7

public static final int X10_DEVICE_CODE_7

X10_DEVICE_CODE_8

public static final int X10_DEVICE_CODE_8

X10_DEVICE_CODE_9

public static final int X10_DEVICE_CODE_9

X10_DEVICE_CODE_10

public static final int X10_DEVICE_CODE_10

X10_DEVICE_CODE_11

public static final int X10_DEVICE_CODE_11

X10_DEVICE_CODE_12

public static final int X10_DEVICE_CODE_12

X10_DEVICE_CODE_13

public static final int X10_DEVICE_CODE_13

X10_DEVICE_CODE_14

public static final int X10_DEVICE_CODE_14

X10_DEVICE_CODE_15

public static final int X10_DEVICE_CODE_15

X10_DEVICE_CODE_16

public static final int X10_DEVICE_CODE_16

X10_HOUSE_CODE_A

public static final int X10_HOUSE_CODE_A

X10_HOUSE_CODE_B

public static final int X10_HOUSE_CODE_B

X10_HOUSE_CODE_C

public static final int X10_HOUSE_CODE_C

X10_HOUSE_CODE_D

public static final int X10_HOUSE_CODE_D

X10_HOUSE_CODE_E

public static final int X10_HOUSE_CODE_E

X10_HOUSE_CODE_F

public static final int X10_HOUSE_CODE_F

X10_HOUSE_CODE_G

public static final int X10_HOUSE_CODE_G

X10_HOUSE_CODE_H

public static final int X10_HOUSE_CODE_H

X10_HOUSE_CODE_I

public static final int X10_HOUSE_CODE_I

X10_HOUSE_CODE_J

public static final int X10_HOUSE_CODE_J

X10_HOUSE_CODE_K

public static final int X10_HOUSE_CODE_K

X10_HOUSE_CODE_L

public static final int X10_HOUSE_CODE_L

X10_HOUSE_CODE_M

public static final int X10_HOUSE_CODE_M

X10_HOUSE_CODE_N

public static final int X10_HOUSE_CODE_N

X10_HOUSE_CODE_O

public static final int X10_HOUSE_CODE_O

X10_HOUSE_CODE_P

public static final int X10_HOUSE_CODE_P

X10_FUNCTION_ALL_UNITS_OFF

public static final byte X10_FUNCTION_ALL_UNITS_OFF

X10_FUNCTION_ALL_LIGHTS_ON

public static final byte X10_FUNCTION_ALL_LIGHTS_ON

X10_FUNCTION_ON

public static final byte X10_FUNCTION_ON

X10_FUNCTION_OFF

public static final byte X10_FUNCTION_OFF

X10_FUNCTION_DIM

public static final byte X10_FUNCTION_DIM

X10_FUNCTION_BRIGHT

public static final byte X10_FUNCTION_BRIGHT

X10_FUNCTION_ALL_LIGHTS_OFF

public static final byte X10_FUNCTION_ALL_LIGHTS_OFF

X10_FUNCTION_EXTENDED_CODE

public static final byte X10_FUNCTION_EXTENDED_CODE

X10_FUNCTION_HAIL_REQUEST

public static final byte X10_FUNCTION_HAIL_REQUEST

X10_FUNCTION_HAIL_ACKNOWLEDGE

public static final byte X10_FUNCTION_HAIL_ACKNOWLEDGE

X10_FUNCTION_PRESET_DIM_1

public static final byte X10_FUNCTION_PRESET_DIM_1

X10_FUNCTION_PRESET_DIM_2

public static final byte X10_FUNCTION_PRESET_DIM_2

X10_FUNCTION_EXTENDED_DATA_TRANSFER

public static final byte X10_FUNCTION_EXTENDED_DATA_TRANSFER

X10_FUNCTION_STATUS_ON

public static final byte X10_FUNCTION_STATUS_ON

X10_FUNCTION_STATUS_OFF

public static final byte X10_FUNCTION_STATUS_OFF

X10_FUNCTION_STATUS_REQUEST

public static final byte X10_FUNCTION_STATUS_REQUEST
Constructor Detail

X10Util

public X10Util()
Method Detail

houseCode2byte

public static byte houseCode2byte(char houseCode)
                           throws java.lang.IllegalArgumentException
Convert a house code to it's corresponding X10 value.
Parameters:
houseCode - character representation of the house code; 'A' - 'P'
Returns:
Value of house code
Throws:
java.lang.IllegalArgumentException - Thrown if the house code not equal to 'A'-'P'.

byte2houseCode

public static char byte2houseCode(byte nibble)
Convert a value to it's corresponding house code.
Parameters:
nibble - the house code value.
Returns:
Character 'A' through 'P' that corresponds to the house code value.

deviceCode2byte

public static byte deviceCode2byte(int deviceCode)
Convert a device code to it's corresponding X10 value.
Parameters:
deviceCode - numeric representation of the device code; 1 - 16
Returns:
Value of device code

byte2deviceCode

public static int byte2deviceCode(byte nibble)
Convert a value to it's corresponding house code.
Parameters:
nibble - the house code value.
Returns:
Character 'A' through 'P' that corresponds to the house code value.