From 0f2be2e000ec96c76249f35d20d5fee74e32916d Mon Sep 17 00:00:00 2001 From: Patrick Schurig Date: Wed, 3 Jun 2026 15:02:25 +0200 Subject: [PATCH] feat: badge origine + catalogue complet PORTING_STATUS (60 plugins) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Partie 1 — Dimension « origine » (3ème badge) - gen_device_reference.py : ORIGIN_BADGES dict, resolve_origin() déduit l'origine depuis repo: (nymea-* → NYMEA, etm-* → ETM) ou champ origin: explicite ; colonne Origine ajoutée dans matrice et index de catégorie ; badge origine dans l'en-tête des fiches générées - extra.css : styles .badge.origin-nymea (gris-bleu), .badge.origin-etm (vert), .badge.origin-tiers (orange) - compatibilite.md : légende étendue aux 3 dimensions (canal, origine, stab.) - Catégorie « generic » ajoutée (Types génériques nymea) Partie 2 — Catalogue complet PORTING_STATUS.yaml - 9 entrées validées conservées avec leurs canaux (stable/testing/nightly) - 41 nouveaux plugins énergie activés (channel: nightly) : onduleurs PV (sma, solax, sungrow, huawei, kostal, mtec, wattsonic, sunspec, bosswerk, solarlog), IRVE (easee, goecharger, evbox, everest, v2xeamberelectric, amperfied, mennekes, webasto, pcelectric, phoenixconnect, inro), HVAC (tado, homeconnect, stiebeleltron, idm, drexelundweiss, alphainnotec, mypv), compteurs (powerfox, bgetech, inepro, schrack, vestel, senseair), smartdevices (shelly, tasmota, tuya, gpio, usbrelay, usbrly82, mqttclient, modbuscommander, unipi), tarifs (awattar, tempo, spothinta), generic (genericenergy, genericheatingcooling, genericcar) - 60 plugins domotique/hors-périmètre commentés (réactivables via # → -) - 50 fiches générées + 2 index créés (tarifs/, generic/) - mkdocs build --strict OK, --check exit 0 (idempotent) Co-Authored-By: Claude Sonnet 4.6 --- PORTING_STATUS.yaml | 378 +++++++++- docs/appareils/SUMMARY.md | 51 ++ docs/appareils/bornes/amperfied.md | 105 +++ docs/appareils/bornes/easee.md | 46 ++ docs/appareils/bornes/evbox.md | 52 ++ docs/appareils/bornes/everest.md | 98 +++ docs/appareils/bornes/goecharger.md | 64 ++ docs/appareils/bornes/inro.md | 41 + docs/appareils/bornes/keba.md | 77 +- docs/appareils/bornes/mennekes.md | 85 +++ docs/appareils/bornes/pcelectric.md | 84 +++ docs/appareils/bornes/phoenixconnect.md | 147 ++++ docs/appareils/bornes/v2xeamberelectric.md | 33 + docs/appareils/bornes/webasto.md | 108 +++ docs/appareils/compatibilite.md | 120 ++- docs/appareils/compteurs/bgetech.md | 53 ++ docs/appareils/compteurs/inepro.md | 53 ++ docs/appareils/compteurs/powerfox.md | 41 + docs/appareils/compteurs/schrack.md | 36 + docs/appareils/compteurs/senseair.md | 29 + docs/appareils/compteurs/vestel.md | 39 + docs/appareils/generic/genericcar.md | 26 + docs/appareils/generic/genericenergy.md | 90 +++ .../generic/genericheatingcooling.md | 70 ++ docs/appareils/generic/index.md | 10 + docs/appareils/hvac/alphainnotec.md | 58 ++ docs/appareils/hvac/drexelundweiss.md | 74 ++ docs/appareils/hvac/homeconnect.md | 201 +++++ docs/appareils/hvac/idm.md | 45 ++ docs/appareils/hvac/index.md | 17 +- docs/appareils/hvac/mypv.md | 34 + docs/appareils/hvac/stiebeleltron.md | 58 ++ docs/appareils/hvac/tado.md | 46 ++ docs/appareils/onduleurs/bosswerk.md | 33 + docs/appareils/onduleurs/huawei.md | 109 +++ docs/appareils/onduleurs/index.md | 16 +- docs/appareils/onduleurs/kostal.md | 85 +++ docs/appareils/onduleurs/mtec.md | 42 ++ docs/appareils/onduleurs/sma.md | 164 ++++ docs/appareils/onduleurs/solarlog.md | 45 ++ docs/appareils/onduleurs/solax.md | 86 +++ docs/appareils/onduleurs/sungrow.md | 68 ++ docs/appareils/onduleurs/sunspec.md | 297 ++++++++ docs/appareils/onduleurs/wattsonic.md | 69 ++ docs/appareils/smart/gpio.md | 126 ++++ docs/appareils/smart/modbuscommander.md | 97 +++ docs/appareils/smart/mqttclient.md | 41 + docs/appareils/smart/shelly.md | 711 ++++++++++++++++++ docs/appareils/smart/tasmota.md | 174 +++++ docs/appareils/smart/tuya.md | 66 ++ docs/appareils/smart/unipi.md | 251 +++++++ docs/appareils/smart/usbrelay.md | 42 ++ docs/appareils/smart/usbrly82.md | 47 ++ docs/appareils/smart/waveshare.md | 34 +- docs/appareils/tarifs/awattar.md | 44 ++ docs/appareils/tarifs/index.md | 10 + docs/appareils/tarifs/spothinta.md | 30 + docs/appareils/tarifs/tempo.md | 60 ++ docs/stylesheets/extra.css | 5 + scripts/gen_device_reference.py | 44 +- 60 files changed, 5195 insertions(+), 70 deletions(-) create mode 100644 docs/appareils/bornes/amperfied.md create mode 100644 docs/appareils/bornes/easee.md create mode 100644 docs/appareils/bornes/evbox.md create mode 100644 docs/appareils/bornes/everest.md create mode 100644 docs/appareils/bornes/goecharger.md create mode 100644 docs/appareils/bornes/inro.md create mode 100644 docs/appareils/bornes/mennekes.md create mode 100644 docs/appareils/bornes/pcelectric.md create mode 100644 docs/appareils/bornes/phoenixconnect.md create mode 100644 docs/appareils/bornes/v2xeamberelectric.md create mode 100644 docs/appareils/bornes/webasto.md create mode 100644 docs/appareils/compteurs/bgetech.md create mode 100644 docs/appareils/compteurs/inepro.md create mode 100644 docs/appareils/compteurs/powerfox.md create mode 100644 docs/appareils/compteurs/schrack.md create mode 100644 docs/appareils/compteurs/senseair.md create mode 100644 docs/appareils/compteurs/vestel.md create mode 100644 docs/appareils/generic/genericcar.md create mode 100644 docs/appareils/generic/genericenergy.md create mode 100644 docs/appareils/generic/genericheatingcooling.md create mode 100644 docs/appareils/generic/index.md create mode 100644 docs/appareils/hvac/alphainnotec.md create mode 100644 docs/appareils/hvac/drexelundweiss.md create mode 100644 docs/appareils/hvac/homeconnect.md create mode 100644 docs/appareils/hvac/idm.md create mode 100644 docs/appareils/hvac/mypv.md create mode 100644 docs/appareils/hvac/stiebeleltron.md create mode 100644 docs/appareils/hvac/tado.md create mode 100644 docs/appareils/onduleurs/bosswerk.md create mode 100644 docs/appareils/onduleurs/huawei.md create mode 100644 docs/appareils/onduleurs/kostal.md create mode 100644 docs/appareils/onduleurs/mtec.md create mode 100644 docs/appareils/onduleurs/sma.md create mode 100644 docs/appareils/onduleurs/solarlog.md create mode 100644 docs/appareils/onduleurs/solax.md create mode 100644 docs/appareils/onduleurs/sungrow.md create mode 100644 docs/appareils/onduleurs/sunspec.md create mode 100644 docs/appareils/onduleurs/wattsonic.md create mode 100644 docs/appareils/smart/gpio.md create mode 100644 docs/appareils/smart/modbuscommander.md create mode 100644 docs/appareils/smart/mqttclient.md create mode 100644 docs/appareils/smart/shelly.md create mode 100644 docs/appareils/smart/tasmota.md create mode 100644 docs/appareils/smart/tuya.md create mode 100644 docs/appareils/smart/unipi.md create mode 100644 docs/appareils/smart/usbrelay.md create mode 100644 docs/appareils/smart/usbrly82.md create mode 100644 docs/appareils/tarifs/awattar.md create mode 100644 docs/appareils/tarifs/index.md create mode 100644 docs/appareils/tarifs/spothinta.md create mode 100644 docs/appareils/tarifs/tempo.md diff --git a/PORTING_STATUS.yaml b/PORTING_STATUS.yaml index 733a655..e170ca3 100644 --- a/PORTING_STATUS.yaml +++ b/PORTING_STATUS.yaml @@ -1,6 +1,19 @@ -# Source de vérité : canal APT + placement nav. -# title/tagline/stability/icon → meta.json du repo plugin. -# slug : nom de fichier de la fiche (défaut = plugin). +# PORTING_STATUS.yaml — source de vérité : catalogue complet ETM PowerSync +# +# Champs : +# repo : repo source (etm-powersync-*, nymea-*) +# plugin : nom du dossier plugin (= nom du integrationplugin*.json sans le préfixe/suffixe) +# slug : nom de fichier de la fiche .md si différent du plugin (optionnel) +# name : libellé affiché (optionnel si meta.json.title existe) +# channel : stable | testing | nightly +# origin : etm | nymea | tiers (déduit du repo si absent) +# category : compteur | irve | smartdevice | hvac | onduleur | batterie | tarif | generic +# +# ── Entrées ACTIVES ────────────────────────────────────────────────────────── +# Modèle whitelist : seules les entrées non commentées apparaissent dans la doc. +# Décommenter une ligne suffit à l'activer (génère matrice + fiche + nav). + +# ── Compteurs ───────────────────────────────────────────────────────────────── - repo: etm-powersync-plugins-modbus plugin: eastron @@ -15,12 +28,37 @@ channel: testing category: compteur -- repo: etm-powersync-plugins-modbus - plugin: waveshare-relay-d8 - slug: waveshare - name: Waveshare relais - channel: testing - category: smartdevice +- repo: nymea-plugins + plugin: powerfox + channel: nightly + category: compteur + +- repo: nymea-plugins-modbus + plugin: bgetech + channel: nightly + category: compteur + +- repo: nymea-plugins-modbus + plugin: inepro + channel: nightly + category: compteur + +- repo: nymea-plugins-modbus + plugin: schrack + channel: nightly + category: compteur + +- repo: nymea-plugins-modbus + plugin: vestel + channel: nightly + category: compteur + +- repo: nymea-plugins-modbus + plugin: senseair + channel: nightly + category: compteur + +# ── Bornes de recharge (IRVE) ───────────────────────────────────────────────── - repo: etm-powersync-plugins-modbus plugin: abbterra @@ -36,10 +74,115 @@ category: irve - repo: nymea-plugins - plugin: fronius - name: Fronius + plugin: easee channel: nightly - category: onduleur + category: irve + +- repo: nymea-plugins + plugin: goecharger + channel: nightly + category: irve + +- repo: nymea-plugins + plugin: evbox + channel: nightly + category: irve + +- repo: nymea-plugins + plugin: everest + channel: nightly + category: irve + +- repo: nymea-plugins + plugin: v2xeamberelectric + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: amperfied + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: mennekes + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: webasto + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: pcelectric + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: phoenixconnect + channel: nightly + category: irve + +- repo: nymea-plugins-modbus + plugin: inro + channel: nightly + category: irve + +# ── SmartDevices (pilotage, relais, thermostats) ────────────────────────────── + +- repo: etm-powersync-plugins-modbus + plugin: waveshare-relay-d8 + slug: waveshare + name: Waveshare relais + channel: testing + category: smartdevice + +- repo: nymea-plugins + plugin: shelly + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: tasmota + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: tuya + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: gpio + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: usbrelay + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: usbrly82 + channel: nightly + category: smartdevice + +- repo: nymea-plugins + plugin: mqttclient + channel: nightly + category: smartdevice + +- repo: nymea-plugins-modbus + plugin: modbuscommander + channel: nightly + category: smartdevice + +- repo: nymea-plugins-modbus + plugin: unipi + channel: nightly + category: smartdevice + +# ── HVAC (PAC, climatisation, ECS) ─────────────────────────────────────────── - repo: nymea-plugins plugin: daikinairco @@ -61,3 +204,214 @@ channel: nightly category: hvac subcategory: pac + +- repo: nymea-plugins + plugin: tado + channel: nightly + category: hvac + +- repo: nymea-plugins + plugin: homeconnect + channel: nightly + category: hvac + +- repo: nymea-plugins-modbus + plugin: stiebeleltron + channel: nightly + category: hvac + +- repo: nymea-plugins-modbus + plugin: idm + channel: nightly + category: hvac + +- repo: nymea-plugins-modbus + plugin: drexelundweiss + channel: nightly + category: hvac + +- repo: nymea-plugins-modbus + plugin: alphainnotec + channel: nightly + category: hvac + +- repo: nymea-plugins-modbus + plugin: mypv + channel: nightly + category: hvac + +# ── Onduleurs / PV / Stockage ───────────────────────────────────────────────── + +- repo: nymea-plugins + plugin: fronius + name: Fronius + channel: nightly + category: onduleur + +- repo: nymea-plugins + plugin: bosswerk + channel: nightly + category: onduleur + +- repo: nymea-plugins + plugin: solarlog + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: sma + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: solax + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: sungrow + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: huawei + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: kostal + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: mtec + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: wattsonic + channel: nightly + category: onduleur + +- repo: nymea-plugins-modbus + plugin: sunspec + channel: nightly + category: onduleur + +# ── Tarifs & prévisions ─────────────────────────────────────────────────────── + +- repo: nymea-plugins + plugin: awattar + channel: nightly + category: tarif + +- repo: nymea-plugins + plugin: tempo + channel: nightly + category: tarif + +- repo: nymea-plugins + plugin: spothinta + channel: nightly + category: tarif + +# ── Types génériques nymea ──────────────────────────────────────────────────── + +- repo: nymea-plugins-genericthings + plugin: genericenergy + channel: nightly + category: generic + +- repo: nymea-plugins-genericthings + plugin: genericheatingcooling + channel: nightly + category: generic + +- repo: nymea-plugins-genericthings + plugin: genericcar + channel: nightly + category: generic + +# ── Entrées COMMENTÉES — hors périmètre énergie ────────────────────────────── +# Domotique grand public : décommenter pour inclure dans la doc si nécessaire. +# Format YAML flow : valide quand décommenté, ajouter category: manuellement. + +# -- nymea-plugins : domotique -- +# - {repo: nymea-plugins, plugin: anel, channel: nightly} +# - {repo: nymea-plugins, plugin: aqi, channel: nightly} +# - {repo: nymea-plugins, plugin: avahimonitor, channel: nightly} +# - {repo: nymea-plugins, plugin: bimmerconnected, channel: nightly} +# - {repo: nymea-plugins, plugin: bluos, channel: nightly} +# - {repo: nymea-plugins, plugin: bose, channel: nightly} +# - {repo: nymea-plugins, plugin: coinmarketcap, channel: nightly} +# - {repo: nymea-plugins, plugin: commandlauncher, channel: nightly} +# - {repo: nymea-plugins, plugin: datetime, channel: nightly} +# - {repo: nymea-plugins, plugin: daylightsensor, channel: nightly} +# - {repo: nymea-plugins, plugin: denon, channel: nightly} +# - {repo: nymea-plugins, plugin: dht, channel: nightly} +# - {repo: nymea-plugins, plugin: doorbird, channel: nightly} +# - {repo: nymea-plugins, plugin: dweetio, channel: nightly} +# - {repo: nymea-plugins, plugin: dynatrace, channel: nightly} +# - {repo: nymea-plugins, plugin: elgato, channel: nightly} +# - {repo: nymea-plugins, plugin: eq-3, channel: nightly} +# - {repo: nymea-plugins, plugin: espsomfyrts, channel: nightly} +# - {repo: nymea-plugins, plugin: espuino, channel: nightly} +# - {repo: nymea-plugins, plugin: fastcom, channel: nightly} +# - {repo: nymea-plugins, plugin: flowercare, channel: nightly} +# - {repo: nymea-plugins, plugin: garadget, channel: nightly} +# - {repo: nymea-plugins, plugin: httpcommander, channel: nightly} +# - {repo: nymea-plugins, plugin: i2cdevices, channel: nightly} +# - {repo: nymea-plugins, plugin: kodi, channel: nightly} +# - {repo: nymea-plugins, plugin: lgsmarttv, channel: nightly} +# - {repo: nymea-plugins, plugin: lifx, channel: nightly} +# - {repo: nymea-plugins, plugin: logilink, channel: nightly} +# - {repo: nymea-plugins, plugin: mailnotification, channel: nightly} +# - {repo: nymea-plugins, plugin: mcp3008, channel: nightly} +# - {repo: nymea-plugins, plugin: mecelectronics, channel: nightly} +# - {repo: nymea-plugins, plugin: meross, channel: nightly} +# - {repo: nymea-plugins, plugin: mystrom, channel: nightly} +# - {repo: nymea-plugins, plugin: nanoleaf, channel: nightly} +# - {repo: nymea-plugins, plugin: neatobotvac, channel: nightly} +# - {repo: nymea-plugins, plugin: netatmo, channel: nightly} +# - {repo: nymea-plugins, plugin: networkdetector, channel: nightly} +# - {repo: nymea-plugins, plugin: notifyevents, channel: nightly} +# - {repo: nymea-plugins, plugin: nuki, channel: nightly} +# - {repo: nymea-plugins, plugin: onewire, channel: nightly} +# - {repo: nymea-plugins, plugin: openuv, channel: nightly} +# - {repo: nymea-plugins, plugin: openweathermap, channel: nightly} +# - {repo: nymea-plugins, plugin: osdomotics, channel: nightly} +# - {repo: nymea-plugins, plugin: philipshue, channel: nightly} +# - {repo: nymea-plugins, plugin: pushbullet, channel: nightly} +# - {repo: nymea-plugins, plugin: pushnotifications,channel: nightly} +# - {repo: nymea-plugins, plugin: reversessh, channel: nightly} +# - {repo: nymea-plugins, plugin: senic, channel: nightly} +# - {repo: nymea-plugins, plugin: serialportcommander, channel: nightly} +# - {repo: nymea-plugins, plugin: somfytahoma, channel: nightly} +# - {repo: nymea-plugins, plugin: sonos, channel: nightly} +# - {repo: nymea-plugins, plugin: sunposition, channel: nightly} +# - {repo: nymea-plugins, plugin: systemmonitor, channel: nightly} +# - {repo: nymea-plugins, plugin: tcpcommander, channel: nightly} +# - {repo: nymea-plugins, plugin: telegram, channel: nightly} +# - {repo: nymea-plugins, plugin: texasinstruments, channel: nightly} +# - {repo: nymea-plugins, plugin: tmate, channel: nightly} +# - {repo: nymea-plugins, plugin: tplink, channel: nightly} +# - {repo: nymea-plugins, plugin: udpcommander, channel: nightly} +# - {repo: nymea-plugins, plugin: unifi, channel: nightly} +# - {repo: nymea-plugins, plugin: wakeonlan, channel: nightly} +# - {repo: nymea-plugins, plugin: wemo, channel: nightly} +# - {repo: nymea-plugins, plugin: wheretheissat, channel: nightly} +# - {repo: nymea-plugins, plugin: ws2812fx, channel: nightly} +# - {repo: nymea-plugins, plugin: yamahaavr, channel: nightly} + +# -- nymea-plugins-genericthings : types hors énergie -- +# - {repo: nymea-plugins-genericthings, plugin: genericbuttons, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericgarages, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericirrigation, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericlights, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericsensors, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericshading, channel: nightly} +# - {repo: nymea-plugins-genericthings, plugin: genericthing, channel: nightly} + +# -- etm-powersync-plugins : hors périmètre direct -- +# - {repo: etm-powersync-plugins, plugin: openmeteo, channel: nightly} +# (keba : fork ETM disponible mais doublon de nymea-plugins/keba ci-dessus) diff --git a/docs/appareils/SUMMARY.md b/docs/appareils/SUMMARY.md index 19310ee..82bf28e 100644 --- a/docs/appareils/SUMMARY.md +++ b/docs/appareils/SUMMARY.md @@ -2,14 +2,65 @@ * [Compteurs](compteurs/index.md) * [Eastron SDM](compteurs/eastron.md) * [Compteur ABB B2x](compteurs/abb-b2x.md) + * [powerfox](compteurs/powerfox.md) + * [B+G E-Tech](compteurs/bgetech.md) + * [inepro Metering](compteurs/inepro.md) + * [Schrack](compteurs/schrack.md) + * [Bestel](compteurs/vestel.md) + * [Senseair](compteurs/senseair.md) * [Bornes de recharge](bornes/index.md) * [Borne ABB Terra AC](bornes/abb-terra.md) * [Keba](bornes/keba.md) + * [Easeex](bornes/easee.md) + * [go-eCharger](bornes/goecharger.md) + * [EVBox](bornes/evbox.md) + * [EVerest](bornes/everest.md) + * [v2xeamberelectric](bornes/v2xeamberelectric.md) + * [Amperfied](bornes/amperfied.md) + * [MENNEKES](bornes/mennekes.md) + * [webasto](bornes/webasto.md) + * [PC Electric](bornes/pcelectric.md) + * [PhoenixConnect](bornes/phoenixconnect.md) + * [INRO](bornes/inro.md) * [SmartDevices](smart/index.md) * [Waveshare relais](smart/waveshare.md) + * [Shelly](smart/shelly.md) + * [Tasmota](smart/tasmota.md) + * [Tuya](smart/tuya.md) + * [GPIO](smart/gpio.md) + * [USB Relay](smart/usbrelay.md) + * [USB-RLY82](smart/usbrly82.md) + * [MQTT client](smart/mqttclient.md) + * [Modbus Commander](smart/modbuscommander.md) + * [UniPi](smart/unipi.md) * [HVAC](hvac/index.md) * [Daikin](hvac/daikinairco.md) * [SG-Ready](hvac/sgready.md) * [SimpleHeatpump](hvac/simpleheatpump.md) + * [Tado](hvac/tado.md) + * [Home Connect](hvac/homeconnect.md) + * [Stiebel Eltron](hvac/stiebeleltron.md) + * [iDM](hvac/idm.md) + * [Drexel und Weiss](hvac/drexelundweiss.md) + * [alpha innotec](hvac/alphainnotec.md) + * [my-PV](hvac/mypv.md) * [Onduleurs / PV](onduleurs/index.md) * [Fronius](onduleurs/fronius.md) + * [Bosswerk](onduleurs/bosswerk.md) + * [Solar-Log](onduleurs/solarlog.md) + * [SMA](onduleurs/sma.md) + * [SolaX Power Inverter](onduleurs/solax.md) + * [Sungrow Inverter](onduleurs/sungrow.md) + * [Huawei FusionSolar](onduleurs/huawei.md) + * [KOSTAL Solar Electric](onduleurs/kostal.md) + * [mtec](onduleurs/mtec.md) + * [Wattsonic](onduleurs/wattsonic.md) + * [SunSpec](onduleurs/sunspec.md) +* [Tarifs & prévisions](tarifs/index.md) + * [aWATTar](tarifs/awattar.md) + * [Tempo](tarifs/tempo.md) + * [spot-hinta](tarifs/spothinta.md) +* [Types génériques](generic/index.md) + * [genericenergy](generic/genericenergy.md) + * [genericheatingcooling](generic/genericheatingcooling.md) + * [genericcar](generic/genericcar.md) diff --git a/docs/appareils/bornes/amperfied.md b/docs/appareils/bornes/amperfied.md new file mode 100644 index 0000000..2b4370d --- /dev/null +++ b/docs/appareils/bornes/amperfied.md @@ -0,0 +1,105 @@ +# Amperfied + +NIGHTLY NYMEA CONSUMER + +Connect Amperfied/Heidelberg wallboxes to nymea. + + +**Fabricant :** Amperfied +**Plugin :** `amperfied` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Energy Control** | Borne de recharge, Compteur de consommation | Modbus RTU | Découverte automatique / Ajout manuel | 9 | +| **connect.home** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 9 | +| **connect.business** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | +| **connect.solar** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | + +#### Détail par modèle +??? abstract "Energy Control — `energyControl`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `rtuMaster` | Modbus RTU master | QString | — | — | non | + | `slaveId` | Modbus slave ID | uint | 1–248 | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + +??? abstract "connect.home — `connectHome`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + +??? abstract "connect.business — `connectBusiness`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + +??? abstract "connect.solar — `connectSolar`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + + diff --git a/docs/appareils/bornes/easee.md b/docs/appareils/bornes/easee.md new file mode 100644 index 0000000..b869f30 --- /dev/null +++ b/docs/appareils/bornes/easee.md @@ -0,0 +1,46 @@ +# Easeex + +NIGHTLY NYMEA CONSUMER + +Integrates Easee wallboxes with nymea. + + +**Fabricant :** Easee +**Plugin :** `easee` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Easee account** | account | — | Ajout manuel | 2 | +| **Easee charger** | Borne de recharge, Compteur de consommation | — | Automatique | 11 | + +#### Détail par modèle +??? abstract "Easee account — `account`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + +??? abstract "Easee charger — `charger`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Charger ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `power` | Power | bool | — | + | `currentPower` | Current charting power | double | Watt | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `phaseCount` | Used phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `connected` | Online | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + + diff --git a/docs/appareils/bornes/evbox.md b/docs/appareils/bornes/evbox.md new file mode 100644 index 0000000..eb9f23b --- /dev/null +++ b/docs/appareils/bornes/evbox.md @@ -0,0 +1,52 @@ +# EVBox + +NIGHTLY NYMEA CONSUMER + +Integrates EVBox wallboxes with nymea. + + +**Fabricant :** EVBox +**Plugin :** `EVBox` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Elvi + MID meter** | Borne de recharge, Compteur de consommation | — | Découverte automatique | 7 | +| **Elvi** | Borne de recharge | — | Découverte automatique | 5 | + +#### Détail par modèle +??? abstract "Elvi + MID meter — `elviMid`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `serialPort` | Serial port | QString | — | — | oui | + | `serialNumber` | Serial number | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `charging` | Charging | bool | — | + | `phaseCount` | Used phases | uint | — | + +??? abstract "Elvi — `elvi`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `serialPort` | Serial port | QString | — | — | oui | + | `serialNumber` | Serial number | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `charging` | Charging | bool | — | + | `phaseCount` | Used phases | uint | — | + + diff --git a/docs/appareils/bornes/everest.md b/docs/appareils/bornes/everest.md new file mode 100644 index 0000000..4db300b --- /dev/null +++ b/docs/appareils/bornes/everest.md @@ -0,0 +1,98 @@ +# EVerest + +NIGHTLY NYMEA CONSUMER + +Control and monitor EVerest based EV chargers + + +**Fabricant :** Chargebyte GmbH +**Plugin :** `everest` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Everest (MQTT)** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 13 | +| **EVerest connection** | gateway | Modbus TCP | Discovery / User | 2 | +| **EVerest AC Charger** | Borne de recharge, Compteur de consommation | — | Automatique | 22 | + +#### Détail par modèle +??? abstract "Everest (MQTT) — `everestMqtt`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `macAddress` | MAC address | QString | — | `00:00:00:00:00:00` | oui | + | `connector` | Connector name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Active phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `connected` | Connected | bool | — | + | `totalEnergyConsumed` | Total energy | double | KiloWattHour | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `state` | State | QString | — | + | `temperature` | Temperature | double | DegreeCelsius | + | `fanSpeed` | Fan speed | double | Rpm | + +??? abstract "EVerest connection — `everestConnection`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `port` | Port | uint | — | `8080` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `macAddress` | MAC address | QString | — | `00:00:00:00:00:00` | oui | + | `port` | Port | uint | — | `8080` | non | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `apiVersion` | API Version | QString | — | + +??? abstract "EVerest AC Charger — `everestChargerAc`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `index` | Index | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Active phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `state` | State | QString | — | + | `totalEnergyConsumed` | Total energy | double | KiloWattHour | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `currentPhaseC` | Phase C current | double | Ampere | + | `voltagePhaseA` | Phase A voltage | double | Volt | + | `voltagePhaseB` | Phase B voltage | double | Volt | + | `voltagePhaseC` | Phase C voltage | double | Volt | + | `temperature` | Temperature | double | DegreeCelsius | + | `fanSpeed` | Fan speed | double | Rpm | + + diff --git a/docs/appareils/bornes/goecharger.md b/docs/appareils/bornes/goecharger.md new file mode 100644 index 0000000..205a54f --- /dev/null +++ b/docs/appareils/bornes/goecharger.md @@ -0,0 +1,64 @@ +# go-eCharger + +NIGHTLY NYMEA CONSUMER + +Control and monitor the go-eCharger smart wallbox for electric vehicles. + + +**Fabricant :** go-e +**Plugin :** `GoECharger` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **go-eCharger Home** | Borne de recharge, Compteur de consommation | Modbus TCP | Discovery / User | 32 | + +#### Détail par modèle +??? abstract "go-eCharger Home — `goeHome`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | non | + | `useMqtt` | Use MQTT interface | bool | — | `False` | non | + | `apiVersion` | API Version | uint | 1–2 | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `carStatus` | Car state | QString | — | + | `pluggedIn` | Car plugged in | bool | — | + | `charging` | Charging | bool | — | + | `access` | Access | QString | — | + | `power` | Allow charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `absoluteMaxAmpere` | Maximal ampere | uint | Ampere | + | `modelMaxAmpere` | Model maximal ampere | uint | Ampere | + | `updateAvailable` | Update available | bool | — | + | `adapterConnected` | Adapter connected | bool | — | + | `cableType2Ampere` | Cable ampere encoding | uint | Ampere | + | `totalEnergyConsumed` | Total energy | double | KiloWattHour | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `currentPhaseC` | Phase C current | double | Ampere | + | `voltagePhaseA` | Phase A voltage | double | Volt | + | `voltagePhaseB` | Phase B voltage | double | Volt | + | `voltagePhaseC` | Phase C voltage | double | Volt | + | `frequency` | Frequency | double | Hertz | + | `phaseCount` | Number of charging phases | uint | — | + | `desiredPhaseCount` | Desired number of charging phases | uint | — | + | `temperatureSensor1` | Temperature 1 | double | DegreeCelsius | + | `temperatureSensor2` | Temperature 2 | double | DegreeCelsius | + | `temperatureSensor3` | Temperature 3 | double | DegreeCelsius | + | `temperatureSensor4` | Temperature 4 | double | DegreeCelsius | + | `firmwareVersion` | Firmware version | QString | — | + + diff --git a/docs/appareils/bornes/inro.md b/docs/appareils/bornes/inro.md new file mode 100644 index 0000000..534fe81 --- /dev/null +++ b/docs/appareils/bornes/inro.md @@ -0,0 +1,41 @@ +# INRO + +NIGHTLY NYMEA CONSUMER + +Connect INRO PANTABOX wallboxes to nymea. + + +**Fabricant :** INRO Elektrotechnik GmbH +**Plugin :** `inro` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **PANTABOX** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 13 | + +#### Détail par modèle +??? abstract "PANTABOX — `pantabox`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `serialNumber` | Serial number | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `chargingState` | Charging state | QString | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `phaseCount` | Active phases | uint | — | + | `usedPhases` | Used phases | QString | — | + | `modbusTcpVersion` | Modbus TCP version | QString | — | + | `firmwareVersion` | Firmware version | QString | — | + + diff --git a/docs/appareils/bornes/keba.md b/docs/appareils/bornes/keba.md index e41666f..31c6739 100644 --- a/docs/appareils/bornes/keba.md +++ b/docs/appareils/bornes/keba.md @@ -32,30 +32,91 @@ Voir [Ajouter un appareil](../../installation/application.md). **Fabricant :** Keba -**Plugin :** `keba` +**Plugin :** `Keba` #### Modèles pris en charge | Modèle | Rôle | Transport | Ajout | Grandeurs | | --- | --- | --- | --- | --- | -| **Keba P30 / P31** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 6 | +| **Keba KeContact** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 31 | +| **KeConnect German Edition** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 19 | #### Détail par modèle -??? abstract "Keba P30 / P31 — `kebaEVCharger`" +??? abstract "Keba KeContact — `keba`" _Réglages :_ | Clé | Libellé | Type | Plage | Défaut | Lecture seule | | --- | --- | --- | --- | --- | --- | | `macAddress` | MAC address | QString | — | — | oui | - | `address` | Host address | QString | — | — | non | - | `port` | Port | uint | — | `502` | non | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | oui | + | `model` | Product name | QString | — | — | oui | _Grandeurs mesurées :_ | Clé | Grandeur | Type | Unité | | --- | --- | --- | --- | | `connected` | Connected | bool | — | - | `pluggedIn` | Plugged in | bool | — | + | `power` | Charging enabled | bool | — | + | `systemEnabled` | System enabled | bool | — | + | `phaseCount` | Number of connected phases | uint | — | + | `activity` | Activity | QString | — | + | `plugState` | Plug state | QString | — | + | `pluggedIn` | Car plugged in | bool | — | | `charging` | Charging | bool | — | - | `maxChargingCurrent` | Maximum charging current | double | Ampere | - | `currentPower` | Active power | double | Watt | + | `maxChargingCurrent` | Maximal charging current | double | Ampere | + | `maxChargingCurrentPercent` | Maximal charging current in percent | uint | Percentage | + | `maxChargingCurrentHardware` | Maximal hardware charging current | uint | Ampere | + | `voltagePhaseA` | Voltage phase A | int | Volt | + | `voltagePhaseB` | Voltage phase B | int | Volt | + | `voltagePhaseC` | Voltage phase C | int | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Power consumption | double | Watt | + | `powerFactor` | Power factor | double | Percentage | + | `sessionId` | Session ID | uint | — | + | `sessionTime` | Session time | int | Minutes | | `sessionEnergy` | Session energy | double | KiloWattHour | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `outputX2` | Output X2 | bool | — | + | `input` | Input | bool | — | + | `uptime` | Uptime | int | Minutes | + | `error1` | Error 1 | int | — | + | `error2` | Error 2 | int | — | + | `failsafeMode` | Failsafe mode | bool | — | + | `firmware` | Firmware | QString | — | + | `hostAddress` | Host address | QString | — | + +??? abstract "KeConnect German Edition — `kebaSimple`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | oui | + | `model` | Product name | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `systemEnabled` | System enabled | bool | — | + | `phaseCount` | Number of connected phases | uint | — | + | `activity` | Activity | QString | — | + | `plugState` | Plug state | QString | — | + | `pluggedIn` | Car plugged in | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Maximal charging current | double | Ampere | + | `maxChargingCurrentPercent` | Maximal charging current in percent | uint | Percentage | + | `maxChargingCurrentHardware` | Maximal hardware charging current | uint | Ampere | + | `outputX2` | Output X2 | bool | — | + | `input` | Input | bool | — | + | `uptime` | Uptime | int | Minutes | + | `error1` | Error 1 | int | — | + | `error2` | Error 2 | int | — | + | `failsafeMode` | Failsafe mode | bool | — | + | `firmware` | Firmware | QString | — | + | `hostAddress` | Host address | QString | — | diff --git a/docs/appareils/bornes/mennekes.md b/docs/appareils/bornes/mennekes.md new file mode 100644 index 0000000..32c1086 --- /dev/null +++ b/docs/appareils/bornes/mennekes.md @@ -0,0 +1,85 @@ +# MENNEKES + +NIGHTLY NYMEA CONSUMER + +Connect MENNEKES wallboxes to nymea. + + +**Fabricant :** MENNEKES +**Plugin :** `Mennekes` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **AMTRON Charge Control/Professional** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | +| **AMTRON XTRA/Premium** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 9 | +| **AMTRON Compact 2.0s** | Borne de recharge, Compteur de consommation | Modbus RTU | Découverte automatique / Ajout manuel | 12 | + +#### Détail par modèle +??? abstract "AMTRON Charge Control/Professional — `amtronECU`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `firmwareVersion` | Firmware version | QString | — | + +??? abstract "AMTRON XTRA/Premium — `amtronHCC3`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + +??? abstract "AMTRON Compact 2.0s — `amtronCompact20`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `1` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentVersion` | Firmware version | QString | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Charging phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `solarChargingMode` | Solar charging mode | QString | — | + + diff --git a/docs/appareils/bornes/pcelectric.md b/docs/appareils/bornes/pcelectric.md new file mode 100644 index 0000000..901ced6 --- /dev/null +++ b/docs/appareils/bornes/pcelectric.md @@ -0,0 +1,84 @@ +# PC Electric + +NIGHTLY NYMEA CONSUMER + +Integrate the PCE EV11.3 wallbox with nymea. + + +**Fabricant :** PC Electric GmbH +**Plugin :** `PcElectric` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **PCE EV11.3** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 26 | +| **PCE EV11.3 (no meter)** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 14 | + +#### Détail par modèle +??? abstract "PCE EV11.3 — `ev11`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Active phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Active power | double | Watt | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `temperature` | Onboard temperature | double | DegreeCelsius | + | `error` | Error | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `digitalInputFlag` | Digital input flag | QString | — | + | `status` | Status | QString | — | + | `digitalInputMode` | Digital input mode | uint | — | + | `modeR37` | R37 mode | int | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + +??? abstract "PCE EV11.3 (no meter) — `ev11NoMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Active phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `temperature` | Onboard temperature | double | DegreeCelsius | + | `error` | Error | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `digitalInputFlag` | Digital input flag | QString | — | + | `status` | Status | QString | — | + | `digitalInputMode` | Digital input mode | uint | — | + | `modeR37` | R37 mode | int | — | + + diff --git a/docs/appareils/bornes/phoenixconnect.md b/docs/appareils/bornes/phoenixconnect.md new file mode 100644 index 0000000..94bcb46 --- /dev/null +++ b/docs/appareils/bornes/phoenixconnect.md @@ -0,0 +1,147 @@ +# PhoenixConnect + +NIGHTLY NYMEA CONSUMER + +Control and monitor Wallbe, Compleo and Scapo wallboxes. + + +**Fabricant :** Wallbe, compleo, scapo +**Plugin :** `PhoenixConnect` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Wallbe ECO 2.0** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 8 | +| **Wallbe Pro** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | +| **Compleo ECO s** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 8 | +| **Compleo PRO** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | +| **Scapo Economy** | Borne de recharge | Modbus TCP | Découverte automatique / Ajout manuel | 8 | +| **Scapo Vision** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 9 | + +#### Détail par modèle +??? abstract "Wallbe ECO 2.0 — `wallbeEco2`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `chargeTime` | Charging Time | int | Minutes | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `phaseCount` | Phase count | uint | — | + +??? abstract "Wallbe Pro — `wallbePro`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `chargeTime` | Charging Time | int | Minutes | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `currentPower` | Current power usage | double | Watt | + | `phaseCount` | Phase count | uint | — | + +??? abstract "Compleo ECO s — `compleoEcoS`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `chargeTime` | Charging Time | int | Minutes | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `phaseCount` | Phase count | uint | — | + +??? abstract "Compleo PRO — `compleoPro`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `chargeTime` | Charging Time | int | Minutes | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `currentPower` | Current power usage | double | Watt | + | `phaseCount` | Phase count | uint | — | + +??? abstract "Scapo Economy — `scapoEco`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `chargeTime` | Charging Time | int | Minutes | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `phaseCount` | Phase count | uint | — | + +??? abstract "Scapo Vision — `scapoVision`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | oui | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `power` | Charging enabled | bool | — | + | `charging` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `firmwareVersion` | Firmware version | QString | — | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `currentPower` | Current power usage | double | Watt | + | `phaseCount` | Phase count | uint | — | + + diff --git a/docs/appareils/bornes/v2xeamberelectric.md b/docs/appareils/bornes/v2xeamberelectric.md new file mode 100644 index 0000000..f5fb7b1 --- /dev/null +++ b/docs/appareils/bornes/v2xeamberelectric.md @@ -0,0 +1,33 @@ +# v2xeamberelectric + +NIGHTLY NYMEA + + +**Fabricant :** Amber Electric +**Plugin :** `AmberElectric` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Amber Electric - V2Xe Amber Electric** | Compteur intelligent | — | User | 7 | + +#### Détail par modèle +??? abstract "Amber Electric - V2Xe Amber Electric — `V2XeAmberElectric`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `authToken` | auth token | QString | — | — | non | + | `currentSite` | current site | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Reachable | bool | — | + | `Sites` | Sites | QString | — | + | `Type` | type | QString | — | + | `forecastprice` | Feedin Price | double | KiloWattHour | + | `currentprice` | Current Price | double | KiloWattHour | + | `currentfeedin` | Current Feedin | double | KiloWattHour | + | `futurefeedin` | Future Feedin | double | KiloWattHour | + + diff --git a/docs/appareils/bornes/webasto.md b/docs/appareils/bornes/webasto.md new file mode 100644 index 0000000..cb28cd4 --- /dev/null +++ b/docs/appareils/bornes/webasto.md @@ -0,0 +1,108 @@ +# webasto + +NIGHTLY NYMEA CONSUMER + +Integrates Webasto Live DC wallbox into nymea. + + +**Fabricant :** Webasto +**Plugin :** `Webasto` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Webasto Live** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 18 | +| **Webasto NEXT** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 22 | +| **Webasto Unite** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 11 | + +#### Détail par modèle +??? abstract "Webasto Live — `webastoLive`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `chargePointState` | Charge point state | QString | — | + | `cableState` | Cable state | QString | — | + | `power` | Charging | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `pluggedIn` | Car plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Number of connected phases | uint | — | + | `currentPhase1` | Current phase 1 | double | Ampere | + | `currentPhase2` | Current phase 2 | double | Ampere | + | `currentPhase3` | Current phase 3 | double | Ampere | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `sessionTime` | Session time | int | Minutes | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `error` | Error | int | — | + | `maxPossibleChargingCurrent` | Maximum possible charging current | double | Ampere | + | `userId` | User ID | QString | — | + +??? abstract "Webasto NEXT — `webastoNext`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + | `port` | Port | uint | — | `502` | non | + | `slaveId` | Slave ID | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Charging current | double | Ampere | + | `pluggedIn` | Car plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Number of connected phases | uint | — | + | `usedPhases` | Phases used for charging | QString | — | + | `currentPower` | Charging power | double | Watt | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `maxCurrentTotal` | Maximum current overall | uint | Ampere | + | `minCurrentTotal` | Minimum current overall | uint | Ampere | + | `maxCurrentCharger` | Maximum current charger | uint | Ampere | + | `maxCurrentCable` | Maximum current cable | uint | Ampere | + | `maxCurrentElectricVehicle` | Maximum current electric vehicle | uint | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `error` | Error | QString | — | + +??? abstract "Webasto Unite — `webastoUnite`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `version` | Firmware version | QString | — | + + diff --git a/docs/appareils/compatibilite.md b/docs/appareils/compatibilite.md index 49905f0..94f82b2 100644 --- a/docs/appareils/compatibilite.md +++ b/docs/appareils/compatibilite.md @@ -3,45 +3,123 @@ Liste de référence des équipements supportés par ETM PowerSync. Générée depuis `PORTING_STATUS.yaml` — ne pas modifier manuellement entre les marqueurs. +Chaque appareil porte trois badges indépendants : + +**Canal APT** — disponibilité sur le dépôt de paquets : + | Badge | Signification | |---|---| -| STABLE | Disponible sur le dépôt APT **stable** — prêt pour la production | -| TESTING | Disponible sur le dépôt APT **testing** — fonctionnel, en cours d'épreuve | +| STABLE | Dépôt APT **stable** — prêt pour la production | +| TESTING | Dépôt APT **testing** — fonctionnel, en cours d'épreuve | | NIGHTLY | Portage en cours — non disponible en production | +**Origine** — provenance du plugin : + +| Badge | Signification | +|---|---| +| ETM | Plugin développé ou maintenu par ETM-Schurig | +| NYMEA | Plugin upstream nymea (communauté open-source) | +| TIERS | Plugin tiers / communautaire externe | + +**Stabilité** — maturité déclarée par l'auteur du plugin (`meta.json`) : + +| Badge | Signification | +|---|---| +| CONSUMER | Validé pour usage grand public | +| COMMUNITY | Plugin communautaire, support best-effort | + ## Compteurs -| Marque / Modèle | Protocole | Canal | Stabilité | -|---|---|---|---| -| Eastron SDM | Modbus RTU | STABLE | — | -| Compteur ABB B2x | Modbus RTU | TESTING | — | +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| Eastron SDM | Modbus RTU | STABLE | ETM | CONSUMER | +| Compteur ABB B2x | Modbus RTU | TESTING | ETM | CONSUMER | +| powerfox | — | NIGHTLY | NYMEA | CONSUMER | +| B+G E-Tech | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| inepro Metering | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| Schrack | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| Bestel | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Senseair | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | ## Bornes de recharge -| Marque / Modèle | Protocole | Canal | Stabilité | -|---|---|---|---| -| Borne ABB Terra AC | Modbus TCP | TESTING | — | -| Keba | Modbus TCP | NIGHTLY | — | +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| Borne ABB Terra AC | Modbus TCP | TESTING | ETM | CONSUMER | +| Keba | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Easeex | — | NIGHTLY | NYMEA | CONSUMER | +| go-eCharger | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| EVBox | — | NIGHTLY | NYMEA | CONSUMER | +| EVerest | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| v2xeamberelectric | — | NIGHTLY | NYMEA | — | +| Amperfied | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| MENNEKES | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| webasto | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| PC Electric | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| PhoenixConnect | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| INRO | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | ## SmartDevices -| Marque / Modèle | Protocole | Canal | Stabilité | -|---|---|---|---| -| Waveshare relais | Modbus RTU | TESTING | — | +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| Waveshare relais | Modbus RTU | TESTING | ETM | — | +| Shelly | — | NIGHTLY | NYMEA | CONSUMER | +| Tasmota | — | NIGHTLY | NYMEA | COMMUNITY | +| Tuya | — | NIGHTLY | NYMEA | COMMUNITY | +| GPIO | — | NIGHTLY | NYMEA | COMMUNITY | +| USB Relay | — | NIGHTLY | NYMEA | CONSUMER | +| USB-RLY82 | — | NIGHTLY | NYMEA | CONSUMER | +| MQTT client | — | NIGHTLY | NYMEA | COMMUNITY | +| Modbus Commander | Modbus TCP | NIGHTLY | NYMEA | COMMUNITY | +| UniPi | — | NIGHTLY | NYMEA | CONSUMER | ## HVAC -| Marque / Modèle | Protocole | Canal | Stabilité | -|---|---|---|---| -| Daikin | — | NIGHTLY | — | -| SG-Ready | — | NIGHTLY | — | -| SimpleHeatpump | — | NIGHTLY | — | +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| Daikin | — | NIGHTLY | NYMEA | COMMUNITY | +| SG-Ready | — | NIGHTLY | NYMEA | COMMUNITY | +| SimpleHeatpump | — | NIGHTLY | NYMEA | COMMUNITY | +| Tado | — | NIGHTLY | NYMEA | COMMUNITY | +| Home Connect | — | NIGHTLY | NYMEA | CONSUMER | +| Stiebel Eltron | Modbus TCP | NIGHTLY | NYMEA | COMMUNITY | +| iDM | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Drexel und Weiss | Modbus RTU | NIGHTLY | NYMEA | COMMUNITY | +| alpha innotec | Modbus TCP | NIGHTLY | NYMEA | COMMUNITY | +| my-PV | — | NIGHTLY | NYMEA | COMMUNITY | ## Onduleurs / PV -| Marque / Modèle | Protocole | Canal | Stabilité | -|---|---|---|---| -| Fronius | Modbus TCP | NIGHTLY | — | +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| Fronius | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Bosswerk | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Solar-Log | — | NIGHTLY | NYMEA | CONSUMER | +| SMA | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| SolaX Power Inverter | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Sungrow Inverter | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| Huawei FusionSolar | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| KOSTAL Solar Electric | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| mtec | Modbus TCP | NIGHTLY | NYMEA | — | +| Wattsonic | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| SunSpec | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | + +## Tarifs & prévisions + +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| aWATTar | — | NIGHTLY | NYMEA | CONSUMER | +| Tempo | — | NIGHTLY | NYMEA | CONSUMER | +| spot-hinta | — | NIGHTLY | NYMEA | CONSUMER | + +## Types génériques + +| Marque / Modèle | Protocole | Canal | Origine | Stabilité | +|---|---|---|---|---| +| genericenergy | — | NIGHTLY | NYMEA | — | +| genericheatingcooling | — | NIGHTLY | NYMEA | — | +| genericcar | — | NIGHTLY | NYMEA | — | diff --git a/docs/appareils/compteurs/bgetech.md b/docs/appareils/compteurs/bgetech.md new file mode 100644 index 0000000..5fb2466 --- /dev/null +++ b/docs/appareils/compteurs/bgetech.md @@ -0,0 +1,53 @@ +# B+G E-Tech + +NIGHTLY NYMEA CONSUMER + +Connect B+G E-Tech energy meters. + + +**Fabricant :** B+G E-Tech +**Plugin :** `bgeTech` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **SDM630** | Compteur d'énergie | Modbus RTU | Découverte automatique | 20 | + +#### Détail par modèle +??? abstract "SDM630 — `sdm630`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `1` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `frequency` | Frequency | double | Hertz | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `energyConsumedPhaseA` | Energy consumed phase A | double | KiloWattHour | + | `energyConsumedPhaseB` | Energy consumed phase B | double | KiloWattHour | + | `energyConsumedPhaseC` | Energy consumed phase C | double | KiloWattHour | + | `energyProducedPhaseA` | Energy produced phase A | double | KiloWattHour | + | `energyProducedPhaseB` | Energy produced phase B | double | KiloWattHour | + | `energyProducedPhaseC` | Energy produced phase C | double | KiloWattHour | + + diff --git a/docs/appareils/compteurs/inepro.md b/docs/appareils/compteurs/inepro.md new file mode 100644 index 0000000..9237eb2 --- /dev/null +++ b/docs/appareils/compteurs/inepro.md @@ -0,0 +1,53 @@ +# inepro Metering + +NIGHTLY NYMEA CONSUMER + +Connect inepro Metering Modbus RTU energy meters. + + +**Fabricant :** inepro Metering +**Plugin :** `inepro` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **PRO380** | Compteur d'énergie | Modbus RTU | Découverte automatique | 20 | + +#### Détail par modèle +??? abstract "PRO380 — `pro380`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `1` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `frequency` | Frequency | double | Hertz | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `energyConsumedPhaseA` | Energy consumed phase A | double | KiloWattHour | + | `energyConsumedPhaseB` | Energy consumed phase B | double | KiloWattHour | + | `energyConsumedPhaseC` | Energy consumed phase C | double | KiloWattHour | + | `energyProducedPhaseA` | Energy produced phase A | double | KiloWattHour | + | `energyProducedPhaseB` | Energy produced phase B | double | KiloWattHour | + | `energyProducedPhaseC` | Energy produced phase C | double | KiloWattHour | + + diff --git a/docs/appareils/compteurs/powerfox.md b/docs/appareils/compteurs/powerfox.md new file mode 100644 index 0000000..c4cd028 --- /dev/null +++ b/docs/appareils/compteurs/powerfox.md @@ -0,0 +1,41 @@ +# powerfox + +NIGHTLY NYMEA CONSUMER + +Connects nymea to powerfox. + + +**Fabricant :** powerfox +**Plugin :** `powerfox` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **powerfox account** | account | — | Ajout manuel | 2 | +| **powerfox smart meter** | Compteur d'énergie | — | Automatique | 6 | + +#### Détail par modèle +??? abstract "powerfox account — `account`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + +??? abstract "powerfox smart meter — `powerMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Reachable | bool | — | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total energy consumption | double | KiloWattHour | + | `totalEnergyProduced` | Total energy production | double | KiloWattHour | + | `currentPhaseA` | Current | double | Ampere | + | `voltagePhaseA` | Voltage (Phase A) | double | Volt | + + diff --git a/docs/appareils/compteurs/schrack.md b/docs/appareils/compteurs/schrack.md new file mode 100644 index 0000000..8fc2165 --- /dev/null +++ b/docs/appareils/compteurs/schrack.md @@ -0,0 +1,36 @@ +# Schrack + +NIGHTLY NYMEA CONSUMER + +Integrate the Schrack i-CHARGE CION wallbox with nymea. + + +**Fabricant :** Schrack GmbH +**Plugin :** `schrack` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **i-CHARGE CION** | Borne de recharge | Modbus RTU | Découverte automatique / Ajout manuel | 8 | + +#### Détail par modèle +??? abstract "i-CHARGE CION — `cion`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `1` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Active phases | uint | — | + | `usedPhases` | Used phases | QString | — | + | `currentVersion` | Firmware version | QString | — | + + diff --git a/docs/appareils/compteurs/senseair.md b/docs/appareils/compteurs/senseair.md new file mode 100644 index 0000000..c0f2314 --- /dev/null +++ b/docs/appareils/compteurs/senseair.md @@ -0,0 +1,29 @@ +# Senseair + +NIGHTLY NYMEA CONSUMER + +Connect Senseair sensors nymea. + + +**Fabricant :** SenseAir +**Plugin :** `SenseAir` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **SenseAir S8** | co2sensor | Modbus RTU | Découverte automatique | 2 | + +#### Détail par modèle +??? abstract "SenseAir S8 — `s8`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `rtuMaster` | Modbus RTU master UUID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `co2` | CO2 | double | PartsPerMillion | + + diff --git a/docs/appareils/compteurs/vestel.md b/docs/appareils/compteurs/vestel.md new file mode 100644 index 0000000..da17781 --- /dev/null +++ b/docs/appareils/compteurs/vestel.md @@ -0,0 +1,39 @@ +# Bestel + +NIGHTLY NYMEA CONSUMER + +Connect Vestel wallboxes to nymea. + + +**Fabricant :** Vestel +**Plugin :** `vestel` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **EVC04** | Borne de recharge, Compteur de consommation | Modbus TCP | Découverte automatique / Ajout manuel | 10 | + +#### Détail par modèle +??? abstract "EVC04 — `evc04`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Connected phases | uint | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `power` | Charging enabled | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `sessionEnergy` | Session energy | double | KiloWattHour | + | `version` | Firmware version | QString | — | + + diff --git a/docs/appareils/generic/genericcar.md b/docs/appareils/generic/genericcar.md new file mode 100644 index 0000000..767576e --- /dev/null +++ b/docs/appareils/generic/genericcar.md @@ -0,0 +1,26 @@ +# genericcar + +NIGHTLY NYMEA + + +**Fabricant :** nymea +**Plugin :** `genericCar` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Generic electric car** | electricvehicle | — | Ajout manuel | 6 | + +#### Détail par modèle +??? abstract "Generic electric car — `car`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `capacity` | Capacity | double | KiloWattHour | + | `batteryCritical` | Battery level critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `minChargingCurrent` | Minimum charging current | uint | Ampere | + | `maxChargingCurrent` | Maximum charging current | uint | Ampere | + | `phaseCount` | Phase count | uint | — | + + diff --git a/docs/appareils/generic/genericenergy.md b/docs/appareils/generic/genericenergy.md new file mode 100644 index 0000000..148eeb0 --- /dev/null +++ b/docs/appareils/generic/genericenergy.md @@ -0,0 +1,90 @@ +# genericenergy + +NIGHTLY NYMEA + + +**Fabricant :** nymea +**Plugin :** `genericEnergy` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Generic power socket** | powersocket | — | Ajout manuel | 1 | +| **Generic energy meter** | Compteur d'énergie | — | Ajout manuel | 12 | +| **Impulse based energy meter** | Compteur de consommation | — | Ajout manuel | 3 | +| **Generic energy storage** | energystorage | — | Ajout manuel | 5 | +| **Generic smart meter consumer** | Compteur de consommation | — | Ajout manuel | 2 | +| **Generic smart meter producer** | Compteur de production | — | Ajout manuel | 2 | +| **Generic wallbox** | Borne de recharge, Compteur de consommation | — | Ajout manuel | 9 | + +#### Détail par modèle +??? abstract "Generic power socket — `socket`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "Generic energy meter — `energyMeter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `currentPower` | Current Power usage | double | Watt | + | `totalEnergyConsumed` | Total obtained energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPhaseA` | Current on phase A | double | Ampere | + | `currentPhaseB` | Current on phase B | double | Ampere | + | `currentPhaseC` | Current on phase C | double | Ampere | + | `currentPowerPhaseA` | Current power on phase A | double | Watt | + | `currentPowerPhaseB` | Current power on phase B | double | Watt | + | `currentPowerPhaseC` | Current power on phase C | double | Watt | + | `voltagePhaseA` | Voltage on phase A | double | Volt | + | `voltagePhaseB` | Voltage on phase B | double | Volt | + | `voltagePhaseC` | Voltage on phase C | double | Volt | + +??? abstract "Impulse based energy meter — `impulseSmartMeter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `currentPower` | Current Power usage | double | Watt | + | `totalEnergyConsumed` | Energy | double | KiloWattHour | + | `impulseInput` | Impulse input | bool | — | + +??? abstract "Generic energy storage — `energyStorage`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `currentPower` | Current power | double | Watt | + | `batteryLevel` | Battery level | int | Percentage | + | `charging` | Charging | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `capacity` | Capacity | double | KiloWattHour | + +??? abstract "Generic smart meter consumer — `smartMeterConsumer`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `currentPower` | Current Power usage | double | Watt | + | `totalEnergyConsumed` | Consumed energy | double | KiloWattHour | + +??? abstract "Generic smart meter producer — `smartMeterProducer`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `currentPower` | Current Power production | double | Watt | + | `totalEnergyProduced` | Produced energy | double | KiloWattHour | + +??? abstract "Generic wallbox — `wallbox`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `maxChargingCurrent` | Maximum charging current | double | Ampere | + | `power` | Charging allowed | bool | — | + | `pluggedIn` | Plugged in | bool | — | + | `charging` | Charging | bool | — | + | `phaseCount` | Used phase count | uint | — | + | `desiredPhaseCount` | Desired phase count | uint | — | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total energy consumption | double | KiloWattHour | + + diff --git a/docs/appareils/generic/genericheatingcooling.md b/docs/appareils/generic/genericheatingcooling.md new file mode 100644 index 0000000..a26460e --- /dev/null +++ b/docs/appareils/generic/genericheatingcooling.md @@ -0,0 +1,70 @@ +# genericheatingcooling + +NIGHTLY NYMEA + + +**Fabricant :** nymea +**Plugin :** `genericHeatingCooling` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Generic heating** | heating | — | Ajout manuel | 1 | +| **Generic ventilation** | ventilation | — | Ajout manuel | 1 | +| **Generic ventilation with flow control** | ventilation | — | Ajout manuel | 2 | +| **Generic thermostat** | thermostat, temperaturesensor | — | Ajout manuel | 4 | +| **Generic cooler** | cooling | — | Ajout manuel | 1 | +| **SG-Ready** | smartgridheatpump | — | Ajout manuel | 4 | +| **Generic simple heat pump** | simpleheatpump | — | Ajout manuel | 1 | + +#### Détail par modèle +??? abstract "Generic heating — `heating`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "Generic ventilation — `ventilation`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "Generic ventilation with flow control — `ventilationFlow`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + | `flowRate` | Air flow rate | int | Percentage | + +??? abstract "Generic thermostat — `thermostat`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `temperature` | Temperature sensor input | double | DegreeCelsius | + | `targetTemperature` | Target temperature | double | DegreeCelsius | + | `heatingOn` | Heating On/off | bool | — | + | `coolingOn` | Cooling On/off | bool | — | + +??? abstract "Generic cooler — `cooling`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Cooler on/off | bool | — | + +??? abstract "SG-Ready — `sgReady`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `relay1` | Relay 1 | bool | — | + | `relay2` | Relay 2 | bool | — | + | `sgReadyMode` | Smart grid mode | QString | — | + | `operatingModeDescription` | Operating mode description | QString | — | + +??? abstract "Generic simple heat pump — `simpleHeatPump`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Heat pump enabled | bool | — | + + diff --git a/docs/appareils/generic/index.md b/docs/appareils/generic/index.md new file mode 100644 index 0000000..17c0bbf --- /dev/null +++ b/docs/appareils/generic/index.md @@ -0,0 +1,10 @@ +# Types génériques + + +| Appareil | Protocole | Canal | Origine | Stabilité | +| --- | --- | --- | --- | --- | +| [genericenergy](genericenergy.md) | — | NIGHTLY | NYMEA | — | +| [genericheatingcooling](genericheatingcooling.md) | — | NIGHTLY | NYMEA | — | +| [genericcar](genericcar.md) | — | NIGHTLY | NYMEA | — | + + diff --git a/docs/appareils/hvac/alphainnotec.md b/docs/appareils/hvac/alphainnotec.md new file mode 100644 index 0000000..e1d0fe8 --- /dev/null +++ b/docs/appareils/hvac/alphainnotec.md @@ -0,0 +1,58 @@ +# alpha innotec + +NIGHTLY NYMEA COMMUNITY + +Integrate alpha innotec heat pumps into nymea. + + +**Fabricant :** alpha Innotec +**Plugin :** `AlphaInnotec` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **alpha connect** | smartgridheatpump | Modbus TCP | Découverte automatique / Ajout manuel | 27 | + +#### Détail par modèle +??? abstract "alpha connect — `alphaConnect`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Modbus slave ID | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `heatingOn` | Heating on | bool | — | + | `coolingOn` | Cooling on | bool | — | + | `flowTemperature` | Flow temperature | double | DegreeCelsius | + | `returnTemperature` | Return temperature | double | DegreeCelsius | + | `externalReturnTemperature` | External return temperature | double | DegreeCelsius | + | `hotWaterTemperature` | Hot water temperature | double | DegreeCelsius | + | `hotGasTemperature` | Hot gas temperature | double | DegreeCelsius | + | `heatSourceInletTemperature` | Heat source inlet temperature | double | DegreeCelsius | + | `heatSourceOutletTemperature` | Heat source outlet temperature | double | DegreeCelsius | + | `roomTemperature1` | Room remote adjuster 1 temperature | double | DegreeCelsius | + | `roomTemperature2` | Room remote adjuster 2 temperature | double | DegreeCelsius | + | `roomTemperature3` | Room remote adjuster 3 temperature | double | DegreeCelsius | + | `solarCollectorTemperature` | Solar collector temperature | double | DegreeCelsius | + | `solarStorageTankTemperature` | Solar storage tank temperature | double | DegreeCelsius | + | `externalEnergySourceTemperature` | External energy source temperature | double | DegreeCelsius | + | `supplyAirTemperature` | Supply air temperature | double | DegreeCelsius | + | `externalAirTemperature` | External air temperature | double | DegreeCelsius | + | `systemStatus` | System status | QString | — | + | `heatingPumpOperatingHours` | Heating pump operating hours | uint | Hours | + | `outdoorTemperature` | Outdoor temperature | double | DegreeCelsius | + | `returnSetpointTemperature` | Return temperature setpoint | double | DegreeCelsius | + | `hotWaterSetpointTemperature` | Hot water temperature setpoint | double | DegreeCelsius | + | `sgReadyMode` | Smart grid mode | QString | — | + | `totalEnergy` | Total energy | double | KiloWattHour | + | `heatingEnergy` | Heating energy | double | KiloWattHour | + | `hotWaterEnergy` | Hot water energy | double | KiloWattHour | + + diff --git a/docs/appareils/hvac/drexelundweiss.md b/docs/appareils/hvac/drexelundweiss.md new file mode 100644 index 0000000..e38b044 --- /dev/null +++ b/docs/appareils/hvac/drexelundweiss.md @@ -0,0 +1,74 @@ +# Drexel und Weiss + +NIGHTLY NYMEA COMMUNITY + +Connect to Drexel und Weiss HVAC systems. + + +**Fabricant :** Drexel und Weiss +**Plugin :** `DrexelUndWeiss` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **X2 LU** | ventilation, co2sensor | Modbus RTU | Découverte automatique | 5 | +| **X2 WP** | thermostat, Compteur de consommation | Modbus RTU | Découverte automatique | 19 | + +#### Détail par modèle +??? abstract "X2 LU — `x2lu`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | 0–250 | `0` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + | `co2` | CO2 | double | PartsPerMillion | + | `ventilationMode` | Ventilation mode | QString | — | + | `activeVentilationLevel` | Ventilation level | int | — | + +??? abstract "X2 WP — `x2wp`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | 0–250 | `0` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + | `temperature` | Room temperature | double | DegreeCelsius | + | `waterTemperature` | Water temperature | double | DegreeCelsius | + | `outsideAirTemperature` | Outside air temperature | double | DegreeCelsius | + | `targetTemperature` | Target room temperature | double | DegreeCelsius | + | `targetWaterTemperature` | Target water temperature | double | DegreeCelsius | + | `heatPumpMode` | Heat pump mode | QString | — | + | `error` | Error | QString | — | + | `currentPower` | Total power consumption | double | Watt | + | `powerCompressor` | Power consumption compressor | double | Watt | + | `powerAirPreheating` | Power consumption air preheating | double | Watt | + | `powerRoomHeating` | Power consumption room heating | double | Watt | + | `powerWaterHeating` | Power consumption water heating | double | Watt | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `energyCompressor` | Energy compressor | double | KiloWattHour | + | `energyAirPreheating` | Energy air preheating | double | KiloWattHour | + | `energyWaterHeating` | Energy water heating | double | KiloWattHour | + | `energyRoomHeating` | Energy room heating | double | KiloWattHour | + + diff --git a/docs/appareils/hvac/homeconnect.md b/docs/appareils/hvac/homeconnect.md new file mode 100644 index 0000000..d4432b8 --- /dev/null +++ b/docs/appareils/hvac/homeconnect.md @@ -0,0 +1,201 @@ +# Home Connect + +NIGHTLY NYMEA CONSUMER + +Connect to Home Connect devices. + + +**Fabricant :** Home Connect +**Plugin :** `homeConnect` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Home Connect account** | account | — | Ajout manuel | 3 | +| **Oven** | closablesensor | — | Automatique | 12 | +| **Dishwasher** | closablesensor | — | Automatique | 8 | +| **Coffee Maker** | closablesensor | — | Automatique | 10 | +| **Dryer** | closablesensor | — | Automatique | 10 | +| **Fridge Freezer** | closablesensor | — | Automatique | 6 | +| **Washer** | closablesensor | — | Automatique | 11 | +| **Cook top** | — | — | Automatique | 1 | +| **Hood** | — | — | Automatique | 4 | +| **Cleaning robot** | — | — | Automatique | 2 | +| **Cook processor** | — | — | Automatique | 2 | + +#### Détail par modèle +??? abstract "Home Connect account — `homeConnectAccount`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + | `userDisplayName` | User name | QString | — | + +??? abstract "Oven — `oven`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `operationState` | Operation state | QString | — | + | `localControlState` | Local control state | bool | — | + | `remoteControlActivationState` | Remote control activation state | bool | — | + | `remoteStartAllowanceState` | Remote start allowance state | bool | — | + | `targetTemperature` | Target temperature | int | DegreeCelsius | + | `currentTemperature` | Current temperature | int | DegreeCelsius | + | `duration` | Duration | int | Minutes | + | `progress` | Progress | int | Percentage | + | `selectedProgram` | Selected program | QString | — | + | `endTime` | End time | QString | — | + +??? abstract "Dishwasher — `dishwasher`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `operationState` | Operation state | QString | — | + | `remoteControlActivationState` | Remote control activation state | bool | — | + | `remoteStartAllowanceState` | Remote start allowance state | bool | — | + | `progress` | Progress | int | Percentage | + | `selectedProgram` | Selected program | QString | — | + | `endTime` | End time | QString | — | + +??? abstract "Coffee Maker — `coffeeMaker`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `operationState` | Operation state | QString | — | + | `localControlState` | Local control state | bool | — | + | `remoteStartAllowanceState` | Remote start allowance state | bool | — | + | `progress` | Progress | int | Percentage | + | `selectedProgram` | Selected program | QString | — | + | `strength` | Strength | QString | — | + | `fillQuantity` | Fill quantity | int | — | + | `temperature` | Temperature | QString | — | + +??? abstract "Dryer — `dryer`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `operationState` | Operation state | QString | — | + | `localControlState` | Local control state | bool | — | + | `remoteControlActivationState` | Remote control activation state | bool | — | + | `remoteStartAllowanceState` | Remote start allowance state | bool | — | + | `progress` | Progress | int | Percentage | + | `selectedProgram` | Selected program | QString | — | + | `dryingTarget` | Drying target | QString | — | + | `endTime` | End time | QString | — | + +??? abstract "Fridge Freezer — `fridge`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `fridgeTemperature` | Fridge temperature | int | DegreeCelsius | + | `fridgeTemperatureSetting` | Fridge temperature setting | int | DegreeCelsius | + | `freezerTemperature` | Freezer temperature | int | DegreeCelsius | + | `freezerTemperatureSetting` | Freezer temperature setting | int | DegreeCelsius | + +??? abstract "Washer — `washer`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `closed` | Door closed | bool | — | + | `operationState` | Operation state | QString | — | + | `localControlState` | Local control state | bool | — | + | `remoteControlActivationState` | Remote control activation state | bool | — | + | `remoteStartAllowanceState` | Remote start allowance state | bool | — | + | `progress` | Progress | int | Percentage | + | `selectedProgram` | Selected program | QString | — | + | `temperature` | Temperature | QString | — | + | `spinSpeed` | Spin speed | QString | — | + | `endTime` | End time | QString | — | + +??? abstract "Cook top — `cookTop`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Hood — `hood`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `localControlState` | Local control state | bool | — | + | `operationState` | Operation state | QString | — | + | `ventingLevel` | Venting level | int | — | + +??? abstract "Cleaning robot — `cleaningRobot`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `operationState` | Operation state | QString | — | + +??? abstract "Cook processor — `cookProcessor`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `operationState` | Operation state | QString | — | + + diff --git a/docs/appareils/hvac/idm.md b/docs/appareils/hvac/idm.md new file mode 100644 index 0000000..263a39f --- /dev/null +++ b/docs/appareils/hvac/idm.md @@ -0,0 +1,45 @@ +# iDM + +NIGHTLY NYMEA CONSUMER + +Control iDM network enabled heat pumps. + + +**Fabricant :** iDM +**Plugin :** `idm` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Navigator 2.0** | thermostat, Compteur de consommation | Modbus TCP | Ajout manuel / Découverte automatique | 16 | + +#### Détail par modèle +??? abstract "Navigator 2.0 — `navigator2`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `temperature` | Room temperature | double | DegreeCelsius | + | `targetTemperature` | Target room temperature | double | DegreeCelsius | + | `waterTemperature` | Water temperature | double | DegreeCelsius | + | `heatingOn` | Heating | bool | — | + | `coolingOn` | Heating | bool | — | + | `outsideTemperature` | Outside temperature | double | DegreeCelsius | + | `targetWaterTemperature` | Target water temperature | double | DegreeCelsius | + | `currentPower` | Current power | double | Watt | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `energyProducedHeating` | Total heating energy | double | KiloWattHour | + | `energyProducedCooling` | Total cooling energy | double | KiloWattHour | + | `energyProducedHotWater` | Total hot water energy | double | KiloWattHour | + | `mode` | Mode | QString | — | + | `operationMode` | Operation mode | QString | — | + | `error` | Error | int | — | + + diff --git a/docs/appareils/hvac/index.md b/docs/appareils/hvac/index.md index 5b19f0d..f0bd56e 100644 --- a/docs/appareils/hvac/index.md +++ b/docs/appareils/hvac/index.md @@ -1,10 +1,17 @@ # HVAC -| Appareil | Protocole | Canal | Stabilité | -| --- | --- | --- | --- | -| [Daikin](daikinairco.md) | — | NIGHTLY | — | -| [SG-Ready](sgready.md) | — | NIGHTLY | — | -| [SimpleHeatpump](simpleheatpump.md) | — | NIGHTLY | — | +| Appareil | Protocole | Canal | Origine | Stabilité | +| --- | --- | --- | --- | --- | +| [Daikin](daikinairco.md) | — | NIGHTLY | NYMEA | COMMUNITY | +| [SG-Ready](sgready.md) | — | NIGHTLY | NYMEA | COMMUNITY | +| [SimpleHeatpump](simpleheatpump.md) | — | NIGHTLY | NYMEA | COMMUNITY | +| [Tado](tado.md) | — | NIGHTLY | NYMEA | COMMUNITY | +| [Home Connect](homeconnect.md) | — | NIGHTLY | NYMEA | CONSUMER | +| [Stiebel Eltron](stiebeleltron.md) | Modbus TCP | NIGHTLY | NYMEA | COMMUNITY | +| [iDM](idm.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [Drexel und Weiss](drexelundweiss.md) | Modbus RTU | NIGHTLY | NYMEA | COMMUNITY | +| [alpha innotec](alphainnotec.md) | Modbus TCP | NIGHTLY | NYMEA | COMMUNITY | +| [my-PV](mypv.md) | — | NIGHTLY | NYMEA | COMMUNITY | diff --git a/docs/appareils/hvac/mypv.md b/docs/appareils/hvac/mypv.md new file mode 100644 index 0000000..9c32387 --- /dev/null +++ b/docs/appareils/hvac/mypv.md @@ -0,0 +1,34 @@ +# my-PV + +NIGHTLY NYMEA COMMUNITY + +Control my-PV network enabled heating rods. + + +**Fabricant :** my-PV +**Plugin :** `Mypv` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **AC Elwa E** | heating, temperaturesensor | — | Discovery | 6 | + +#### Détail par modèle +??? abstract "AC Elwa E — `elwa`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + | `heatingPower` | Power consumption | int | Watt | + | `temperature` | Water temperature | double | DegreeCelsius | + | `targetWaterTemperature` | Target water temperature | double | DegreeCelsius | + | `status` | Status | QString | — | + + diff --git a/docs/appareils/hvac/stiebeleltron.md b/docs/appareils/hvac/stiebeleltron.md new file mode 100644 index 0000000..6c521fe --- /dev/null +++ b/docs/appareils/hvac/stiebeleltron.md @@ -0,0 +1,58 @@ +# Stiebel Eltron + +NIGHTLY NYMEA COMMUNITY + +Integrate Stiebel Eltron heat pumps into nymea. + + +**Fabricant :** Stiebel Eltron +**Plugin :** `StiebelEltron` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Stiebel Eltron Heatpump** | smartgridheatpump | Modbus TCP | Découverte automatique / Ajout manuel | 27 | + +#### Détail par modèle +??? abstract "Stiebel Eltron Heatpump — `stiebelEltron`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Modbus slave ID | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `flowTemperature` | Flow temperature | double | DegreeCelsius | + | `returnTemperature` | Return temperature | double | DegreeCelsius | + | `outdoorTemperature` | Outdoor temperature | double | DegreeCelsius | + | `hotWaterTemperature` | Hot water temperature | double | DegreeCelsius | + | `storageTankTemperature` | Storage tank temperature | double | DegreeCelsius | + | `heatingEnergy` | Heating energy | uint | KiloWattHour | + | `hotWaterEnergy` | Hot water energy | uint | KiloWattHour | + | `consumedEnergyHotWater` | Consumed energy hot water | uint | KiloWattHour | + | `consumedEnergyHeating` | Consumed energy heating | uint | KiloWattHour | + | `operatingMode` | Operating mode | QString | — | + | `pumpOne` | Pump 1 | bool | — | + | `pumpTwo` | Pump 2 | bool | — | + | `heatingUp` | Heating up | bool | — | + | `auxHeating` | Electric auxiliary heating | bool | — | + | `heating` | Heating mode | bool | — | + | `hotWater` | Hot water mode | bool | — | + | `compressor` | Compressor | bool | — | + | `summerMode` | Summer mode | bool | — | + | `coolingMode` | Cooling mode | bool | — | + | `defrosting` | Defrosting mode | bool | — | + | `silentMode` | Silent mode | bool | — | + | `silentMode2` | Silent mode 2 (Off) | bool | — | + | `sgReadyActive` | SG Ready enabled | bool | — | + | `sgReadyMode` | SG Ready mode | QString | — | + | `sourceTemperature` | Source temperature (tbd) | double | DegreeCelsius | + | `roomTemperature1` | Room temperature (tbd) | double | DegreeCelsius | + + diff --git a/docs/appareils/hvac/tado.md b/docs/appareils/hvac/tado.md new file mode 100644 index 0000000..0222c26 --- /dev/null +++ b/docs/appareils/hvac/tado.md @@ -0,0 +1,46 @@ +# Tado + +NIGHTLY NYMEA COMMUNITY + +Connect to your Tado account to interact with the heating setup. + + +**Fabricant :** Tado +**Plugin :** `Tado` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Tado account** | account | — | Ajout manuel | 3 | +| **Zone** | thermostat, heating, temperaturesensor, humiditysensor | — | Automatique | 8 | + +#### Détail par modèle +??? abstract "Tado account — `tadoAccount`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + | `userDisplayName` | Username | QString | — | + +??? abstract "Zone — `zone`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `homeId` | Home id | QString | — | — | oui | + | `zoneId` | Zone id | QString | — | — | oui | + | `type` | Type | bool | — | `False` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `mode` | Mode | QString | — | + | `tadoMode` | Tado mode | QString | — | + | `power` | Power | bool | — | + | `windowOpenDetected` | Window open detected | bool | — | + | `temperature` | Temperature | double | DegreeCelsius | + | `targetTemperature` | Target temperature | double | DegreeCelsius | + | `humidity` | Humidity | double | Percentage | + + diff --git a/docs/appareils/onduleurs/bosswerk.md b/docs/appareils/onduleurs/bosswerk.md new file mode 100644 index 0000000..e136b1a --- /dev/null +++ b/docs/appareils/onduleurs/bosswerk.md @@ -0,0 +1,33 @@ +# Bosswerk + +NIGHTLY NYMEA CONSUMER + +Integrates Bosswerk solar inverters with nymea. + + +**Fabricant :** Bosswerk +**Plugin :** `bosswerk` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **MI-300/600** | solarinverter | Modbus TCP | Découverte automatique | 4 | + +#### Détail par modèle +??? abstract "MI-300/600 — `mix00`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | `00:00:00:00:00:00` | oui | + | `address` | IP address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyProduced` | Total produced energy | double | KiloWattHour | + + diff --git a/docs/appareils/onduleurs/huawei.md b/docs/appareils/onduleurs/huawei.md new file mode 100644 index 0000000..a11e862 --- /dev/null +++ b/docs/appareils/onduleurs/huawei.md @@ -0,0 +1,109 @@ +# Huawei FusionSolar + +NIGHTLY NYMEA CONSUMER + +Connect to Huawei FusionSolar devices. + + +**Fabricant :** Huawei +**Plugin :** `Huawei` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Huawei FusionSolar Inverter (SmartDongle)** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 4 | +| **SmartLogger** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 3 | +| **Huawei FusionSolar Inverter (Modbus RTU)** | solarinverter | Modbus RTU | Découverte automatique | 3 | +| **Huawei Meter** | Compteur d'énergie | — | Automatique | 13 | +| **Huawei Battery** | battery, energystorage | — | Automatique | 6 | + +#### Détail par modèle +??? abstract "Huawei FusionSolar Inverter (SmartDongle) — `huaweiFusionSolarInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `activePower` | Active power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + +??? abstract "SmartLogger — `huaweiSmartLogger`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `meterSlaveId` | Meter slave ID | int | — | `5` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + +??? abstract "Huawei FusionSolar Inverter (Modbus RTU) — `huaweiRtuInverter`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | oui | + | `slaveAddress` | Modbus slave address | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + +??? abstract "Huawei Meter — `huaweiMeter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Total real power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `totalEnergyConsumed` | Total energy imported | double | KiloWattHour | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `currentPhaseC` | Phase C current | double | Ampere | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + +??? abstract "Huawei Battery — `huaweiBattery`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `unit` | Unit | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `currentPower` | Total real power | double | Watt | + | `capacity` | Capacity | double | KiloWattHour | + | `chargingState` | Charging state | QString | — | + + diff --git a/docs/appareils/onduleurs/index.md b/docs/appareils/onduleurs/index.md index 3819fb5..72c65eb 100644 --- a/docs/appareils/onduleurs/index.md +++ b/docs/appareils/onduleurs/index.md @@ -1,8 +1,18 @@ # Onduleurs / PV -| Appareil | Protocole | Canal | Stabilité | -| --- | --- | --- | --- | -| [Fronius](fronius.md) | Modbus TCP | NIGHTLY | — | +| Appareil | Protocole | Canal | Origine | Stabilité | +| --- | --- | --- | --- | --- | +| [Fronius](fronius.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [Bosswerk](bosswerk.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [Solar-Log](solarlog.md) | — | NIGHTLY | NYMEA | CONSUMER | +| [SMA](sma.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [SolaX Power Inverter](solax.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [Sungrow Inverter](sungrow.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [Huawei FusionSolar](huawei.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [KOSTAL Solar Electric](kostal.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | +| [mtec](mtec.md) | Modbus TCP | NIGHTLY | NYMEA | — | +| [Wattsonic](wattsonic.md) | Modbus RTU | NIGHTLY | NYMEA | CONSUMER | +| [SunSpec](sunspec.md) | Modbus TCP | NIGHTLY | NYMEA | CONSUMER | diff --git a/docs/appareils/onduleurs/kostal.md b/docs/appareils/onduleurs/kostal.md new file mode 100644 index 0000000..abf8d3b --- /dev/null +++ b/docs/appareils/onduleurs/kostal.md @@ -0,0 +1,85 @@ +# KOSTAL Solar Electric + +NIGHTLY NYMEA CONSUMER + +Connect to Kostal Solar Electric inverters. + + +**Fabricant :** KOSTAL Solar Electric +**Plugin :** `Kostal` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **KOSTAL Inverter** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 13 | +| **KOSTAL Meter** | Compteur d'énergie | — | Automatique | 14 | +| **KOSTAL Battery** | energystorage | — | Automatique | 8 | + +#### Détail par modèle +??? abstract "KOSTAL Inverter — `kostalInverter`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `port` | Port | int | — | `1502` | + | `slaveId` | Slave ID | int | — | `71` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `macAddress` | MAC address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `address` | IP address | QString | — | — | non | + | `serialNumber` | serialNumber | QString | — | — | non | + | `port` | Port | int | — | `1502` | non | + | `slaveId` | Slave ID | int | — | `71` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `phaseACurrent` | Phase A current | double | Ampere | + | `phaseBCurrent` | Phase B current | double | Ampere | + | `phaseCCurrent` | Phase C current | double | Ampere | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `frequency` | Frequency | double | Hertz | + +??? abstract "KOSTAL Meter — `kostalMeter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `totalEnergyConsumed` | Total imported energy | double | KiloWattHour | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `currentPhaseC` | Phase C current | double | Ampere | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `frequency` | Frequency | double | Hertz | + +??? abstract "KOSTAL Battery — `kostalBattery`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `currentPower` | Total real power | double | Watt | + | `voltage` | Voltage | double | Volt | + | `temperature` | Temperature | double | DegreeCelsius | + | `capacity` | Capacity | double | KiloWattHour | + | `chargingState` | Charging state | QString | — | + + diff --git a/docs/appareils/onduleurs/mtec.md b/docs/appareils/onduleurs/mtec.md new file mode 100644 index 0000000..51b7e92 --- /dev/null +++ b/docs/appareils/onduleurs/mtec.md @@ -0,0 +1,42 @@ +# mtec + +NIGHTLY NYMEA + + +**Fabricant :** M-Tec +**Plugin :** `MTec` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **MTec** | thermostat | Modbus TCP | Découverte automatique / Ajout manuel | 15 | + +#### Détail par modèle +??? abstract "MTec — `mtec`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | IP address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `heatPumpState` | Heat pump state | QString | — | + | `targetTemperature` | Target room temperature (heat circuit 0) | double | DegreeCelsius | + | `temperature` | Room temperature heat circuit 0 | double | DegreeCelsius | + | `heatingOn` | Heating on | bool | — | + | `coolingOn` | Cooling on | bool | — | + | `outdoorTemperature` | Outdoor temperature | double | DegreeCelsius | + | `waterTankTopTemperature` | Water tank top temperature | double | DegreeCelsius | + | `bufferTankTemperature` | Buffer tank temperature | double | DegreeCelsius | + | `totalAccumulatedHeatingEnergy` | Total accumulated heating energy | double | KiloWattHour | + | `totalAccumulatedElectricalEnergy` | Total accumulated electrical energy | double | KiloWattHour | + | `heatMeterPowerConsumption` | Heat meter power consumption | double | Watt | + | `energyMeterPowerConsumption` | Energy meter power consumption | double | Watt | + | `smartHomeEnergy` | Smart home energy | uint | Watt | + | `smartHomeEnergyElectricityMeter` | Smart home energy consumed | double | Watt | + + diff --git a/docs/appareils/onduleurs/sma.md b/docs/appareils/onduleurs/sma.md new file mode 100644 index 0000000..520e0bd --- /dev/null +++ b/docs/appareils/onduleurs/sma.md @@ -0,0 +1,164 @@ +# SMA + +NIGHTLY NYMEA CONSUMER + +Connect to SMA solar equipment. + + +**Fabricant :** SMA Solar Technology AG +**Plugin :** `sma` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **SMA Sunny WebBox** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 6 | +| **SMA Energy Meter** | Compteur d'énergie | — | Découverte automatique / Ajout manuel | 20 | +| **SMA Inverter** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 14 | +| **SMA Battery** | energystorage | — | Automatique | 9 | +| **SMA Solar Inverter (Modbus)** | solarinverter | Modbus TCP | Découverte automatique / Ajout manuel | 14 | +| **SMA Battery Inverter (Modbus)** | energystorage | Modbus TCP | Découverte automatique / Ajout manuel | 7 | + +#### Détail par modèle +??? abstract "SMA Sunny WebBox — `sunnyWebBox`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `dayEnergyProduced` | Day energy produced | double | KiloWattHour | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `mode` | Mode | QString | — | + | `error` | Error | QString | — | + +??? abstract "SMA Energy Meter — `speedwireMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `serialNumber` | Serial number | QString | — | — | oui | + | `modelId` | Model ID | uint | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `energyConsumedPhaseA` | Energy consumed phase A | double | KiloWattHour | + | `energyConsumedPhaseB` | Energy consumed phase B | double | KiloWattHour | + | `energyConsumedPhaseC` | Energy consumed phase C | double | KiloWattHour | + | `energyProducedPhaseA` | Energy produced phase A | double | KiloWattHour | + | `energyProducedPhaseB` | Energy produced phase B | double | KiloWattHour | + | `energyProducedPhaseC` | Energy produced phase C | double | KiloWattHour | + | `firmwareVersion` | Firmware version | QString | — | + +??? abstract "SMA Inverter — `speedwireInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | oui | + | `serialNumber` | Serial number | QString | — | — | oui | + | `modelId` | Model ID | uint | — | `0` | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Current power | double | Watt | + | `currentPowerMpp1` | DC power MPP1 | double | Watt | + | `currentPowerMpp2` | DC power MPP2 | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `energyProducedToday` | Energy produced today | double | KiloWattHour | + | `frequency` | Frequency | double | Hertz | + | `firmwareVersion` | Firmware version | QString | — | + +??? abstract "SMA Battery — `speedwireBattery`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltage` | Voltage | double | Volt | + | `current` | Current | double | Ampere | + | `temperature` | Temperature | double | DegreeCelsius | + | `currentPower` | Current power | double | Watt | + | `capacity` | Available energy | double | KiloWattHour | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `chargingState` | Charging state | QString | — | + +??? abstract "SMA Solar Inverter (Modbus) — `modbusSolarInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `3` | non | + | `serialNumber` | Serial number | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `energyProducedToday` | Energy produced today | double | KiloWattHour | + | `firmwareVersion` | Firmware version | QString | — | + +??? abstract "SMA Battery Inverter (Modbus) — `modbusBatteryInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `3` | non | + | `serialNumber` | Serial number | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery critical | bool | — | + | `currentPower` | Current power | double | Watt | + | `capacity` | Capacity | double | KiloWattHour | + | `chargingState` | Charging state | QString | — | + | `firmwareVersion` | Firmware version | QString | — | + + diff --git a/docs/appareils/onduleurs/solarlog.md b/docs/appareils/onduleurs/solarlog.md new file mode 100644 index 0000000..a0a441b --- /dev/null +++ b/docs/appareils/onduleurs/solarlog.md @@ -0,0 +1,45 @@ +# Solar-Log + +NIGHTLY NYMEA CONSUMER + +Integrate Solar-Log devices with nymea. + + +**Fabricant :** Solar-Log +**Plugin :** `solarlog` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Solar-Log** | Compteur de production | — | Ajout manuel / Découverte automatique | 18 | + +#### Détail par modèle +??? abstract "Solar-Log — `solarlog`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `host` | Address | QString | — | `solar-log` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Reachable | bool | — | + | `lastupdate` | Last update | QString | — | + | `currentPower` | Power AC | double | Watt | + | `pdc` | Power DC | double | Watt | + | `uac` | AC voltage | double | Volt | + | `dcVoltage` | DC voltage | double | Volt | + | `yieldDay` | Yield day | double | KiloWattHour | + | `yieldYesterday` | Yield yesterday | double | KiloWattHour | + | `yieldMonth` | Yield month | double | KiloWattHour | + | `yieldYear` | Yield year | double | KiloWattHour | + | `totalEnergyProduced` | Yield total | double | KiloWattHour | + | `powerUsage` | Current total power consumption | double | Watt | + | `consYieldDay` | Energy consumption day | double | KiloWattHour | + | `consYieldYesterday` | Energy consumption yesterday | double | KiloWattHour | + | `consYieldMonth` | Energy consumption month | double | KiloWattHour | + | `consYieldYear` | Energy consumption year | double | KiloWattHour | + | `consYieldTotal` | Energy consumption total | double | KiloWattHour | + | `totalPower` | Installed generator power | double | Watt | + + diff --git a/docs/appareils/onduleurs/solax.md b/docs/appareils/onduleurs/solax.md new file mode 100644 index 0000000..ede5019 --- /dev/null +++ b/docs/appareils/onduleurs/solax.md @@ -0,0 +1,86 @@ +# SolaX Power Inverter + +NIGHTLY NYMEA CONSUMER + +Connect to SolaX Power X1 and X3 G4 inverters. + + +**Fabricant :** SolaX Power +**Plugin :** `Solax` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Solax Inverter** | solarinverter | Modbus TCP | Découverte automatique | 7 | +| **Solax Inverter** | solarinverter | — | Automatique | 3 | +| **SolaX Meter** | Compteur d'énergie | — | Automatique | 14 | +| **SolaX Battery** | energystorage | — | Automatique | 8 | + +#### Détail par modèle +??? abstract "Solax Inverter — `solaxInverterTcp`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Active power | double | Watt | + | `currentVoltage` | Voltage | double | Volt | + | `current` | Current | double | Ampere | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `temperature` | Temperature | double | DegreeCelsius | + | `frequency` | Frequency | double | Hertz | + +??? abstract "Solax Inverter — `solaxInverterChild`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + +??? abstract "SolaX Meter — `solaxMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Meter ID | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `totalEnergyConsumed` | Total imported energy | double | KiloWattHour | + | `frequency` | Frequency | double | Hertz | + +??? abstract "SolaX Battery — `solaxBattery`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `currentPower` | Total real power | double | Watt | + | `voltage` | Voltage | double | Volt | + | `temperature` | Temperature | double | DegreeCelsius | + | `capacity` | Capacity | double | KiloWattHour | + | `chargingState` | Charging state | QString | — | + + diff --git a/docs/appareils/onduleurs/sungrow.md b/docs/appareils/onduleurs/sungrow.md new file mode 100644 index 0000000..ea8a935 --- /dev/null +++ b/docs/appareils/onduleurs/sungrow.md @@ -0,0 +1,68 @@ +# Sungrow Inverter + +NIGHTLY NYMEA CONSUMER + +Connect to Sungrow inverters. + + +**Fabricant :** Sungrow +**Plugin :** `Sungrow` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Sungrow Inverter** | solarinverter | Modbus TCP | Découverte automatique | 5 | +| **Sungrow Meter** | Compteur d'énergie | — | Automatique | 14 | +| **Sungrow Battery** | energystorage | — | Automatique | 8 | + +#### Détail par modèle +??? abstract "Sungrow Inverter — `sungrowInverterTcp`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Active power | double | Watt | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `temperature` | Temperature | double | DegreeCelsius | + | `frequency` | Frequency | double | Hertz | + +??? abstract "Sungrow Meter — `sungrowMeter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + | `apparentPowerPhaseA` | Apparent power phase A | double | VoltAmpere | + | `apparentPowerPhaseB` | Apparent power phase B | double | VoltAmpere | + | `apparentPowerPhaseC` | Apparent power phase C | double | VoltAmpere | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `totalEnergyConsumed` | Total imported energy | double | KiloWattHour | + | `frequency` | Frequency | double | Hertz | + +??? abstract "Sungrow Battery — `sungrowBattery`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `currentPower` | Total real power | double | Watt | + | `voltage` | Voltage | double | Volt | + | `temperature` | Temperature | double | DegreeCelsius | + | `capacity` | Capacity | double | KiloWattHour | + | `chargingState` | Charging state | QString | — | + + diff --git a/docs/appareils/onduleurs/sunspec.md b/docs/appareils/onduleurs/sunspec.md new file mode 100644 index 0000000..fc9267b --- /dev/null +++ b/docs/appareils/onduleurs/sunspec.md @@ -0,0 +1,297 @@ +# SunSpec + +NIGHTLY NYMEA CONSUMER + +Connect to SunSpec devices. + + +**Fabricant :** SunSpec, SolarEdge +**Plugin :** `SunSpec` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **SunSpec Generic** | gateway | Modbus TCP | Découverte automatique / Ajout manuel | 1 | +| **SunSpec single phase inverter** | solarinverter | — | Auto | 13 | +| **SunSpec split phase inverter** | solarinverter | — | Auto | 16 | +| **SunSpec three phase inverter** | solarinverter | — | Auto | 18 | +| **SunSpec single phase meter** | Compteur d'énergie | — | Auto | 8 | +| **SunSpec split phase meter** | Compteur d'énergie | — | Auto | 18 | +| **SunSpec three phase meter** | Compteur d'énergie | — | Auto | 21 | +| **SunSpec Storage** | battery | — | Auto | 11 | +| **SolarEdge** | gateway | Modbus TCP | Découverte automatique / Ajout manuel | 1 | +| **SolarEdge battery** | energystorage | — | Auto | 14 | + +#### Détail par modèle +??? abstract "SunSpec Generic — `sunspecConnection`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveId` | Slave ID | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `1` | non | + | `endianness` | Endianness | QString | — | `Big Endian` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "SunSpec single phase inverter — `sunspecSinglePhaseInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | — | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalCurrent` | Total AC current | double | Ampere | + | `phaseVoltage` | Phase voltage | double | Volt | + | `currentPower` | AC power | double | Watt | + | `frequency` | Frequency | double | Hertz | + | `totalEnergyProduced` | AC energy | double | KiloWattHour | + | `voltageDc` | DC voltage | double | Volt | + | `currentDc` | DC current | double | Ampere | + | `currentPowerDc` | DC power | double | Watt | + | `cabinetTemperature` | Cabinet temperature | double | DegreeCelsius | + | `operatingState` | Operating state | QString | — | + | `error` | Error | QString | — | + | `version` | Version | QString | — | + +??? abstract "SunSpec split phase inverter — `sunspecSplitPhaseInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | — | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalCurrent` | Total AC current | double | Ampere | + | `phaseACurrent` | Phase A current | double | Ampere | + | `phaseBCurrent` | Phase B current | double | Ampere | + | `phaseANVoltage` | Phase AN voltage | double | Volt | + | `phaseBNVoltage` | Phase BN voltage | double | Volt | + | `currentPower` | AC power | double | Watt | + | `frequency` | Line frequency | double | Hertz | + | `totalEnergyProduced` | AC energy | double | KiloWattHour | + | `voltageDc` | DC voltage | double | Volt | + | `currentDc` | DC current | double | Ampere | + | `currentPowerDc` | DC power | double | Watt | + | `cabinetTemperature` | Cabinet temperature | double | DegreeCelsius | + | `operatingState` | Operating state | QString | — | + | `error` | Error | QString | — | + | `version` | Version | QString | — | + +??? abstract "SunSpec three phase inverter — `sunspecThreePhaseInverter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | — | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalCurrent` | Total AC current | double | Ampere | + | `phaseACurrent` | Phase A current | double | Ampere | + | `phaseBCurrent` | Phase B current | double | Ampere | + | `phaseCCurrent` | Phase C current | double | Ampere | + | `phaseANVoltage` | Phase AN voltage | double | Volt | + | `phaseBNVoltage` | Phase BN voltage | double | Volt | + | `phaseCNVoltage` | Phase CN voltage | int | Volt | + | `currentPower` | AC power | double | Watt | + | `frequency` | Frequency | double | Hertz | + | `totalEnergyProduced` | AC energy | double | KiloWattHour | + | `voltageDc` | DC voltage | double | Volt | + | `currentDc` | DC current | double | Ampere | + | `currentPowerDc` | DC power | double | Watt | + | `cabinetTemperature` | Cabinet temperature | double | DegreeCelsius | + | `operatingState` | Operating state | QString | — | + | `error` | Error | QString | — | + | `version` | Version | QString | — | + +??? abstract "SunSpec single phase meter — `sunspecSinglePhaseMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | `0` | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Total real power | double | Watt | + | `totalEnergyProduced` | Total real energy exported | double | KiloWattHour | + | `totalEnergyConsumed` | Total real energy imported | double | KiloWattHour | + | `currentPhaseA` | Phase A current | double | Ampere | + | `voltagePhaseA` | Phase A voltage | double | Volt | + | `frequency` | Frequency | double | Hertz | + | `version` | Version | QString | — | + +??? abstract "SunSpec split phase meter — `sunspecSplitPhaseMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | `0` | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalEnergyProduced` | Total real energy exported | double | KiloWattHour | + | `totalEnergyConsumed` | Total real energy imported | double | KiloWattHour | + | `currentPower` | Total real power | double | Watt | + | `energyConsumedPhaseA` | Energy consumed phase A | double | KiloWattHour | + | `energyConsumedPhaseB` | Energy consumed phase B | double | KiloWattHour | + | `energyProducedPhaseA` | Energy produced phase A | double | KiloWattHour | + | `energyProducedPhaseB` | Energy produced phase B | double | KiloWattHour | + | `totalCurrent` | Total AC current | double | Ampere | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `lnACVoltage` | Line to Neutral AC Voltage | double | Volt | + | `voltagePhaseA` | Phase A voltage | double | Volt | + | `voltagePhaseB` | Phase B voltage | double | Volt | + | `frequency` | Frequency | double | Hertz | + | `version` | Version | QString | — | + +??? abstract "SunSpec three phase meter — `sunspecThreePhaseMeter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | `0` | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalEnergyProduced` | Total real energy exported | double | KiloWattHour | + | `totalEnergyConsumed` | Total real energy imported | double | KiloWattHour | + | `currentPower` | Total real power | double | Watt | + | `energyConsumedPhaseA` | Energy consumed phase A | double | KiloWattHour | + | `energyConsumedPhaseB` | Energy consumed phase B | double | KiloWattHour | + | `energyConsumedPhaseC` | Energy consumed phase C | double | KiloWattHour | + | `energyProducedPhaseA` | Energy produced phase A | double | KiloWattHour | + | `energyProducedPhaseB` | Energy produced phase B | double | KiloWattHour | + | `energyProducedPhaseC` | Energy produced phase C | double | KiloWattHour | + | `currentPowerPhaseA` | Current power phase A | double | Watt | + | `currentPowerPhaseB` | Current power phase B | double | Watt | + | `currentPowerPhaseC` | Current power phase C | double | Watt | + | `currentPhaseA` | Phase A current | double | Ampere | + | `currentPhaseB` | Phase B current | double | Ampere | + | `currentPhaseC` | Phase C current | double | Ampere | + | `voltagePhaseA` | Phase A voltage | double | Volt | + | `voltagePhaseB` | Phase B voltage | double | Volt | + | `voltagePhaseC` | Phase C voltage | double | Volt | + | `frequency` | Frequency | double | Hertz | + | `version` | Version | QString | — | + +??? abstract "SunSpec Storage — `sunspecStorage`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modelId` | Model | int | — | `0` | oui | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | `Unkown` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `storageStatus` | Status | QString | — | + | `chargingState` | Charging state | QString | — | + | `gridCharging` | Grid charging | bool | — | + | `enableCharging` | Charging | bool | — | + | `enableDischarging` | Discharging | bool | — | + | `chargingRate` | Charging rate | int | Percentage | + | `dischargingRate` | Discharging rate | int | Percentage | + | `version` | Version | QString | — | + +??? abstract "SolarEdge — `solarEdgeConnection`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveId` | Slave ID | int | — | `1` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `address` | Host address | QString | — | — | non | + | `hostName` | Host name | QString | — | — | non | + | `macAddress` | MAC address | QString | — | — | non | + | `port` | Port | int | — | `502` | non | + | `slaveId` | Slave ID | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "SolarEdge battery — `solarEdgeBattery`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modbusAddress` | Modbus address | uint | — | `0` | oui | + | `manufacturer` | Manufacturer | QString | — | `Unkown` | non | + | `deviceModel` | Device model | QString | — | `Unkown` | non | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `chargingState` | Charging state | QString | — | + | `ratedEnergy` | Rated energy | double | KiloWattHour | + | `averageTemperature` | Average temperature | double | DegreeCelsius | + | `instantaneousVoltage` | Instantaneous voltage | double | Volt | + | `instantaneousCurrent` | Instantaneous current | double | Ampere | + | `currentPower` | Instantaneous power | double | Watt | + | `maxEnergy` | Maximum energy | double | KiloWattHour | + | `capacity` | Available energy | double | KiloWattHour | + | `stateOfHealth` | State of health (SOH) | double | Percentage | + | `batteryStatus` | Battery status | QString | — | + | `version` | Version | QString | — | + + diff --git a/docs/appareils/onduleurs/wattsonic.md b/docs/appareils/onduleurs/wattsonic.md new file mode 100644 index 0000000..ee05c3f --- /dev/null +++ b/docs/appareils/onduleurs/wattsonic.md @@ -0,0 +1,69 @@ +# Wattsonic + +NIGHTLY NYMEA CONSUMER + +Connect Wattsonic devices to nymea. + + +**Fabricant :** Wattsonic +**Plugin :** `Wattsonic` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Wattsonic hybrid inverter** | solarinverter | Modbus RTU | Découverte automatique / Ajout manuel | 3 | +| **Wattsonic energy meter** | Compteur d'énergie | — | Automatique | 13 | +| **Wattsonic energy storage** | energystorage | — | Automatique | 6 | + +#### Détail par modèle +??? abstract "Wattsonic hybrid inverter — `inverter`" + _Paramètres de découverte :_ + | Clé | Libellé | Type | Plage | Défaut | + | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `247` | + + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | uint | — | `247` | non | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | non | + | `serialNumber` | Serial number | QString | — | — | non | + | `inverterGeneration` | Inverter generation | QString | — | `Auto` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `totalEnergyProduced` | Total energy produced | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Wattsonic energy meter — `meter`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPowerPhaseA` | Power consumption phase A | double | Watt | + | `currentPowerPhaseB` | Power consumption phase B | double | Watt | + | `currentPowerPhaseC` | Power consumption phase C | double | Watt | + | `voltagePhaseA` | Voltage phase A | double | Volt | + | `voltagePhaseB` | Voltage phase B | double | Volt | + | `voltagePhaseC` | Voltage phase C | double | Volt | + | `currentPhaseA` | Current phase A | double | Ampere | + | `currentPhaseB` | Current phase B | double | Ampere | + | `currentPhaseC` | Current phase C | double | Ampere | + +??? abstract "Wattsonic energy storage — `battery`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `batteryCritical` | Battery critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + | `chargingState` | Charging state | QString | — | + | `currentPower` | Current power consumption | double | Watt | + | `capacity` | Capacity | double | KiloWattHour | + + diff --git a/docs/appareils/smart/gpio.md b/docs/appareils/smart/gpio.md new file mode 100644 index 0000000..61ca582 --- /dev/null +++ b/docs/appareils/smart/gpio.md @@ -0,0 +1,126 @@ +# GPIO + +NIGHTLY NYMEA COMMUNITY + +Control GPIOs for Raspberry Pi or BeagleBone Black. + + +**Fabricant :** Raspberry Pi, Beaglebone Black +**Plugin :** `GpioController` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **GPIO Output** | power | — | Découverte automatique | 1 | +| **GPIO Input** | — | — | Découverte automatique | 1 | +| **GPIO Button** | longpressbutton | — | Découverte automatique | 0 | +| **Counter** | — | — | Découverte automatique | 1 | +| **GPIO Output** | power | — | Découverte automatique | 1 | +| **GPIO Input** | — | — | Découverte automatique | 1 | +| **GPIO Button** | longpressbutton | — | Découverte automatique | 0 | +| **Counter** | — | — | Découverte automatique | 1 | + +#### Détail par modèle +??? abstract "GPIO Output — `gpioOutputRpi`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "GPIO Input — `gpioInputRpi`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + +??? abstract "GPIO Button — `gpioButtonRpi`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + +??? abstract "Counter — `counterRpi`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `counter` | Counter | int | Hertz | + +??? abstract "GPIO Output — `gpioOutputBbb`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "GPIO Input — `gpioInputBbb`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "GPIO Button — `gpioButtonBbb`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + +??? abstract "Counter — `counterBbb`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `gpio` | GPIO | int | — | `-1` | non | + | `pin` | Pin number | int | — | `-1` | non | + | `activeLow` | Active low | bool | — | `False` | non | + | `description` | Description | QString | — | `-` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `counter` | Counter | int | Hertz | + + diff --git a/docs/appareils/smart/modbuscommander.md b/docs/appareils/smart/modbuscommander.md new file mode 100644 index 0000000..4b90674 --- /dev/null +++ b/docs/appareils/smart/modbuscommander.md @@ -0,0 +1,97 @@ +# Modbus Commander + +NIGHTLY NYMEA COMMUNITY + +Write and read Modbus register. + + +**Fabricant :** nymea +**Plugin :** `ModbusCommander` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Modbus TCP client** | — | Modbus TCP | Ajout manuel / Découverte automatique | 1 | +| **Modbus RTU client** | — | Modbus RTU | Découverte automatique | 1 | +| **Coil** | — | — | Découverte automatique | 2 | +| **Discrete input** | — | — | Découverte automatique | 2 | +| **Input register** | — | — | Découverte automatique | 2 | +| **Holding register** | — | — | Découverte automatique | 2 | + +#### Détail par modèle +??? abstract "Modbus TCP client — `modbusTCPClient`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP Address | QString | — | `127.0.0.1` | non | + | `port` | Port | uint | — | `502` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Modbus RTU client — `modbusRTUClient`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Coil — `coil`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | — | `1` | non | + | `registerAddress` | Register address | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `value` | Value | bool | — | + +??? abstract "Discrete input — `discreteInput`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | — | `1` | non | + | `registerAddress` | Register address | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `value` | Value | bool | — | + +??? abstract "Input register — `inputRegister`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | — | `1` | non | + | `registerAddress` | Register address | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `value` | Value | int | — | + +??? abstract "Holding register — `holdingRegister`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Slave address | uint | — | `1` | non | + | `registerAddress` | Register address | uint | — | `0` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `value` | Value | uint | — | + + diff --git a/docs/appareils/smart/mqttclient.md b/docs/appareils/smart/mqttclient.md new file mode 100644 index 0000000..a1db03d --- /dev/null +++ b/docs/appareils/smart/mqttclient.md @@ -0,0 +1,41 @@ +# MQTT client + +NIGHTLY NYMEA COMMUNITY + +Subscribe to the internal or an external MQTT broker and send and receive MQTT messages. + + +**Fabricant :** nymea +**Plugin :** `mqttclient` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Internal MQTT client** | inputtrigger, outputtrigger | — | Ajout manuel | 0 | +| **MQTT client** | inputtrigger, outputtrigger | — | Ajout manuel | 0 | + +#### Détail par modèle +??? abstract "Internal MQTT client — `internalMqttClient`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `topicFilter` | Subscription topic filter | QString | — | `#` | non | + +??? abstract "MQTT client — `mqttClient`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `serverAddress` | Address | QString | — | — | non | + | `serverPort` | Port | int | 0–65535 | `1883` | non | + | `username` | Username | QString | — | — | non | + | `clientId` | Client Id | QString | — | `nymea` | non | + | `password` | Password | QString | — | — | non | + | `topicFilter` | Subscription topic filter | QString | — | `#` | non | + | `useSsl` | Use SSL | bool | — | `False` | non | + | `willTopic` | Will topic | QString | — | — | non | + | `willMessage` | Will message | QString | — | — | non | + | `willRetain` | Retain will | bool | — | `False` | non | + | `willQoS` | Will QoS | uint | 0–2 | `0` | non | + | `keepAlive` | Keep alive | uint | 0–65535 | `60` | non | + + diff --git a/docs/appareils/smart/shelly.md b/docs/appareils/smart/shelly.md new file mode 100644 index 0000000..652f97c --- /dev/null +++ b/docs/appareils/smart/shelly.md @@ -0,0 +1,711 @@ +# Shelly + +NIGHTLY NYMEA CONSUMER + +Use Shelly devices with nymea. + + +**Fabricant :** Shelly +**Plugin :** `shelly` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Shelly 1** | gateway, update | — | Découverte automatique | 6 | +| **Shelly Plus 1** | gateway, update | — | Découverte automatique | 6 | +| **Shelly 1PM** | gateway, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly Plus 1PM** | gateway, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly Pro 1PM** | gateway, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly 1L** | gateway, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly 2** | gateway, update | — | Découverte automatique | 7 | +| **Shelly 2.5** | gateway, update | — | Découverte automatique | 7 | +| **Shelly Plus 2PM** | gateway, update | — | Découverte automatique | 7 | +| **Shelly Plus Plug S/US/UK/IT** | powersocket, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly Plug/PlugS** | powersocket, Compteur de consommation, update | — | Découverte automatique | 8 | +| **Shelly RGBW2** | colorlight, update | — | Découverte automatique | 11 | +| **Shelly Dimmer (2) / Vintage** | dimmablelight, update | — | Découverte automatique | 8 | +| **Shelly button 1** | longpressmultibutton, battery, update | — | Découverte automatique | 7 | +| **Shelly I3** | longpressmultibutton, update | — | Découverte automatique | 8 | +| **Shelly H&T** | temperaturesensor, humiditysensor, battery, update | — | Découverte automatique | 9 | +| **Shelly TRV** | thermostat, temperaturesensor, battery, update | — | Découverte automatique | 13 | +| **Shelly Flood** | watersensor, temperaturesensor, battery, update | — | Découverte automatique | 9 | +| **Shelly Smoke** | firesensor, temperaturesensor, battery, update | — | Découverte automatique | 9 | +| **Shelly Plus Smoke** | firesensor, battery, update | — | Découverte automatique | 9 | +| **Shelly Gas** | gassensor, update | — | Découverte automatique | 10 | +| **Shelly switch** | powerswitch | — | Automatique | 3 | +| **Shelly 3EM (gen1)** | Compteur d'énergie, update | — | Découverte automatique | 27 | +| **Shelly Pro 3EM (120A / 400A)** | Compteur d'énergie, update | — | Découverte automatique | 24 | +| **Shelly 3EM (Gen3)** | Compteur d'énergie, update | — | Découverte automatique | 24 | +| **Shelly EM** | gateway, power, update | — | Découverte automatique | 6 | +| **Shelly Power meter Channel** | Compteur de consommation | — | Automatique | 4 | +| **Shelly EM Channel** | Compteur d'énergie | — | Automatique | 7 | +| **Shelly Motion** | presencesensor, lightsensor, update, battery | — | Découverte automatique | 10 | +| **Shelly connected Roller Shutter** | extendedshutter, Compteur de consommation | — | Automatique | 6 | +| **Shelly Addon temperature sensor** | temperaturesensor | — | Automatique | 3 | + +#### Détail par modèle +??? abstract "Shelly 1 — `shelly1`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Plus 1 — `shellyPlus1`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly 1PM — `shelly1pm`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Shelly Plus 1PM — `shellyPlus1pm`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Shelly Pro 1PM — `shellyPro1Pm`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Shelly 1L — `shelly1l`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Shelly 2 — `shelly2`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + | `rollerMode` | Roller shutter mode | bool | — | `False` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `channel1` | Power channel 1 | bool | — | + | `channel2` | Power channel 2 | bool | — | + +??? abstract "Shelly 2.5 — `shelly25`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + | `rollerMode` | Roller shutter mode | bool | — | `False` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `channel1` | Power channel 1 | bool | — | + | `channel2` | Power channel 2 | bool | — | + +??? abstract "Shelly Plus 2PM — `shellyPlus25`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `rollerMode` | Roller shutter mode | bool | — | `False` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `channel1` | Power channel 1 | bool | — | + | `channel2` | Power channel 2 | bool | — | + +??? abstract "Shelly Plus Plug S/US/UK/IT — `shellyPlusPlug`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Powered | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + +??? abstract "Shelly Plug/PlugS — `shellyPlug`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | Powered | bool | — | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Power consumption | double | Watt | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly RGBW2 — `shellyRgbw2`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | On | bool | — | + | `brightness` | Brightness | int | — | + | `colorTemperature` | Color temperature | int | — | + | `color` | Color | QColor | — | + | `whiteChannel` | White channel | uint | — | + | `currentPower` | Current power consumption | double | Watt | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Dimmer (2) / Vintage — `shellyDimmer`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | On | bool | — | + | `brightness` | Brightness | int | Percentage | + | `currentPower` | Current power consumption | double | Watt | + | `updateStatus` | Firmware update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly button 1 — `shellyButton1`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly I3 — `shellyI3`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `input1` | Input 1 | bool | — | + | `input2` | Input 2 | bool | — | + | `input3` | Input 3 | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly H&T — `shellyHT`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `temperature` | Temperature | double | DegreeCelsius | + | `humidity` | Humidity | double | Percentage | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly TRV — `shellyTrv`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `temperature` | Temperature | double | DegreeCelsius | + | `targetTemperature` | Target temperature | double | DegreeCelsius | + | `valvePosition` | Valve position | uint | Percentage | + | `heatingOn` | Heating | bool | — | + | `boost` | Boost | bool | — | + | `windowOpen` | Window open | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Flood — `shellyFlood`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `waterDetected` | Water detected | bool | — | + | `temperature` | Temperature | double | DegreeCelsius | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Smoke — `shellySmoke`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `fireDetected` | Fire detected | bool | — | + | `temperature` | Temperature | double | DegreeCelsius | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Plus Smoke — `shellyPlusSmoke`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `fireDetected` | Fire detected | bool | — | + | `mute` | Muted | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `batteryLevel` | Battery level | int | Percentage | + | `batteryCritical` | Battery level critical | bool | — | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + +??? abstract "Shelly Gas — `shellyGas`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `gasLevel` | Gas level | double | PartsPerMillion | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `sensorOperation` | Sensor operation | QString | — | + | `selfTest` | Self test | QString | — | + | `gas` | Gas level index | QString | — | + | `valveState` | Valve state | QString | — | + +??? abstract "Shelly switch — `shellySwitch`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `channel` | Channel | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | On/Off | bool | — | + +??? abstract "Shelly 3EM (gen1) — `shellyEm3`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Power usage (Phase A) | double | Watt | + | `powerFactorPhaseA` | Power factor (Phase A) | double | — | + | `currentPhaseA` | Current (Phase A) | double | Ampere | + | `voltagePhaseA` | Voltage (Phase A) | double | Volt | + | `energyConsumedPhaseA` | Total consumed energy (Phase A) | double | KiloWattHour | + | `energyProducedPhaseA` | Total returned energy (Phase A) | double | KiloWattHour | + | `currentPowerPhaseB` | Power usage (Phase B) | double | Watt | + | `powerFactorPhaseB` | Power factor (Phase B) | double | — | + | `currentPhaseB` | Current (Phase B) | double | Ampere | + | `voltagePhaseB` | Voltage (Phase B) | double | Volt | + | `energyConsumedPhaseB` | Total consumed energy (Phase B) | double | KiloWattHour | + | `energyProducedPhaseB` | Total returned energy (Phase B) | double | KiloWattHour | + | `currentPowerPhaseC` | Power usage (Phase C) | double | Watt | + | `powerFactorPhaseC` | Power factor (Phase C) | double | — | + | `currentPhaseC` | Current (Phase C) | double | Ampere | + | `voltagePhaseC` | Voltage (Phase C) | double | Volt | + | `energyConsumedPhaseC` | Total consumed energy (Phase C) | double | KiloWattHour | + | `energyProducedPhaseC` | Total returned energy (Phase C) | double | KiloWattHour | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `power` | Powered | bool | — | + +??? abstract "Shelly Pro 3EM (120A / 400A) — `shellyPro3EM`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Power usage (Phase A) | double | Watt | + | `currentPhaseA` | Current (Phase A) | double | Ampere | + | `voltagePhaseA` | Voltage (Phase A) | double | Volt | + | `energyConsumedPhaseA` | Total consumed energy (Phase A) | double | KiloWattHour | + | `energyProducedPhaseA` | Total returned energy (Phase A) | double | KiloWattHour | + | `currentPowerPhaseB` | Power usage (Phase B) | double | Watt | + | `currentPhaseB` | Current (Phase B) | double | Ampere | + | `voltagePhaseB` | Voltage (Phase B) | double | Volt | + | `energyConsumedPhaseB` | Total consumed energy (Phase B) | double | KiloWattHour | + | `energyProducedPhaseB` | Total returned energy (Phase B) | double | KiloWattHour | + | `currentPowerPhaseC` | Power usage (Phase C) | double | Watt | + | `currentPhaseC` | Current (Phase C) | double | Ampere | + | `voltagePhaseC` | Voltage (Phase C) | double | Volt | + | `energyConsumedPhaseC` | Total consumed energy (Phase C) | double | KiloWattHour | + | `energyProducedPhaseC` | Total returned energy (Phase C) | double | KiloWattHour | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `power` | Powered | bool | — | + +??? abstract "Shelly 3EM (Gen3) — `shelly3EM`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPowerPhaseA` | Power usage (Phase A) | double | Watt | + | `currentPhaseA` | Current (Phase A) | double | Ampere | + | `voltagePhaseA` | Voltage (Phase A) | double | Volt | + | `energyConsumedPhaseA` | Total consumed energy (Phase A) | double | KiloWattHour | + | `energyProducedPhaseA` | Total returned energy (Phase A) | double | KiloWattHour | + | `currentPowerPhaseB` | Power usage (Phase B) | double | Watt | + | `currentPhaseB` | Current (Phase B) | double | Ampere | + | `voltagePhaseB` | Voltage (Phase B) | double | Volt | + | `energyConsumedPhaseB` | Total consumed energy (Phase B) | double | KiloWattHour | + | `energyProducedPhaseB` | Total returned energy (Phase B) | double | KiloWattHour | + | `currentPowerPhaseC` | Power usage (Phase C) | double | Watt | + | `currentPhaseC` | Current (Phase C) | double | Ampere | + | `voltagePhaseC` | Voltage (Phase C) | double | Volt | + | `energyConsumedPhaseC` | Total consumed energy (Phase C) | double | KiloWattHour | + | `energyProducedPhaseC` | Total returned energy (Phase C) | double | KiloWattHour | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `power` | Powered | bool | — | + +??? abstract "Shelly EM — `shellyEm`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `power` | Powered | bool | — | + +??? abstract "Shelly Power meter Channel — `shellyPowerMeterChannel`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `channel` | Channel | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + +??? abstract "Shelly EM Channel — `shellyEmChannel`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `channel` | Channel | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + | `totalEnergyProduced` | Total returned energy | double | KiloWattHour | + | `currentPower` | Current power | double | Watt | + | `currentPhaseA` | Current | double | Ampere | + | `voltagePhaseA` | Voltage | double | Volt | + +??? abstract "Shelly Motion — `shellyMotion`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Shelly ID | QString | — | — | oui | + | `coapMode` | CoIoT peer mode | QString | — | `unicast` | non | + | `username` | Username (optional) | QString | — | — | non | + | `password` | Password (optional) | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `isPresent` | Person is present | bool | — | + | `lightIntensity` | Light intensity | double | Lux | + | `vibration` | Vibration | bool | — | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `updateStatus` | Update status | QString | — | + | `currentVersion` | Current firmware version | QString | — | + | `availableVersion` | Available firmware version | QString | — | + | `batteryCritical` | Battery level critical | bool | — | + | `batteryLevel` | Battery level | int | Percentage | + +??? abstract "Shelly connected Roller Shutter — `shellyRoller`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `channel` | Channel | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `totalEnergyConsumed` | Total energy consumed | double | KiloWattHour | + | `currentPower` | Current power consumption | double | Watt | + | `moving` | Moving | bool | — | + | `percentage` | Position | int | Percentage | + +??? abstract "Shelly Addon temperature sensor — `shellyAddonTempSensor`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `addonId` | ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `temperature` | Temperature | double | DegreeCelsius | + + diff --git a/docs/appareils/smart/tasmota.md b/docs/appareils/smart/tasmota.md new file mode 100644 index 0000000..5b62f85 --- /dev/null +++ b/docs/appareils/smart/tasmota.md @@ -0,0 +1,174 @@ +# Tasmota + +NIGHTLY NYMEA COMMUNITY + +Connect ESPs flashed with Tasmota to nymea. + + +**Fabricant :** Tasmota +**Plugin :** `tasmota` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Single switch (Sonoff Basic, RF, Touch...)** | gateway | — | Ajout manuel | 3 | +| **Dual switch (Sonoff Dual, T1 2CH...)** | gateway | — | Ajout manuel | 4 | +| **3 channel switch (Sonoff 3CH, Tuya 3CH...)** | gateway | — | Ajout manuel | 5 | +| **4 channel switch (Sonoff 4CH, T1 4CH...)** | gateway | — | Ajout manuel | 6 | +| **Dimmer (Sonoff D1...)** | dimmablelight | — | Ajout manuel | 4 | +| **Tasmota power switch** | powerswitch | — | Automatique | 3 | +| **Tasmota light** | light | — | Automatique | 3 | +| **Tasmota shutter** | shutter, closable | — | Automatique | 2 | +| **Tasmota blinds** | blind, closable | — | Automatique | 2 | +| **Power meter** | Compteur de consommation | — | Automatique | 4 | + +#### Détail par modèle +??? abstract "Single switch (Sonoff Basic, RF, Touch...) — `sonoff_basic`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + | `attachedDeviceCH1` | Connected device | QString | — | `None` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | Power | bool | — | + +??? abstract "Dual switch (Sonoff Dual, T1 2CH...) — `sonoff_dual`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + | `attachedDeviceCH1` | Connected device 1 | QString | — | `None` | non | + | `attachedDeviceCH2` | Connected device 2 | QString | — | `None` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `powerCH1` | Power channel 1 | bool | — | + | `powerCH2` | Power channel 2 | bool | — | + +??? abstract "3 channel switch (Sonoff 3CH, Tuya 3CH...) — `sonoff_tri`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + | `attachedDeviceCH1` | Connected device 1 | QString | — | `None` | non | + | `attachedDeviceCH2` | Connected device 2 | QString | — | `None` | non | + | `attachedDeviceCH3` | Connected device 3 | QString | — | `None` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `powerCH1` | Power channel 1 | bool | — | + | `powerCH2` | Power channel 2 | bool | — | + | `powerCH3` | Power channel 3 | bool | — | + +??? abstract "4 channel switch (Sonoff 4CH, T1 4CH...) — `sonoff_quad`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + | `attachedDeviceCH1` | Connected device 1 | QString | — | `None` | non | + | `attachedDeviceCH2` | Connected device 2 | QString | — | `None` | non | + | `attachedDeviceCH3` | Connected device 3 | QString | — | `None` | non | + | `attachedDeviceCH4` | Connected device 4 | QString | — | `None` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `powerCH1` | Power channel 1 | bool | — | + | `powerCH2` | Power channel 2 | bool | — | + | `powerCH3` | Power channel 3 | bool | — | + | `powerCH4` | Power channel 4 | bool | — | + +??? abstract "Dimmer (Sonoff D1...) — `sonoff_dimmer`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `ipAddress` | IP address | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | Power | bool | — | + | `brightness` | Brightness | int | — | + +??? abstract "Tasmota power switch — `tasmotaSwitch`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `channelName` | Channel name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | Power | bool | — | + +??? abstract "Tasmota light — `tasmotaLight`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `channelName` | Channel name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `power` | Power | bool | — | + +??? abstract "Tasmota shutter — `tasmotaShutter`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `openingChannel` | Opening channel | QString | — | — | non | + | `closingChannel` | Closing channel | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + +??? abstract "Tasmota blinds — `tasmotaBlinds`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `openingChannel` | Opening channel | QString | — | — | non | + | `closingChannel` | Closing channel | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + +??? abstract "Power meter — `powerMeterChannel`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `channelName` | Channel name | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `signalStrength` | Signal strength | uint | Percentage | + | `currentPower` | Current power consumption | double | Watt | + | `totalEnergyConsumed` | Total consumed energy | double | KiloWattHour | + + diff --git a/docs/appareils/smart/tuya.md b/docs/appareils/smart/tuya.md new file mode 100644 index 0000000..5ca7f16 --- /dev/null +++ b/docs/appareils/smart/tuya.md @@ -0,0 +1,66 @@ +# Tuya + +NIGHTLY NYMEA COMMUNITY + +Connect to the Tuya cloud. + + +**Fabricant :** Tuya +**Plugin :** `tuya` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Tuya cloud login** | account | — | Ajout manuel | 3 | +| **Tuya switch** | powersocket | — | Automatique | 2 | +| **Tuya blinds** | blind | — | Automatique | 1 | +| **Tuya color light** | colorlight | — | Automatique | 5 | + +#### Détail par modèle +??? abstract "Tuya cloud login — `tuyaCloud`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + | `userDisplayName` | Username | QString | — | + +??? abstract "Tuya switch — `tuyaSwitch`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + +??? abstract "Tuya blinds — `tuyaClosable`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Tuya color light — `tuyaLight`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | ID | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + | `brightness` | Brightness | int | Percentage | + | `color` | Color | QColor | — | + | `colorTemperature` | Color temperature | int | — | + + diff --git a/docs/appareils/smart/unipi.md b/docs/appareils/smart/unipi.md new file mode 100644 index 0000000..23af7a6 --- /dev/null +++ b/docs/appareils/smart/unipi.md @@ -0,0 +1,251 @@ +# UniPi + +NIGHTLY NYMEA CONSUMER + +Integrates UniPi with nymea + + +**Fabricant :** UniPi +**Plugin :** `UniPi` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **UniPi 1** | gateway | — | Ajout manuel | 1 | +| **UniPi 1 Lite** | gateway | — | Ajout manuel | 1 | +| **Neuron L403** | gateway | — | Ajout manuel | 1 | +| **Neuron S103** | gateway | — | Ajout manuel | 1 | +| **Neuron M103** | gateway | — | Ajout manuel | 1 | +| **Neuron M203** | gateway | — | Ajout manuel | 1 | +| **Neuron M303** | gateway | — | Ajout manuel | 1 | +| **Neuron M403** | gateway | — | Ajout manuel | 1 | +| **Neuron M503** | gateway | — | Ajout manuel | 1 | +| **Neuron L203** | gateway | — | Ajout manuel | 1 | +| **Neuron L303** | gateway | — | Ajout manuel | 1 | +| **Neuron L503** | gateway | — | Ajout manuel | 1 | +| **Neuron L513** | gateway | — | Ajout manuel | 1 | +| **Neuron xS10** | gateway | — | Ajout manuel | 1 | +| **Neuron xS20** | gateway | — | Ajout manuel | 1 | +| **Neuron xS30** | gateway | — | Ajout manuel | 1 | +| **Neuron xS40** | gateway | — | Ajout manuel | 1 | +| **Neuron xS50** | gateway | — | Ajout manuel | 1 | +| **Neuron xS11** | gateway | — | Ajout manuel | 1 | +| **Neuron xS51** | gateway | — | Ajout manuel | 1 | +| **Digital input** | — | — | Découverte automatique | 1 | +| **Digital output** | power | — | Découverte automatique | 1 | +| **Analog output** | — | — | Découverte automatique | 1 | +| **Analog Input** | — | — | Découverte automatique | 1 | +| **User LED** | power | — | Découverte automatique | 1 | + +#### Détail par modèle +??? abstract "UniPi 1 — `uniPi1`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "UniPi 1 Lite — `uniPi1Lite`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron L403 — `neuronL403`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron S103 — `neuronS103`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron M103 — `neuronM103`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron M203 — `neuronM203`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron M303 — `neuronM303`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron M403 — `neuronM403`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron M503 — `neuronM503`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron L203 — `neuronL203`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron L303 — `neuronL303`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron L503 — `neuronL503`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron L513 — `neuronL513`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS10 — `neuronXS10`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS20 — `neuronXS20`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS30 — `neuronXS30`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS40 — `neuronXS40`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS50 — `neuronXS50`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS11 — `neuronXS11`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Neuron xS51 — `neuronXS51`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `slaveAddress` | Modbus slave address | int | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "Digital input — `digitalInput`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `circuit` | Circuit | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `inputStatus` | Digital input | bool | — | + +??? abstract "Digital output — `digitalOutput`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `circuit` | Circuit | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + +??? abstract "Analog output — `analogOutput`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `circuit` | Circuit | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `outputValue` | Analog output | double | Volt | + +??? abstract "Analog Input — `analogInput`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `circuit` | Circuit | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `inputValue` | Analog input | double | Volt | + +??? abstract "User LED — `userLED`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `circuit` | Circuit | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `power` | Power | bool | — | + + diff --git a/docs/appareils/smart/usbrelay.md b/docs/appareils/smart/usbrelay.md new file mode 100644 index 0000000..f51c8e6 --- /dev/null +++ b/docs/appareils/smart/usbrelay.md @@ -0,0 +1,42 @@ +# USB Relay + +NIGHTLY NYMEA CONSUMER + +Control relays connected over USB. + + +**Fabricant :** USB Relay +**Plugin :** `UsbRelay` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **USB Relay Connector** | gateway | — | Discovery | 1 | +| **USB Relay** | power | — | Auto | 2 | + +#### Détail par modèle +??? abstract "USB Relay Connector — `usbRelayConnector`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `path` | System path | QString | — | — | non | + | `relayCount` | Relay count | uint | — | `2` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + +??? abstract "USB Relay — `usbRelay`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `relayNumber` | Relay number | uint | — | `1` | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `power` | Power | bool | — | + + diff --git a/docs/appareils/smart/usbrly82.md b/docs/appareils/smart/usbrly82.md new file mode 100644 index 0000000..3b4d583 --- /dev/null +++ b/docs/appareils/smart/usbrly82.md @@ -0,0 +1,47 @@ +# USB-RLY82 + +NIGHTLY NYMEA CONSUMER + +Control relays connected over USB and read digital and analog inputs. + + +**Fabricant :** Robot electronics +**Plugin :** `UsbRly82` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **USB-RLY82** | gateway | — | Découverte automatique / Automatique | 20 | + +#### Détail par modèle +??? abstract "USB-RLY82 — `usbRelay`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `serialNumber` | Serial number | QString | — | — | non | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `powerRelay1` | Power relay 1 | bool | — | + | `powerRelay2` | Power relay 2 | bool | — | + | `digitalInputChannel1` | Channel 1 | bool | — | + | `digitalInputChannel2` | Channel 2 | bool | — | + | `digitalInputChannel3` | Channel 3 | bool | — | + | `digitalInputChannel4` | Channel 4 | bool | — | + | `digitalInputChannel5` | Channel 5 | bool | — | + | `digitalInputChannel6` | Channel 6 | bool | — | + | `digitalInputChannel7` | Channel 7 | bool | — | + | `digitalInputChannel8` | Channel 8 | bool | — | + | `analogInputChannel1` | Analog Channel 1 | double | — | + | `analogInputChannel2` | Analog Channel 2 | double | — | + | `analogInputChannel3` | Analog Channel 3 | double | — | + | `analogInputChannel4` | Analog Channel 4 | double | — | + | `analogInputChannel5` | Analog Channel 5 | double | — | + | `analogInputChannel6` | Analog Channel 6 | double | — | + | `analogInputChannel7` | Analog Channel 7 | double | — | + | `analogInputChannel8` | Analog Channel 8 | double | — | + | `version` | Version | QString | — | + + diff --git a/docs/appareils/smart/waveshare.md b/docs/appareils/smart/waveshare.md index 38f8b83..9044404 100644 --- a/docs/appareils/smart/waveshare.md +++ b/docs/appareils/smart/waveshare.md @@ -33,32 +33,40 @@ Voir [Ajouter un appareil](../../installation/application.md). **Fabricant :** Waveshare -**Plugin :** `waveshare-relay-d8` +**Plugin :** `WaveshareRelayD8` #### Modèles pris en charge | Modèle | Rôle | Transport | Ajout | Grandeurs | | --- | --- | --- | --- | --- | -| **Waveshare 8-Channel Relay (RS485)** | — | Modbus RTU | Ajout manuel | 9 | +| **Waveshare Relay D8** | — | Modbus RTU | Découverte automatique | 17 | #### Détail par modèle -??? abstract "Waveshare 8-Channel Relay (RS485) — `waveshareRelayD8`" +??? abstract "Waveshare Relay D8 — `waveshareRelayD8`" _Réglages :_ | Clé | Libellé | Type | Plage | Défaut | Lecture seule | | --- | --- | --- | --- | --- | --- | - | `modbusMasterUuid` | Modbus RTU master | QUuid | — | — | oui | - | `slaveAddress` | Slave address | uint | 1–247 | `1` | non | + | `rtuMaster` | Modbus RTU master UUID | QString | — | — | non | + | `slaveAddress` | Modbus slave address | int | 1–247 | `1` | non | _Grandeurs mesurées :_ | Clé | Grandeur | Type | Unité | | --- | --- | --- | --- | | `connected` | Connected | bool | — | - | `relay1` | Relay 1 | bool | — | - | `relay2` | Relay 2 | bool | — | - | `relay3` | Relay 3 | bool | — | - | `relay4` | Relay 4 | bool | — | - | `relay5` | Relay 5 | bool | — | - | `relay6` | Relay 6 | bool | — | - | `relay7` | Relay 7 | bool | — | - | `relay8` | Relay 8 | bool | — | + | `relay1State` | Relay 1 | bool | — | + | `relay2State` | Relay 2 | bool | — | + | `relay3State` | Relay 3 | bool | — | + | `relay4State` | Relay 4 | bool | — | + | `relay5State` | Relay 5 | bool | — | + | `relay6State` | Relay 6 | bool | — | + | `relay7State` | Relay 7 | bool | — | + | `relay8State` | Relay 8 | bool | — | + | `input1State` | Input 1 | bool | — | + | `input2State` | Input 2 | bool | — | + | `input3State` | Input 3 | bool | — | + | `input4State` | Input 4 | bool | — | + | `input5State` | Input 5 | bool | — | + | `input6State` | Input 6 | bool | — | + | `input7State` | Input 7 | bool | — | + | `input8State` | Input 8 | bool | — | diff --git a/docs/appareils/tarifs/awattar.md b/docs/appareils/tarifs/awattar.md new file mode 100644 index 0000000..cafe8e0 --- /dev/null +++ b/docs/appareils/tarifs/awattar.md @@ -0,0 +1,44 @@ +# aWATTar + +NIGHTLY NYMEA CONSUMER + +Get the latest energy price from aWATTar. + + +**Fabricant :** aWATTar +**Plugin :** `awattar` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **aWATTar AT** | — | — | Ajout manuel | 8 | +| **aWATTar DE** | — | — | Ajout manuel | 8 | + +#### Détail par modèle +??? abstract "aWATTar AT — `awattarAT`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Online | bool | — | + | `currentMarketPrice` | Current market price | double | EuroCentPerKiloWattHour | + | `averageDeviation` | Average deviation | int | Percentage | + | `validUntil` | Valid until | int | UnixTime | + | `averagePrice` | Average market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `lowestPrice` | Lowest market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `highestPrice` | Highest market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `rank` | Current rank (lower is better) | uint | — | + +??? abstract "aWATTar DE — `awattarDE`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Online | bool | — | + | `currentMarketPrice` | Current market price | double | EuroCentPerKiloWattHour | + | `averageDeviation` | Average deviation | int | Percentage | + | `validUntil` | Valid until | int | UnixTime | + | `averagePrice` | Average market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `lowestPrice` | Lowest market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `highestPrice` | Highest market price [+/- 12 h] | double | EuroCentPerKiloWattHour | + | `rank` | Current rank (lower is better) | uint | — | + + diff --git a/docs/appareils/tarifs/index.md b/docs/appareils/tarifs/index.md new file mode 100644 index 0000000..1bc1cc9 --- /dev/null +++ b/docs/appareils/tarifs/index.md @@ -0,0 +1,10 @@ +# Tarifs & prévisions + + +| Appareil | Protocole | Canal | Origine | Stabilité | +| --- | --- | --- | --- | --- | +| [aWATTar](awattar.md) | — | NIGHTLY | NYMEA | CONSUMER | +| [Tempo](tempo.md) | — | NIGHTLY | NYMEA | CONSUMER | +| [spot-hinta](spothinta.md) | — | NIGHTLY | NYMEA | CONSUMER | + + diff --git a/docs/appareils/tarifs/spothinta.md b/docs/appareils/tarifs/spothinta.md new file mode 100644 index 0000000..286af6e --- /dev/null +++ b/docs/appareils/tarifs/spothinta.md @@ -0,0 +1,30 @@ +# spot-hinta + +NIGHTLY NYMEA CONSUMER + +Get Findlands current energy price from spot-hinta.fi. + + +**Fabricant :** spot-hinta +**Plugin :** `spothinta` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **spot-hinta** | — | — | Ajout manuel | 8 | + +#### Détail par modèle +??? abstract "spot-hinta — `spothinta`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Online | bool | — | + | `currentMarketPrice` | Current market price | double | EuroCentPerKiloWattHour | + | `currentRank` | Current rank | uint | — | + | `validUntil` | Valid until | int | UnixTime | + | `averagePrice` | Average market price today | double | EuroCentPerKiloWattHour | + | `lowestPrice` | Lowest market price today | double | EuroCentPerKiloWattHour | + | `highestPrice` | Highest market price today | double | EuroCentPerKiloWattHour | + | `averageDeviation` | Average deviation | int | Percentage | + + diff --git a/docs/appareils/tarifs/tempo.md b/docs/appareils/tarifs/tempo.md new file mode 100644 index 0000000..680a1ab --- /dev/null +++ b/docs/appareils/tarifs/tempo.md @@ -0,0 +1,60 @@ +# Tempo + +NIGHTLY NYMEA CONSUMER + +Get logged hours from Tempo. + + +**Fabricant :** Tempo +**Plugin :** `tempo` + +#### Modèles pris en charge +| Modèle | Rôle | Transport | Ajout | Grandeurs | +| --- | --- | --- | --- | --- | +| **Tempo connection** | account | — | Ajout manuel | 2 | +| **Account** | — | — | Découverte automatique | 10 | +| **Team** | — | — | Découverte automatique | 4 | + +#### Détail par modèle +??? abstract "Tempo connection — `tempoConnection`" + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `loggedIn` | Logged in | bool | — | + +??? abstract "Account — `account`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `key` | Key | QString | — | — | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `status` | Status | QString | — | + | `global` | Global | bool | — | + | `monthlyBudget` | Monthly budget | int | — | + | `lead` | Lead | QString | — | + | `contact` | Contact | QString | — | + | `category` | Category | QString | — | + | `Customer` | Customer | QString | — | + | `totalTimeSpent` | Total time spent | double | Hours | + | `monthTimeSpent` | This month time spent | double | Hours | + +??? abstract "Team — `team`" + _Réglages :_ + | Clé | Libellé | Type | Plage | Défaut | Lecture seule | + | --- | --- | --- | --- | --- | --- | + | `id` | Id | int | — | `0` | oui | + + _Grandeurs mesurées :_ + | Clé | Grandeur | Type | Unité | + | --- | --- | --- | --- | + | `connected` | Connected | bool | — | + | `lead` | Lead | QString | — | + | `totalTimeSpent` | Total time spent | double | Hours | + | `monthTimeSpent` | This month time spent | double | Hours | + + diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index a8e0c12..5f9916e 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -25,6 +25,11 @@ .badge.consumer {color:#31a3dd;background:rgba(49,163,221,.1);border:1px solid rgba(49,163,221,.3)} .badge.community {color:#a78bfa;background:rgba(167,139,250,.1);border:1px solid rgba(167,139,250,.3)} +/* origine plugin (PORTING_STATUS.repo ou champ origin:) */ +.badge.origin-nymea {color:#94a3b8;background:rgba(148,163,184,.1);border:1px solid rgba(148,163,184,.3)} +.badge.origin-etm {color:#4ade80;background:rgba(74,222,128,.1);border:1px solid rgba(74,222,128,.3)} +.badge.origin-tiers {color:#fb923c;background:rgba(251,146,60,.1);border:1px solid rgba(251,146,60,.3)} + /* maturité fonctionnalités (à la main) */ .badge.ok {color:#3fd18a;background:rgba(63,209,138,.12);border:1px solid rgba(63,209,138,.3)} .badge.part {color:#fec113;background:rgba(254,193,19,.1);border:1px solid rgba(254,193,19,.3)} diff --git a/scripts/gen_device_reference.py b/scripts/gen_device_reference.py index ecf2572..7dde7f8 100644 --- a/scripts/gen_device_reference.py +++ b/scripts/gen_device_reference.py @@ -53,6 +53,7 @@ CATEGORY_LABELS = { "onduleur": "Onduleurs / PV", "batterie": "Batteries / ESS", "tarif": "Tarifs & prévisions", + "generic": "Types génériques", } CATEGORY_FOLDER = { @@ -63,9 +64,12 @@ CATEGORY_FOLDER = { "onduleur": "onduleurs", "batterie": "batteries", "tarif": "tarifs", + "generic": "generic", } -CATEGORY_ORDER = ["compteur", "irve", "smartdevice", "hvac", "onduleur", "batterie", "tarif"] +CATEGORY_ORDER = [ + "compteur", "irve", "smartdevice", "hvac", "onduleur", "batterie", "tarif", "generic", +] CHANNEL_BADGES = { "stable": 'STABLE', @@ -78,6 +82,24 @@ STABILITY_BADGES = { "community": 'COMMUNITY', } +ORIGIN_BADGES = { + "nymea": 'NYMEA', + "etm": 'ETM', + "tiers": 'TIERS', +} + + +def resolve_origin(e: dict) -> str: + """Détermine l'origine depuis le champ explicite `origin:` ou depuis `repo:`.""" + if e.get("origin"): + return e["origin"] + repo = e.get("repo", "") + if repo.startswith("nymea-"): + return "nymea" + if repo.startswith("etm-"): + return "etm" + return "tiers" + MARKER_RE = re.compile( r"()(?P.*?)()", re.DOTALL, @@ -274,7 +296,6 @@ def render_nightly_stub(entry: dict, meta: dict) -> str: def render_category_index(cat: str, entries: list, plugins: dict, src: Path) -> str: """Tableau listant les appareils d'une catégorie, pour l'index.md auto-généré.""" - folder = CATEGORY_FOLDER.get(cat, cat) cat_entries = [e for e in entries if e.get("category") == cat and e.get("plugin")] if not cat_entries: return "_Aucun appareil dans cette catégorie._\n" @@ -288,11 +309,13 @@ def render_category_index(cat: str, entries: list, plugins: dict, src: Path) -> slug = e.get("slug") or e["plugin"] protocol = resolve_protocol(plugin_data) if plugin_data else "—" channel_badge = CHANNEL_BADGES.get(e["channel"], e["channel"]) + origin_badge = ORIGIN_BADGES.get(resolve_origin(e), "—") stability = meta.get("stability", "") stability_badge = STABILITY_BADGES.get(stability, "—") if stability else "—" - rows.append([f"[{name}]({slug}.md)", protocol, channel_badge, stability_badge]) + rows.append([f"[{name}]({slug}.md)", protocol, channel_badge, origin_badge, + stability_badge]) - return md_table(["Appareil", "Protocole", "Canal", "Stabilité"], rows) + "\n" + return md_table(["Appareil", "Protocole", "Canal", "Origine", "Stabilité"], rows) + "\n" def render_matrix(entries: list, plugins: dict, src: Path) -> str: @@ -317,14 +340,17 @@ def render_matrix(entries: list, plugins: dict, src: Path) -> str: name = entry_name(e, meta) protocol = resolve_protocol(plugin_data) channel_badge = CHANNEL_BADGES.get(e["channel"], e["channel"]) + origin_badge = ORIGIN_BADGES.get(resolve_origin(e), "—") stability = meta.get("stability", "") stability_badge = STABILITY_BADGES.get(stability, "—") if stability else "—" - cat_rows.append(f"| {name} | {protocol} | {channel_badge} | {stability_badge} |") + cat_rows.append( + f"| {name} | {protocol} | {channel_badge} | {origin_badge} | {stability_badge} |" + ) if not cat_rows: continue lines.append(f"## {label}\n") - lines.append("| Marque / Modèle | Protocole | Canal | Stabilité |") - lines.append("|---|---|---|---|") + lines.append("| Marque / Modèle | Protocole | Canal | Origine | Stabilité |") + lines.append("|---|---|---|---|---|") lines.extend(cat_rows) lines.append("") @@ -409,9 +435,11 @@ def build_device_page(e: dict, plugin_data: dict | None, meta: dict) -> str: fname = f"integrationplugin{plugin}.json" channel_badge = CHANNEL_BADGES.get(e["channel"], e["channel"]) + origin_badge = ORIGIN_BADGES.get(resolve_origin(e), "") stability = meta.get("stability", "") stability_badge = STABILITY_BADGES.get(stability, "") if stability else "" - badges_line = channel_badge + (" " + stability_badge if stability_badge else "") + badges_parts = [b for b in [channel_badge, origin_badge, stability_badge] if b] + badges_line = " ".join(badges_parts) tagline = meta.get("tagline", "") if plugin_data: