noffycws / iobroker.senec

ioBroker adapter for Senec Home 2.1

ioBroker.senec

Tests::

senec adapter for ioBroker

Dokumentation DE
Documentation EN

Targeted at the Senec Home V2.1 System. Other systems should work, as long as they use lala.cgi. Although datapoints may differ (missing, additional, changed).

Systems that might work:

• Senec Home 4.0 / Blei
• Senec Home 6.0 Pb
• Senec Home 8.0 / Blei
• Senec Home 10.0 Pb
• Senec Home 5.0/7.5/10.0 / Lithium
• Senec Home 15.0 / Lithium
• Senec Home V2 5.0/7.5/10.0
• Senec Home V2 10.0 / Blei
• Senec Home V2.1 1ph / Lithium
• Senec.Home V3 Hybrid
• Senec.Home V3 Hybrid duo
• Senec Business 30.0 / Blei
• Senec Business V2 30.0 / Blei
• Senec Business 25.0 / Lithium
• Senec Business V2_2ph / Lithium
• Senec Business V2 3ph / Lithium
• ADS Tec
• OEM LG
• Solarinvert Storage 10.0 / Blei,

Installation

You can either install the adapter via the ioBroker web interface or on your local machine via npm.

Browser-based

1. Open your ioBroker web interface in a browser (eg: 192.168.178.42:8081)
2. Click on Tab "Adapters"
3. Type "senec" in the filter
4. Click on the "+" symbol of the senec adapter

Local machine

Navigate into your iobroker folder and execute the following command:

npm i iobroker.senec

Setup

Additional to the adapter installation you have to add an instance of the adapter.

ioBroker

1. Open your ioBroker interface in a browser (eg: 192.168.178.42:8081) (if configuration dialogue was opened automatically after installation, skip to 4.).
2. Navigate to Tab "Instances"
3. Click on the wrench symbol of the senec adapter
4. Now you can see the main settings of the adapter configuration page.
   4.1 Type in the IP-address of your SENEC system (FQDN is also possible if you have a working local DNS).
   4.2 You can change the polling interval, too. (Default: 10 seconds for high priority data, 60 minutes for low priority data)
   Warning! If you are polling too often, your SENEC system will not be able to connect to the SENEC servers anymore! So please be aware of this!
   4.3 If your network requires a higher timeout for requests sent to SENEC, please change the Request-Timeout in miliseconds accordingly. (Default: 5000 miliseconds)
   4.4 In case there is an issue communicating with SENEC the adapter will retry several times. You can adjust how often it will try to read from SENEC. (Default: 10)
   4.5 To space retries apart a bit more you can adjust the Polling Retry Factor. (Default: 2)
   Example: Using default settings the 1st retry will happen 20 seconds after the initial try, the 2nd will happen 40 seconds after the 2nd try.
   After each successful connect to SENEC, the number of retries is reset.
5. Click on Save & Close

Usage

Here you can find a description of the states and how to use them. All states of this adapter are read-only states.

Example States (States differ per System and Version)

Channel: info

• info.connection

  Data type	Permission
  boolean	R

  Read-only boolean which is true if the adapter is connected to the senec system.

Channel: BMS

• MODULES_CONFIGURED

  Data type	Permission
  number	R

  Read-only number, which represents the number of modules currently configured in the system.

• MODULE_COUNT

  Data type	Permission
  number	R

  Read-only number, which represents the number of modules currently known the system (incl. non-configured).

Channel: ENERGY

• GUI_BAT_DATA_CURRENT

  Data type	Permission
  number	R

  Read-only number, which represents the battery's current in Amps.

• GUI_BAT_DATA_FUEL_CHARGE

  Data type	Permission
  number	R

  Read-only number, which represents the current level of your battery system in %.

• GUI_BAT_DATA_VOLTAGE

  Data type	Permission
  number	R

  Read-only number, which represents the battery's current voltage in volt.

• GUI_BAT_DATA_POWER

  Data type	Permission
  number	R

  Read-only number, which represents how much power is coming from / going into the battery in Watts. Negative values are discharging.

• GUI_BOOSTING_INFO

  Data type	Permission
  boolean	R

  Read-only boolean, which we don't know the exact meaning of yet.

• GUI_CHARGING_INFO

  Data type	Permission
  boolean	R

  Read-only boolean, which represents if the battery is currently charging.

• GUI_GRID_POW

  Data type	Permission
  number	R

  Read-only number, which represents the power currenty coming from / going into the grid in Watts. Negative values are sending into the grid.

• GUI_HOUSE_POW

  Data type	Permission
  number	R

  Read-only number, which represents the power in Watts currently consumed by the house.

• GUI_INVERTER_POWER

  Data type	Permission
  number	R

  Read-only number, which represents the current power supplied by your PV system.

• STAT_HOURS_OF_OPERATION

  Data type	Permission
  number	R

  Read-only number, detailing the system's uptime in hours.

• STAT_MAINT_REQUIRED

  Data type	Permission
  boolean	R

  Read-only boolean, which represents if your senec system requires maintenance.

• STAT_STATE

  Data type	Permission
  number	R

  Read-only number, which represents the system's state.

• STAT_STATE_Text

  Data type	Permission
  string	R

  Read-only string, which represents the system's state in human readable format (sorry - we only have the german states from senec).

Channel: STATISTIC

• STAT_DAY_BAT_CHARGE

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power charged into the battery in kWh today.

• STAT_DAY_BAT_DISCHARGE

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power drawn from the battery in kWh today.

• STAT_DAY_E_GRID_EXPORT

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power in kWh delivered into the net today.

• STAT_DAY_E_GRID_IMPORT

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power in kWh drawn from the net today.

• STAT_DAY_E_HOUSE

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power in kWh consumed by the house today.

• STAT_DAY_E_PV

  Data type	Permission
  number	R

  Read-only number, which represents the amount of power in kWh generated by your PV today.

Channel: SYS_UPDATE

• NPU_IMAGE_VERSION

  Data type	Permission
  number	R

  Read-only number, representing the Revision NPU-IMAGE

• NPU_VER

  Data type	Permission
  number	R

  Read-only number, representing the Revision NPU-REGS

• UPDATE_AVAILABLE

  Data type	Permission
  boolean	R

  boolean-value which is true if there is an update available (Updates happen automatically and are scheduled by SENEC).

Channel: WIZARD

• APPLICATION_VERSION

  Data type	Permission
  string	R

  Read-only text, representing the Revision MCU

• CONFIG_LOADED

  Data type	Permission
  boolean	R

  boolean-value which is true if configuration is loaded. This being false is very unlikely and it shouldn't persist as false.

• INTERFACE_VERSION

  Data type	Permission
  string	R

  Read-only text, representing the Revision GUI

• SETUP_NUMBER_WALLBOXES

  Data type	Permission
  number	R

  Read-only number, which designates how many wallboxes are configured in the system.

• SETUP_WALLBOX_SERIAL[0..3]

  Data type	Permission
  number	R

  Read-only number, which designates the number of wallbox [0..3]. This is only available on systems with configured wallboxes.

Changelog

1.0.12 (NoBl)

• Just set 'supportCustoms' to false so it won't show up in admin custom config.

1.0.11 (NoBl)

• Update to current adapter template
• Added Datapoints: PV1.MPP_CUR, MPP_VOL, MPP_POWER (former: MPP_INT which is unused at this moment but does still exist)
• Added Datapoints (please feedback any improvements for their descriptions, ...): FEATURES.SGREADY, WIZARD.SETUP_WALLBOX_MAX_TOTAL_CURRENT_BY_GRID, WIZARD.SG_READY_CURR_MODE, BMS.ERROR, BMS.RECOVERLOCKED, BMS.SERIAL, BMS.START_SELFTEST, BAT1.RESET, BAT1.SELFTEST_ACT, BAT1.SELFTEST_LIMIT, BAT1.SELFTEST_OFF, BAT1.SELFTEST_OVERALL_STATE, BAT1.SELFTEST_STATE, BAT1.SELFTEST_STEP, BAT1.SELFTEST_TIME, BAT1.SERIAL, BAT1.TRIG_ITALY_SELF, BAT1OBJ1.COMM, GRIDCONFIG.AU_SOFT_RAMP_EN, GRIDCONFIG.AU_VRR_MAX, GRIDCONFIG.AU_VRR_MIN, GRIDCONFIG.AU_VVAR_PERCENTAGE, GRIDCONFIG.AU_VVAR_P_MAX, GRIDCONFIG.AU_VVAR_P_MIN, GRIDCONFIG.AU_VVAR_VOLTAGE, GRIDCONFIG.AU_VWC_VOLTAGE, GRIDCONFIG.AU_VWD_VOLTAGE, GRIDCONFIG.CEI_SEGNALE_ESTERNO, GRIDCONFIG.VDELVFRTDISABLE, GRIDCONFIG.VDEURMSMAX10

1.0.10 (NoBl, smartpran)

• DateType objects are stored as date again
• changed WIZARD.SETUP_POWER_RULE unit to '%'
• changed name of STATISTIC.STAT_SUM_E_PU to "STAT_SUM Energy PowerUnit"
• changed name of STATISTIC.STAT_SUM_E_WB to "STAT_SUM Energy Wallbox"
• changed name of STATISTIC.LIVE_WB_ENERGY to "Live Wallbox Energy"
• changed name of STATISTIC.LIVE_PU_ENERGY to "Live PowerUnit Energy"
• changed name of WIZARD.PWRCFG_PEAK_PV_POWER to "Configured Peak PV Power"
• enforcing conversion of number values to Number(). Otherwise they are created as String in ioBroker (manually delete existing datapoints in ioBroker to change them!)
• fixed representation for temp values (off by *10)
• json delivers a non-value (apparently an error message produced by senec itself). Ignoring that.
• Added variable mpp_int to high priority and changed unit it. (smartpran)

1.0.9 (NoBl)

• IP types are shown as IP again.
• added datapoints for FACTORY along with more state descriptions for Battery Type, Country and System Type.
• added datapoints for GRIDCONFIG

1.0.8 (NoBl)

• Added more states to known states (please feedback if they need special handling (unit, special description, value modification, ...))
• Bugfix in creating debug data
• Unknown states are now reported in debug instead of info.
• Code cleanup

1.0.7 (NoBl)

• Reading all known states from SENEC.
• Split states into high/low priority (heavy requesting the SENEC system renders it unable to sync with the SENEC datacenter!).
• Updated adapter-core and testing versions along with current dev dependencies. Removed node 8 support.
• Added more state descriptions to manual. But need input on these and those that are still not documented.

1.0.6 (NoBl)

• Moved senec states and state attributes to libs
• Added missing state descriptions

1.0.5 (2020-03-07) (NoBl)

• Added States for: Energy: GUI_BAT_DATA_VOLTAGE, GUI_BAT_DATA_CURRENT, STAT_HOURS_OF_OPERATION; Sys_update: NPU_VER, NPU_IMAGE_VERSION, Wizard: APPLICATION_VERSION, INTERFACE_VERSION
• Readme and Documentation (EN exists, now) updated
• Changed behavior for unknown values completely. They will now be stored as string plus prefixed with "REPORT TO DEV:" so users can easily report back what needs updating.
• added handling for "st_" values in json
• added additional configuration options
• changed retry-behaviour in case of connection issues, ...

1.0.4 (2020-03-06)

• (NoBl) Repo URL updated

1.0.3 (2020-03-06)

• (NoBl) added link to documentation in german

1.0.2 (2020-03-04)

• (NoBl) added missing status codes (85 in total now)
• (NoBl) added status code to status message for easier reference
• (NoBl) added states for wallboxes and battery modules

1.0.1

• (NoBl) updated readme

1.0.0

• (NoBl) initial release

License

MIT License

Copyright (c) 2020 Norbert Bluemle [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.