node-zowi v0.2.5

About

Nodejs wrapper for BQ Zowi Robot

❤️ Awesome Features:

• Out of the box simple Interface. 🔥
• USB Support (including auto-port selection) 🍺
• Commands library mapped out (gestures, sounds, buzzer, movements...) 🎉
• Direct support to listen Bus communications 🔊
• General information available with a configurable interval (distance, noise, battery level...) 👾
• debug is supported 💪
• Refresh time is customizable 🧐
• Easy to use and great test coverage ✅

Installation

npm install node-zowi

Usage

const zowi = require('./lib')()

;(async () => {
  const { commands } = zowi
  const { getHealth, onClaim, obey } = await zowi.start({ checkVitals: true })

  // Let's check the health in 5 segs
  setTimeout(() => {
    console.log('Health:', getHealth())
  }, 5000)

  // Log all the messages from the serial comms
  onClaim(console.log)

  // Let's send some commands
  await obey(commands.buzzer.tone(3000, 1000))
  console.log('Sent Tone Request!')

  await obey(commands.sounds.ohOoh2())
  console.log('Sent OhOhh Sound Request!')

  await obey(commands.gestures.superHappy())
  console.log('Sent Gesture Request!')
})()

Making off :muscle:

This project was under development for a very long time across engineering clasess with my students and software events.

Finally I managed to finish the library and publish a solid initial version.

Fictizia Master'19

Full video

JsDayCanarias 2019

Built With

Development only:

• Standard - Linting propuses
• Husky - Git Hooks
• commitlint - Linting commit messages
• jest - Testing
• standard - Linting
• standard-version - Manage changelog and releases

Production only:

• debug - Debug the app
• serialport - Access serial ports with JavaScript
• @serialport/parser-readline - Transfirmation

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ulises Gascón - Initial work- - @ulisesGascon

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU AGPL3.0 License - see the LICENSE.md file for details

Acknowledgments

• This project is under development, but you can help us to improve it! We :heart: FOSS!