This commit is contained in:
J. Nick Koston 2025-04-17 20:52:45 -10:00
parent 98284ecf1b
commit 92dfe1a1e5
No known key found for this signature in database

View File

@ -3,10 +3,11 @@ rules:
action-setup: action-setup:
status: exempt status: exempt
comment: | comment: |
Actions are per device and not per integration. Since actions are defined per device, rather than per integration,
ESPHome supports user defined actions which come they are specific to the device's YAML configuration. Additionally,
from the device YAML configuration. ESPHome allows for user-defined actions, making it difficult to provide
https://esphome.io/components/api.html#user-defined-actions standard documentation since these actions vary by device. For more
information, see: https://esphome.io/components/api.html#user-defined-actions
appropriate-polling: done appropriate-polling: done
brands: done brands: done
common-modules: done common-modules: done
@ -16,10 +17,11 @@ rules:
docs-actions: docs-actions:
status: exempt status: exempt
comment: | comment: |
Actions are per device and not per integration. Since actions are defined per device, rather than per integration,
ESPHome supports user defined actions which come they are specific to the device's YAML configuration. Additionally,
from the device YAML configuration. ESPHome allows for user-defined actions, making it difficult to provide
https://esphome.io/components/api.html#user-defined-actions standard documentation since these actions vary by device. For more
information, see: https://esphome.io/components/api.html#user-defined-actions
docs-high-level-description: done docs-high-level-description: done
docs-installation-instructions: done docs-installation-instructions: done
docs-removal-instructions: done docs-removal-instructions: done
@ -31,10 +33,10 @@ rules:
test-before-setup: test-before-setup:
status: exempt status: exempt
comment: | comment: |
ESPHome uses sleepy devices and fast reconnect logic ESPHome relies on sleepy devices and fast reconnect logic, so we
so we cannot raise ConfigEntryNotReady as we need to use can't raise `ConfigEntryNotReady`. Instead, we need to utilize the
the reconnect logic in aioesphomeapi to know when to trigger reconnect logic in `aioesphomeapi` to determine the right moment
connections. to trigger the connection.
unique-config-entry: done unique-config-entry: done
# Silver # Silver
action-exceptions: done action-exceptions: done
@ -54,7 +56,13 @@ rules:
discovery-update-info: done discovery-update-info: done
discovery: done discovery: done
docs-data-update: todo docs-data-update: todo
docs-examples: todo docs-examples:
status: exempt
comment: |
Since ESPHome is a framework for creating custom devices, the
possibilities are virtually limitless. As a result, example
automations would likely only be relevant to the specific user
of the device and not generally useful to others.
docs-known-limitations: todo docs-known-limitations: todo
docs-supported-devices: todo docs-supported-devices: todo
docs-supported-functions: todo docs-supported-functions: todo