API Field Descriptions, validations etc

5 comments started 2023-04-10 last 2023-04-10
APIsHome Automation
#1 ivell

Hi
Is there an accurate document that lists the fields accessible via GivTCP API?
Trying to decipher and select the right fields for HA dashboard
thanks

#3 ivell

Thanks BobB, but doesn't provide the basics.
As a new user, i'm faced with dozens of fields
Difficult to know what's real time, what's daily etc
Surprised GA haven't released API documentation to support

T
#4 Tim

ivell The GivTCP we are all using is based on the Givenergy Modbus repository but @Britkat (AKA Mark) has forked that and is actively maintaining it for everyone's benefit.

To understand better what the structure of the GivTCP objects are, you could do worse than use MQTT Explorer. This enables you to see all the traffic between the inverter and MQTT broker:

Each of the higher-level topics (except raw) are a device in HA, with entities as seen within the MQTT hierarchy

You'll see that the entities under Power relate to real-time (or as close as you can get.
Inverter Details are static
Energy gives you daily and total kWh
Timeslots are static, or at least unless you change them
Control tells you what the current settings are of values that you can change
Battery Details are a mix of static and dynamic data
Raw (if you have enabled that in the GivTCP Config) has no hierarchy, so while you get more data, it's much more difficult to understand where it fits in and isn't available in HA.

#5 ivell

cheers Tim!