Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
This page describes how to view, modify, and contribute to the source code behind SolarNetwork.
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.
SolarNetwork Developer Guide
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 Eclipse Setup Guide will guide you through manually configuring an Eclipse IDE development environment for working with the SolarNetwork code.
- Debugging SolarNetwork with Eclipse shows how to run and debug SolarNetwork applications inside Eclipse
- Building SolarNetwork applications describes how to build applications (without using Eclipse)
- Deploy a new SolarNode device (e.g. Raspberry Pi) 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
SolarNode is the distributed component of the SolarNetwork platform, and typically runs on small, low-power computers.
- 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 centralized service component of the SolarNetwork platform.
- 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.
SolarDRAS is a centralized demand-response application where SolarNodes can participate in grid demand events.
- SolarDRAS Development Guide describes how to set up a development environment for the SolarDRAS application.