iobroker.faikout 0.2.0 → 1.1.0

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 (86) hide show
  1. package/README.md +207 -23
  2. package/admin/custom/assets/Components-DaQJD7hd.js +72 -0
  3. package/admin/custom/assets/Kennlinie-BOtdi_aK.js +1 -0
  4. package/admin/custom/assets/_virtual_mf-localSharedImportMap___mfe_internal__ConfigCustomFaikoutSet__mf_owner__1-BzvR7nJt.js +1 -0
  5. package/admin/custom/assets/dist-DkW_pC22.js +1 -0
  6. package/admin/custom/assets/helpers-go7zUEpz.js +1 -0
  7. package/admin/custom/assets/utils-D_dxHZAD.js +4 -0
  8. package/admin/custom/assets/vite-preload-helper-BbbETgeG.js +1 -0
  9. package/admin/custom/customComponents.js +12 -0
  10. package/admin/custom/i18n/de.json +17 -0
  11. package/admin/custom/i18n/en.json +17 -0
  12. package/admin/custom/i18n/es.json +17 -0
  13. package/admin/custom/i18n/fr.json +17 -0
  14. package/admin/custom/i18n/it.json +17 -0
  15. package/admin/custom/i18n/nl.json +17 -0
  16. package/admin/custom/i18n/pl.json +17 -0
  17. package/admin/custom/i18n/pt.json +17 -0
  18. package/admin/custom/i18n/ru.json +17 -0
  19. package/admin/custom/i18n/uk.json +17 -0
  20. package/admin/custom/i18n/zh-cn.json +17 -0
  21. package/admin/custom/mf-manifest.json +1 -0
  22. package/admin/i18n/de.json +273 -17
  23. package/admin/i18n/en.json +275 -19
  24. package/admin/i18n/es.json +284 -28
  25. package/admin/i18n/fr.json +289 -33
  26. package/admin/i18n/it.json +286 -30
  27. package/admin/i18n/nl.json +279 -23
  28. package/admin/i18n/pl.json +276 -20
  29. package/admin/i18n/pt.json +286 -30
  30. package/admin/i18n/ru.json +276 -20
  31. package/admin/i18n/uk.json +281 -25
  32. package/admin/i18n/zh-cn.json +283 -27
  33. package/admin/jsonConfig.json +3323 -474
  34. package/admin/verbrauch.html +1000 -0
  35. package/admin/wochenplan.html +1611 -0
  36. package/io-package.json +130 -37
  37. package/lib/anbinden.js +519 -0
  38. package/lib/broker.js +65 -6
  39. package/lib/brokerextern.js +388 -0
  40. package/lib/devicemanager.js +930 -31
  41. package/lib/discovery.js +557 -0
  42. package/lib/effizienz/index.js +1283 -0
  43. package/lib/effizienz/kalibrierung.js +258 -0
  44. package/lib/effizienz/luft.js +82 -0
  45. package/lib/effizienz/luftstrom.js +233 -0
  46. package/lib/effizienz/modelle.js +213 -0
  47. package/lib/effizienz/modelle.json +3009 -0
  48. package/lib/effizienz/rechnen.js +256 -0
  49. package/lib/effizienz/texte.js +719 -0
  50. package/lib/effizienz/wirksamkeit.js +104 -0
  51. package/lib/effizienz/zaehler.js +125 -0
  52. package/lib/fields.js +10 -7
  53. package/lib/kennlinienbild.js +9 -0
  54. package/lib/kennlinienzug.js +480 -0
  55. package/lib/moduleinstellungen.js +265 -0
  56. package/lib/namen.js +50 -50
  57. package/lib/oberflaeche.js +4252 -0
  58. package/lib/raumkorrekturzug.js +102 -0
  59. package/lib/regel/bedarf.js +435 -0
  60. package/lib/regel/control.js +44 -0
  61. package/lib/regel/faehigkeit.js +83 -0
  62. package/lib/regel/feuchte.js +159 -0
  63. package/lib/regel/fuehler.js +59 -0
  64. package/lib/regel/handeingriff.js +136 -0
  65. package/lib/regel/index.js +1812 -0
  66. package/lib/regel/kennlinie.js +122 -0
  67. package/lib/regel/koordinator.js +419 -0
  68. package/lib/regel/nutzlast.js +131 -0
  69. package/lib/regel/quellen.js +112 -0
  70. package/lib/regel/schreiber.js +111 -0
  71. package/lib/regel/sender.js +160 -0
  72. package/lib/regel/texte.js +1776 -0
  73. package/lib/regel/umzug.js +314 -0
  74. package/lib/regel/vorlage.js +181 -0
  75. package/lib/regel/wochenplan.js +548 -0
  76. package/lib/regel/zustand.js +105 -0
  77. package/lib/suche.js +281 -0
  78. package/lib/verbrauch.js +13 -10
  79. package/lib/verbrauchbild.js +780 -0
  80. package/lib/zeitplaene.js +774 -0
  81. package/main.js +1331 -20
  82. package/package.json +10 -6
  83. package/widgets/faikout/css/faikout.css +33 -0
  84. package/widgets/faikout/js/faikout.js +447 -152
  85. package/widgets/faikout/js/kennlinienbild.js +386 -0
  86. package/widgets/faikout.html +62 -27
package/README.md CHANGED
@@ -59,6 +59,55 @@ Objects are grouped per device:
59
59
  connections, which is the usual case inside a home network.
60
60
  3. Open the web interface of each faikout module, go to **Settings → Basic** and set
61
61
  **MQTT host** to `<ioBroker IP>:<port>`. The module reconnects on its own.
62
+ The tab **Find modules** shows the exact value to copy (see below).
63
+
64
+ ### Internal or external broker
65
+
66
+ By default the adapter runs its **own MQTT broker** – nothing else has to be installed, the
67
+ modules only point to it. In the tab **MQTT broker** you can choose an **external broker** instead
68
+ (for example Mosquitto or the ioBroker MQTT adapter): the adapter then connects as a client with
69
+ address, port, optional TLS, user name, password, client ID and an optional topic prefix. "Test
70
+ connection" checks the values of the form before saving and says whether the broker is reachable,
71
+ rejects the sign-in or does not answer.
72
+
73
+ With an external broker the adapter's own broker does not run and its port becomes free. The
74
+ modules must point to the external broker themselves (module setting `mqtthost`); the adapter does
75
+ not change that automatically – the tab "Find modules" shows which modules still point elsewhere
76
+ and can switch one over. Switching between the two modes loses no data; the adapter restarts after
77
+ saving.
78
+
79
+ ### Find modules
80
+
81
+ The tab **Find modules** in the instance settings helps with step 3:
82
+
83
+ - **Address for modules** is the address under which the modules reach this ioBroker. It is
84
+ pre-filled from the network interfaces of the host. If only Docker addresses (172.16.0.0/12)
85
+ are found, enter the address of the Docker host yourself. Below it the ready-to-copy value
86
+ for **MQTT host** (`address:port`) is shown.
87
+ - **Search** asks once via mDNS for `_http._tcp` (every faikout module announces its web interface
88
+ there) and reads the settings page `/revk-settings` of every candidate - read only, with a 2 s
89
+ timeout and at most 4 requests at a time. Nothing is changed on the modules, and there is no
90
+ background or scheduled search. Answers repeated by an mDNS reflector (e.g. a UniFi gateway)
91
+ are attributed to the address in the A record, not to the reflector.
92
+ - **Check address** reads the settings page of one IP address or host name - useful in Docker
93
+ (bridge network), where mDNS does not reach the modules. There is no range scan.
94
+ - The result lists name / host name, IP, firmware / hardware and the status: connected to this
95
+ adapter, set to this adapter but not connected, no MQTT broker set, other MQTT broker, settings
96
+ protected by password, or web login required.
97
+
98
+ - **Connect a module** sets the MQTT host of ONE module to this adapter: choose the module from
99
+ the search, click **Check** (fresh read of the module, preview of host name, IP, firmware and
100
+ MQTT host old → new), then **Connect** and confirm. If the module currently uses another MQTT
101
+ broker, "Replace other broker" has to be ticked as well. Right before saving the module is read
102
+ again; if anything changed since the check, nothing is saved. The module gets one POST with
103
+ `mqtthost=<address>:<port>` (plus MQTT user/password if this adapter has a user) and restarts;
104
+ it has to report to this adapter within 90 s. **Restore** writes the MQTT host read before
105
+ back (an old MQTT password cannot be read back - you get a warning if it was changed). A
106
+ settings password of the module is used for that one action only and never saved. Nothing else
107
+ is changed: no second broker, no firmware update, no OTA settings, and never several modules
108
+ at once.
109
+
110
+ Values from the modules' settings forms (broker, user, passwords) are neither logged nor saved.
62
111
 
63
112
  ### Running ioBroker in Docker
64
113
 
@@ -121,18 +170,89 @@ the device cards. Lovelace, however, converts the keys of `common.states` to num
121
170
  climate entity; with text keys this gives `NaN` and the command is lost. Use the numeric twins in
122
171
  `<device>.control.*` for such tools:
123
172
 
124
- | State | Role | Values |
125
- | ----------- | --------------------------- | ------------------------------------------------------------------- |
126
- | `modeNum` | `level.mode.airconditioner` | 0 off, 1 heat_cool, 2 cool, 3 heat, 4 dry, 5 fan_only |
127
- | `fanNum` | `level.mode.fan` | 0 auto, 1 night, 2 low, 3 lowMedium, 4 medium, 5 mediumHigh, 6 high |
128
- | `swingNum` | `level.mode.swing` | 0 off, 1 on, 2 vertical, 3 horizontal, 4 both, 5 comfort |
129
- | `presetNum` | `level.mode` | 0 home, 1 eco, 2 boost |
173
+ | State | Role | Values |
174
+ | ----------- | --------------------------- | ----------------------------------------------------------------------------- |
175
+ | `modeNum` | `level.mode.airconditioner` | 0 off, 1 heat_cool, 2 cool, 3 heat, 4 dry, 5 fan_only |
176
+ | `fanNum` | `level.mode.fan` | 0 auto, 1 night, 2 low, 3 lowMedium, 4 medium, 5 mediumHigh, 6 high |
177
+ | `swingNum` | `level.mode.swing` | 0 off, 1 on, 2 vertical, 3 horizontal, 4 both, 5 comfort, 6 horizontalComfort |
178
+ | `presetNum` | `level.mode` | 0 home, 1 eco, 2 boost |
130
179
 
131
180
  The roles let the type detector find them as part of an air conditioner. Writing `2`, `"2"` or the label
132
181
  `"cool"` to `modeNum` sends one command `cool` to the module; `modeNum` and `mode` are both set with
133
182
  `ack=true` when the module confirms. A value outside the list is discarded with a warning in the log.
134
183
  The twins are created with the first report of a module after the update.
135
184
 
185
+ ## Climate control
186
+
187
+ The tabs **Schedules** (when which temperature applies) and **Climate control** (how the unit is
188
+ run) of the instance settings, the device cards (admin, device manager) and the vis widget
189
+ "Climate control" operate the built-in control. A step-by-step guide with pictures:
190
+ [English](docs/en/README.md) · [Deutsch](docs/de/README.md).
191
+
192
+ Nothing is sent until you switch a function on per unit. To try things out first there is a
193
+ **dry run** (tab "Climate control", "For advanced users"): the adapter then calculates and shows what
194
+ it would do, but sends nothing. Instances from older versions keep their dry run switched on.
195
+
196
+ - **Global template and per unit**: the template holds strategy, curves, limits (factory default
197
+ 40 % to 100 %), temperature levels and a template schedule and applies to all units. Each unit
198
+ has an entry with who controls, sensor sources and frost protection. A unit follows the template
199
+ until you change something for it: a curve, limit, strategy or temperature level you adjust becomes
200
+ the unit's own value, "Reset to the template" takes it back (each part separately).
201
+ - **Visible calculation**: below each unit curve the line "How the value comes about right now" shows
202
+ curve (or previous day) → room correction → result with the numbers of the control; the strength of
203
+ the room correction and its dead band are dragged in a chart under "For advanced users".
204
+ - **Who controls**: *ioBroker adapter controls* (schedule, temperature levels, power limit, humidity – nothing is stored
205
+ in the module) or *Faikout module controls itself* (the module controls to the target itself; the adapter supplies
206
+ target, sensor value and schedule). While the module controls itself the power limit is only set with the
207
+ strategy "Auto", and every change of the target is stored in the module's flash memory – the
208
+ settings warn when a schedule changes the target six or more times a day.
209
+ - **Demand control** limits the power (`demand`) in 5 % steps, either by a curve over the outside
210
+ temperature (drawn live, with the current operating point) or as "Auto" (yesterday's consumption
211
+ plus a margin).
212
+ - **Temperature levels and weekly schedule** (tab "Schedules"): a temperature level is a complete
213
+ state of the unit (on/off, mode, target, fan, maximum power). The weekly schedule is edited in the
214
+ tab "Schedules" or on the device card (button "Weekly schedule") and takes effect at once: click into a block to
215
+ add a switching time, drag a line to move it, click a line to change or delete it, copy and paste
216
+ whole days, load the default schedule, set an absence.
217
+ - **Sensor sources**: automatic, sensor of the unit, BLE sensor on the module or any ioBroker data
218
+ point. A room data point either adjusts the setpoint of the unit (recommended) or is sent to the
219
+ module.
220
+ - **Humidity and dew point**, **manual override** (schedule and temperature levels wait after someone used the
221
+ remote control; "End manual override" on the card ends the wait) and **public holidays** are set
222
+ once for all units.
223
+ - **Copy, paste, reset**: below every chart of the settings (curve, temperature levels, humidity,
224
+ weekly schedule) the content can be copied, pasted at another unit or in the template, and reset
225
+ to the template or the factory default – with a short-lived "Undo".
226
+ - **Device card**: state and reason, power limit, temperature level and next switching time, three symbol
227
+ buttons for demand control, humidity control and weekly schedule, sensors with a warning when a
228
+ fallback sensor is used. The chart button explains the current decision (curve with operating
229
+ point, steps of the calculation, last 24 hours).
230
+
231
+ ### Power limit on Daikin units
232
+
233
+ The power limit (`demand`) only has an effect on a Daikin unit if
234
+
235
+ 1. the **original Daikin Wi-Fi module is switched on** (remote control: hold "Powerful" for
236
+ 5 seconds until "SP 1" appears). No internet and no cloud connection are needed – the app may be
237
+ offline – and
238
+ 2. **demand control is set to "On"** in the Daikin app.
239
+
240
+ "Off" in the app always means 100 %; values sent by the faikout module then have no effect. With
241
+ "On", both the app and faikout may write, the last value wins. "Auto" means the cloud controls. A
242
+ value rejected while the unit is switched off says nothing – the adapter keeps showing "not tested
243
+ yet".
244
+
245
+ ### Changing settings in the module
246
+
247
+ The tab **Module settings** reads a fixed list of settings from the module (HTTP GET only), shows
248
+ the difference to the form and writes after a confirmation: one MQTT message
249
+ `setting/<module name>` with only the changed values, then it reads back and reports the result
250
+ per setting. Before every write the state that was read is kept (the last five per module) and
251
+ can be loaded into the form again. Settings a module does not offer (this depends on firmware and
252
+ unit) are named and never written. Firmware/OTA, broker, Wi-Fi, passwords and the host name can
253
+ never be written from here. Every write wears the flash memory of the module and restarts it for
254
+ some settings.
255
+
136
256
  ## Visualisation (vis templates)
137
257
 
138
258
  The folder [`vis-templates/`](vis-templates/) contains ready-made **vis 1** views for two units: overview,
@@ -140,12 +260,93 @@ one detail page per unit with controls, energy history and a phone view. They us
140
260
  `faikout.0` and the widgets of this adapter – no scripts, no other adapters. Import instructions:
141
261
  [vis-templates/README.md](vis-templates/README.md).
142
262
 
263
+ ## Languages
264
+
265
+ The adapter, its settings page, device cards and data point names are available in English, German,
266
+ Russian, Portuguese, Dutch, French, Italian, Spanish, Polish, Ukrainian and Simplified Chinese. German
267
+ and English are maintained by the author; the other nine translations are machine-made and
268
+ machine-proofread (consistent terms, layout checked in every language), but have not been reviewed by
269
+ native speakers – corrections are welcome (issue or pull request). The vis widgets
270
+ show their texts in the same eleven languages (they follow the language of vis and fall back to English);
271
+ their attribute names are translated too. The step-by-step
272
+ guide exists in [English](docs/en/README.md) and [German](docs/de/README.md).
273
+
143
274
  ## Changelog
144
275
 
145
276
  <!--
146
277
  Placeholder for the next version (at the beginning of the line):
147
278
  ### **WORK IN PROGRESS**
148
279
  -->
280
+ ### 1.1.0 (2026-11-22)
281
+ - Efficiency: estimated heat and cooling output, live COP/EER and heat/cooling energy and COP per day and
282
+ month for every unit (data points `efficiency.*`). Calculated from airflow (fan level or fan speed via the
283
+ airflow curve of the model) and the temperatures the unit reports; defrosting and pauses are detected and
284
+ count no heat. Every value carries its quality (estimated, calibrated, measured) and an uncertainty in %.
285
+ Units that do not report the required values (e.g. IR bridges) show "not available" with the reason.
286
+ - New tab "Efficiency": diagram of the calculation, one card per unit with live values, model choice
287
+ (list of 96 Daikin indoor units from the manufacturer tables with source and gaps; own models can be added),
288
+ airflow per fan level as draggable bars, ε per level, optional electricity price → cost per kWh of heat.
289
+ - Calibration assistant: choose an outlet sensor, the adapter measures for days (survives a restart) and shows
290
+ the coverage per fan level and outdoor temperature; result with ε per level, residual error and reasoning,
291
+ adopt or discard. Alternatively manual measurements (time and outlet temperature). Several calibrations per
292
+ unit, reset to the data sheet estimate.
293
+ - Consumption chart: switchable to heat with a COP line (electricity stays the default); device card shows
294
+ "COP today".
295
+ - Simulator (tests): true heat output, airflow and a simulated outlet sensor.
296
+
297
+ ### 1.0.0 (2026-11-21)
298
+ - Climate control per unit: power limit by outdoor curve or "Auto" (previous day plus margin),
299
+ weekly schedule with temperature levels, public holidays and absence, humidity and dew point control, manual
300
+ override, frost protection, optional dry run. Every decision is shown with its reason.
301
+ - Two levels only: a global template and own values per unit, which arise when you change something
302
+ for a unit ("Reset to the template" takes them back). "Scenes" are now called temperature levels and live in the tab "Schedules" together
303
+ with the weekly schedules (also reachable from the device card, button "Weekly schedule").
304
+ Factory defaults: lower limit 40 %, upper limit 100 % (was 95 %), top point of the heating curve
305
+ −10 °C → 100 % (was 95 %); "2 K below the target → 100 %" stays.
306
+ - Settings of pre-release builds are migrated once at start: existing unit entries keep their own
307
+ values (same behaviour as before), `regelSzenen`/`szenen` → `regelStufen`/`stufen`, the old
308
+ factory defaults 95 % → 100 % (own values are never overwritten), broker user name `User` → `user`.
309
+ Data points `regulation.schedule.scene`/`nextScene` → `level`/`nextLevel`, JSON key `scene` → `level`.
310
+ - Sensor sources with fallback (BLE sensor at the module, any data point, sensor of the unit);
311
+ external or slow room sensors are handled by a slow correction of the unit's setpoint.
312
+ - Device cards with control state, weekly schedule dialog and details dialog; new VIS widget.
313
+ - The control data points live below `<unit>.regulation.*` with English IDs, state values and JSON
314
+ keys; data points and JSON values of pre-release builds (`regel.*`, German keys) are moved or
315
+ rewritten once at start.
316
+ - Instance settings ordered by importance: Setup, Schedules, Climate control, Consumption, Find modules,
317
+ then the technical tabs (MQTT broker, Module settings); details for advanced users are collapsed.
318
+ The setup tab lists the steps as a checklist that ticks off what is already done.
319
+ - Module settings can be read and written (with preview, backup and read-back).
320
+ - The reason why a unit does not accept the power limit is explained (Daikin Wi-Fi module and app).
321
+ - New tab "Find modules" in the instance settings: one-off mDNS search or check of a single
322
+ address, read-only fingerprint of the module's settings page, status per module (connected,
323
+ no broker, other broker, password protected, web login); new setting "Address for modules" with
324
+ the ready-to-copy MQTT host value.
325
+ - "Connect a module": sets the MQTT host of one module to this adapter after a check and a
326
+ confirmation, verifies that it reports within 90 s, and can restore the previous MQTT host.
327
+ - Optional external MQTT broker (for example Mosquitto) instead of the built-in one, with a
328
+ connection test in the settings.
329
+ - Settings: setup guide as the first tab in numbered steps with a live status; module
330
+ selection lists all units; sensor data points are checked while typing and show their live value;
331
+ default curve as a table; consumption chart (stacked bars per unit, day/week/month/year).
332
+ - Device cards: "not set up" with a "Create schedule" button instead of "fault" while no schedule
333
+ exists, buttons − and + for the target temperature, energy of the current month.
334
+
335
+ ### 0.2.1 (2026-11-19)
336
+ - `control.swing` / `swingNum`: new value `H+C` (`horizontalComfort`, number 6) for comfort mode with
337
+ horizontal swing. Comfort is a mode of the vertical louvres; the swing selector (e.g. in Lovelace) can now
338
+ combine it with horizontal swing. Needs Faikout firmware with `H+C` support; older firmware reports `C`
339
+ during comfort and treats a written `H+C` as `off`.
340
+ - Renamed modules (issue #6): after changing the hostname of a module, the adapter kept the old name in memory
341
+ until the next restart and, once its objects were deleted, logged `State "...consumption..." has no existing
342
+ object` every hour. The module is now recognised by its hardware ID (`info.id`): the old name is no longer
343
+ updated, its consumption counters (today, month, JSON series) continue under the new name, and its objects
344
+ stay untouched until you delete them (SmarthomeElektroniker)
345
+ - Deleted objects are noticed while the adapter runs: a deleted device is dropped, a deleted state or branch is
346
+ created again before the next write; states are no longer written to objects that do not exist
347
+ (SmarthomeElektroniker)
348
+ - Dev dependency `@iobroker/testing` 6.3.2 (SmarthomeElektroniker)
349
+
149
350
  ### 0.2.0 (2026-11-13)
150
351
  - Numeric twins of the text control states: `control.modeNum`, `fanNum`, `swingNum` and `presetNum` with
151
352
  `common.states` (`{0: "off", 1: "heat_cool", ...}`) and the roles `level.mode.airconditioner`,
@@ -183,23 +384,6 @@ one detail page per unit with controls, energy history and a phone view. They us
183
384
  cannot set CSS custom properties with `.css()`, so it always stayed blue.
184
385
  - New: vis templates (`vis-templates/`) – overview, detail page per unit, energy and phone view.
185
386
 
186
- ### 0.0.17
187
- - Fixed units of `status.comp` and `status.fanfreq`: the module sends Hz by default and rpm only with `ha.comprpm`/`ha.fanrpm`.
188
- The adapter now takes the unit from the module's Home Assistant discovery (a fractional fan value is always Hz),
189
- sets it on the state and remembers it per device. The VIS widgets show the unit of the state.
190
- - All fields the module can report are described: new `status.action` (with `no.hvacaction` off), `status.loopback`,
191
- `status.bletemp`/`blehum`/`blebat`, `info.dma`, `info.restart`, `info.ipv6`, `info.secureboot`, `info.nvsecryption`.
192
- `dma` and `restart` were created as unknown fields under `status.*` up to 0.0.16 and are moved to `info.*` on start.
193
- - New tab "Module settings" in the instance configuration: which settings the faikout module needs for the complete set of
194
- data points (all eleven languages). Same table in the README.
195
- - Warning in the log when a module is connected without `ha.enable`.
196
-
197
- ### 0.0.16
198
- - Release notes in `io-package.json` trimmed to seven entries and translated into all languages (repository checker E1032/E1144).
199
-
200
- ### 0.0.15
201
- - The MQTT broker's shutdown timeout uses the adapter's `setTimeout` (repository checker E5005).
202
-
203
387
  [Older changelog entries can be found here](CHANGELOG_OLD.md)
204
388
 
205
389
  ## Trademark and relationship to the hardware project