npm - iobroker.senec - Versions diffs - 1.3.0 → 1.3.4 - Mend

iobroker.senec 1.3.0 → 1.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/LICENSE +3 -1
package/README.md +17 -3
package/io-package.json +67 -194
package/lib/adapter-config.d.ts +18 -18
package/lib/state_attr.js +848 -136
package/lib/state_trans.js +282 -0
package/lib/tools.js +99 -98
package/main.js +104 -36
package/package.json +34 -24
package/CHANGELOG_old.md +0 -68
package/admin/admin.d.ts +0 -93
package/docs/de/README.md +0 -574
package/docs/de/media/mainSettings.png +0 -0
package/docs/en/README.md +0 -554
package/docs/en/media/mainSettings.png +0 -0
package/main.test.js +0 -30

package/docs/en/README.md DELETED Viewed

@@ -1,554 +0,0 @@
-![Logo](/admin/senec.png)
-# ioBroker.senec
-## senec adapter for ioBroker
-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 is facilitated via the ioBroker web interface and the configuration will auto-open once installation is completed.
-## Setup
-In addition to the adapter installation you have to add an instance of the adapter.
-### Configuration
-![Main Settings](media/mainSettings.png "Main Settings")
-| Field         | Description |
-|:-------------|:-------------|
-|SENEC System    |Type in the IP-address of your SENEC system (FQDN is also possible if you have a working local DNS).|
-|Polling Interval High Priority Data|You can change the polling interval for high priority data (how often the Adapter reads from your Senec System), too. (Default: 10 seconds)|
-|Polling Interval Low Priority Data|You can change the polling interval for low priority data (how often the Adapter reads from your Senec System), too. (Default: 60 minutes)<br>
-Please be careful with high-frequency polling because this can render your SENEC machine unable to connect to the SENEC server!|
-|Request-Timeout|If your network requires a higher timeout for requests sent to SENEC, please change the Request-Timeout in miliseconds accordingly. (Default: 5000 miliseconds)|
-|Polling Retries|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)<br>
-This does not apply to Adapter Start - if the System is unavailable to Adapter will stop.|
-|Polling Retry Factor|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.|
-Once finished setting up configuration, hit `SAVE AND CLOSE` to leave configuration dialogue. The adapter will automatically restart.
-## Usage
-Here you can find a description of the states and how to use them. All states of this adapter are read-only states.
-Depending on the individual system states might not be available or additional states could be there.
-If a state is not documented (or only partially documented) and you know what it represents, please send a pull request (or open a ticket with the information).
-### 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: _calc
-This channel contains calculated values. Currently these are day/week/month/year values at specific data points.
-* xxx.refDay/Week/Month/Year
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|W|
-   *Modifiable number indicating for which day/week/month/year the data is valid.
-* xxx.refValue/Week/Mont/Year
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|W|
-   *Modifiable number indicating what the reference value is for calculating the current value.
-* xxx.today/week/month/year
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|W|
-   *Modifiable number representing the current value for day/week/month/year of the corresponding data point.
-* xxx.yesterday/lastWeek/lastMonth/lastYear
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|W|
-   *Modifiable number representing the previous value for day/week/month/year of the corresponding data point.
-#### Channel: BMS
-* BL[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents ? for each battery pack.*
-* CHARGED_ENERGY[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents the amount of charged energy per battery pack in unit ?*
-* CHARGE_CURRENT_LIMIT[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents the current charge limit in Ampere per battery pack.*
-* CURRENT[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's current in Ampere.*
-* CYCLES[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's current charching cycles.*
-* DISCHARGED_ENERGY[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents the amount of energy discharged per battery in unit ?.*
-* DISCHARGE_CURRENT_LIMIT[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's current discharge limit in Ampere.*
-* FW[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's firmware version.*
-* HW_EXTENSION[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's ?.*
-* HW_MAINBOARD[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's mainboard version.*
-* MAX_CELL_VOTAGE[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's maximum cell voltage in Volts.*
-* MIN_CELL_VOTAGE[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's minimum cell voltage in Volts.*
-* SN[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's serial number.*
-* SOC[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's state of charge.*
-* SOH[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's state of health.*
-* STATUS[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's status.*
-* TEMP_MAX[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's maximum temperature.*
-* TEMP_MIN[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's minimum temperature.*
-* VOLTAGE[0-3]
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only number, which represents each battery pack's voltage in Volts.*
-* BMS_READY_FLAG
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only boolean, which represents if the BMS is ready.*
-* 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).*
-* START_UPDATE
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only boolean, which represents if an update is to be started.*
-* WIZARD_ABORT
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only boolean, which represents if the setup wizard was aborted.*
-* WIZARD_CONFIRM
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only boolean, which represents if the setup wizard was confirmed.*
-* WIZARD_DCCONNECT
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only boolean, which represents ?.*
-* WIZARD_START
-    |Data type|Permission|
-    |:---:|:---:|
-    |number|R|
-   *Read-only boolean, which represents if the setup wizard is to be started.*
-* WIZARD_STATE
-    |Data type|Permission|
-    |:---:|:---:|
-    |boolean|R|
-   *Read-only number, which represents the setup wizard's state.*
-#### 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|
-    |:---:|:---:|
-    |string|R|
-   *Read-only text, which designates the serial number of wallbox [0..3].*

package/docs/en/media/mainSettings.png DELETED Viewed

Binary file

package/main.test.js DELETED Viewed

@@ -1,30 +0,0 @@
-'use strict';
-/**
- * This is a dummy TypeScript test file using chai and mocha
- *
- * It's automatically excluded from npm and its build output is excluded from both git and npm.
- * It is advised to test all your modules with accompanying *.test.js-files
- */
-// tslint:disable:no-unused-expression
-const { expect } = require('chai');
-// import { functionToTest } from "./moduleToTest";
-describe('module to test => function to test', () => {
-    // initializing logic
-    const expected = 5;
-    it(`should return ${expected}`, () => {
-        const result = 5;
-        // assign result a value from functionToTest
-        expect(result).to.equal(expected);
-        // or using the should() syntax
-        result.should.equal(expected);
-    });
-    // ... more tests => it
-});
-// ... more test suites => describe