Commit Graph
44 Commits
Author SHA1 Message Date
Michael Fritsche e8b3274ab0 feat(msg): rename rover throttle setpoint to surface_vehicle_thrust_setpoint (#29777)
* feat(msg): rename rover throttle setpoint to surface_vehicle_*

The throttle setpoint was the last rover topic shared by rovers and boats
without the surface_vehicle_* prefix decided in #29524. Rename
RoverThrottleSetpoint to SurfaceVehicleThrottleSetpoint and the
TYPE_ROVER_THROTTLE_* setpoint types to TYPE_SURFACE_VEHICLE_THROTTLE_*.
The type values are unchanged.

The topic rename breaks ROS 2 users anyway, so also shorten the fields of
the throttle and speed setpoints to x and y: the message name already says
what the value is and [@frame Body] states the frame.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* fix(zenoh): bring surface_vehicle rename to the zenoh dds topics

* fix(concept): rename rover throttle setpoint to surface_vehicle_* in navigation terminology

* fix(tools): update px4-ros2-interface-lib pin

* docs(msg): describe sideways fields as omnidirectional, not mecanum

The surface vehicle messages are shared by rovers and boats, and the lateral
axis applies to any vehicle that can move sideways, not only mecanum rovers.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(ros2): use the surface vehicle setpoint type names of the interface lib

The pinned px4-ros2-interface-lib names the rover setpoint types
SurfaceVehicle*SetpointType. The table and the example reference still used
the old Rover*SetpointType class names, which do not exist in that version.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* feat(msg)!: rename surface vehicle throttle setpoint to thrust setpoint

The setpoint is a normalized force command along the body x and y axes,
which is a thrust, not a throttle. Throttle stays the name for the motor
command the actuator control derives from it.

surface_vehicle_throttle_setpoint is now surface_vehicle_thrust_setpoint
(SurfaceVehicleThrustSetpoint), and SetpointConfig
TYPE_SURFACE_VEHICLE_THROTTLE_* are now TYPE_SURFACE_VEHICLE_THRUST_*
(same values). The px4-ros2-interface-lib pin follows the matching rename
there.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* fix(tools): update px4-ros2-interface-lib pin

* fix(commander): do not enable velocity control for surface vehicle thrust setpoints

The SurfaceVehicleThrust* setpoint types enabled the velocity flag, taken
over from the original interface lib configuration. Nothing in these types
uses velocity, and offboard mode maps the same combinations without it.

The flag kept the rover speed controller running: switching from a
SurfaceVehicleSpeed* to a SurfaceVehicleThrust* type sets the same flags,
so the controllers were not reset and a stale speed setpoint kept
overriding the commanded thrust. It also made external modes that only
command thrust require a local position estimate.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(msg): apply review suggestions for the surface vehicle setpoints

Add long descriptions to the thrust and speed setpoints and the speed
status, name modules instead of C++ classes, and use single spaces before
field comments. Rename the speed status PID integrals from pid_throttle_*
to pid_thrust_*, since the speed controller drives the thrust setpoint.

Update the docs and the rover control structure diagram for the thrust
setpoint and omnidirectional vehicles, note the Rover*SetpointType names of
PX4 v1.17 and v1.18, and add the ROS 2 release note.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

---------

Signed-off-by: Michael Fritsche <frimi999@gmail.com>
2026-11-13 10:05:26 +01:00
Beniamino Pozzan 4412069de6 docs(ros2): document runtime Zenoh selection in SITL
Explain how to pick uXRCE-DDS or Zenoh in the prebuilt SITL packages
and containers (PX4_ROS2_MIDDLEWARE, ZENOH_ENABLE, PX4_ZENOH_LOCATOR),
how to run the Zenoh router, and what Zenoh does not support yet:
multiple instances and time synchronization with ROS, which the
navigation interfaces need.

Point the Zenoh and ROS 2 guides at the regular SITL targets instead of
px4_sitl_zenoh, link the uXRCE-DDS startup to px4-rc.uxrce_dds, and
describe the Zenoh leg of the ROS integration CI.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
2026-11-04 15:51:34 +00:00
Michael Fritsche ec454b9a9b feat(msg): rename shared rover topics to surface_vehicle_* (#29524)
Signed-off-by: Michael Fritsche <frimi999@gmail.com>
2026-11-04 15:21:37 +01:00
Ahmet Burak TektasandJacob Dahl b3cee891b2 fix(ekf2): keep v1.17 auxiliary global position settings on upgrade (#29351)
* fix(parameters): migrate EKF2_AGP_* to EKF2_AGP0_*

The auxiliary global position parameters became per-source EKF2_AGP<n>_*
parameters in #26306 without a translation, so on an upgrade from v1.17
the stored EKF2_AGP_CTRL, _MODE, _DELAY, _NOISE and _GATE are dropped as
unrecognised. Move them to the first slot.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: A.Burak Tektas <15087318+Abtektas@users.noreply.github.com>

* fix(ekf2): mark EKF2_AGPn_ID as reboot required

The sources are created when EKF2 starts, for the slots whose ID is not
zero, so a changed ID only takes effect after a reboot.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: A.Burak Tektas <15087318+Abtektas@users.noreply.github.com>

* docs: explain EKF2_AGPn_ID for auxiliary global position

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: A.Burak Tektas <15087318+Abtektas@users.noreply.github.com>

* fix(parameters): set EKF2_AGP0_ID when migrating a v1.17 AGP source

Migrating EKF2_AGP_* alone fuses nothing: a slot with ID 0 has no source. v1.17 messages had no ID, but a v1.17 source now arrives with ID 1 either way, from the message translation node or as GlobalPositionMeasurementInterface's default, so a non-zero EKF2_AGP_CTRL also sets EKF2_AGP0_ID to 1.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com>

---------

Signed-off-by: A.Burak Tektas <15087318+Abtektas@users.noreply.github.com>
Signed-off-by: Jacob Dahl <dahl.jakejacob@gmail.com>
Co-authored-by: Jacob Dahl <dahl.jakejacob@gmail.com>
2026-10-30 16:46:55 -06:00
Samuel Adetunji e9418b3948 fix: Typo in ROS2 docs (#29477) 2026-10-29 10:24:30 +11:00
Hamish Willee 377dcbfa6a Docs(docs): PX4 ROS 2 Control Interface not experimental (#29053)
Removed HTML character entities from badges in documentation.
2026-10-13 01:23:58 +11:00
LtxxandBeniamino Pozzan d2de298122 fix(uxrce_dds): align SITL namespace prefix (#28338)
* fix(uxrce_dds): align SITL namespace prefix

Use the same uav_ namespace prefix for SITL multi-instance startup and UXRCE_DDS_NS_IDX fallback. This keeps simulation and hardware topic names consistent without changing the existing hardware default.

Assisted-by: OpenAI Codex: GPT-5

* docs(uxrce): update uxrce_dds docs

* docs(release): update `main` release page

---------

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
Co-authored-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
2026-09-27 00:12:55 +01:00
Ramon Roche de9c69316e docs(simulation): replace jMAVSim with SIH and Hawkeye
The jMAVSim pages become redirects to SIH, examples and HITL options
move to SIH, Gazebo or Gazebo Classic, and SIH on hardware gets Hawkeye
as its 3D display-only view through a MAVLink bridge to its UDP port.
The release notes flag the removal in the upgrade guide.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-09-26 14:28:26 -07:00
Andrea Bernasconi b38dcb1f6c fix(navigator): use "Return" instead of "RTL" in user-facing text (#28543) 2026-09-26 12:40:56 +10:00
Ltxx 6a01835bb3 docs(ros2): clarify VehicleCommand routing (#28245) 2026-09-02 17:51:07 +10:00
Beniamino Pozzan 92d54bce01 docs(ros2): global rename of "ROS2" into "ROS 2" (#28358)
Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-08-26 16:32:29 +10:00
PX4BuildBot abacf664cb docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
2026-08-26 06:13:24 +00:00
Beniamino Pozzan 3593b06b61 docs(ros2): reorder setup step to have standalone px4_msgs ROS 2 workspace first (#28354)
* docs(ros2): reorder setup steps

- Use a standalone ROS 2 workspace for px4_msgs and
(optionally) the uXRCE-DDS Agent
- Build uXRCE-DDS Agent inside the ROS 2 workspace
- remove `px4_ros_com` package as mandatory package in the
workspace setup. Now it is just used in the examples.

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>

* Apply suggestions from code review

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

* Apply suggestion from @hamishwillee

* docs(docs): fix up the links to broken anchors

---------

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-08-26 16:07:02 +10:00
Beniamino Pozzan 8c1dc380cf docs(ros2): add instruction for configuring firmware depending on chosen middleware (#28353)
* docs(uxrce_dds): add subsection for Firmware cofiguration

It mirrors the one used in Zenoh.

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>

* docs(ros2): instructions to add client modules to px4 firmware

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>

* docs(docs): Fix broken links

* Update docs/en/ros2/user_guide.md

---------

Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-08-25 09:18:01 +10:00
1fe6feed1f docs(docs): ROS2 Jazzy migration and cleanup (#28251)
* Added Jazzy removed Foxy

* Added Zenoh, restructured Middleware setup

* Added sim and hardware clarification

* Mentioned Interface Library

* docs(docs): Remove old pre v1.14 context

* docs(docs): subedit

---------

Co-authored-by: Patrik Dominik Pördi pad <pad@sdu-143792.c.sdu.dk>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-08-20 14:57:54 +10:00
Ferdinand 9673ae5896 docs(docs): Fix typos in docs ros2 user guide (#28186)
* Fix minor typo

A minor typo prevents correct Markdown interpretation of source code and explanation.

* Fix minor typos
2026-08-08 13:02:10 +10:00
Ferdinand ea58e72f11 Fix link to official ROS 2 Humble installation guide (#28135) 2026-08-04 08:13:22 +10:00
Jorge Rios 31ebf1a681 Fix typo in Multi Vehicle Simulation description (#27417) 2026-05-20 14:16:00 -06:00
Ramon Roche 4d2996cb93 docs(releases): v1.17.0 release notes (#27225)
* docs(releases): draft v1.17.0 release notes

Drafts the v1.17.0 release notes based on commits in the
release/1.16..release/1.17 diff, with every PR citation verified as an
ancestor of release/1.17 and not shared with release/1.16.

Major Changes leads with the experimental MC Neural Network Control
mode and the on-device TFLM integration, the new Altitude Cruise mode
for multicopters, FW Takeoff improvements, FW and Rover ROS 2 Control
Interface setpoints, and the in-tree Zenoh middleware maturing toward
rmw_zenoh compatibility.

Hardware Support is reorganized into four sub-groups: New Flight
Controllers, New Build Targets for Existing Hardware, New CAN
Peripherals & Vehicle Platforms, and Existing Boards: Improvements.
The Simulation section is split into Gazebo and SIH sub-groups. The
ROS 2 / DDS section is split into uXRCE-DDS and Zenoh.

Posted on main as a draft to give docs maintainers visibility and
collect review feedback. Backport strategy to release/1.17 (alpha/beta
banner variant vs the stable banner variant on main) is a follow-up
discussion.

Also fixes a long-anchor scroll-restoration bug in
px4_ros2_control_interface.md by giving the FwLateralLongitudinal
heading an explicit short anchor (#fw-lateral-longitudinal-setpoint),
and updates the corresponding link in releases/main.md.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* docs(releases): address review on v1.17.0 notes

- Cross-link Altitude Cruise in the intro paragraph.
- Reframe MC Neural Network Control as an experimental test path
  rather than first-class on-device inference; move it to the bottom
  of Major Changes.
- Drop the redundant "opt-in" wording from the Zenoh Major Changes
  bullet.
- Rewrite Upgrade Guide as a true upgrade procedure (actionable
  numbered steps with what to do and why) following the v1.14 release
  notes pattern instead of a flat parameter-delta list.
- Add the missing PR reference for the extended MISSION_CURRENT entry
  (#25034, populating the MAVLink mavlink/mavlink#1869 fields).
- Dedupe Safety / Commander against Common: failsafe takeover,
  Offboard-to-Position-without-RC, and motor-failure timeout checks
  are now listed only once in Common.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-05-13 10:59:28 -07:00
Dorten8 3cefb4aee2 docs(docs): Fix typo in Python package name in user guide (#27207) 2026-04-30 16:47:18 +10:00
Beniamino Pozzan 238840a64d docs(ros2): update docs for Zenoh, ROS 2 and msgs sync (#26761) 2026-04-22 15:50:51 +10:00
Hamish Willee b37733459d docs: Codespell check on English sources + swd fixes (#26657) 2026-03-05 12:50:59 +11:00
Leonardo Cencetti de9698e7fa zenoh: Add support for ROS2 Humble and earlier (#26619)
* Add support for hash-less Zenoh topic key expressions

- Add kConfig option ZENOH_KEY_TYPE_HASH to toggle the inclusion
- Update topic and liveliness generators

* chore: Update Zenoh kConfig param description and help message

* docs(zenoh): Document Zenoh configuration for Humble

* docs: Clarify PX4 ROS2 Interface library compatibility
2026-03-04 10:00:58 -09:00
Hamish Willee 209c971c1b docs: Link fixes in docs - including 404 fixes (#26605)
* Redirect 301/308 HTTP link fixes
* Easy 404 fixes - easy
* Add internal anchor fixes and generate msg docs fix
2026-02-28 17:09:53 +11:00
Hamish Willee c0af8b9952 docs: Link fixes such as 301 redirects (#26586) 2026-02-26 18:33:37 +11:00
PX4BuildBot 36b5e1e1bb docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
2026-02-11 22:43:01 +00:00
Beat Küng 8115cf2597 docs: update link for px4 ros2 interface lib python api docs 2026-02-09 10:03:55 +01:00
Beat Küng b9bd820186 docs: mention python bindings in ros lib 2026-01-29 08:20:03 +01:00
Hamish Willee cf50ecf41b Split out PX4 v1.17 release note (#26225) 2026-01-10 14:06:19 +11:00
Hamish Willee e83d18cad2 metadata - _sidebar and only display front page warning on main (#25761)
* _sidebar and only display front page warning on main

* Update metadata and fix internal flaws
2025-10-15 12:28:33 +11:00
chfriedrich98andHamish Willee 66b07d8219 Docs: Rover API (#25499)
* docs: add RoverSetpointTypes

* docs: add rover api

* docs: remove rover offboard mavlink support

* docs: fix broken links

* Apply suggestion from @hamishwillee

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2025-09-26 10:33:35 +10:00
Beat KüngandHamish Willee 7dcbad536d docs: add page for ROS 2 waypoint missions (#25492)
* docs: add page for ROS 2 waypoint missions

Corresponds to https://github.com/Auterion/px4-ros2-interface-lib/pull/137

* Ros lib subedit

* Waypoint missions - prettier

* Make compatibility very clear

* docs: add ROS-based waypoint missions to release notes

* docs: ROS-based waypoint mission clarifications

* Subedit intro

* docs: ros waypoint missions clarifications

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2025-09-25 17:27:25 +10:00
Beat Küng cf0def1b69 docs: minor api updates for ros modes (#25563) 2025-09-24 17:13:04 +10:00
Alex Espinoza 78d602e68a switched instructions for cloning Micro-XRCE-DDS from v2.4.2 to v2.4.3 (#25525)
* switched instructions for clodning Micro-XRCE-DDS from v2.4.2 to v2.4.3 since v2.4.2 references a bad fast-dds tag that doesnt build

* reverted uxrce instructions changes from docs/ko docs/uk and docs/zh sin
ce they are generated automatically and should not be changed manually
2025-09-17 11:57:32 +10:00
Jacob Dahl a48ed22f9f docs: fix typo mgs (#25352) 2025-08-03 08:19:01 +02:00
Hamish Willee 2c31e2bad5 Fix all possible HTTP to HTTPS docs links (#25153) 2025-07-03 18:09:58 +10:00
Matthias Grob 2bc04f91f8 docs: fix all end of file newlines
Note: Some files are autogenerated and I did not yet
go through each source of generation to fix it there.
Instead I adjusted the filter to only exclude those
such that we can fix things in steps.
2025-06-26 11:03:23 -07:00
Hamish Willee 53ae458fb5 Update dds_yaml links to the markdown doc 2025-06-12 08:26:34 +10:00
Hamish Willee 3a4dc784eb Fix up badges refering to main/v116 to just be 116 2025-06-04 12:39:33 +10:00
mahima-yoga 029e0a7740 DOCS: add OdometryAirspeed docs 2025-05-28 15:47:50 +02:00
mahima-yoga 255216e471 DOCS: VTOL API documentation in px4-ros2-interface-lib 2025-05-28 15:47:50 +02:00
mahima-yoga 418b653160 DOCS: add FwLateralLongitudinalSetpointType documentation in px4-ros2-interface-lib 2025-05-28 15:47:50 +02:00
Beat KüngandHamish Willee fee575f944 docs: update integration tests (#24671)
* docs: update integration tests

Updates for https://github.com/PX4/PX4-Autopilot/pull/22494.
Transferred from https://github.com/PX4/PX4-user_guide/pull/2970.

* Apply suggestions from code review

* Update docs/en/test_and_ci/integration_testing_ros1_mavros.md

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2025-05-07 13:52:03 +10:00
Hamish WilleeandRamon Roche 88d623bedb Move PX4 Guide source into /docs (#24490)
* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2025-03-13 16:08:27 +11:00