Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

pimatic-fronius-solar

mwittig13GPL-2.00.0.18

Pimatic Plugin to access PV live logs using the Fronius Solar API

pimatic, SolarView, Solar Energy, Photovolatics, SmartHome, SmartMeter, Volkszaehler, Monitoring, Metering

readme

pimatic-fronius-solar

npm version

Pimatic Plugin to access PV live logs using the Fronius Solar API. This plugin is based on node-fronius-solar.

Configuration

You can load the plugin by editing your config.json to include the following in the plugins section. The property interval specifies the time interval in seconds for updating the data set. For debugging purposes you may set property debug to true. This will write additional debug messages to the pimatic log. The values properties interval and debug represent the the default values.

{
      "plugin": "fronius-solar",
      "interval": 60,
      "debug": false
},

Then you need to add a device in the devices section. Currently, the following device types are supported:

  • FroniusInverterRealtimeData: This type is to obtain the measurements data for an inverter device using the GetInverterRealtimeData service call of the Solar API V0/V1
  • FroniusComponentsData: This type is to obtain the measurements data for an PV system using an undocumented API service provided by the Fronius Data Manager provided with Symo inverters. In contrast to the regular Solar API Calls which do not require authentication, you may need to provide username and password properties to the options dictionary (if authentication has been enabled
  • FroniusPowerFlowRealtimeData: This type is to obtain the measurements data for an PV system using the GetInverterRealtimeData service call of the Solar API V1 which should work with Fronius Data Manager v3.4.2-1 (and higher)

As part of the FroniusInverterRealtimeData device definition you need to provide the deviceId which is the number of the inverter devices according to your PV system setup. You also need to provide host of the device providing Solar API, which is either your inverter (Fronius Galvo and Fronius Symo inverter models) or a Fronius Datamanager device.

For FroniusComponentsData and FroniusPowerFlowRealtimeData device configuration you can choose which attributes should be exposed by the device. See device-config-schema for details.

If you've configured your Fronius inverter to use power save mode, enter the threshold in watts at which power saving is activated. This helps to omit the nightly errors of the unreachable server.

{
      "id": "fronius1",
      "class": "FroniusInverterRealtimeData",
      "name": "Fronius Inverter",
      "host": "fronius.fritz.box",
      "deviceId": 1
      "threshold": 50
},
{
      "id": "fronius2",
      "class": "FroniusComponentsData",
      "name": "Fronius Inverter 2",
      "host": "fronius.fritz.box",
      "username": "admin",
      "password": "admin",
      "attributes": [
        "powerGenerate", 
        "powerLoad", 
        "powerGrid", 
        "powerAkkuSum", 
        "powerPvSum", 
        "relativeSelfConsumption", 
        "relativeAutonomy", 
        "powerSelfConsumption"
      ]
    },
    {
      "id": "fronius3",
      "class": "FroniusPowerFlowRealtimeData",
      "name": "Fronius Inverter 3",
      "host": "fronius.fritz.box",
      "attributes": [
        "mode",
        "powerGrid",
        "powerLoad",
        "powerAkku",
        "powerGenerate",
        "energyDay",
        "energyYear",
        "energyTotal"
      ]
    },

Contributions and Donations

Contributions to the project are welcome. You can simply fork the project and create a pull request with your contribution to start with. If you wish to support my work with a donation I'll highly appreciate this. Please also consider ★ starring the project on github.

PayPal donate button

Release History

See Release History.

License

Copyright (c) 2016-2019, Marcus Wittig and contributors. All rights reserved.

AGPL-3.0 License.

changelog

Release History

  • 20150514, V0.0.1
    • Initial Version
  • 20150518, V0.0.2
    • Improved error handling
  • 20150520, V0.0.3
    • Attribute values are now recovered from DB (lastState) on pimatic startup rather than using zero values
  • 20150520, V0.0.4
    • Added status attribute representing the status of the inverter device
    • Fixed bug "TypeError: Cannot call method 'hasOwnProperty' of undefined"
    • PAC, IAC, UAC are now transient values (not recovered from DB on startup)
  • 20150526, V0.0.5
    • Nullify IAC, UAC & PAC if no value has been received (inverter shutting down) or an error has occurred
  • 20150623, V0.0.6
  • 20151127, V0.0.7
    • Added parameter "threshold" to support the powersave mode of the inverter and to omit errors during powersave (contributed by @mplessing)
  • 20160311, V0.0.8
  • 20160322, V0.0.9
    • Fixed compatibility issue with Coffeescript 1.9 as required for pimatic 0.9 (thanks @sweebee)
    • Updated peerDependencies property for compatibility with pimatic 0.9
  • 20160325, V0.0.10
    • Added default value 80 for port property in device config schema
    • Updated README configuration example
    • Added license info to README
    • Updated list of contributors
    • Moved release history to separate file
  • 20160331, V0.0.11
    • Implemented new devices FroniusComponentsData and FroniusPowerFlowRealtimeData based on extension node-fronius-solar@0.0.6
    • Refactoring, now using pimatic-plugin-commons
    • Updated README
  • 20160417, V0.0.12
    • Added destroy method to cancel an scheduled update when the device is removed or updated
  • 20160601, V0.0.13
    • Added support for Fronius API V0 callouts to GetInverterRealtimeData
  • 20160831, V0.0.14
    • Dependency Update
    • Handle updates of FroniusComponentsData and FroniusPowerFlowRealtimeData device attributes as continuous values
  • 20160901, V0.0.15
    • Fixed creation of getter methods for dynamic attributes of FroniusComponentsData and FroniusPowerFlowRealtimeData which wrong accessor for attribute values, issue #3
  • 20160901, V0.0.16
    • Fixed updating attribute values for FroniusInverterRealtimeDataDevice, issue #3
  • 20170412, V0.0.17
    • Updated dependencies
    • Revised README, updated copyright notice
  • 20190220, V0.0.18
    • Fix: set powerGenerate to 0 if no power is generated by the inverter (null value), issue #11
    • Updated dependencies
    • Revised README, updated copyright notice