Browse Source

Add README.md

master
Peter J. Jones 2 years ago
parent
commit
60ff13959d
Signed by: Peter Jones <pjones@devalot.com> GPG Key ID: 9DAFAA8D01941E49
1 changed files with 21 additions and 0 deletions
  1. 21
    0
      README.md

+ 21
- 0
README.md View File

@@ -0,0 +1,21 @@
1
+# zigbee-commander -- Manage a Network of ZigBee Devices
2
+
3
+This is a very incomplete (yet working) Haskell library and
4
+command-line tool for controlling a network of ZigBee/XBee devices.
5
+In order to work, this tool assumes there is a ZigBee device connected
6
+to a USB port which it can command with `AT` frames.
7
+
8
+The basic idea is to start a "server" with a YAML configuration file.
9
+(See the `examples` directory for example configuration files.)
10
+
11
+As events in the network fire, the configuration file tells the
12
+commander how to respond.  You can respond by changing the state of a
13
+node or by running a shell command.
14
+
15
+## Forked Dependencies
16
+
17
+The `vendor` directory contains changes to the `serialport` package
18
+and the `zigbee-znet25` package.  I sent pull requests/patches to the
19
+upstream packages but they both seem to be inactive.
20
+
21
+That means you need to build using my forked copies in `vendor`.

Loading…
Cancel
Save