npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@particle/device-os-protobuf

v2.6.1

Published

Particle Device OS Protobuf Definitions

Downloads

1,813

Readme

CircleCI

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.

Note that most common Javascript use cases Device OS Protobuf usage over USB would be better accommodated by particle-usb rather than this project because it provides a higher level API that is easier to use and covers protobuf transmission over USB (not just encoding/decoding);

Device OS declares all control request IDs in system-control.h. Additionally, Device OS depends on control/*.proto files in this repo via a git submodule.

iOS and Android applications also depend on control/*.proto files directly via a git submodule.

See the protobuf definitions reference for more details about specific requests.

Usage

Node.js

Install package with npm install @particle/device-os-protobuf

See docs/reference.md for public api documentation

See src/*.test.js files for basic usage examples.

See particle-usb for production usage examples.

Development

Ensure you have installed dependencies via npm install.

Edit the protocol buffer definitions in proto.

Generate the protobufjs JavaScript & JSON files and markdown documentation with npm run build. Make sure to do this before asking for PR reviews/merging.

Ensure npm run test:ci is passing

Building the protobuf definitions reference is done with npm run build:docs:protobuf. This command uses Docker to remove the dependency on protoc-gen-doc tool.

Release

Packages are only released from the main branch after peer review via the following process.

  1. make sure you have the latest:
    • $ git checkout main
    • $ git pull
  2. make sure tests pass
    • $ npm test:ci
  3. Tag a new version:
    • npm version
  4. Cut the release:
    • $ git push origin main --follow-tags
    • CircleCI will publish the package to npm.