update changelog entry, add new content to the README.Debian file
[debian/gcpegg] / debian / README.debian
1 The upstream source assumes you will use a traditional hard-wired serial
2 port, but those are getting rare.  Rather than refactor the code, I've just
3 made the Debian package always open the device /dev/REG.  Associated with this,
4 the package delivers a udev rules file that creates a /dev/REG symlink to
5 /dev/ttyS0.  If you need some other device linked, creating an appropriate udev
6 rule is likely the best way to do that.
7
8 The 'port' field in the REG line of the eggrc file will be ignored, so just
9 leave it set to '0'.
10
11                         - - - - -
12
13 The systemd service file used to invoke the daemon hard-codes virtual terminal
14 8 as the place to run the eggsh program.  That means you can use Alt-F8 on
15 your system's console to go see what the program is doing.  Note that we're
16 assuming the machine running this program is not running X.  If it is, you
17 may need to tweak the service file to pick some other virtual terminal.
18
19                         - - - - -
20
21 If the EGG computer is behind a firewall, it must be programmed
22 to allow UDP packets on port 2510 outgoing packet and UDP port
23 1105 for an incoming connection.
24
25 This allows the bidirectional communication required for the data
26 to be transmitted. What happens is that your program sends an
27 "awake" packet when it has unsent data. The server in Princeton
28 responds with a "data request" packet, and then the EGG program
29 will send the data.
30