Github Mirror / telegraf-plugins: de28577f

verified

Start a README

Start a README

Commit de28577f.

Authored 2023-05-16T08:56:58.000+01:00 by B Tasker in project Github Mirror / telegraf-plugins

+38 lines -0 lines

Commit Signature

Changes

diff --git a/soliscloud/README.md b/soliscloud/README.md
--- a/soliscloud/README.md
+++ b/soliscloud/README.md
# @@ -0,0 +1,38 @@
# +### Soliscloud Telegraf Plugin
# +
# +This is an exec based plugin for Telegraf designed to collect Electricity usage and generation statistics from [Soliscloud](https://www.soliscloud.com/). Inverters, Dataloggers, EPMs and Meters made by [Ginlong Technologies](https://www.ginlong.com/) tend to report into Soliscloud.
# +
# +This plugin calls the Soliscloud API in order to retrieve information so that [Telegraf](https://github.com/influxdata/telegraf) can write it into InfluxDB.
# +
# +More information on the original development can be found in [utilities/telegraf-plugins#9](https://projects.bentasker.co.uk/gils_projects/issue/utilities/telegraf-plugins/9.html)
# +
# +
# +----
# +
# +### Dependencies
# +
# +* Python >= 3
# +* Python Requests Module
# +
# +----
# +
# +### Pre-Requisites
# +
# +You will need API access, but this is not enabled by default.
# +
# +As [detailed here](https://solis-service.solisinverters.com/support/solutions/articles/44002212561-api-access-soliscloud) you'll need to raise a support ticket requesting access (mine was acted on promptly).
# +
# +Once API access has been enabled for your account, instructions will be given on how to generate credentials. This will result in you having
# +
# +* An API domain
# +* An API Key ID
# +* An API Secret
# +
# +
# +
# +
# +----
# +
# +### License
# +
# +Copyright 2023, B Tasker. Released under [BSD 3 Clause](https://www.bentasker.co.uk/pages/licenses/bsd-3-clause.html).
#