tegacodes / solarprotocoldata

Working with Solar Protocol Data

• Data is from the Solar Protocol API: http://solarprotocol.net/api/v2/. Please read the documentation there.
• Offline examples of API data are saved in the data folder in this repository.

Examples are in Javascript (p5js) and Python (Gizeh).

P5JS (client side rendering)

• Javascript using the P5 library. https://p5js.org/
• If running your code from a local server, access the network data direct from the Solar Protocol API. If developing in an online editor, you will need to use the development server to access network data due to the Cross-Origin Resource Sharing standard that will block http requests from https servers. Development server is here: https://server.solarpowerforartists.com

Install p5.js:

• Either download the library and run a server locally.
• Or use the online editor.

Example: 0-single-value

• Access a single data point from the server
• Code
• Example in code editor

To access the data, loadJSON() is used with a callback function called gotData.

loadJSON(URL, gotData); 

Example: 1-value-duration

• Work with the timeseries of a charge controller parameter like current or voltage.

• Code

• Example in code editor

• Uses day.js library to deal with dates and timestamps: https://day.js.org/en/

Example: 2-cc-data

• Visualize the timeseries of all charge controller parameters

• Code

• Example in code editor

• Uses day.js library to deal with dates and timestamps: https://day.js.org/en/

Example: 3 Point of Entry

• Visualizes time series of parameters from all servers on the network.
• Code

Python (server side rendering)

• Visualizing data server side using Python and either a plotting library called Plotly or a graphics library called Gizeh:

Plotly

• Documentation: https://plotly.com/

Example: 0-single-value

• Access a single data point from the server
• Code

Gizeh

• Documentation: https://github.com/Zulko/gizeh

Install Gizeh

• Upgrade pip: python3 -m pip install --upgrade pip
• Install cairo sudo apt-get install libcairo2-dev
• Install gizeh sudo pip3 install gizeh
• Or use the online editor.

Notes on Gizeh

Color

• Takes RGB color of the form (r,g,b) where each element is comprised between 0 and 1 (1 is 100%).
• (1,1,1) is white
• (0,0,0) is black
• See the rip codes in this online color converter

Example: 0-single-value

• Access a single data point from the server
• Code

Example: 1-value-duration

• Work with the timeseries of a charge controller parameter like current or voltage.
• Code

Example: 2-cc-data

• Visualize the timeseries of all charge controller parameters
• Code coming soon.