Skip to content

Conversation

@magraina
Copy link
Contributor

Related Issue

[Cite any related issue(s) this pull request addresses. If none, simply state "None”]

Description

[Please include a brief description of the changes or features added]
Added a time based connection check for sbus with an additional getSerialConnectionStatus() method.
In case no data is received/processed within 200ms the connection is assumed to be lost.

Added getters to get the additional sbus data bits like failsafe, framelos etc.

The getters can be used to evaluate if the channel data is up to date and valid.

Type of PR

  • Bug fix
  • Feature enhancement
  • Documentation update
  • Other (specify): _______________

Screenshots / videos (if applicable)

[Attach any relevant screenshots or videos demonstrating the changes]

Checklist:

  • I have performed a self-review of my code
  • I have read and followed the Contribution Guidelines.
  • I have tested the changes thoroughly before submitting this pull request.
  • I have provided relevant issue numbers, screenshots, and videos after making the changes.
  • I have commented my code, particularly in hard-to-understand areas.

Additional context:

[Include any additional information or context that might be helpful for reviewers.]

@magraina magraina requested a review from Witty-Wizard as a code owner August 26, 2025 16:07
@Witty-Wizard Witty-Wizard added the enhancement 🪄 New feature or request label Aug 27, 2025
@Witty-Wizard Witty-Wizard changed the title feat[sbus]: Added serial connection monitoring and getters for additional data enhancement 🪄:: Sbus: Added serial connection monitoring and getters for additional data Aug 27, 2025
@Witty-Wizard Witty-Wizard linked an issue Aug 27, 2025 that may be closed by this pull request
1 task
@Witty-Wizard Witty-Wizard added the bugfixes 🐞 Address bugs label Aug 27, 2025
@magraina magraina requested a review from Witty-Wizard August 27, 2025 06:11
Copy link
Owner

@Witty-Wizard Witty-Wizard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@magraina, Now the changes look good to me. Let me once test the changes. Then I will merge them

@Witty-Wizard
Copy link
Owner

@magraina, Can you maybe also add these new functions to the documentation?
https://github.com/Witty-Wizard/SerialIO/tree/main/Docs/source

@magraina
Copy link
Contributor Author

@magraina, Can you maybe also add these new functions to the documentation?
https://github.com/Witty-Wizard/SerialIO/tree/main/Docs/source

Isn't that auto-generated or am I missing something?

@Witty-Wizard
Copy link
Owner

@magraina, Can you maybe also add these new functions to the documentation?
https://github.com/Witty-Wizard/SerialIO/tree/main/Docs/source

Isn't that auto-generated or am I missing something?

The doxygen comments are automatically integrated into the documentation, rest is manually maintained

@magraina
Copy link
Contributor Author

The doxygen comments are automatically integrated into the documentation, rest is manually maintained

I might have to have a closer look into doxygen, as I didn't used that before.

@magraina
Copy link
Contributor Author

@magraina, Can you maybe also add these new functions to the documentation?
https://github.com/Witty-Wizard/SerialIO/tree/main/Docs/source

Isn't that auto-generated or am I missing something?

The doxygen comments are automatically integrated into the documentation, rest is manually maintained

So I figured how doxygen & sphinx is working. Might be helpful to have a little dev-documentation, on how to setup certain tools and cli commands for devs that are new to a project.

  • I've fixed the examples in the docs and added some new ones.
  • The API is auto-generated -> So nothing to do there.
  • Added a section within the tutorial about the new monitoring option (that can be generalized in case this is been used on other protocols as well).

@magraina magraina requested a review from Witty-Wizard August 27, 2025 21:48
@Witty-Wizard
Copy link
Owner

@magraina, Can you maybe also add these new functions to the documentation?

https://github.com/Witty-Wizard/SerialIO/tree/main/Docs/source

Isn't that auto-generated or am I missing something?

The doxygen comments are automatically integrated into the documentation, rest is manually maintained

So I figured how doxygen & sphinx is working. Might be helpful to have a little dev-documentation, on how to setup certain tools and cli commands for devs that are new to a project.

  • I've fixed the examples in the docs and added some new ones.

  • The API is auto-generated -> So nothing to do there.

  • Added a section within the tutorial about the new monitoring option (that can be generalized in case this is been used on other protocols as well).

You are right I need to add a dev documentation.

@Witty-Wizard Witty-Wizard merged commit d25c6c1 into Witty-Wizard:main Aug 28, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugfixes 🐞 Address bugs enhancement 🪄 New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨FEATURE: Add Failsafe

2 participants