{"id":22860077,"url":"https://github.com/reelyactive/hlc-server","last_synced_at":"2025-04-30T17:46:22.538Z","repository":{"id":20442495,"uuid":"23719381","full_name":"reelyactive/hlc-server","owner":"reelyactive","description":"Serves real-time real-world context at a human scale by combining RFID, RTLS and M2M with structured, linked data on the web.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2023-08-15T11:14:43.000Z","size":2770,"stargazers_count":9,"open_issues_count":2,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-17T09:50:40.671Z","etag":null,"topics":["bluetooth-low-energy","hyperlocal-context","iot-platform","m2m","nodejs","pareto-anywhere","rtls"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/context/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reelyactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-09-05T21:47:22.000Z","updated_at":"2024-04-19T12:29:27.000Z","dependencies_parsed_at":"2024-12-13T09:08:57.778Z","dependency_job_id":"674cea7c-139f-43b5-af11-3bad11e30e67","html_url":"https://github.com/reelyactive/hlc-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fhlc-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fhlc-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fhlc-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fhlc-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/hlc-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251754223,"owners_count":21638477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bluetooth-low-energy","hyperlocal-context","iot-platform","m2m","nodejs","pareto-anywhere","rtls"],"created_at":"2024-12-13T09:08:52.645Z","updated_at":"2025-04-30T17:46:22.513Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","readme":"hlc-server\n==========\n\nHyperlocal context (HLC) server combining all the core open source software packages of [Pareto Anywhere by reelyActive](https://www.reelyactive.com/pareto/anywhere/) for convenience and ease of exploration of features and applications.  _Observe who/what is where/how, in real time, in any physical space_ ([learn more](https://reelyactive.github.io/diy/rfid-unity/)). Just add [radio-identification infrastructure](https://www.reelyactive.com/pareto/anywhere/infrastructure/) to harness ambient source data.\n\n__hlc-server__ has been superseded by [pareto-anywhere](https://github.com/reelyactive/pareto-anywhere/) and is no longer under active development.\n\n\nGetting Started Tutorials\n-------------------------\n\nThe easiest way to get started with __hlc-server__:\n- [Install our open source software suite on a Laptop](https://reelyactive.github.io/diy/laptop-suite/)\n- [Install our open source software suite on a Pi](https://reelyactive.github.io/diy/pi-suite/)\n\n_However,_ we recommend migration to __pareto-anywhere__:\n- [Run Pareto Anywhere on a PC](https://reelyactive.github.io/diy/pareto-anywhere-pc/)\n- [Run Pareto Anywhere on a Raspberry Pi](https://reelyactive.github.io/diy/pareto-anywhere-pi/)\n\n\nInstallation and Quick Start\n----------------------------\n\nIt is possible to install and run __hlc-server__ using either [npm](https://www.npmjs.com/) or [Docker](https://www.docker.com/).\n\n### Using git and npm\n\n```\ngit clone https://github.com/reelyactive/hlc-server.git\ncd hlc-server\nnpm install\n```\n\nAdd then to run:\n\n```\nnpm start\n```\n\n### Using Docker\n\n```\ndocker run -p 3001:3001 -p 50000:50000/udp -p 50001:50001/udp reelyactive/hlc-server\n```\n\n\nHello Hyperlocal Context\n------------------------\n\nBrowse to [localhost:3001](http://localhost:3001) to see the landing page.\n\n__hlc-server__ will listen for data as follows:\n- reel packets over UDP on port 50000 (via [barnowl-reel](https://github.com/reelyactive/barnowl-reel) UdpListener)\n- encoded [raddecs](https://github.com/reelyactive/raddec) over UDP on port 50001\n- data using Minew's _Binary Long_ format via HTTP POST to /minew\n\n__hlc-server__ will output data as follows:\n- [socket.io](https://socket.io/) stream on port 3001 (via [barnacles-socketio](https://github.com/reelyactive/barnacles-socketio))\n- decoded [raddecs](https://github.com/reelyactive/raddec) to Elasticsearch, if an instance is running (by default on port 9200)\n\n![Default I/O](https://reelyactive.github.io/hlc-server/images/default-io.png)\n\n\nWeb Apps\n--------\n\nA 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](http://localhost:3001).  These web apps are built with the open source _beacorcut_ stack of [beaver.js](https://github.com/reelyactive/beaver), [cormorant.js](https://github.com/reelyactive/cormorant) and [cuttlefish.js](https://github.com/reelyactive/cuttlefish).\n\n\nArchitecture Overview\n---------------------\n\nNote that the integration of some open source software packages with hlc-server is still a work in progress.\n\n![Architecture Overview](https://reelyactive.github.io/hlc-server/images/architecture-overview.png)\n\n\nEnvironment Variables\n---------------------\n\n__hlc-server__ observes the following environment variables:\n\n| Environment Variable | Default               | Description                 | \n|:---------------------|:----------------------|:----------------------------|\n| PORT                 | 3001                  | The hlc-server port         |\n| REEL_PORT            | 50000                 | The port on which to listen for reel packets over UDP |\n| RADDEC_PORT          | 50001                 | The port on which to listen for raddecs over UDP |\n| ELASTICSEARCH_NODE   | http://localhost:9200 | The Elasticsearch node      |\n\n\nAdd listeners and interfaces\n----------------------------\n\n__hlc-server__ wraps the [barnowl](https://github.com/reelyactive/barnowl/) addListener() function and the [barnacles](https://github.com/reelyactive/barnacles/) addInterface() function to facilitate adding listeners and interfaces.\n\n### addListener()\n\nAdd any [barnowl-x listener](https://github.com/reelyactive/barnowl#where-to-listen) to connect with a hardware interface in just two lines of code.  For example, to listen for reel data over a serial connection:\n\n```javascript\nconst HLCServer = require('hlc-server');\nconst BarnowlReel = require('barnowl-reel'); // 1: Include the interface package\n\nlet app = new HLCServer();\n\n// 2: Add the specific listener with relevant options\napp.addListener(BarnowlReel, {}, BarnowlReel.SerialListener, { path: \"auto\" });\n```\n\n### addInterface()\n\nAdd any [barnacles-x interface](https://github.com/reelyactive/barnacles#how-to-distribute-data) to distribute the data stream in just two lines of code.  For example, to forward data via a webhook:\n\n```javascript\nconst HLCServer = require('hlc-server');\nconst BarnaclesWebhook = require('barnacles-webhook'); // 1: Include the package\n\nlet app = new HLCServer();\n\n// 2: Add the interface with relevant options\napp.addInterface(BarnaclesWebhook, { hostname: \"127.0.0.1\", port: 3000 });\n```\n\n\nWhat's next?\n------------\n\n__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](https://github.com/reelyactive/hlc-server/tree/release-0.5) and as [hlc-server@0.5.21 on npm](https://www.npmjs.com/package/hlc-server/v/0.5.21).\n\nThe v1.0 release of __hlc-server__ is a work in progress as the v1.0 releases of [barnowl](https://github.com/reelyactive/barnowl/), [barnacles](https://github.com/reelyactive/barnacles/), [chickadee](https://github.com/reelyactive/chickadee/), [barterer](https://github.com/reelyactive/barterer/), [beaver](https://github.com/reelyactive/beaver/), [cormorant](https://github.com/reelyactive/cormorant/) and [cuttlefish](https://github.com/reelyactive/cuttlefish/) evolve and/or become available.  The objective is to combine all these ingredients required for [hyperlocal context](https://www.reelyactive.com/context/) in a user-friendly deploy-anywhere package/container that promotes discovery and experimentation.\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2014-2022 [reelyActive](https://www.reelyactive.com)\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR \nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, \nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE \nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER \nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN \nTHE SOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fhlc-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fhlc-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fhlc-server/lists"}