@camstack/addon-provider-enpal 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3] - 2026-10-27
+
 ### Added
 
 - Enpal solar box provider: InfluxDB 2.x source with the local device page as fallback, device adoption for PV, battery, grid, house and heat pump.

package/README.md

@@ -1,30 +1,32 @@
 # @camstack/addon-provider-enpal
 
-Enpal solar box device-provider addon for CamStack — PV production, inverter, battery, grid import/export, house consumption and heat pump as Sensor devices with history.
+Enpal solar box provider for CamStack: the box is an integration, and the equipment it reports (photovoltaic, battery, grid, house, heat pump) is adopted as Container devices with history. There is no device for the box itself.
 
 ## What it does
 
-- **Enpal** (`provider-enpal`): add a box by its host; the box is a Hub device that polls the box's InfluxDB 2.x (or, as fallback, its local device page) and offers the data groups it actually reports for adoption.
+- **Enpal** (`provider-enpal`): add an integration with the box's host. The addon polls the box's InfluxDB 2.x (or, as fallback, its local device page) and offers one Container per piece of equipment the box actually reports. Adopting a container adopts its children.
   - Node placement: `hub-only`.
-  - Capabilities: `device-provider`.
+  - Capabilities: `device-provider`, `device-adoption`.
 
-Devices (each adopted from the box's discovery panel, only when the box reports them):
+Containers and their children (a container is offered only when the box reported at least one of its values; a child only when the box reported its value):
 
-| Device | Caps |
-| --- | --- |
-| PV production | `power-meter` (W, lifetime kWh) |
-| Battery | `battery` (state of charge), `power-meter` (signed W, V, A) |
-| Battery charged / discharged | `meter` (lifetime kWh) |
-| Grid import / export | `power-meter` (W, lifetime kWh) |
-| House consumption | `power-meter` |
-| Heat pump, hot water, outside temperature | `power-meter` / `numeric-sensor` |
-| Inverter / battery temperature, battery health | `numeric-sensor` |
+| Container | Child | Caps |
+| --- | --- | --- |
+| Photovoltaic | Production | `power-meter` (W, lifetime kWh) |
+| | Inverter temperature | `numeric-sensor` |
+| Battery | Battery | `battery` (state of charge), `power-meter` (signed W, V, A) |
+| | Energy charged / discharged | `meter` (lifetime kWh) |
+| | Temperature, Health | `numeric-sensor` |
+| Grid | Import, Export | `power-meter` (W, lifetime kWh) |
+| House | Consumption | `power-meter` |
+| Heat pump | Consumption | `power-meter` |
+| | Hot water temperature, Outside temperature | `numeric-sensor` |
 
-An unreachable box marks its devices offline; it never publishes zeros. A lifetime counter that drops for one poll is held at its previous value.
+Removing the integration removes its devices. An unreachable box marks its devices offline; it never publishes zeros. A lifetime counter that drops for one poll is held at its previous value.
 
-## Settings
+## Integration settings
 
-- **Box host / IP** — the box on the LAN. The box does not advertise itself, so it is added by hand.
+- **Box host / IP** — the box on the LAN. The box does not advertise itself, so the integration is added by hand.
 - **Source** — `auto` (InfluxDB when a token is set, the device page otherwise or when InfluxDB cannot be read), `influx`, or `page`.
 - **InfluxDB access token** — issued by Enpal support (ask in the Enpal app chat). Stored in the keychain. Organisation (`enpal`), bucket (`solar`) and port (`8086`) default to the usual values.
 - **Poll interval** — 30 s by default, 10 s minimum.
@@ -35,3 +37,35 @@ Firmware 8.51 and later render the device rows of the device page only through a
 ## Requirements
 
 - A CamStack hub on the same network as the box.
+
+<!-- readme:generated:start (derived from the manifest; edit outside this block) -->
+
+Package `@camstack/addon-provider-enpal` on npm.
+
+## What it provides
+
+- **Enpal** (`provider-enpal`): Add an Enpal solar box as an integration (InfluxDB, device page as fallback) and adopt its equipment: photovoltaic, battery, grid, house and heat pump. Category: providers.
+  - Capabilities: `device-provider`, `device-adoption`.
+
+## Configuration
+
+Edit these from System, Addons, this addon, Settings (a device's own settings are on its device page). A password field is stored in the keychain.
+
+**Connection**
+
+- Box: Box host / IP
+- Data source: Source, InfluxDB access token, InfluxDB organisation, InfluxDB bucket, InfluxDB port, Device page port
+- Polling: Poll interval (ms), Invert battery power sign
+
+## Requirements
+
+- Placement: hub-only.
+- A CamStack hub. An agent is used only where the placement above allows it.
+
+## Documentation
+
+- [docs/architecture/device-model.md](https://github.com/camstack/server/blob/main/docs/architecture/device-model.md)
+
+See [CHANGELOG.md](./CHANGELOG.md) for what changed in each version.
+
+<!-- readme:generated:end -->