Skip to content

Show an "ESPHome device setup wizard" to ease onboarding of capabilities surfaced by the ESPHome device #191

Description

@mkerstner

This epic tracks the delivery of the following roadmap opportunity:

Description

We aim to have a (new) "ESPHome device setup wizard" shown once the initial ESPHome setup was done to further guide users to unlock and configure their new functionality.

In order to remain flexible we aim to introduce this wizard as a checklist showing a dynamic list of functionality exposed by the ESPHome device's (DeviceInfo) capabilities.

The wizard's checklist should be accessible to users at any time and will be anchored at the device level to continue configuring and changing settings. This enables users to e.g. only enable a certain functionality for the beginning and revisit to unlock the full potential at a later point in time.

From a capability perspective we aim to focus on 4 primary use cases for a start:

  • Audio streaming via Sendspin capable servers (e.g. Music Assistant)
  • Extending connectivity via Connect Line products (ZBT-2 / ZWA-2) enabling Zigbee and Z-Wave
  • Controlling devices via serial proxying for e.g. AV receivers
  • Bluetooth proxying

So, the checklist will query the device and surface options based on the capabilities exposed, e.g.

  • If a serial entity was added → include serial in feature list
  • If an infrared entity was added → include infrared in feature list
  • etc.

Deliverables/features

  • UX flows / mocks
  • ESPHome device setup wizard as a dynamic checklist

Completion criteria

Must haves

  • Exposing functionality based on ESPHome device capabilities emitted
  • Focusing on 4 primary use cases

Should haves

  • Identifying plugged in Connect line products (ZBT-2 and ZWA-2) and showing them in feature list with further information
  • Identifying infrared and showing it in the feature list with further information
  • Identifying radio frequency and showing it in the feature list with further information

Additional context

This approach is a dynamic one and needs revisiting in case DeviceInfo changes.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

Status
Now

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions