Browse Source

Add readme and license.

master
flabbergast 3 years ago
parent
commit
5e07807c41
  1. 7
      LICENSE
  2. 49
      README.md

7
LICENSE

@ -0,0 +1,7 @@
Copyright 2018 flabbergast@drak.xyz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

49
README.md

@ -0,0 +1,49 @@
# jeethru
The "usual" (well, mine anyway) small sensor network layout using [jeenode]s:
```
{{jeenode sensor(s)...}} <~~[radio]~~>
<~~> {{jeenode gateway}} <--UART-->
/--------------- computer ---------------\
<-->|{ser2net} <--TCP--> {jeethru} <-> .... |
\----------------------------------------/
```
The aim of this project is to provide a single binary daemon, which listens on a TCP port (with the expectation of incoming [jeenode] gateway messages), processes them (i.e. decodes the RF12demo-formwatted messages into meaningful sensor data), and then pushes them further. The output options are:
* Another TCP port. This works as a simple forwarder, i.e. no decoding is done and the incoming messages are just relayed further. This relaying actually works both ways (i.e. also *towards* the jeenode gateway). However this daemon accepts more than one simultaneous connection (so it can act as a multiplexer for [ser2net], which is usually used to relay the UART/serial messages from the gateway to/from TCP).
* Plain CSV files (one line per reading, one file per type).
* Publish MQTT messages (this is also potentially two-way, but the "to gateway" direction is not implemented yet).
* Insert into MongoDB database.
This program is written in [rust], which is excellent in producing single static binaries which can be just copied around; and it is also very simple to cross-compile (e.g. using [this docker setup](https://github.com/messense/rust-musl-cross), I compile on my laptop and just copy the resulting binary to [my pocket beagle](https://flabbergast.drak.xyz/posts/pb-rfmcape/)).
One drawback is that the "decoding the gateway messages" bit is hardcoded into the program (see `sensordata.rs` and `decode_jee.rs` source files), so if anyone wants to use this, they will need to have a look at the code and modify for their own sensor types/
devices.
I wrote this program primarily for myself and my own small sensor network (and as a thing for learning [rust]), and I have no illusions about anyone else using this ;) So hardcoding the sensors was good enough for me. Also, because of the brutal ease of cross-compiling and having a single binary daemon with no dependencies, I do not feel compelled to implement some complicated sensordata configuration system.
## license
The project is licensed under [MIT license].
[MIT license]: https://git.drak.xyz/flabbergast/jeethru/src/branch/master/LICENSE
[jeenode]: https://www.digitalsmarties.net/
[ser2net]: http://ser2net.sourceforge.net/
[rust]: https://www.rust-lang.org/
Loading…
Cancel
Save