3 ppower - Client for controlling x10 hardware.
7 B<ppower> S<[I<OPTION>]... [I<COMMAND>]>
11 Ppower is the client program for accessing x10 hardware. With it you can
12 ask the ppowerd daemon to change the state of x10 hardware as well as
13 monitor x10 messages received by the daemon from the power line.
17 If no other arguments are given, ppower expects a command. The command is
20 [I<DEVICE>],...:[I<STATE>]<:I<VALUE>><:I<EXTENDED VALUE>>
22 A I<DEVICE> is specified as a housecode letter and a devicecode digit like
23 "a1" or a named device like "light1" if such a name has been defined in the
26 The I<VALUE> is used by B<BIM> and B<BRIGHT> commands to specify the change
27 from 0 to 22, where 0 is the least change.
29 An B<EXTENDED_DATA_TRANSFER> requires the I<VALUE> and I<EXTENDED VALUE> to
32 See the B<EXAMPLES> section for example commands.
38 =item B<ALL_UNITS_OFF>
40 Turn all units on the given housecode off. For this command, instead of a
41 device list, you can specify the housecode letter.
43 =item B<ALL_LIGHTS_ON>
45 Turn all lights on the given housecode on. For this command, instead of a
46 device list, you can specify the housecode letter.
50 Turn the selected devices on.
54 Turn the selected devices off.
58 Dim the selected devices by a I<VALUE>.
62 Brighten the selected devices by a I<VALUE>.
64 =item B<ALL_LIGHTS_OFF>
66 Turn all lights on the given housecode off. For this command, instead of a
67 device list, you can specify the housecode letter.
69 =item B<EXTENDED_CODE>
71 XXX: I haven't figured out what this does. It might only pertain to
76 Sends a hail request to the listed devices.
78 =item B<HAIL_ACKNOWLEDGE>
80 Sends a hail acknowledge to the listed devices.
84 Sends the first preset dim to the listed devices.
88 Sends the second preset dim to the listed devices.
90 =item B<EXTENDED_DATA_TRANSFER>
92 Sends two bytes of data to selected devices. The I<VALUE> and I<EXTENDED
93 VALUE> must be specified.
103 =item B<STATUS_REQUEST>
105 Returns the status of the listed devices. The only thing I have that
106 answers this is the transceiver.
114 =item B<-v, --version>
116 display program vesrion
122 =item B<-m, --monitor>
124 monitors the x10 hardware for changes
126 =item B<-s, --status>
128 reports status of known x10 devices
130 =item B<-f, --conf=FILE>
132 specify alternate configuration file
134 =item B<-d, --debug=LEVEL>
136 set the debug level, 0 is off; check the program's --help to see what the
137 maximum debug level currently is as well as the compiled in default
141 force the daemon to reload the configuration file; this is mainly for
142 devices, aliases and macros; sockets and permissions won't be affected
146 stop the currently running daemon
152 =head2 Issuing Commands
154 Turn the device set to a1 on.
157 Turn the fan you have listed in your configuration file on.
160 Turn a group of devices on.
161 B< ppower a1,b2,c3:ON>
163 Dim the light attached to a2 by about 50%.
166 Dim the light attached to a2 as far as it will go.
169 =head2 Listening to the Daemon
171 Monitor incoming x10 commands.
174 List the status of all known devices.
183 The configuration file for the ppower package. See the example
184 configuration file included in the distribution and the documentation for
191 Steven Brown <swbrown@ucsd.edu>.
195 A lot of the states arn't accepted by any x10 hardware I know of. Also, a
196 lot of functionality is missing or half-implemented as this project is quite
197 new. Check the B<TODO> file included in the distribution for a better list.
199 =head1 REPORTING BUGS
201 Report bugs to <swbrown@ucsd.edu>.