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

OpenGoPro command response documentation incomplete #521

Closed
aaramirez-g opened this issue Apr 16, 2024 · 2 comments
Closed

OpenGoPro command response documentation incomplete #521

aaramirez-g opened this issue Apr 16, 2024 · 2 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@aaramirez-g
Copy link

What is the bug in?

  • Documentation

Describe the bug
The new OpenGoPro BLE documentation is missing the Command Response Error codes that were present in the previous version. For example the Set AP Control response link just points to (https://gopro.github.io/OpenGoPro/ble/protocol/ble_setup.html#ble-characteristics) which does not give any details on what the response is.

Previous Version: https://github.com/gopro/OpenGoPro/blob/90e8965f36f0233f17768e0ca04f9a17e5b5136a/docs/specs/ble_versions/ble_2_0.md#command-response

Screenshots
If applicable, add screenshots to help explain your problem.
openGoPro

@aaramirez-g aaramirez-g added the bug Something isn't working label Apr 16, 2024
@github-actions github-actions bot added the triage Needs to be reviewed and assigned label Apr 16, 2024
@tcamise-gpsw
Copy link
Collaborator

good catch. I'll add these back in

@tcamise-gpsw tcamise-gpsw added documentation Improvements or additions to documentation and removed triage Needs to be reviewed and assigned labels Apr 16, 2024
@tcamise-gpsw tcamise-gpsw self-assigned this Apr 16, 2024
@tcamise-gpsw
Copy link
Collaborator

I've added the table of Command Statuses to the Command TLV documentation.

Since these are common to all TLV Commands, they are not documented in each command. The idea is that you click on the TLV Type, i.e. TLV Command for "Set AP Control":

image

to then see this common information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants