Research and implement logging feature introduced in v2.23

[tijsverkoyen]

Added support for retrieving measurement data (for device properties having a logging feature)

See the new documentation.
Check what devices have these logging feature and add it to the integration

Added Device model – NHC Metering module (pulse meter)

Available properties that are exposed:

• ElectricalEnergy, Unit: Wh, Positive = energy consumed, Negative = energy produced
• Gasvolume, Unit: m3
• WaterVolume, Unit: m3

I think this is the only one that would be useful to expose totals.

Updated Device model – NHC ZigBee Electricity Metering module (with clamp)
Updated Device model – NHC Electricity Metering module (with clamp)
Updated Device model – NHC Zigbee Smart plug
Updated Device model – Generic Zigbee Smart plug
Generic Charging Station

Available measurements that are exposed:

• ElectricalEnergy, Unit: Wh, Positive = energy consumed, Negative = energy produced

Updated Device model – Energy Home

Available measurements that are exposed:

• ElectricalEnergyToGrid, Unit: Wh, Energy injected in the grid
• ElectricalEnergyFromGrid, Unit: Wh, Energy consumed from the grid
• ElectricalEnergyProduction, Unit: Wh, Energy produced in the installation
• ElectricalEnergySelfConsumption, Unit: Wh, Energy consumed in he home, ElectricalEnergyProduction - ElectricalEnergyToGrid
• ElectricalEnergyConsumption, Unit: Wh, ElectricalEnergySelfConsumption + ElectricalEnergyFromGrid
• ElectricalPeakPowerToGrid, Unit: W
• ElectricalPeakPowerFromGrid, Unit: W
• ElectricalMonthlyPeakPowerFromGrid, Unit: W, Monthly peak power from grid
• WaterVolume, Unit: m3
• GasVolume, Unit: m3
• ElectricalEnergyToGridCost, Unit: , Energy cost injected in the grid
• ElectricalEnergyFromGridCost, Unit: , Energy cost consumed from the grid
• WaterCost, Unit: , Water cost
• GasCost, Unit: , Gas cost

NHC Battery Metering Clamp
ZigBee Battery Metering Clamp

Available measurements that are exposed:

• ElectricalEnergyCharged, Unit: Wh
• ElectricalEnergyDischarged, Unit: Wh

[tijsverkoyen]

I did some digging.

Niko now exposes the "measurements" over a REST API.

Measurement data

The measurement data can be retrieved via the REST API
Measurement data can be retrieved for device properties having the “Logging” feature enabled

• Get latest measurement values for all channels of a given device
• Get raw measurement values for a given device property
• Get aggregated measurement values for a given device property
• Get aggregated measurement values for all properties of a given device

Attached is a Postman collection that you can use to discover which data is available: Niko Home Control.postman_collection.json

While this is very useful data, I don't think this needs to be added in this integration. As Home Assistant does the same thing.

But feel free to give feedback/opinions.

[BN3000]

Hi @tijsverkoyen

My opinion is that this would be a great addition to the NHC II integration because this way a lot of interesting measurement data will come available in Home Assistant to use on for example the energy dashboard (like the gas and water reading from the smart meter or data from metering clamps, car chargers, ...) or on dashboards or in automations. This also solves the request of #263.

I don't totally agree with the statement that Home Assistant does the same thing. For that to come true you need to add additional hardware which most of us already have in our NHC installations (and which do the same thing and doubles the cost). So if it is possible to (re-)use data which is already available in our NHC installations like water and gas readings (readings from the smart meter), measurements from home batteries or EV chargers this would be a great added value for the integration.

[tijsverkoyen]

I can agree that only the "Get latest measurement values for all channels of a given device" can be relevant.

But the other ones: raw measurement, and aggregations are exactly what Home Assistant does.
I welcome any PR implementing this.

For me it is not easy to develop this as I don't own any connected Water/Gas meter.
If you have access and can provide me with example responses I can give it a try. But no promises, and note that my time is limited at this point.

[BN3000]

That said I understand your statement. Indeed it's only about the last/most recent values that are needed. Just readout the values and place them into some entities. It would be greatly appreciated if you would give this a try.

[tijsverkoyen]

Really relevant comment: #264 (reply in thread)

[tijsverkoyen]

This will be implemented once #274 is merged.
Thx to @firepinn