ioBroker.sonnen
===========================
Installation
You can either install the adapter via the ioBroker web interface or on your local machine via npm.
Browser-based
- Open your ioBroker web interface in a browser (eg: 192.168.30.70:8081)
- Click on Tab "Adapters"
- Type "sonnen" in the filter
- Click on the three points and then on the "+" symbol of the sonnen adapter
Local machine
Navigate into your iobroker folder and execute the following command:
npm i iobroker.sonnenSetup
Additional to the adapter installation you have to add an instance of the adapter.
ioBroker
- Open your ioBroker interface in a browser (eg: 192.168.1.33:8081)
- Navigate to Tab "Adapters"
- Click on the three points and then on the "+" symbol of the sonnen adapter
- Now you can see the main settings of the adapter configuration page --> type in the ip-address of your sonnen battery
- If you want to thange the interval in which the states are polled, click on the tab "Advanced Settings"
- You can set the poll interval between 2000 ms (2 seconds) and 60000 ms (1 minute), the default value is 7 seconds
- Click on Save & Close
Usage
Here you can find a description of the states and how to use them. The most states of this adapter are read-only states. Note, that there are two different sonnen API's so if you are missing states, they are probably not supported.
States
Channel: info
-
info.connection
Data type Permission boolean R Read-only boolean which is true if the adapter is connected to the battery.
-
info.lastSync
Data type Permission timestamp R Read-only timestamp w. r. t. the last successful synchronization time.
-
info.configuration
Data type Permission string R Read-only JSON string, which contains configuration information of your battery.
-
info.powerMeter
Data type Permission string R Read-only JSON string, which contains power metering information of your battery.
-
info.inverter
Data type Permission string R Read-only JSON string, which contains inverter information of your battery.
Channel: status
-
status.consumption
Data type Permission number R Read-only number, which represents the current consumption of your house in watts.
-
status.production
Data type Permission number R Read-only number, which represents the current production of you photovoltaics system in watts.
-
status.pacTotal
Data type Permission number R Read-only number, which represents the inverter AC Power in watts. If the value is greater than 0 the battery is discharging, if greater than zero it is charging.
-
status.relativeSoc
Data type Permission number R Read-only number, which represents the state of charge of your battery in percent.
-
status.userSoc
Data type Permission number R Read-only number, which represents the state of charge of your battery in percent.
-
status.acFrequency
Data type Permission number R Read-only number, which represents the AC Frequency in hertz.
-
status.acVoltage
Data type Permission number R Read-only number, which represents the current AC voltage of your inverter.
-
status.batteryVoltage
Data type Permission number R Read-only number, which represents the current DC voltage of the battery.
-
status.systemTime
Data type Permission date R Read-only ISO date, which represents the system time of your battery.
-
status.systemInstalled
Data type Permission boolean R Read-only boolean indicator. True if system is installed otherwise false.
-
status.batteryCharging
Data type Permission boolean R Read-only boolean indicator. True if battery is charging, otherwise false.
-
status.flowConsumptionBattery
Data type Permission boolean R Read-only boolean indicator. True if you are consuming from battery, otherwise false.
-
status.flowConsumptionGrid
Data type Permission boolean R Read-only boolean indicator. True if you are consuming from grid, otherwise false.
-
status.flowConsumptionProduction
Data type Permission boolean R Read-only boolean indicator. True if you are consuming from your current production, otherwise false.
-
status.flowGridBattery
Data type Permission boolean R Read-only boolean indicator. True if grid charges battery, otherwise false.
-
status.flowProductionBattery
Data type Permission boolean R Read-only boolean indicator. True if production charges battery, otherwise false.
-
status.flowProductionGrid
Data type Permission boolean R Read-only boolean indicator. True if production flows into grid, otherwise false.
-
status.gridFeedIn
Data type Permission number R Read-only number, which represents the amount of watts consuming from or feeding in grid. If the number is positive you are feeding the grid, if negative you are consuming from grid.
Channel: control
-
control.charge
Data type Permission number R/W Number-value which allows you to control the charging rate of the battery in watts. If you set garbage here it will also be acknowledged, because acknowldging just means that the battery received your command.
Example:
setState('sonnen.0.control.charge', 1250); // Do not charge more than 1250 watts
-
control.discharge
Data type Permission number R/W Number-value which allows you to control the discharging rate of the battery in watts. If you set garbage here it will also be acknowledged, because acknowldging just means that the battery received your command.
Example:
setState('sonnen.0.control.discharge', 1250); // Do not discharge more than 1250 watts
Changelog
1.4.2 (2020-04-16)
- (foxriver76) added more translations
- (foxriver76) optimizations for compact mode
1.4.0
- (foxriver76) introducing new states with power metering and inverter information (supported on :8080 API)
- (foxriver76) only minimum support until we know what users need as states
1.3.0
- (foxriver76) introducing new state with configuration information (supported on :8080 API)
1.2.0
- (foxriver76) support of another sonnen api
1.1.2
- (foxriver76) bugfix for control states
1.1.1
- (foxriver76) add compact mode compatibility
1.0.2
- (foxriver76) use adapter-core module
1.0.1
- (foxriver76) take timezone offset into account on time states
1.0.0
- (foxriver76) formal version increment
0.0.8
- (foxriver76) Enhanced debug logging
- (foxriver76) Prevent crashing when a return code is received
0.0.7
- (foxriver76) Only set info.connection on change
0.0.6
- (foxriver76) Only set states if request was successfull --> prevents adapter crash
0.0.5
- (foxriver76) translations on index_m.html
- (foxriver76) use 7000 as interval if poll interval is undefined
0.0.3
- (foxriver76) fixed links to bugs, repo etc
0.0.2
- (foxriver76) bugfixes on control states
- (foxriver76) big readme update
- (foxriver76) addded more states
- (foxriver76) added advanced settings
0.0.1
- (foxriver76) initial release
License
The MIT License (MIT)
Copyright (c) 2018-2020 Moritz Heusinger moritz.heusinger@gmail.com
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.