|
| |
The XtenWEB.Device class is used to describe a single Device that consists of
one or more X10 Modules within a single House code. The
following are examples of Devices: A:1
C:3 A:1,2,5 F:1-5,13,16 .
The following describes the XtenWEB.Device properties:
| Property |
Description |
| House |
The House code of the one or more X10 modules to be
defined by this Device. Valid values are "A" through
"P". |
| Modules |
A long binary number that defines the one or more modules
(within the single House code) to be defined by this
Device. Modules is a bit-mapped value that defines which of
the 16 modules is to be defined by this Device. Modules 1 through
16 are represented by bits from the left to right (most-significant to
least-significant) respectively. For example: module 1 would
be represented by a hex value of 8000, module 16 by hex value of 0001,
and modules 1-4 by a hex value F000. Individual bits of the Modules
property can be set and retrieved using the AddModule and GetModule
methods described below. |
| Description |
A character string containing a description of the Device
(one or more modules) defined by this Device object. Maximum of 25
characters. |
| String |
A read-only character string that describes the house and
modules defined by this object. For instance: "A:1,2,5-8,12". |
| ActionStatus |
A read-only integer that contains the status of the last
XtenWEB.Device request. A value of 0 indicates a successful
result; any other value indicates an error. |
| ActionStatusText |
A read-only character string that describes the results of
the last XtenWEB.Device request. |
The following describes the XtenWEB.Device methods:
| Method |
Description |
| DeviceOn |
Issues the X10 ON command to the modules defined by
this Device object. |
| DeviceOff |
Issues the X10 OFF command to the modules defined
by this Device object. |
| DeviceDim level |
Issues the X10 DIM command to the modules defined
by this Device object. A level parameter must be specified. |
| DeviceBrighten steps |
Issues the X10 Brighten command to the modules
defined by this Device object. A steps parameter must be
specified. |
| AddModule m1[,m2,...,m16] |
Adds one or more modules (sets one or more bits) to the
Device.Modules property. |
| GetModule m |
Returns the value of the specified bit (1-16) from the
Device.Modules property (0 or 1). |
|
