Add diagnostics platform, config-flow gap warning, issue template
Completes the device-capability-diagnostics spec: - diagnostics.py: the standard HA diagnostics hook, returning device type, one_ui_version, unbound hrefs, and the redacted raw resource tree, plus integration and smartthings-local version numbers. This is what the Repairs issue (added in the previous commit) points users at, and what they attach to a device-support issue. - config_flow.py: _probe_and_validate now also reports oneUiVersion and whether the device type is recognized. Recognized types are unaffected; an unrecognized type shows a new confirm_unknown_type step explaining that only common capabilities will be available before creating the entry, so expectations are set at setup time rather than only after the fact via Repairs. - .github/ISSUE_TEMPLATE/device-support.yml: structured template for filing a capability gap, linked from both the Repairs issue and the config-flow confirmation step. - README: short section pointing at this whole mechanism.
This commit is contained in:
1 parent
ca754cbb01
commit
d2699f0f5b
9 files changed
+221
-12
No files matched your search
@@ -128,6 +128,17 @@ docker-compose.yml / ha_config/ Local HA dev environment
|
||||
|
||||
---
|
||||
|
||||
## Reporting a capability gap
|
||||
|
||||
If your appliance's type isn't recognized, or it exposes resources this integration doesn't model yet, a Repairs
|
||||
issue appears under Settings > System > Repairs pointing you at Settings > Devices & Services > this device >
|
||||
the menu > Download diagnostics. That download is already redacted of account/network identifiers (Bixby login
|
||||
email, access tokens, device IDs, MAC addresses, serial numbers) before it's generated, so it's safe to attach
|
||||
directly to a new issue using the linked device-support template. This is the fastest way to help add or expand
|
||||
support for hardware the maintainers don't have.
|
||||
|
||||
---
|
||||
|
||||
## Adding a new appliance type
|
||||
|
||||
1. Capture the appliance's `/device/0` response to see what resources/fields it exposes. An authenticated `DtlsCoapSession` from `smartthings_local.protocol.dtls_session` GET is enough; `local-tools/probe_device.py` wraps this.
|
||||
|
||||
Reference in new issue
Block a user