This repo serves as the specification for what constitutes a valid Spark firmware library and an actual example library you can use as a reference when writing your own libraries.
Particle Libraries can be used in the Particle IDE. Soon you'll also be able to use them with the Particle CLI and when compiling firmware locally with Particle firmware.
This README describes how to create libraries as well as the Particle Library Spec.
The other files constitute the Particle Library itself:
$ npm install -g particle-cli
$ particle library init this-is-my-library-name
this-is-my-library-name
with the actual lib name. Your library's name should be lower-case, dash-separated.library.properties
, firmware .h and .cpp files$ particle library validate
and
$ particle library publish
This repo is meant to serve as a place to consolidate insights from conversations had about libraries on the Particle community site, GitHub, or elsewhere on the web. "Proposals" to change the spec are pull requests that both define the conventions in the README AND illustrate them in underlying code. If something doesn't seem right, start a community thread or issue pull requests to stir up the conversation about how it ought to be!