Skip to content
This repository has been archived by the owner on Jan 5, 2019. It is now read-only.

Commit

Permalink
Documented need for library.json file in firmware modules
Browse files Browse the repository at this point in the history
  • Loading branch information
LeonChambers committed Jan 20, 2017
1 parent 6de4aa2 commit 72f1868
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/firmware_modules.rst
Expand Up @@ -57,6 +57,12 @@ In addition the module should define a `module.json` file containing all of the
metadata about the firmware module. In particular, it should be an instance of
the :py:class:`openag.models.FirmwareModuleType` schema encoded as JSON.

The system uses PlatformIO to compile Arduino sketches, so modules must also
define a `library.json` file meeting the PlatformIO specifications. To work
with our system, this file need only contain the fields `name` and `framework`.
The `name` field should be the name of the module, and the `framework` field
should have the value `arduino`.

I/O Categories
--------------

Expand Down

0 comments on commit 72f1868

Please sign in to comment.