File: README

package info (click to toggle)
wmx10 0.02-4.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 208 kB
  • ctags: 164
  • sloc: ansic: 1,070; sh: 64; makefile: 58
file content (113 lines) | stat: -rw-r--r-- 3,921 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
wmx10 - A DockApp gui for controlling X10's 
        Firecracker kit through bottlerocket
--------------------------------------------------------------
Author: Joshua Hawkins (jhawkins@osiris.978.org)

Installation
--------------------------------------------------------------
Please see the file "INSTALL".

Description
--------------------------------------------------------------
wmx10 provides a graphical user interface for controlling
X10's Firecracker module.  The dockapp is simply a front end
to "bottlerocket", originally written by Tymm Twillman
(tymm@acm.org) and can be obtained from:

http://mlug.missouri.edu/~tymm/ 

The Bottlerocket package which is an excellent command 
line based Firecracker controller.

The applet contains the bottlerocket code in the form of the
following files:

br_cmd.h
br_cmd.c
br_translate.h

wmx10 simply takes advantage of bottlerocket's "x10_br_out" 
function call, and sends commands to the Firecracker device 
that way.

This version of wmx10 is based on Bottlerocket 0.04.

Using wmx10
--------------------------------------------------------------
wmx10 has several command line options.  To view them, execute

wmx10 -h

To run the program, simply call it on the command line.  To
install it into your dock or Wharf, read the man page of your
window manager.

The gui has several buttons and displays for controlling the
Firecracker.  They are as follows:

-----------------------
|  HOUSE     <letter> |  <-- Displays the current house letter
|                     |
|   prev <num> next   |  <-- "prev" and "next" change the device number
|       OFF  ON       |  <-- These should be obvious...
|                     |
|    DIM    BRIGHT    |  <-- Dim or brighten the current lamp number
|      oooooooo       |  <-- Status display -
-----------------------                     - Green indicates the lamp
					      is turned on or recently
					      brightened. The indicator
					      brightens and dims when
					      the respective button is
					      pushed.
					    - Nothing (gray) indicates
					      the device is off.

* To change the house number from the default of "A", you must
  specify so on the command line.  For example:

     wmx10 B

   will use house code "B".  The Firecracker kit provides house codes
   "A" through "P".  Giving a value beyond these specs will cause 
   wmx10 to abort.

Problems and Possible Solutions
--------------------------------------------------------------
Q: The gui comes up fine, however when I click on, it doesn't
   work!  What do I do?

A: There could be several problems.  Make sure you:
    - Edited "wmx10.h" and changed the #define SERIAL_PORT
      to match the serial port your Firecracker device is on.
      The default value is "/dev/ttyS0" (COM 1 under DOS).
    - Look at the values in br_cmd.c for 
        BitWait, Delay, HoldLoops.
      You may need to increase these values slightly.  
      These are now bottlerocket routines, which you may 
      direct questions to Tymm Twillman (tymm@acm.org).

Q: It won't compile!

A: wmx10 requires several standard X11 libraries.  Tested
   systems include at this point just Linux based ones 
   (Redhat 6, Debian).  Read the docs thoroughly before
   emailing me with any compilation problems.

Q: I get permission denied errors!

A: You will probably need to be root to run this program,
   because you don't have permissions to access the serial
   port device.  Making wmx10 setuid root will solve this 
   problem as well, however consider the usual caveats that
   go with setuid root programs.

Q: I have some other question that's not listed here.

A: Email me and I'll do my best to answer your question.


Copyright
--------------------------------------------------------------
wmx10 is Copyright (c) 1999 by Joshua Hawkins and licensed 
through the GNU General Public License. Read the COPYING file
for the complete GNU license.