Nepotistic Pontifex Maximus
Join us to discuss the challenges, solutions and best practices for in-house JavaScript code sharing. Tuesday, 12/17 at 10am PT/1pm ET.Sign up here »

hlc-server

1.0.18 • Public • Published

hlc-server

Hyperlocal context (HLC) server combining all the core open source software packages of the reelyActive stack for convenience and ease of exploration of features and applications. Observe who/what is where/how, in real time, in any physical space. Just add radio infrastructure (ex: RFID readers, Raspberry Pi, ...) for source data.

Getting Started Tutorials

The easiest way to get started with hlc-server:

Installation and Quick Start

It is possible to install and run hlc-server using either npm or Docker.

Using git and npm

git clone https://github.com/reelyactive/hlc-server.git
cd hlc-server
npm install

Add then to run:

npm start

Using Docker

docker run -p 3001:3001 -p 50000:50000/udp -p 50001:50001/udp reelyactive/hlc-server

Hello Hyperlocal Context

Browse to localhost:3001 to see the landing page.

hlc-server will listen for data as follows:

  • reel packets over UDP on port 50000 (via barnowl-reel UdpListener)
  • encoded raddecs over UDP on port 50001

hlc-server will output data as follows:

Default I/O

Web Apps

A variety of web apps designed to make it easy to familiarise oneself with the many platform features and capabilities can be accessed via the landing page at localhost:3001. These web apps are built with the open source beacorcut stack of beaver.js, cormorant.js and cuttlefish.js.

Architecture Overview

Note that the integration of some open source software packages with hlc-server is still a work in progress.

Architecture Overview

Environment Variables

hlc-server observes the following environment variables:

Environment Variable Default Description
PORT 3001 The hlc-server port
REEL_PORT 50000 The port on which to listen for reel packets over UDP
RADDEC_PORT 50001 The port on which to listen for raddecs over UDP
ELASTICSEARCH_NODE http://localhost:9200 The Elasticsearch node

Add listeners and interfaces

hlc-server wraps the barnowl addListener() function and the barnacles addInterface() function to facilitate adding listeners and interfaces.

addListener()

Add any barnowl-x listener to connect with a hardware interface in just two lines of code. For example, to listen for reel data over a serial connection:

const HLCServer = require('hlc-server');
const BarnowlReel = require('barnowl-reel'); // 1: Include the interface package
 
let app = new HLCServer();
 
// 2: Add the specific listener with relevant options
app.addListener(BarnowlReel, {}, BarnowlReel.SerialListener, { path: "auto" });

addInterface()

Add any barnacles-x interface to distribute the data stream in just two lines of code. For example, to forward data via a webhook:

const HLCServer = require('hlc-server');
const BarnaclesWebhook = require('barnacles-webhook'); // 1: Include the package
 
let app = new HLCServer();
 
// 2: Add the interface with relevant options
app.addInterface(BarnaclesWebhook, { hostname: "127.0.0.1", port: 3000 });

What's next?

hlc-server v1.0.0 was released in February 2019, superseding all earlier versions, the latest of which remains available in the release-0.5 branch and as hlc-server@0.5.21 on npm.

The v1.0 release of hlc-server is a work in progress as the v1.0 releases of barnowl, barnacles, chickadee, barterer, beaver, cormorant and cuttlefish evolve and/or become available. The objective is to combine all these ingredients required for hyperlocal context in a user-friendly deploy-anywhere package/container that promotes discovery and experimentation.

License

MIT License

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

Install

npm i hlc-server

DownloadsWeekly Downloads

171

Version

1.0.18

License

MIT

Unpacked Size

2.04 MB

Total Files

60

Last publish

Collaborators

  • avatar