Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ Guidance for coding agents in this repository.
- CI `colcon test` is a merge gate and must pass before merge.
- Follow generated-code workflows (`cog`, docs extractors/templates); do not hand-edit generated regions.
- Use commit subject format: `<component>: ...` with short component names (for example: `msgs`, `extras`, `tools`).
- Never print, echo, export, or otherwise output the value of any token/secret environment variable
(e.g. `*_TOKEN`, `*_SECRET`, `*_KEY`, `*_USERNAME`, `*_PASSWORD`, `GH_TOKEN`, `GITHUB_*`, `GITLAB_*`).
Reference them only by variable name (e.g. `"$GITHUB_MCP_RO_TOKEN"`) so the value is
never captured in tool output, logs, or transcripts. Prefer MCP/tooling that handles auth internally
over shelling out with an explicit secret value.

## Repository Scope

Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
MAVROS
======
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mavlink/mavros)](https://github.com/mavlink/mavros/releases) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mavlink/mavros?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![CI](https://github.com/mavlink/mavros/actions/workflows/main.yml/badge.svg)](https://github.com/mavlink/mavros/actions/workflows/main.yml)
=====
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mavlink/mavros)](https://github.com/mavlink/mavros/releases) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mavlink/mavros?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![CI](https://github.com/mavlink/mavros/actions/workflows/main.yml/badge.svg)](https://github.com/mavlink/mavros/actions/workflows/main.yml) [![Documentation](https://readthedocs.org/projects/mavros/badge/?version=latest)](https://mavros.readthedocs.io/en/latest/)

MAVLink extendable communication node for ROS.

- Full documentation: [https://mavros.readthedocs.io/][rtd]
- Plugin reference (all ROS API): [Plugin index](docs/plugins/index.md)
- Per-package C++/Python API reference (auto-generated): [https://docs.ros.org/en/rolling/p/mavros/][api]

- Since 2014-08-11 this repository contains several packages.
- Since 2014-11-02 hydro support separated from master to hydro-devel branch.
- Since 2015-03-04 all packages also dual licensed under terms of BSD license.
Expand Down Expand Up @@ -78,6 +82,8 @@ CI Statuses


[mrrm]: https://github.com/mavlink/mavros/blob/ros2/mavros/README.md
[rtd]: https://mavros.readthedocs.io/en/latest/
[api]: https://docs.ros.org/en/rolling/p/mavros/
[exrm]: https://github.com/mavlink/mavros/blob/ros2/mavros_extras/README.md
[libmc]: https://github.com/mavlink/mavros/blob/ros2/libmavconn/README.md
[test]: https://github.com/mavlink/mavros/blob/ros2/test_mavros/README.md
Expand Down
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@ Index data used for generation:
- `docs/plugins/std/index.json`
- `docs/plugins/extras/index.json`

Auto-generated per-package C++/Python API reference (published by ROS 2):

- [mavros](https://docs.ros.org/en/rolling/p/mavros/),
[mavros_extras](https://docs.ros.org/en/rolling/p/mavros_extras/),
[mavros_msgs](https://docs.ros.org/en/rolling/p/mavros_msgs/),
[libmavconn](https://docs.ros.org/en/rolling/p/libmavconn/)


Build And Test (Workspace)
--------------------------
Expand Down
138 changes: 0 additions & 138 deletions docs/mavlink-e2e-tests-plan.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/plugins/extras/3dr_radio.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@


## Publishers
- `radio_status` ([mavros_msgs::msg::RadioStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/RadioStatus.html))
- `radio_status` ([mavros_msgs::msg::RadioStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/RadioStatus.html)) - Publish radio status from MAVLink RADIO_STATUS/RADIO.


## Subscribers
Expand All @@ -23,7 +23,7 @@


## Parameters
- `low_rssi` [type: integer, default: `40`]
- `low_rssi` [type: integer, default: `40`] - Low RSSI threshold for diagnostics [dB].


## MAVLink Subscriptions
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/extras/adsb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
- Brief: ADS-B Vehicle plugin


Publish/subscribe Automatic dependent surveillance-broadcast data to/from a vehicle.
Publish/subscribe Automatic dependent surveillance-broadcast data to/from a vehicle. Implements the [MAVLink Traffic Management (UTM/ADS-B)](https://mavlink.io/en/services/traffic_management.html).

## Publishers
- `~/vehicle` ([mavros_msgs::msg::ADSBVehicle](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ADSBVehicle.html))
- `~/vehicle` ([mavros_msgs::msg::ADSBVehicle](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ADSBVehicle.html)) - Publish received ADSB_VEHICLE messages (MAVLink traffic management).


## Subscribers
- `~/send` ([mavros_msgs::msg::ADSBVehicle](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ADSBVehicle.html))
- `~/send` ([mavros_msgs::msg::ADSBVehicle](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ADSBVehicle.html)) - Subscribe to ADSBVehicle messages to send as ADSB_VEHICLE to the FCU.


## Services
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/extras/cam_imu_sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
This plugin publishes a timestamp for when a external camera system was triggered by the FCU. Sequence ID from the message and the image sequence from camera can be correlated to get the exact shutter trigger time.

## Publishers
- `~/cam_imu_stamp` ([mavros_msgs::msg::CamIMUStamp](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CamIMUStamp.html))
- `~/cam_imu_stamp` ([mavros_msgs::msg::CamIMUStamp](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CamIMUStamp.html)) - Publish camera IMU trigger timestamp from MAVLink CAMERA_TRIGGER.


## Subscribers
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/extras/camera.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
- Brief: Camera plugin plugin


Plugin for interfacing on the mavlink camera protocol @see command_cb()
Plugin for interfacing on the mavlink camera protocol. Implements the [MAVLink Camera Protocol v2](https://mavlink.io/en/services/camera.html). @see command_cb()

## Publishers
- `~/image_captured` ([mavros_msgs::msg::CameraImageCaptured](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CameraImageCaptured.html))
- `~/image_captured` ([mavros_msgs::msg::CameraImageCaptured](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CameraImageCaptured.html)) - Publish camera image capture info from MAVLink CAMERA_IMAGE_CAPTURED.


## Subscribers
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/extras/cellular_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Users must publish to the topic the CellularStatus message and it will be relaye


## Subscribers
- `~/status` ([mavros_msgs::msg::CellularStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CellularStatus.html))
- `~/status` ([mavros_msgs::msg::CellularStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CellularStatus.html)) - Subscribe to CellularStatus messages to send as CELLULAR_STATUS to the FCU.


## Services
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/extras/companion_process_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Publishes the status of components running on the companion computer @see status


## Subscribers
- `~/status` ([mavros_msgs::msg::CompanionProcessStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CompanionProcessStatus.html))
- `~/status` ([mavros_msgs::msg::CompanionProcessStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/CompanionProcessStatus.html)) - Subscribe to CompanionProcessStatus to send as HEARTBEAT to the FCU.


## Services
Expand Down
12 changes: 6 additions & 6 deletions docs/plugins/extras/debug_value.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@


## Publishers
- `~/debug` (DV) - publishers
- `~/debug_vector` (DV)
- `~/debug_float_array` (DV)
- `~/named_value_float` (DV)
- `~/named_value_int` (DV)
- `~/debug` (DV) - publishers Publish DEBUG messages from MAVLink DEBUG.
- `~/debug_vector` (DV) - Publish DEBUG_VECT messages from MAVLink DEBUG_VECT.
- `~/debug_float_array` (DV) - Publish DEBUG_FLOAT_ARRAY messages from MAVLink DEBUG_FLOAT_ARRAY.
- `~/named_value_float` (DV) - Publish NAMED_VALUE_FLOAT messages from MAVLink NAMED_VALUE_FLOAT.
- `~/named_value_int` (DV) - Publish NAMED_VALUE_INT messages from MAVLink NAMED_VALUE_INT.


## Subscribers
- `~/send` (DV)
- `~/send` (DV) - subscribers Subscribe to DebugValue to send MAVLink debug messages to the FCU.


## Services
Expand Down
8 changes: 4 additions & 4 deletions docs/plugins/extras/distance_sensor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
This plugin allows publishing distance sensor data, which is connected to an offboard/companion computer through USB/Serial, to the FCU or vice-versa.

## Publishers
- `topic_name` (Range)
- `topic_name` (Range) - Publish sensor_msgs/Range from MAVLink DISTANCE_SENSOR.


## Subscribers
- `topic_name` (Range)
- `topic_name` (Range) - Subscribe sensor_msgs/Range to send as DISTANCE_SENSOR to the FCU.


## Services
Expand All @@ -25,8 +25,8 @@ This plugin allows publishing distance sensor data, which is connected to an off


## Parameters
- `base_frame_id` [default: `"base_link"`]
- `config` [type: string, default: `""`]
- `base_frame_id` [default: `"base_link"`] - Base frame id used for distance sensor transforms.
- `config` [type: string, default: `""`] - Sensor mapping configuration (YAML: id, topic, orientation, etc).


## MAVLink Subscriptions
Expand Down
4 changes: 2 additions & 2 deletions docs/plugins/extras/esc_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@


## Publishers
- `~/info` ([mavros_msgs::msg::ESCInfo](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCInfo.html))
- `~/status` ([mavros_msgs::msg::ESCStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCStatus.html))
- `~/info` ([mavros_msgs::msg::ESCInfo](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCInfo.html)) - Publish ESC information from MAVLink ESC_INFO.
- `~/status` ([mavros_msgs::msg::ESCStatus](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCStatus.html)) - Publish ESC status from MAVLink ESC_STATUS.


## Subscribers
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/extras/esc_telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
APM specific plugin.

## Publishers
- `~/telemetry` ([mavros_msgs::msg::ESCTelemetry](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCTelemetry.html))
- `~/telemetry` ([mavros_msgs::msg::ESCTelemetry](https://docs.ros.org/en/rolling/p/mavros_msgs/msg/ESCTelemetry.html)) - Publish ESC telemetry from MAVLink ESC_TELEMETRY_* messages.


## Subscribers
Expand Down
Loading
Loading