Home Explore Help
Sign In
zhilong
/
smartknob
mirror of https://github.com/scottbez1/smartknob.git
1
0
Fork 0
Files Issues 0 Wiki
Tree: 948297fa82
Branches Tags
smartknob
/
software
/
js
Scott Bezek 2afc38f7f9 Updated config schema, improved demo (#121) 2 years ago
..
packages 2afc38f7f9 Updated config schema, improved demo (#121) 2 years ago
.gitignore ae28d523e0 Protobuf serial protocol (#101) 3 years ago
.npmrc ae28d523e0 Protobuf serial protocol (#101) 3 years ago
README.md 9431ed3971 New detent configurations (magnetic and biased-to-center) and demo React app (#105) 3 years ago
package-lock.json 2afc38f7f9 Updated config schema, improved demo (#121) 2 years ago
package.json 9431ed3971 New detent configurations (magnetic and biased-to-center) and demo React app (#105) 3 years ago

README.md

Typescript SmartKnob protobuf interface library and examples

Requirements (nvm is recommended)

  • node >= 18.11.0
  • npm >= 8.19.2

Setup

npm ci
npm run build

Example

A basic Node.js CLI example. Connect the SmartKnob via USB, then run the example:

npm run example