{"id":15011296,"url":"https://github.com/reelyactive/advlib-esp","last_synced_at":"2025-12-28T22:33:42.280Z","repository":{"id":58965330,"uuid":"534651601","full_name":"reelyactive/advlib-esp","owner":"reelyactive","description":"Open source library for decoding EnOcean Serial Protocol (ESP) sensor data packets. We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2024-01-23T15:02:44.000Z","size":110,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-25T23:04:02.901Z","etag":null,"topics":["advlib","enocean","enocean-alliance","node-js","packet-decoding","pareto-anywhere"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/pareto/anywhere/devices/enocean-alliance/","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-09-09T13:21:11.000Z","updated_at":"2024-01-13T21:15:38.000Z","dependencies_parsed_at":"2024-09-24T19:51:34.694Z","dependency_job_id":null,"html_url":"https://github.com/reelyactive/advlib-esp","commit_stats":{"total_commits":20,"total_committers":1,"mean_commits":20.0,"dds":0.0,"last_synced_commit":"7655a5768ffef49efa30f36224e9c29076d40d9c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-esp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-esp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-esp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-esp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/advlib-esp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243307333,"owners_count":20270256,"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":["advlib","enocean","enocean-alliance","node-js","packet-decoding","pareto-anywhere"],"created_at":"2024-09-24T19:40:30.781Z","updated_at":"2025-12-28T22:33:42.275Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"advlib-esp\n==========\n\nWireless advertising packet decoding library for EnOcean Alliance devices via the EnOcean Serial Protocol (ESP).  __advlib-esp__ can be used standalone or, more commonly, as a processor module of the protocol-agnostic [advlib](https://github.com/reelyactive/advlib) library.\n\n![Overview of advlib-esp](https://reelyactive.github.io/advlib-esp/images/overview.png)\n\n__advlib-esp__ is a lightweight [Node.js package](https://www.npmjs.com/package/advlib-esp) that implements the subset of ESP3 specific to sensor data and radio-identification, and can be extended with libraries to decode EnOcean Equipment Profiles (EEP).\n\n| Library | Decodes |\n|:--------|:--------|\n| [advlib-eep-vld](https://github.com/reelyactive/advlib-eep-vld) | Variable-length data (VLD) telegrams |\n| [advlib-eep-4bs](https://github.com/reelyactive/advlib-eep-4bs) | 4-byte sensor (4BS) telegrams |\n| [advlib-eep-rps](https://github.com/reelyactive/advlib-eep-rps) | Rocker position switch (RPS) telegrams |\n| [advlib-eep-msc](https://github.com/reelyactive/advlib-eep-msc) | Manufacturer-specific communication (MSC) telegrams |\n\n\nInstallation\n------------\n\n    npm install advlib-esp\n\n\nHello advlib-esp!\n-----------------\n\n```javascript\nconst advlib = require('advlib-esp');\n\nconst LIBRARIES = [ require('advlib-eep-vld'),\n                    require('advlib-eep-4bs'),\n                    require('advlib-eep-rps'),\n                    require('advlib-eep-msc') ];\n\nlet packet = '55000707017ad5090591ee968001ffffffff47003c';\nlet processedPacket = advlib.process(packet, LIBRARIES);\n\nconsole.log(processedPacket);\n```\n\nWhich should yield the following console output:\n\n    { type: \"RADIO_ERP1\",\n      dataLength: 7,\n      optionalLength: 7,\n      telegramType: \"1BS\",\n      deviceIds: [ \"0591ee96/7\" ],\n      isContactDetected: [ true ],\n      uri: \"https://sniffypedia.org/Organization/EnOcean_Alliance/\" }\n\n\nOptions\n-------\n\n__advlib-esp__ supports the following options for its process function:\n\n| Property               | Default | Description                         | \n|:-----------------------|:--------|:------------------------------------|\n| ignoreProtocolOverhead | false   | Ignore non-sensor \u0026 non-identifier properties (type, dataLength, optionalLenth, telegramType, etc.) |\n| isERP1PayloadOnly      | false   | Interpret data as an ERP1 payload only (i.e. only the data portion of the RADIO_ERP1 ESP packet) |\n| deviceProfiles         | {}      | Map or Object of devices indexed by device signature and containing EEP types to facilitate decoding |\n\nFor example, to ignore the Enocean Serial Protocol (ESP) overhead, and to provide only an ERP1 payload, and to specify the profile for the given device (or simply for all devices):\n\n```javascript\nlet payload = 'd29165c02963e4f5d8000414006980';\nlet deviceProfiles = { \"04140069/7\": { eepType: \"D2-14-41\" } };\nlet options = {\n    ignoreProtocolOverhead: true,\n    isERP1PayloadOnly: true,\n    deviceProfiles: deviceProfiles\n};\nlet processedPacket = advlib.process(payload, LIBRARIES, options);\n```\n\nWhich should yield the following console output:\n\n    { deviceIds: [ \"04140069/7\" ],\n      acceleration: [ -0.01, -0.045, 1.02 ],\n      illuminance: 331,\n      isContactDetected: [ false ],\n      isMotionDetected: [ false ],\n      relativeHumidity: 75.5,\n      temperature: 18.1\n      uri: \"https://sniffypedia.org/Organization/EnOcean_Alliance/\" }\n\nNote that each device signature in the deviceProfiles is a combination of the 32-bit EnOcean Unique Radio Identifier of the device and [\"/7\" which specifies the EURID-32 type](https://github.com/reelyactive/raddec#identifier-types).\n\n\nSupported EnOcean Equipment Profiles\n------------------------------------\n\n1BS (1-Byte Sensor) EEPs, as listed in the table below, are currently supported directly by __advlib-esp__.  Other telegram types are supported by extension of the libraries described above. \n\n| EEP      | Profile Name         |\n|:---------|:---------------------|\n| D5-00-01 | Single Input Contact |\n\nSee [www.reelyactive.com/pareto/anywhere/devices/enocean-alliance/](https://www.reelyactive.com/pareto/anywhere/devices/enocean-alliance/) for a list of all EEPs supported by our [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source IoT middleware.\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-2025 [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%2Fadvlib-esp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fadvlib-esp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fadvlib-esp/lists"}