Add multiple ZCS inverters

[zmoog]

Context

The collector is successfully fetching metrics from my own ZCS inverter. However, I now want to fetch metrics from other two ZCS inverters that belong to family members.

Goal

• Find how to fetch metrics from multiple ZCS inverters.
• Set up the collector.
• Update the existing dashboard in Kibana and double-check that everything works.

Impact

Monitor all the family ZCS inverters.

[zmoog]

Config for one inverter:

receivers:
  zcsazzurro:
    collection_interval: ${env:WS_INTERVAL:-5m}
    client_id: ${env:ZCS_CLIENT_ID}
    auth_key: ${env:ZCS_AUTH_KEY}
    thing_key: ${env:ZCS_THING_KEY}

I wasn't able to find official ZCS API docs, and all unofficial clients¹ seems to always use the same "get realtime data" request with the thing key.

I tried sending a request w/o the thing key and I got:

{
  "realtimeData": {
    "errorMsg": "Property 'thingKey' absent",
    "success": false
  }
}

Our standard ZCS accounts only allow us to register one inverter per account.

Option 1

I don't think it's worth supporting multiple things in the same receiver since would also require multiple authorizations.

receivers:
  zcsazzurro:
    collection_interval: ${env:WS_INTERVAL:-5m}
    things:
      - key: thing1
        client_id: client-1
        auth_key: auth-1
      - key: thing2
        client_id: client-2
        auth_key: auth-2

Option 2

The simplest setup would be defining multiple receivers, one for each account:

receivers:
  zcsazzurro/p0:
    collection_interval: ${env:WS_INTERVAL:-5m}
    client_id: ${env:ZCS_CLIENT_ID}
    auth_key: ${env:ZCS_AUTH_KEY}
    thing_key: ${env:ZCS_THING_KEY}
  zcsazzurro/p1:
    collection_interval: ${env:WS_INTERVAL:-5m}
    client_id: ${env:ZCS_CLIENT_ID}
    auth_key: ${env:ZCS_AUTH_KEY}
    thing_key: ${env:ZCS_THING_KEY}
  zcsazzurro/p2:
    collection_interval: ${env:WS_INTERVAL:-5m}
    client_id: ${env:ZCS_CLIENT_ID}
    auth_key: ${env:ZCS_AUTH_KEY}
    thing_key: ${env:ZCS_THING_KEY}

Conclusions

Option 1 seems a more flexible solution, but I can accomplish my goals with using the current version.

Footnotes

1. I found https://github.com/AlePerla/zcs_azzurro_api/blob/main/zcs_azzurro_api/inverter.py and https://github.com/aturri/ha-zcsazzurro/blob/main/custom_components/zcsazzurro/api.py ↩