home-assistant / home-assistant.io

:blue_book: Home Assistant User documentation
https://www.home-assistant.io
Other
4.83k stars 7.22k forks source link

missing description #31530

Open Sniffi174 opened 7 months ago

Sniffi174 commented 7 months ago

Feedback

https://www.home-assistant.io/integrations/knx#button description: payload_length integer (optional, default: 0) The length of the payload data in the telegram. Use 0 for DPT 1, 2 or 3. -> DPT 1=1Bit, 2=2bit or 3=4bit. OK -> missing required values for other DTP-types, Use n for 8bit and up etc.

URL

https://www.home-assistant.io/integrations/knx#button

Version

2024.2.2

Additional information

No response

home-assistant[bot] commented 7 months ago

Hey there @julius2342, @farmio, @marvin-w, mind taking a look at this feedback as it has been labeled with an integration (knx) you are listed as a code owner for? Thanks!

Code owner commands Code owners of `knx` can trigger bot actions by commenting: - `@home-assistant close` Closes the feedback. - `@home-assistant rename Awesome new title` Renames the feedback. - `@home-assistant reopen` Reopen the feedback. - `@home-assistant unassign knx` Removes the current integration label and assignees on the feedback, add the integration domain after the command. - `@home-assistant add-label needs-more-information` Add a label (needs-more-information) to the feedback. - `@home-assistant remove-label needs-more-information` Remove a label (needs-more-information) on the feedback.
farmio commented 7 months ago

Hi 👋!

missing required values for other DTP-types, Use n for 8bit and up etc.

If you use specific DPT type, using the type key, payload_length is invalid anyway. It is intended for advanced use / unspecified DPT. Payload length is measured in bytes - so a 1 byte would have 1, 2byte 2 etc. If you think this needs explicit mention in the docs, feel free to open a PR clarifying the text.