signalk-solar-forecast

1.0.1 • Public • Published

SignalK Solar Production Forecast

Release GitHub Issues GitHub Pull Requests License


A plugin for the node.js Signal K server for boats to retrieve solar production forecast data from the API at https://forecast.solar/ and provide this as SignalK paths.

📝 Table of Contents

🧐 About

  • Signal K is an open source server application that runs as a central information hub on a boat. It centralises data, provides a rich API to consume the data, and is extensible through a comprehensive suite of plugins (such as this one) and web applications.

  • https://forecast.solar/ is a limited free API that calculates a forecasted solar production based on historical solar irradiation data, historical weather data, current weather forecast data, and the caracteristics of your solar installation.

This plugin's purpose is to bring together these 2 components by making the data from the API available as Signal K paths which can then be consumed by interested parties.

🏁 Getting Started

These instructions will get you up and running.

Prerequisites

  • A running instance of the Signal K node server with a position source (a GPS).

Instructions here

Installing this plugin

Through the Signal K server Appstore, search for signalk-solar-forecast, and click the Install button.

Configuration

In the Signal K menu, head to Server -> Plugin Config, and find "Solar production forecast plugin for SignalK node server" and proceed with configuration as per the instructions provided Click Submit. Toggle the slider to enable the plugin.

🎈 Usage

The API data will become available under a number of new paths that should be easy to find. You can now come up with creative ways to use the data.

✍️ Authors

Buy Me A Coffee

See also the list of contributors who participated in this project.

Package Sidebar

Install

npm i signalk-solar-forecast

Weekly Downloads

3

Version

1.0.1

License

MIT

Unpacked Size

25.3 kB

Total Files

10

Last publish

Collaborators

  • captain_spes