Particle Device OS Protobuf Definitions
Particle devices expose Control Requests over USB and BLE for functionality like device information and Wi-Fi setup. This repo contains the definition for all these control requests in Protobuf format.
Device OS declares all control request IDs in system-control.h. Additionally, Device OS depends on
control/*.proto files in this repo via a
iOS and Android applications also depend on
control/*.proto files directly via a
See the protobuf definitions reference for more details about specific requests.
Install package with
npm install @particle/device-os-protobuf
See docs/reference.md for public api documentation
src/*.test.js files for basic usage examples.
particle-usb for production usage examples.
Ensure you have installed dependencies via
Edit the protocol buffer definitions in
npm run build. Make sure to do this before asking for PR reviews/merging.
npm run test:ci is passing
Packages are only released from the
main branch after peer review via the following process.
- make sure you have the latest:
$ git checkout main
$ git pull
- make sure tests pass
$ npm test:ci
- Tag a new version:
$ git add+
- Cut the release:
$ git push origin main --follow-tags
- CircleCI will publish the package to npm.