will/easy-usb-relay
1
0
Fork 0
mirror of https://github.com/zyphlar/easy-usb-relay.git synced 2024-03-08 07:57:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
A Node.js library to control USB connected relays
3 Commits 2 Branches 3 Tags 109 KiB
JavaScript 100%
2cf4893252
Go to file
Dana Woodman 2cf4893252 Update module name
2018-07-23 13:09:30 -07:00
examples First pass at the API 🦄 2018-07-23 12:50:02 -07:00
src First pass at the API 🦄 2018-07-23 12:50:02 -07:00
.eslintignore First pass at the API 🦄 2018-07-23 12:50:02 -07:00
.eslintrc.yml First pass at the API 🦄 2018-07-23 12:50:02 -07:00
.gitignore First pass at the API 🦄 2018-07-23 12:50:02 -07:00
.prettierignore First pass at the API 🦄 2018-07-23 12:50:02 -07:00
.prettierrc First pass at the API 🦄 2018-07-23 12:50:02 -07:00
package-lock.json Update module name 2018-07-23 13:09:30 -07:00
package.json Update module name 2018-07-23 13:09:30 -07:00
README.md Update module name 2018-07-23 13:09:30 -07:00

README.md

easy-usb-relay

THIS IS CURRENTLY IN AN EXPERIMENTAL STATE: It does not yet support multiple boards or other manufacturers. Coming soon...

A Node.js library to control USB connected relays

Setup

npm install --save usbrelay

Usage

const { Board } = require('usbrelay')

const numRelays = 2
const relays = new Board(numRelays)

// Turn all relays off:
relays.allOff()

// Turn all relays on:
relays.allOn()

// Turn relay #1 on:
relays.on(1)

// Turn relay #1 off:
relays.off(1)

Please see examples directory for more examples on using usbrelay

API

relays.allOff()

Turn all relays off.

relays.allOn()

Turn all relays on.

relays.on(index)

Turn 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.

relays.off(index)

Turn 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.

Contribute

Contributions welcome! Please submit a Pull Request and make sure to format your code with Prettier and write tests!

License

MIT

Credits

© Dana Woodman 2018