-
Notifications
You must be signed in to change notification settings - Fork 2
Developer Guide
This page describes how to use the SolarNetwork API or view, modify, and contribute to the source code powering the SolarNetwork platform.
The SolarNetwork API allows external applications to be built using the SolarNetwork platform.
- API Guide is a good place to start for understanding the SolarNewtork API.
- API SDK Docs are available for the SolarNetwork API SDK.
- Visualization Gallery contains example visualizations of live data pulled from the SolarNetwork API.
- Create your own SolarNode dashboard to visualize your data.
- Use the SolarNode Stream Viewer to view your node's most recent data quickly.
SolarNode is the distributed "edge" component of the SolarNetwork platform, and typically runs on small, low-power computers. Here are some resources to help you deploy SolarNode on physical devices (like a Raspberry Pi):
- Deploy a new SolarNodeOS device using a prebuilt image
- Get a SolarNode device to join SolarNetwork so it can start posting data
- Learn to debug SolarNode running on a device
- Interact with the OSGi shell to inspect OSGi services, install new plugins, and more
- Create a customized SolarNodeOS image for your organization
If you want to develop the SolarNetwork platform itself, there are many resources to help you get started.
- Developer VM is a good place to start if you're new to SolarNetwork. It will guide you through setting up a fully configured SolarNetwork development environment running in a virtual machine.
- Alternatively the Build Guide will guide you through manually downloading the SolarNetwork code and setting up your developer environment for building the SolarNetwork applications.
Once you have your development environment set up, here are some resources to help with developing the SolarNode application:
- SolarNode Development Guide describes how to set up a development environment for the SolarNode application.
- Building the SolarNode application shows how to build the SolarNode application
- Local data storage talks about how data is stored locally in SolarNode
- Pushing data to SolarNet discusses how data stored locally in SolarNode is pushed up to SolarNet
- Receiving instructions from SolarNet outlines how SolarNet can send instructions to SolarNode
- Datum Capture Guide is a tutorial for developing your first SolarNode OSGi bundle that captures data from a fictional power inverter
- Custom SolarNode Settings UI is a guide showing how an OSGi bundle can hook into the SolarNode web GUI to provide custom widgets
SolarNet is the "cloud" component of the SolarNetwork platform. Once you have your development environment set up, here are some resources to help with developing SolarNet applications:
- SolarNet Development Guide describes how to set up a development environment for the SolarNet application.
- Developer PKI Guide describes how to set up the necessary public key infrastructure to enable SolarNode to SolarNet secure communication in a development environment.