{"id":15639848,"url":"https://github.com/danawoodman/easy-usb-relay","last_synced_at":"2025-04-13T14:25:58.663Z","repository":{"id":57676283,"uuid":"142062055","full_name":"danawoodman/easy-usb-relay","owner":"danawoodman","description":"A Node.js library to control USB connected relays","archived":false,"fork":false,"pushed_at":"2018-10-06T01:11:30.000Z","size":148,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-08T20:36:40.194Z","etag":null,"topics":["control","electronics","hardware","hid","iot","relay","sainsmart","usb"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danawoodman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-23T19:50:14.000Z","updated_at":"2021-01-16T14:42:21.000Z","dependencies_parsed_at":"2022-09-02T22:31:19.738Z","dependency_job_id":null,"html_url":"https://github.com/danawoodman/easy-usb-relay","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danawoodman%2Feasy-usb-relay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danawoodman%2Feasy-usb-relay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danawoodman%2Feasy-usb-relay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danawoodman%2Feasy-usb-relay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danawoodman","download_url":"https://codeload.github.com/danawoodman/easy-usb-relay/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229056730,"owners_count":18013282,"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":["control","electronics","hardware","hid","iot","relay","sainsmart","usb"],"created_at":"2024-10-03T11:27:59.416Z","updated_at":"2024-12-10T11:41:12.781Z","avatar_url":"https://github.com/danawoodman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# easy-usb-relay\n\n**THIS IS CURRENTLY IN AN EXPERIMENTAL STATE:** It does not yet support multiple boards or other manufacturers. Coming soon...\n\n\u003e A Node.js library to control USB connected relays\n\n## Setup\n\n```bash\nnpm install --save easy-usb-relay\n```\n\n## Usage\n\n```js\nconst { Board } = require('easy-usb-relay')\n\nconst numRelays = 2\nconst relays = new Board(numRelays)\n\n// Turn all relays off:\nrelays.allOff()\n\n// Turn all relays on:\nrelays.allOn()\n\n// Turn relay #1 on:\nrelays.on(1)\n\n// Turn relay #1 off:\nrelays.off(1)\n```\n\nPlease see [examples directory](/examples) for more examples on using `easy-usb-relay`\n\n## API\n\n### `relays.allOff()`\n\nTurn all relays off.\n\n### `relays.allOn()`\n\nTurn all relays on.\n\n### `relays.on(index)`\n\nTurn relay with `index` on. Index starts at `1` and goes to the number of available relays. Throws an exception if the relay `index` is greater than the available number of relays.\n\n### `relays.off(index)`\n\nTurn relay with `index` off. Index starts at `1` and goes to the number of available relays. Throws an exception if the relay `index` is greater than the available number of relays.\n\n## Contribute\n\nContributions welcome! Please submit a Pull Request and make sure to format your code with Prettier and write tests!\n\n## License\n\nMIT\n\n## Credits\n\n\u0026copy; [Dana Woodman](http://danawoodman.com) 2018\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanawoodman%2Feasy-usb-relay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanawoodman%2Feasy-usb-relay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanawoodman%2Feasy-usb-relay/lists"}