README
¶
Ninja Sphere - Golang Library
Introduction
A Golang library to interact with the Ninja Sphere-- used for creating tubular new drivers and radical apps.
It takes care of the connection to MQTT, implementing and calling services using JSON-RPC, device protocols, schema validation, configuration, logging etc. It's your hero in a half-sphere.
tl;dr - Writing a driver in Go? Use this.
For development outside of a devkit/sphere, ensure you have sphere-serial in your path, and have sphere-config and schemas checked out and accessible.
Usage
For example usage in drivers, check out driver-go-chromecast, the example fakedriver or any of our other released drivers.
See Also
-
schemas - Json Schemas describing all the communication between services (drivers, apps etc.) in Ninja Sphere.
-
sphere-config - The base configuration that is shared in Sphere.
More Information
More information can be found on the project site or by visiting the Ninja Blocks forums.
Contributing Changes
To contribute code changes to the project, please clone the repository and submit a pull-request (What does that mean?).
License
This project is licensed under the MIT license, a copy of which can be found in the LICENSE file.
Copyright
This work is Copyright (c) 2014-2015 - Ninja Blocks Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bugs provides a wrapper around bugsnag so additional ninja specific stuff can be added to the configuration without duplicating it in every driver.
|
Package bugs provides a wrapper around bugsnag so additional ninja specific stuff can be added to the configuration without duplicating it in every driver. |
|
The package is intended to provide objects used to build implementations of the App, Driver and Device interfaces since there is typically only one possible implementation for many of these methods.
|
The package is intended to provide objects used to build implementations of the App, Driver and Device interfaces since there is typically only one possible implementation for many of these methods. |
|
+build ignore
|
+build ignore |