gdoor-org / gdoor

Wifi adapter and bus protocol documentation for the Gira TKS Door System
https://gdoor-org.github.io/
GNU General Public License v3.0
14 stars 4 forks source link

add docs for Home Assistant integration #7

Closed jschroeter closed 2 months ago

DaSchaef commented 2 months ago

Good points! Merge as-is or should we maybe move Home Assistent to the root and the protocol to a sub page?

Small things:

FYI: I do not know if you can always depend on the parameter field only, most likely you can - but I'm not 100% sure about it. To capture all bus installation situations you may need to check:

(These are also the fields which Gira devices check, e.g. they ignore the "type" field)

DaSchaef commented 2 months ago

Adding to the parameter field: Another warning, we also noticed that sometimes the second byte had two different values send by the outdoor station (still not fully understood).

DaSchaef commented 2 months ago

And one last thing: I need to update the protocol description once we merge the JSON update, so that the naming and format is consistent between Homeassistent, ESP Code, MQTT and protocol description. :see_no_evil:

jschroeter commented 2 months ago

I like the idea of moving the protocol into an own file and did it.

I also addressed some more things, but didn't add the video part yet - will do this in a separate PR as I still need to investigate a bit what exactly is happening on the bus. And yes, we should sync the wording in docs & code.

Regarding the parameters I'm also not 100% sure yet, let's see :-)

I would say let's merge this PR now and improve on the go. Please hit the button if you agree with the changes.