{"id":19517453,"url":"https://github.com/ivkos/sds011-client","last_synced_at":"2025-09-02T21:37:02.698Z","repository":{"id":57371609,"uuid":"121000138","full_name":"ivkos/sds011-client","owner":"ivkos","description":null,"archived":false,"fork":false,"pushed_at":"2024-06-04T21:54:56.000Z","size":118,"stargazers_count":7,"open_issues_count":3,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-04T09:11:20.391Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ivkos.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}},"created_at":"2018-02-10T08:55:52.000Z","updated_at":"2023-12-04T08:38:20.000Z","dependencies_parsed_at":"2023-02-09T02:45:38.205Z","dependency_job_id":null,"html_url":"https://github.com/ivkos/sds011-client","commit_stats":{"total_commits":65,"total_committers":2,"mean_commits":32.5,"dds":0.3538461538461538,"last_synced_commit":"7a6d129c19515910d5570080d70c6bc1cd41a1c9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fsds011-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fsds011-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fsds011-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fsds011-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivkos","download_url":"https://codeload.github.com/ivkos/sds011-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250944118,"owners_count":21511696,"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":[],"created_at":"2024-11-11T00:03:43.773Z","updated_at":"2025-04-26T06:31:20.964Z","avatar_url":"https://github.com/ivkos.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"SDS011 Client for Node.js\n=========\n[![Build Status](https://travis-ci.org/ivkos/sds011-client.svg?branch=master)](https://travis-ci.org/ivkos/sds011-client)  [![Codecov](https://img.shields.io/codecov/c/github/ivkos/sds011-client.svg)](https://codecov.io/gh/ivkos/sds011-client)\n\n\nAir quality measurements made easy with client library for SDS011 UART interface.\n\nSave your time and focus on specific IoT solution instead of serial communication.\n\n[![NPM](https://nodei.co/npm/sds011-client.png)](https://npmjs.org/package/sds011-client)\n\n## Watch out!\n\nNova Fitness SDS011 laser is designed for 8000 hours of continuous use - this is less than one year. It is recommended to configure [working period](https://github.com/ivkos/sds011-client/wiki/API#SDS011Client+setWorkingPeriod) to extend life span of your solution.\n\n## Synopsis\n\n1. Require the module\n```js\nconst SDS011Client = require(\"sds011-client\");\n```\n2. Connect to your sensor through serial port\n```js\nconst sensor = new SDS011Client(\"COM5\");\n```\n3. Configure\n```js\nPromise\n    .all([sensor.setReportingMode('active'), sensor.setWorkingPeriod(10)])\n    .then(() =\u003e {\n        // everything's set\n    });\n```\n4. Do awesome things\n```js\nsensor.on('reading', r =\u003e {\n    if (r.pm2p5 \u003e 10) {\n        powerAirPurifierOn();\n    } else {\n        powerAirPurifierOff();\n    }\n});\n```\n\n## Installation\n\n  `npm install sds011-client`\n\n## Usage\n\n- Check the 'examples' folder.\n- See the [API docs](https://github.com/ivkos/sds011-client/wiki/API)\n\n## Contributors\n\nThis project is based on the original work by [Michał Wilski](https://github.com/triforcely) - [SDS011-Wrapper](https://github.com/triforcely/sds011-wrapper).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fsds011-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivkos%2Fsds011-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fsds011-client/lists"}