iobroker.sma-echarger 0.1.7 → 0.1.8

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 (3) hide show
  1. package/README.md +38 -104
  2. package/io-package.json +34 -31
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -2,124 +2,58 @@
2
2
 
3
3
  # ioBroker.sma-echarger
4
4
 
5
- [![NPM version](https://img.shields.io/npm/v/iobroker.sma-echarger.svg)](https://www.npmjs.com/package/iobroker.sma-echarger)
6
- [![Downloads](https://img.shields.io/npm/dm/iobroker.sma-echarger.svg)](https://www.npmjs.com/package/iobroker.sma-echarger)
7
- ![Number of Installations](https://iobroker.live/badges/sma-echarger-installed.svg)
8
- ![Current version in stable repository](https://iobroker.live/badges/sma-echarger-stable.svg)
5
+ [![NPM version](https://shields.io)](https://npmjs.com)
6
+ [![Downloads](https://shields.io)](https://npmjs.com)
7
+ ![Number of Installations](https://iobroker.live)
8
+ ![Current version in stable repository](https://iobroker.live)
9
9
 
10
- [![NPM](https://nodei.co/npm/iobroker.sma-echarger.png?downloads=true)](https://nodei.co/npm/iobroker.sma-echarger/)
10
+ [![NPM](https://nodei.co)](https://nodei.co)
11
11
 
12
- **Tests:** ![Test and Release](<https://github.com/SpongeTroN/ioBroker.sma-echarger/workflows/Test%20and%20Release/badge.svg>)
12
+ **Tests:** ![Test and Release](https://github.com)
13
13
 
14
- ## sma-echarger adapter for ioBroker
14
+ ## SMA eCharger adapter for ioBroker
15
15
 
16
- Anbindung eines SMA eChargers. Lesen und Steuern
16
+ This adapter connects your **SMA eCharger** (e.g., EVC22-3AC-20) locally via its HTTPS JSON API to ioBroker. It allows you to monitor live charging values, read device parameters, and control charging modes or power limits.
17
17
 
18
- ## Developer manual
18
+ ### Features
19
+ * **Live Measurements (`Live.*`):** Current charging power (W), total and session energy (Wh), charging status, device health, phase currents (L1–L3), and voltages.
20
+ * **Device Parameters (`Parameter.*`):** Automatic retrieval of all readable SMA eCharger configuration parameters.
21
+ * **Remote Control (`Control.*`):** Change the charging mode (Fast, PV Surplus, Target, Stop), adjust maximum active power (`WMax` / `WMaxIn`), and control charging release.
19
22
 
20
- This section is intended for the developer. It can be deleted later.
23
+ ### Configuration
24
+ 1. Open the adapter instance settings in ioBroker.
25
+ 2. Enter the local **IP address** of your SMA eCharger.
26
+ 3. Enter your **Username** (`user` for reading values, or `admin` / an installer account if you want to modify inverter power limits like `WMax`) and **Password**.
27
+ 4. Set the desired **Poll interval** in seconds (default: `15` seconds).
21
28
 
22
- ### DISCLAIMER
29
+ ---
23
30
 
24
- Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README.
25
- You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you.
31
+ ## Deutsche Beschreibung
26
32
 
27
- ### Getting started
33
+ Dieser Adapter bindet deinen **SMA eCharger** (z. B. EVC22-3AC-20) lokal über die HTTPS-JSON-Schnittstelle an ioBroker an. Damit lassen sich Live-Messwerte auslesen, Geräteparameter überwachen sowie Lademodus und Leistungsbegrenzungen direkt steuern.
28
34
 
29
- You are almost done, only a few steps left:
35
+ ### Funktionen
36
+ * **Live-Messwerte (`Live.*`):** Aktuelle Ladeleistung (W), Gesamt- und Sitzungsenergie (Wh), Fahrzeug-/Ladestatus, Gerätestatus sowie Phasenströme (L1–L3) und Spannungen.
37
+ * **Geräteparameter (`Parameter.*`):** Automatisches Auslesen der Konfigurationsparameter des SMA eChargers.
38
+ * **Steuerung (`Control.*`):** Umschalten des Lademodus (Schnellladen, PV-Überschuss, Zielvorgabe, Stopp), Setzen der maximalen Wirkleistung (`WMax` / `WMaxIn`) und Ladefreigabe.
30
39
 
31
- 1. Create a new repository on GitHub with the name `ioBroker.sma-echarger`
32
- 2. Initialize the current folder as a new git repository:
40
+ ### Konfiguration
41
+ 1. Öffne die Instanz-Einstellungen des Adapters im ioBroker Admin-Panel.
42
+ 2. Trage die lokale **IP-Adresse** deines SMA eChargers ein.
43
+ 3. Hinterlege **Benutzername** (`user` zum reinen Auslesen, oder `admin` bzw. ein Installateur-Konto, wenn Leistungsparameter wie `WMax` geschrieben werden sollen) und **Passwort**.
44
+ 4. Lege das gewünschte **Abfrageintervall** in Sekunden fest (Standard: `15` Sekunden).
33
45
 
34
- ```bash
35
- git init -b master
36
- git add .
37
- git commit -m "Initial commit"
38
- ```
39
- 3. Link your local repository with the one on GitHub:
40
-
41
- ```bash
42
- git remote add origin https://github.com/SpongeTroN/ioBroker.sma-echarger
43
- ```
44
- 4. Push all files to the GitHub repo:
45
-
46
- ```bash
47
- git push origin master
48
- ```
49
- 5. Add a new secret under https://github.com/SpongeTroN/ioBroker.sma-echarger/settings/secrets. It must be named `AUTO_MERGE_TOKEN` and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens.
50
- 6. Head over to [main.js](main.js) and start programming!
51
-
52
- ### Best Practices
53
-
54
- We've collected some [best practices](https://github.com/ioBroker/ioBroker.repositories#development-and-coding-best-practices) regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should
55
- check them out. If you're already experienced, you should also take a look at them - you might learn something new :)
56
-
57
- ### State Roles
58
-
59
- When creating state objects, it is important to use the correct role for the state. The role defines how the state should be interpreted by visualizations and other adapters. For a list of available roles and their meanings, please refer to the [state roles documentation](https://www.iobroker.net/#en/documentation/dev/stateroles.md).
60
-
61
- **Important:** Do not invent your own custom role names. If you need a role that is not part of the official list, please contact the ioBroker developer community for guidance and discussion about adding new roles.
62
-
63
- ### Scripts in `package.json`
64
-
65
- Several npm scripts are predefined for your convenience. You can run them using `npm run <scriptname>`
66
-
67
- | Script name | Description |
68
- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
69
- | `test:js` | Executes the tests you defined in `*.test.js` files. |
70
- | `test:package` | Ensures your `package.json` and `io-package.json` are valid. |
71
- | `test:integration` | Tests the adapter startup with an actual instance of ioBroker. |
72
- | `test` | Performs a minimal test run on package files and your tests. |
73
- | `check` | Performs a type-check on your code (without compiling anything). |
74
- | `lint` | Runs `ESLint` to check your code for formatting errors and potential bugs. |
75
- | `translate` | Translates texts in your adapter to all required languages, see [`@iobroker/adapter-dev`](https://github.com/ioBroker/adapter-dev#manage-translations) for more details. |
76
- | `release` | Creates a new release, see [`@alcalzone/release-script`](https://github.com/AlCalzone/release-script#usage) for more details. |
77
-
78
- ### Writing tests
79
-
80
- When done right, testing code is invaluable, because it gives you the
81
- confidence to change your code while knowing exactly if and when
82
- something breaks. A good read on the topic of test-driven development
83
- is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92.
84
- Although writing tests before the code might seem strange at first, but it has very
85
- clear upsides.
86
-
87
- The template provides you with basic tests for the adapter startup and package files.
88
- It is recommended that you add your own tests into the mix.
89
-
90
- ### Publishing the adapter
91
-
92
- Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form
93
- `v<major>.<minor>.<patch>`. We **strongly recommend** that you do. The necessary steps are described in `.github/workflows/test-and-release.yml`.
94
-
95
- Since you installed the release script, you can create a new
96
- release simply by calling:
97
-
98
- ```bash
99
- npm run release
100
- ```
101
-
102
- Additional command line options for the release script are explained in the
103
- [release-script documentation](https://github.com/AlCalzone/release-script#command-line).
104
-
105
- To get your adapter released in ioBroker, please refer to the documentation
106
- of [ioBroker.repositories](https://github.com/ioBroker/ioBroker.repositories#requirements-for-adapter-to-get-added-to-the-latest-repository).
107
-
108
- ### Test the adapter manually with dev-server
109
-
110
- Since you set up `dev-server`, you can use it to run, test and debug your adapter.
111
-
112
- You may start `dev-server` by calling from your dev directory:
113
-
114
- ```bash
115
- dev-server watch
116
- ```
117
-
118
- The ioBroker.admin interface will then be available at http://localhost:undefined/
119
-
120
- Please refer to the [`dev-server` documentation](https://github.com/ioBroker/dev-server#command-line) for more details.
46
+ ### Disclaimer
47
+ *SMA* and *eCharger* are registered trademarks of SMA Solar Technology AG. This project is an independent open-source adapter and is not affiliated with or endorsed by SMA Solar Technology AG.
121
48
 
122
49
  ## Changelog
50
+ <!--
51
+ Placeholder for the next version (at the beginning of the line):
52
+ ### **WORK IN PROGRESS**
53
+ -->
54
+ ### 0.1.8 (2026-11-18)
55
+ * (SpongeTroN86) Updated README documentation and fixed repository metadata in io-package.json
56
+
123
57
  ### 0.1.7 (2026-11-18)
124
58
 
125
59
  * SpongeTroN86 fix: removed windows-latest from test-and-release.yml
package/io-package.json CHANGED
@@ -1,8 +1,21 @@
1
1
  {
2
2
  "common": {
3
3
  "name": "sma-echarger",
4
- "version": "0.1.7",
4
+ "version": "0.1.8",
5
5
  "news": {
6
+ "0.1.8": {
7
+ "en": "Updated README documentation and fixed repository metadata in io-package.json",
8
+ "de": "README-Dokumentation aktualisiert und Repository-Metadaten in io-package.json korrigiert",
9
+ "ru": "Обновленная документация README и исправленные метаданные репозитория в io-package.json",
10
+ "pt": "Documentação README atualizada e metadados fixos em io-package.json",
11
+ "nl": "Bijgewerkte README-documentatie en metagegevens van vaste opslagplaatsen in io-package.json",
12
+ "fr": "Documentation README mise à jour et métadonnées du dépôt corrigées dans io-package.json",
13
+ "it": "Documentazione README aggiornata e metadati fissi in io-package.json",
14
+ "es": "Documentación README actualizada y metadatos fijos en io-package.json",
15
+ "pl": "Zaktualizowano dokumentację README i stałe metadane repozytorium w io-package.json",
16
+ "uk": "Оновлена документація README та фіксовані метадані сховища в io-package.json",
17
+ "zh-cn": "更新了 io-package.json 中的 README 文档并修复了存储库元数据"
18
+ },
6
19
  "0.1.7": {
7
20
  "en": "SpongeTroN86 fix: removed windows-latest from test-and-release.yml",
8
21
  "de": "SpongeTron86 Fix: Windows-Latest aus Test-and-Release.yml entfernt",
@@ -80,19 +93,6 @@
80
93
  "pl": "Dodano zaufany przepływ pracy publikowania i zaktualizowane zależności adaptera",
81
94
  "uk": "Додано надійний робочий процес публікації та оновлені залежності адаптера",
82
95
  "zh-cn": "添加了可信发布工作流程并更新了适配器依赖关系"
83
- },
84
- "0.1.1": {
85
- "en": "initial release",
86
- "de": "erste Version",
87
- "ru": "первоначальный релиз",
88
- "pt": "versão inicial",
89
- "nl": "eerste uitgave",
90
- "fr": "sortie initiale",
91
- "it": "prima versione",
92
- "es": "versión inicial",
93
- "pl": "wstępne wydanie",
94
- "uk": "первинний випуск",
95
- "zh-cn": "初始版本"
96
96
  }
97
97
  },
98
98
  "titleLang": {
@@ -125,10 +125,13 @@
125
125
  "SpongeTroN86 <rolf@bunter-waeschekorb.de>"
126
126
  ],
127
127
  "keywords": [
128
- "template",
128
+ "SMA",
129
129
  "automation",
130
130
  "IoT",
131
- "integration"
131
+ "integration",
132
+ "EV",
133
+ "Wallbox",
134
+ "eCharger"
132
135
  ],
133
136
  "licenseInformation": {
134
137
  "type": "free",
@@ -137,8 +140,8 @@
137
140
  "platform": "Javascript/Node.js",
138
141
  "icon": "sma-echarger.png",
139
142
  "enabled": true,
140
- "extIcon": "https://raw.githubusercontent.com/SpongeTroN86/ioBroker.sma-echarger/master/admin/sma-echarger.png",
141
- "readme": "https://github.com/SpongeTroN86/ioBroker.sma-echarger/blob/master/README.md",
143
+ "extIcon": "https://raw.githubusercontent.com/SpongeTroN86/ioBroker.sma-echarger/main/admin/sma-echarger.png",
144
+ "readme": "https://github.com/SpongeTroN86/ioBroker.sma-echarger/blob/main/README.md",
142
145
  "loglevel": "info",
143
146
  "tier": 3,
144
147
  "mode": "daemon",
@@ -160,7 +163,18 @@
160
163
  }
161
164
  ]
162
165
  },
163
- "native": {},
166
+ "native": {
167
+ "ipAddress": "192.168.178.xxx",
168
+ "pollInterval": 15,
169
+ "username": "user",
170
+ "password": "***"
171
+ },
172
+ "encryptedNative": [
173
+ "password"
174
+ ],
175
+ "protectedNative": [
176
+ "password"
177
+ ],
164
178
  "objects": [],
165
179
  "instanceObjects": [
166
180
  {
@@ -182,18 +196,7 @@
182
196
  "write": false,
183
197
  "def": false
184
198
  },
185
- "encryptedNative": [
186
- "password"
187
- ],
188
- "protectedNative": [
189
- "password"
190
- ],
191
- "native": {
192
- "ipAddress": "",
193
- "pollInterval": 15,
194
- "username": "user",
195
- "password": "***"
196
- }
199
+ "native": {}
197
200
  }
198
201
  ]
199
202
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "iobroker.sma-echarger",
3
- "version": "0.1.7",
3
+ "version": "0.1.8",
4
4
  "description": "Anbindung eines SMA eChargers. Lesen und Steuern",
5
5
  "author": {
6
6
  "name": "SpongeTroN",