Edge software for the reelyActive Owl-in-One based on the Tessel 2 platform. Forwards raddecs from a reel module (BLE) and/or from tcpdump (WiFi) to:
- a remote server via UDP and/or webhook (HTTP POST), and/or
- an Elasticsearch database, and/or
- Google Analytics
For complementary functionality, consider instead:
- tessel-monitor to monitor Bluetooth Low Energy advertising traffic dynamics
- tessel-roam for mobile geolocated data capture
Consult the following tutorials as step-by-step configuration guides:
Clone this repository, browse to its root, then run:
npm install
All configuration parameters can be found in the file config.js. Update only this file, as required.
| Parameter | Description |
|---|---|
| RADDEC_TARGETS | Array of targets for raddec data (see below) |
| DIRACT_PROXIMITY_TARGETS | Array of targets for diract-proximity data |
| DIRACT_DIGEST_TARGETS | Array of targets for diract-digest data |
| ES_NODE | Path to Elasticsearch node |
| IS_UDP_BROADCAST | Set to true if target is UDP broadcast (default: true) |
| LISTEN_TO_REEL | Enable listener on reel module (default: true) |
| LISTEN_TO_TCPDUMP | Enable listener on tcpdump (default: false) |
| ENABLE_MIXING | Combine multiple decodings of an individual transmitter into a single raddec (default: true) |
| MIXING_DELAY_MILLISECONDS | Mixing delay of radio decodings (default: 1000) |
| RADDEC_FILTER_PARAMETERS | (see raddec-filter) |
| INCLUDE_TIMESTAMP | Include the optional timestamp in each raddec (default: true) |
| INCLUDE_PACKETS | Include the optional packets in each raddec (default: true) |
| IS_DEBUG_MODE | Set true and t2 run index.js for console log |
Each raddec target in the RADDEC_TARGETS array is an object with the following properties:
- host: an IP address or hostname (ex: '192.168.1.10')
- port: the target port (default: 50001)
- protocol: either 'udp', 'webhook' (HTTP POST), 'elasticsearch' or 'ua' (Google Analytics)
- tid: required only for Google Analytics (ex: 'UA-1234567-8')
- options: based on the protocol as follows
- webhook defaults are { useHttps: false, path: "/raddecs" }
- ua defaults are { useHttps: true, path: "/collect", page: "/owl-in-one" }
To broadcast UDP to all devices on the subnet, set the host to the corresponding broadcast address (ex: 192.168.1.255) and set IS_UDP_BROADCAST to true.
The DIRACT_PROXIMITY_TARGETS and DIRACT_DIGEST_TARGETS support the 'webhook' and 'elasticsearch' protocols, as described above.
Programming the Tessel 2 requires the t2-cli package which can be installed by following these instructions.
With the Tessel 2 connected to the programming station via USB, from the root of this repository run:
t2 push index.js
The code will be pushed to flash memory on the Tessel and will run every time it boots.
The tessel-edge software expects the following:
- a reel or reelceiver module connected via UART on Port A
- maximum baud rate of Port A set to at least 230400
- tcpdump installed (only if LISTEN_TO_TCPDUMP is true)
MIT License
Copyright (c) 2018-2022 reelyActive
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.