Github Mirror / telegraf-plugins: 97ee3a15




Add information on fields

Add information on fields

Commit 97ee3a15.

Authored 2023-06-01T14:34:56.000+01:00 by B Tasker in project Github Mirror / telegraf-plugins

+47 lines -0 lines

Commit Signature

Changes

diff --git a/soliscloud/README.md b/soliscloud/README.md
--- a/soliscloud/README.md
+++ b/soliscloud/README.md
# @@ -52,6 +52,53 @@ The API details can be passed via the `environment` configuration option
# ]
# ```
#
# +----
# +
# +### Example Output
# +
# +```
# +solar_inverter,type=device,device_type=battery,inverter_id=123456,inverter_sn=78901112,station=13141516178,userId=1920212223,batteryType=1.0,influxdb_database=Systemstats,batteryState=charging batteryPowerUnit="kW",batteryPowerPerc=46.0,batteryHealthPerc=100.0,batteryCurrentStr="A",batteryTodayChargeEnergy=2.5,batteryTodayChargeEnergyStr="kWh",batteryTodayDischargeEnergy=0.3,batteryTodayDischargeEnergyStr="kWh",readingAge=6i,batteryVoltage=50.6,batteryChargeRate=0.612,batteryDischargeRate=0.0,batteryCurrent=12.1
# +solar_inverter,type=device,device_type=inverter,inverter_id=123456,inverter_sn=78901112,station=13141516178,userId=1920212223,inverter_model=3101,influxdb_database=Systemstats state=3,todayYield=6.4,todayYieldStr="kWh",power_ac=1.097,power_ac_str="kW",temperature=36.8,gridBuyToday=5.0,gridSellToday=0.0,batterySupplyToday=0.3,batteryChargeToday=2.5,readingAge=6i,stationCapacity=3.28,stationCapacityUsedPerc=38.0,consumptionToday=10.0,panel_1=558.0,panel_2=540.0,panel_3=0.0,panel_4=0.0,panel_5=0.0,panel_6=0.0,panel_7=0.0,panel_8=0.0,panel_9=0.0,panel_10=0.0,panel_11=0.0,panel_12=0.0,panel_13=0.0,panel_14=0.0,panel_15=0.0,panel_16=0.0,panel_17=0.0,panel_18=0.0,panel_19=0.0,panel_20=0.0,panel_21=0.0,panel_22=0.0,panel_23=0.0,panel_24=0.0,panel_25=0.0,panel_26=0.0,panel_27=0.0,panel_28=0.0,panel_29=0.0,panel_30=0.0,panel_31=0.0
# +```
# +
# +----
# +
# +### Fields
# +
# +Note: many of the fields are accompanied by a field denoting the unit (for example `batteryCurrent` and `batteryCurrentStr`). These are drawn from the API and (appear) to be drawn from localisation settings in the user's Soliscloud profile.
# +
# +There's reason to believe that values reported are [not always in these units](https://projects.bentasker.co.uk/gils_projects/issue/utilities/telegraf-plugins/9.html#comment4648) - for example, a field claiming to be in `kWh` might report 500 watts as `500` rather than `0.5` (whereas `1500` would use the correct unit - `1.5`).
# +
# +
# +`device_type=battery`
# +
# +- `batteryPowerPerc`: percentage charge of the battery
# +- `batteryHealthPerc`: The batteries internal assessment of it's health vs manufacturer lifetime expectations
# +- `batteryTodayChargeEnergy`: Amount of energy (usually `kWh`) pushed into the battery today
# +- `batteryTodayDischargeEnergy`: Amount of energy (usually `kWh`) drawn from the battery today
# +- `readingAge`: how long ago (in seconds) since the inverter reported these stats into soliscloud
# +- `batteryVoltage`: Current battery voltage
# +- `batteryChargeRate`: Current rate at which the battery is being charged (usually `kW`)
# +- `batteryDischargeRate`: Current rate at which the battery is discharging (usually `kW`)
# +- `batteryCurrent`: Current in/out of the battery (usually in `A`)
# +
# +
# +`device_type=inverter`
# +
# +- `state`: a numerical indicator of the inverter's state (online, offline, alarm). There is [a mismatch](https://projects.bentasker.co.uk/gils_projects/issue/utilities/telegraf-plugins/9.html#comment4649) between observed values and those in the API docs, so it's recommended that any monitoring watch for changes in value
# +- `todayYield`: Energy generated by solar panels
# +- `power_ac`: current power output of inverter (normally `kW`)
# +- `temperature`: Ambient temperature
# +- `gridBuyToday` : Energy taken from the grid today
# +- `gridSellToday`: Energy exported to the grid today
# +- `batterySupplyToday`: Energy supplied by the battery today
# +- `batteryChargeToday`: Energy stored/charged into the battery today
# +- `readingAge`: how long ago (in seconds) since the inverter reported these stats into soliscloud
# +- `stationCapacity`: Installed solar capacity (usually in `kWp`)
# +- `stationCapacityUsedPerc`: Currently realised percentage of installed capacity
# +- `consumptionToday`: Total energy consumed today from all sources
# +- `panel_1`..`panel_31`: Current energy output (usually in `W`) of each solar string
# +
#
# ----
#
#