Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom flow capability for commissioners without local UI #538

Closed
tleacmcsa opened this issue Jan 26, 2024 · 4 comments
Closed

Add custom flow capability for commissioners without local UI #538

tleacmcsa opened this issue Jan 26, 2024 · 4 comments
Assignees
Milestone

Comments

@tleacmcsa
Copy link

tleacmcsa commented Jan 26, 2024

Commissioners that do not have a local user interface (visual or vocal) need a facility to enable a remote device on the operational network, such as a mobile phone, to present an interactive user interface to the user on behalf of the commissioner.

One way to do this is to provide information similar to the Pairing Hint for commissionable devices in the DNS-SD TXT payload returned from commissioner discovery. This commissioner hint would indicate that a custom commissioner flow should be used, which would trigger the commissionee to look up and open the related URL from the DCL. The commissionee could choose to provide its own setup code information to this URL, which might be generated for the particular operation and/or with expiration.

Clearly this would only work for commissionees that are already on the operational network due to discovery of the commissioner, access to the DCL, and invocation of the commissioner's URL.

Changes requested include:

  • update DCL DeviceModel schema to include a new optional URL that a commissionee would use to show a custom flow UI for the commissioner
  • update Commissioner Discovery to include a new optional DNS-SD TXT key/value pair that would indicate to a client that the DCL should be referenced for a commissioner custom flow URL.
@ashcherbakov ashcherbakov added this to the v1.3: DCL 1.3 milestone Feb 15, 2024
@ashcherbakov
Copy link
Contributor

ashcherbakov commented Feb 15, 2024

What needs to be done in DCL code:
Add a new optional field string CommissioningCustomUIUrl to the Model .proto

@ashcherbakov
Copy link
Contributor

ashcherbakov commented Feb 19, 2024

UPDATE: the new optional field name: string CommissionerCustomUiFlowUrl

@tleacmcsa
Copy link
Author

Update: The latest optional field name (renamed to reduce confusion): string CommissionerRemoteUiFlowUrl

Abdulbois added a commit that referenced this issue Mar 20, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 20, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 23, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 23, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 25, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 26, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 26, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
Abdulbois added a commit that referenced this issue Mar 26, 2024
Signed-off-by: Abdulbois <abdulbois.tursunov@dsr-corporation.com>
Signed-off-by: Abdulbois <abdulbois123@gmail.com>
akarabashov added a commit that referenced this issue Mar 26, 2024
…oteUiFlowUrl-field-into-Model-schema

#538 Add commissioner remote UI flow url field into model schema
@akarabashov
Copy link
Collaborator

PR: #555

  • Added a new CommissionerRemoteUiFlowUrl field to the DCL Model schema
  • Unit and integration tests are updated
  • Docs are updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants