PX4-user_guide icon indicating copy to clipboard operation
PX4-user_guide copied to clipboard

Differential Drive Documentation

Open PerFrivik opened this issue 1 year ago • 10 comments

Documentation for the Rover Differential Drive module in PX4.

This documentation needs to wait for one or two PX4 PR's before we can merge this documentation, as it is based on some changes that I want to implement based on user feedback (

  • [ ] https://github.com/PX4/PX4-Autopilot/pull/22877

PerFrivik avatar Mar 25 '24 08:03 PerFrivik

Oops, thank you GitHub Actions Bot :+1:

PerFrivik avatar Mar 25 '24 08:03 PerFrivik

All obey the bot.

hamishwillee avatar Mar 27 '24 02:03 hamishwillee

Note, I have only fly-by looked at this. I'll review when you ask for it or it goes out of draft.

hamishwillee avatar Mar 27 '24 23:03 hamishwillee

/en/flight_modes_rover/manual_rover.md

  • LinkedFileMissingAnchor: #RRD_SPEED_SCALE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RRD_ANG_SCALE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

/en/flight_modes_rover/mission_rover.md

  • CurrentFileMissingAnchor: [by default](#COM_RC_OVERRIDE): anchor doesn't match any heading id or element id
  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

/en/config_rover/configure_rover_differential.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

github-actions[bot] avatar May 09 '24 05:05 github-actions[bot]

@PerFrivik I assume the module is not going into PX4 v1.15? Keep me posted when you need a review.

hamishwillee avatar Jun 19 '24 01:06 hamishwillee

@PerFrivik This feels a bit stalled :-(. Note, there is a "related PR" for a ackermann in https://github.com/PX4/PX4-user_guide/pull/3265

hamishwillee avatar Jul 10 '24 04:07 hamishwillee

/en/flight_modes_rover/manual_rover.md

  • LinkedFileMissingAnchor: #RRD_SPEED_SCALE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RRD_ANG_SCALE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

/en/flight_modes_rover/mission_rover.md

  • CurrentFileMissingAnchor: [by default](#COM_RC_OVERRIDE): anchor doesn't match any heading id or element id
  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

/en/config_rover/configure_rover_differential.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)
  • PageNotLinkedInternally: Page is orphan (not linked by any other page)

github-actions[bot] avatar Jul 10 '24 04:07 github-actions[bot]

@chfriedrich98 Do we still need this documentation?

hamishwillee avatar Jul 31 '24 02:07 hamishwillee

@hamishwillee Could we leave this PR up until https://github.com/PX4/PX4-user_guide/pull/3311 is merged? I based some of my documentation on it and I might copy some more of it, especially the graphics are really good.

chfriedrich98 avatar Jul 31 '24 08:07 chfriedrich98

Of course!

hamishwillee avatar Jul 31 '24 10:07 hamishwillee

This pull request has been mentioned on Discussion Forum for PX4, Pixhawk, QGroundControl, MAVSDK, MAVLink. There might be relevant details there:

https://discuss.px4.io/t/px4-v1-15-public-changes-what-needs-docs/39850/10

DronecodeBot avatar Aug 07 '24 11:08 DronecodeBot