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

Deprecate generate-qr command for end devices #6345

Closed
2 of 4 tasks
KrishnaIyer opened this issue Jun 30, 2023 · 4 comments · Fixed by #6370
Closed
2 of 4 tasks

Deprecate generate-qr command for end devices #6345

KrishnaIyer opened this issue Jun 30, 2023 · 4 comments · Fixed by #6370
Assignees
Labels
compat/api This could affect API compatibility in progress We're working on it
Milestone

Comments

@KrishnaIyer
Copy link
Member

Summary

Deprecate generate-qr command for end devices. Refs
https://github.com/TheThingsIndustries/lorawan-join-server/issues/55 and https://github.com/TheThingsIndustries/product-management/issues/13

Current Situation

The generate-qr command requires an end device to be registered to generate the QR Code. This doesn't work with the new claiming flow.

We should also maybe deprecate the Generate function of the EndDeviceQRCodeGenerator since QR generation should be a function of an external join server.

Why do we need this? Who uses it, and when?

This is to remove functionality that doesn't work.

Proposed Implementation

Follow the usual deprecation steps.

Contributing

  • I can help by doing more research.
  • I can help by implementing the feature after the proposal above is approved.
  • I can help by testing the feature before it's released.

Code of Conduct

@KrishnaIyer KrishnaIyer added the needs/triage We still need to triage this label Jun 30, 2023
@KrishnaIyer KrishnaIyer added this to the v3.27.0 milestone Jun 30, 2023
@johanstokking johanstokking added the compat/api This could affect API compatibility label Jun 30, 2023
@johanstokking
Copy link
Member

So what do we do, return an error in generate-qr?

@KrishnaIyer
Copy link
Member Author

I think we should do a noop with a warning that asks the user to use ttjs-cli and point to the docs.

@johanstokking
Copy link
Member

I'm not sure what you mean with noop. This command is expected to write an image to a file. If we suddenly stop doing that while returning 0 exit code, we break CLI compatibility.

This command is marked EXPERIMENTAL, but still, changing it to not doing anything breaks scripts that are using it.

I don't see another way of returning an error.

@KrishnaIyer
Copy link
Member Author

Ok I see. Then let's indeed return an error with a message to use the ttjs-cli and point to the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compat/api This could affect API compatibility in progress We're working on it
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants