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.

Sign up for GitHub

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

Jump to bottom

Adding ice control description #3574

Merged
merged 3 commits into from
Feb 19, 2025
Merged

Adding ice control description #3574

merged 3 commits into from
Feb 19, 2025
+0 −0

Conversation

Perrrewi
Copy link
Contributor

@Perrrewi Perrrewi commented Feb 7, 2025 •
edited
Loading

Adding description of Internal Combustion Engine control. The context is fully described in the dependent PR.

Depends on

@Perrrewi Perrrewi requested a review from hamishwillee February 7, 2025 09:14
@Perrrewi Perrrewi self-assigned this Feb 7, 2025
@hamishwillee hamishwillee mentioned this pull request Feb 13, 2025
Merged
@hamishwillee
Copy link
Collaborator

@Perrrewi Sorry for the delay. Module docs are autogenerated - but we still need the images. I have added suggestions in PX4/PX4-Autopilot#24055 (i.e. you can delete the module doc.

What we'd add directly to docs is more general info about ICE - as per my comment here: https://github.com/PX4/PX4-Autopilot/pull/24055/files#r1955269816.

Can you help with that?

@Perrrewi
Copy link
Contributor Author

Can you help with that?

Absolutely, thanks a lot for the inputs!

@hamishwillee hamishwillee force-pushed the add-ice-control-module-description branch from 451a7cf to db1d77d Compare February 18, 2025 22:04
@github-actions GitHub Actions
Copy link

/en/config_rover/ackermann.md

  • LinkedFileMissingAnchor: #RA_MAX_THR_SPEED not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_ACCEL not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_DECEL not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_JERK not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_STR_RATE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_LAT_ACCEL not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_LAT_ACCEL_P not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_LAT_ACCEL_I not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_MAX_SPEED not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_SPEED_P not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RA_SPEED_I not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)

/en/config_rover/differential.md

  • LinkedFileMissingAnchor: #RD_MAX_YAW_RATE not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_YAW_RATE_P not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_YAW_RATE_I not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_YAW_P not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_YAW_I not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_SPEED not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_THR_SPD not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_SPEED_P not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_SPEED_I not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_SPEED not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_ACCEL not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_DECEL not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)
  • LinkedFileMissingAnchor: #RD_MAX_JERK not found in ../advanced_config/parameter_reference.md (/home/runner/work/PX4-user_guide/PX4-user_guide/en/advanced_config/parameter_reference.md)

/en/modules/modules_system.md

/en/msg_docs/InternalCombustionEngineControl.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverAttitudeSetpoint.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverAttitudeStatus.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverRateSetpoint.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverRateStatus.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverSteeringSetpoint.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverThrottleSetpoint.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/RoverVelocityStatus.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

/en/msg_docs/VehicleStatusV0.md

  • PageNotInTOC: Page not in Table of Contents (/home/runner/work/PX4-user_guide/PX4-user_guide/en/SUMMARY.md)

@hamishwillee
Copy link
Collaborator

@Perrrewi This is good now, except that I've proposed more updates to the docs in PX4/PX4-Autopilot#24359, including moving the location of the images, and adding the Actuator setup image too. Probably worth pushing that in and updating this before merging this.

Can you help with that?

Absolutely, thanks a lot for the inputs!

Thank you so much! Can you start a page en/ice/index.md in the source tree, put it under under the hardware > actuators section in en/SUMMARY.md. I'm not sure what should go in it, but definitely the stuff about actuator configuration and enabling. Also usually we'd list what you need for setup - such as an RPM sensor, and any engines we recommend and have tested.
Please click the button to make the page editable when you create the PR.

FYI only, I also added this question PX4/PX4-Autopilot#24041 (comment) to address the fact that the docs say RPM sensors are not supported.

@hamishwillee
Copy link
Collaborator

@Perrrewi Actually I'm going to merge this to fix build errors with the missing images. We'll have to move them later.

Note "next steps" covered in #3574 (comment)

@hamishwillee hamishwillee merged commit 4114d3d into main Feb 19, 2025
3 checks passed
@hamishwillee hamishwillee deleted the add-ice-control-module-description branch February 19, 2025 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hamishwillee hamishwillee hamishwillee left review comments

Assignees

@Perrrewi Perrrewi

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Perrrewi @hamishwillee @perrrre