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

[Doc] Enhance Movehub doc about connectionless Bluetooth messaging #1819

Open
BertLindeman opened this issue Sep 12, 2024 · 0 comments
Open
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@BertLindeman
Copy link

Describe the issue

  1. Doc on MoveHub uses block image of PrimeHub and PrimeHub. as command prefix.
    See picture(s).
  2. Explain that the MoveHub cannot broadcast if connected to another device like a PC. As David suggests in BOOST hub, broadcast #1810

Suggested improvement

  1. Drop the hubname from the functions and create a movehub blocking image.
    Or maybe this is on purpose, so no movehub image needed to be made?
  2. Add some text like Note: The MoveHub cannot broadcast if it is connected to another device, like a PC or tablet.

One picture ...
afbeelding

another one
afbeelding

This is from the 3.5.0 doc.

From https://github.com/pybricks/pybricks-api/blob/v3.5.0/doc/main/hubs/movehub.rst

    .. rubric:: Using connectionless Bluetooth messaging

    .. blockimg:: pybricks_blockBleBroadcast_PrimeHub

    .. automethod:: pybricks.hubs::PrimeHub.ble.broadcast

    .. blockimg:: pybricks_blockBleObserve_PrimeHub

    .. automethod:: pybricks.hubs::PrimeHub.ble.observe

I could make a PR for this, but there is no MoveHub blockimg.
Assume there needs to be made a new pybricks.hubs::MoveHub.ble.broadcast.
And no idea how and where to make it.

ls -1 pybricks_blockBleBroadcast_*Hub.svg
pybricks_blockBleBroadcast_CityHub.svg
pybricks_blockBleBroadcast_EssentialHub.svg
pybricks_blockBleBroadcast_PrimeHub.svg
pybricks_blockBleBroadcast_TechnicHub.svg

Bert

@BertLindeman BertLindeman added documentation Improvements or additions to documentation triage Issues that have not been triaged yet labels Sep 12, 2024
@laurensvalk laurensvalk added bug Something isn't working and removed triage Issues that have not been triaged yet labels Sep 12, 2024
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