{"id":22860002,"url":"https://github.com/reelyactive/barnowl-enocean","last_synced_at":"2025-03-31T08:22:53.077Z","repository":{"id":61074565,"uuid":"528161654","full_name":"reelyactive/barnowl-enocean","owner":"reelyactive","description":"Collect ambient EnOcean Wireless Standard packets from EnOcean Serial Protocol (ESP) devices.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2024-01-23T16:57:37.000Z","size":78,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-25T10:02:41.272Z","etag":null,"topics":["barnowl","enocean","enocean-alliance","pareto-anywhere","raddec"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/pareto/anywhere/","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":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-08-23T21:01:34.000Z","updated_at":"2022-10-27T23:15:05.000Z","dependencies_parsed_at":"2024-12-13T09:08:41.614Z","dependency_job_id":"9ed22f80-dcd1-44b0-ac56-96fca33530f1","html_url":"https://github.com/reelyactive/barnowl-enocean","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"5bd64f0ee56bddf98a8de1d1d9baad64bd77f6b5"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-enocean","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-enocean/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-enocean/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-enocean/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/barnowl-enocean/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436981,"owners_count":20777129,"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":["barnowl","enocean","enocean-alliance","pareto-anywhere","raddec"],"created_at":"2024-12-13T09:08:39.411Z","updated_at":"2025-03-31T08:22:53.061Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"barnowl-enocean\n===============\n\n__barnowl-enocean__ converts ambient EnOcean Wireless Standard packets collected from EnOcean Serial Protocol (ESP) devices into standard developer-friendly JSON that is vendor/technology/application-agnostic.\n\n![Overview of barnowl-enocean](https://reelyactive.github.io/barnowl-enocean/images/overview.png)\n\n__barnowl-enocean__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-enocean) that can run on resource-constrained edge devices.  It is typically run behind a [barnowl](https://github.com/reelyactive/barnowl) instance which is included in the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite.\n\n\nGetting Started\n---------------\n\nLearn \"owl\" about the __raddec__ JSON data output:\n-  [reelyActive Developer's Cheatsheet](https://reelyactive.github.io/diy/cheatsheet/)\n\n\nQuick Start\n-----------\n\nClone this repository, install package dependencies with `npm install`, and then from the root folder run at any time:\n\n    npm start\n\n__barnowl-enocean__ will attempt to connect to an EnOcean Serial Protocol device (ex: USB dongle) and output (flattened) __raddec__ JSON to the console.\n\n\nHello barnowl-enocean!\n----------------------\n\nThe following code will listen to _simulated_ hardware and output packets to the console:\n\n```javascript\nconst BarnowlEnOcean = require('barnowl-enocean');\n\nlet barnowl = new BarnowlEnOcean();\n\nbarnowl.addListener(BarnowlEnOcean.TestListener, {});\n\nbarnowl.on(\"raddec\", function(raddec) {\n  console.log(raddec);\n});\n\nbarnowl.on(\"infrastructureMessage\", function(message) {\n  console.log(message);\n});\n```\n\nAs output you should see a stream of [raddec](https://github.com/reelyactive/raddec/) objects similar to the following:\n\n```javascript\n{\n  transmitterId: \"04141559\",\n  transmitterIdType: 7,\n  rssiSignature: [\n    {\n      receiverId: \"38bdfde8b5e5415a830551bda6484c23\",\n      receiverIdType: 6,\n      rssi: -58,\n      numberOfDecodings: 1\n    }\n  ],\n  packets: [ '55000f07012bd295db00b163e0f85800041415598001ffffffff3b0047' ],\n  timestamp: 1645568542222\n}\n```\n\nRegardless of the underlying RF protocol and hardware, the [raddec](https://github.com/reelyactive/raddec/) specifies _what_ (transmitterId) is _where_ (receiverId \u0026 rssi), as well as _how_ (packets) and _when_ (timestamp).\n\n\nIdentifiers and Packet Formats\n------------------------------\n\nThe `receiverId` is a 128-bit UUID, which, as of v1.0.0, is generated on a per-session basis.  In future versions, this UUID may remain persistent across sessions for a specific USB dongle.\n\nEach `packets` entry is an EnOcean Serial Protocol 3 (ESP3) packet (from Sync byte to CRC8D, inclusive).\n\n\nSupported Listener Interfaces\n-----------------------------\n\nThe following listener interfaces are supported.\n\n### Serial\n\nListen on a local serial interface to an EnOcean Serial Protocol (ESP) device.  Check the [serialport](https://serialport.io/docs/guide-installation) package for prerequisites specific to the target platform if any problems are encountered.\n\n```javascript\nbarnowl.addListener(BarnowlEnOcean.SerialListener, { path: \"auto\" });\n```\n\nOn Ubuntu, it may be necessary to add the user to the _dialout_ group in order to have the necessary permissions to access the device, which can be accomplished with the command ```sudo usermod -a -G dialout $USER``` and made to take effect by logging out and back in to the user account.\n\n### Test\n\nProvides a steady stream of simulated packets for testing purposes.\n\n```javascript\nbarnowl.addListener(BarnowlEnOcean.TestListener, {});\n```\n\n\nIs that owl you can do?\n-----------------------\n\nWhile __barnowl-enocean__ may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software packages:\n- [advlib](https://github.com/reelyactive/advlib) to decode the individual packets from hexadecimal strings into JSON\n- [barnowl](https://github.com/reelyactive/barnowl) to combine parallel streams of RF decoding data in a technology-and-vendor-agnostic way\n\nThese packages and more are bundled together as the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere) open source middleware suite, which includes several __barnowl-x__ listeners.\n\n\nPareto Anywhere Integration\n---------------------------\n\n__barnowl-enocean__ includes a script to forward data to a local [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) instance as UDP raddecs with target localhost:50001.  Start this script with the command:\n\n    npm run forwarder\n\nInstall __Pareto Anywhere__ _and_ __barnowl-enocean__ by following a step-by-step tutorial on our [reelyActive Developers](https://reelyactive.github.io/) site:\n- [Run Pareto Anywhere on a PC](https://reelyactive.github.io/diy/pareto-anywhere-pc/)\n- [Run Pareto Anywhere on a Pi](https://reelyactive.github.io/diy/pareto-anywhere-pi/)\n\n\nProject History\n---------------\n\n__barnowl-enocean__ v1.0.0 was released in January 2024, superseding all earlier versions, the latest of which remains in the [release-0.3 branch](https://github.com/reelyactive/barnowl-enocean/tree/release-0.3) and as [barnowl-enocean@0.3.1 on npm](https://www.npmjs.com/package/barnowl-enocean/v/0.3.1).\n\n\nContributing\n------------\n\nDiscover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).\n\n\nSecurity\n--------\n\nConsult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2022-2024 [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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-enocean","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fbarnowl-enocean","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-enocean/lists"}