Skip to content
Edge software for reelyActive Owl-in-One based on the Tessel 2 platform. We believe in an open Internet of Things.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.npmrc
.tesselinclude
LICENSE
README.md
config.js
index.js
package.json

README.md

tessel-edge

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).

Consult the following tutorials for a step-by-step configuration guide:

Installation

Clone this repository, browse to its root, then run:

npm install

Configuration

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)
IS_UDP_BROADCAST Set to true if target is UDP broadcast (default: false)
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)
INCLUDE_TIMESTAMP Include the optional timestamp in each raddec (default: true)
INCLUDE_PACKETS Include the optional packets in each raddec (default: true)

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: the transport protocol, either 'udp' or 'webhook' (HTTP POST)
  • options: in the case of a 'webhook' the defaults are { useHttps: false, path: '/raddecs' }, which can be overridden

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.

Programming

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.

Prerequisites

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

License

MIT License

Copyright (c) 2018-2019 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.

You can’t perform that action at this time.