code/debian/tablet-config.pod

   1 =head1 NAME
   2
   3 ppower - Client for controlling x10 hardware.
   4
   5 =head1 SYNOPSIS
   6
   7 B<ppower> S<[I<OPTION>]... [I<COMMAND>]>
   8
   9 =head1 DESCRIPTION
  10
  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.
  14
  15 =head2 Command Format
  16
  17 If no other arguments are given, ppower expects a command.  The command is
  18 of the form
  19
  20 [I<DEVICE>],...:[I<STATE>]<:I<VALUE>><:I<EXTENDED VALUE>>
  21
  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
  24 configuration file.
  25
  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.
  28
  29 An B<EXTENDED_DATA_TRANSFER> requires the I<VALUE> and I<EXTENDED VALUE> to
  30 be specified.
  31
  32 See the B<EXAMPLES> section for example commands.
  33
  34 =head2 States
  35
  36 =over 7
  37
  38 =item B<ALL_UNITS_OFF>
  39
  40 Turn all units on the given housecode off.  For this command, instead of a
  41 device list, you can specify the housecode letter.
  42
  43 =item B<ALL_LIGHTS_ON>
  44
  45 Turn all lights on the given housecode on.  For this command, instead of a
  46 device list, you can specify the housecode letter.
  47
  48 =item B<ON>
  49
  50 Turn the selected devices on.
  51
  52 =item B<OFF>
  53
  54 Turn the selected devices off.
  55
  56 =item B<DIM>
  57
  58 Dim the selected devices by a I<VALUE>.
  59
  60 =item B<BRIGHT>
  61
  62 Brighten the selected devices by a I<VALUE>.
  63
  64 =item B<ALL_LIGHTS_OFF>
  65
  66 Turn all lights on the given housecode off.  For this command, instead of a
  67 device list, you can specify the housecode letter.
  68
  69 =item B<EXTENDED_CODE>
  70
  71 XXX: I haven't figured out what this does.  It might only pertain to
  72 hardware macros.
  73
  74 =item B<HAIL_REQUEST>
  75
  76 Sends a hail request to the listed devices.
  77
  78 =item B<HAIL_ACKNOWLEDGE>
  79
  80 Sends a hail acknowledge to the listed devices.
  81
  82 =item B<PRESET_DIM1>
  83
  84 Sends the first preset dim to the listed devices.
  85
  86 =item B<PRESET_DIM2>
  87
  88 Sends the second preset dim to the listed devices.
  89
  90 =item B<EXTENDED_DATA_TRANSFER>
  91
  92 Sends two bytes of data to selected devices.  The I<VALUE> and I<EXTENDED
  93 VALUE> must be specified.
  94
  95 =item B<STATUS_ON>
  96
  97 XXX: Unknown.
  98
  99 =item B<STATUS_OFF>
 100
 101 XXX: Unknown.
 102
 103 =item B<STATUS_REQUEST>
 104
 105 Returns the status of the listed devices.  The only thing I have that
 106 answers this is the transceiver.
 107
 108 =back
 109
 110 =head1 OPTIONS
 111
 112 =over 7
 113
 114 =item B<-v, --version>
 115
 116 display program vesrion
 117
 118 =item B<-h, --help>
 119
 120 give help on usage
 121
 122 =item B<-m, --monitor>
 123
 124 monitors the x10 hardware for changes
 125
 126 =item B<-s, --status>
 127
 128 reports status of known x10 devices
 129
 130 =item B<-f, --conf=FILE>
 131
 132 specify alternate configuration file
 133
 134 =item B<-d, --debug=LEVEL>
 135
 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
 138
 139 =item B<--refresh>
 140
 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
 143
 144 =item B<--shutdown>
 145
 146 stop the currently running daemon
 147
 148 =back
 149
 150 =head1 EXAMPLES
 151
 152 =head2 Issuing Commands
 153
 154 Turn the device set to a1 on.
 155 B<    ppower a1:ON>
 156
 157 Turn the fan you have listed in your configuration file on.
 158 B<    ppower fan:ON>
 159
 160 Turn a group of devices on.
 161 B<    ppower a1,b2,c3:ON>
 162
 163 Dim the light attached to a2 by about 50%.
 164 B<    ppower a2:DIM:11>
 165
 166 Dim the light attached to a2 as far as it will go.
 167 B<    ppower a2:DIM:22>
 168
 169 =head2 Listening to the Daemon
 170
 171 Monitor incoming x10 commands.
 172 B<    ppower -m>
 173
 174 List the status of all known devices.
 175 B<    ppower -s>
 176
 177 =head1 FILES
 178
 179 =over 7
 180
 181 =item F<ppower.conf>
 182
 183 The configuration file for the ppower package.  See the example
 184 configuration file included in the distribution and the documentation for
 185 examples.
 186
 187 =back
 188
 189 =head1 AUTHOR
 190
 191 Steven Brown <swbrown@ucsd.edu>.
 192
 193 =head1 BUGS
 194
 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.
 198
 199 =head1 REPORTING BUGS
 200
 201 Report bugs to <swbrown@ucsd.edu>.