Skip to content

Commit

Permalink
tree: Spell out default
Browse files Browse the repository at this point in the history 
Signed-off-by: Ryan Friedman <[email protected]>
  • Loading branch information
@Ryanf55 @Hwurzburg
Ryanf55 authored and Hwurzburg committed Mar 3, 2025
1 parent 05f704d commit 5da61eb
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion common/source/docs/common-pixhawk-serial-names.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Cube where ArduPilot is concerned. This document attempts to supply a
mapping between them.

+-----------+-------------+------------+--------------+--------------+-----------------+----------------+
| DataSheet | ParamPrefix | HW Label | Cube Full CB | Def Role | SERIAL_CONTROL* | Notes |
| DataSheet | ParamPrefix | HW Label | Cube Full CB | Default Role | SERIAL_CONTROL* | Notes |
+===========+=============+============+==============+==============+=================+================+
| | \SERIAL0_ | | Console | Console | | Micro-USB Plug |
+-----------+-------------+------------+--------------+--------------+-----------------+----------------+
Expand Down
38 changes: 19 additions & 19 deletions dev/source/docs/learning-ardupilot-uarts-and-the-console.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ The 8 UARTs

The ArduPilot HAL currently defines 8 UARTs. The HAL itself does not define any particular roles for these UARTs, but the other parts of ArduPilot assume they will be assigned particular functions. The command-line options for using with sim_vehicle.py the serial port should be preceded by :code:`-A` to pass along to the vehicle binary. Make sure to include the :code:`uart` protocol. Specifying a baudrate is not required, but is more consistent. For example, :code:`sim_vehicle.py --console --map -A --serial5=uart:/dev/ttyS15:115200`.

+-------------+----------------------+----------+-------------------------+
| ParamPrefix | Sim_vehicle Cmd Line | Def Role | Default Connection |
+=============+======================+==========+=========================+
| \SERIAL0_ | \- -serial0= | Console | tcp:localhost:5760:wait |
+-------------+----------------------+----------+-------------------------+
| \SERIAL1_ | \- -serial1= | MAVLink | tcp:localhost:5762 |
+-------------+----------------------+----------+-------------------------+
| \SERIAL2_ | \- -serial2= | MAVLink | tcp:localhost:5763 |
+-------------+----------------------+----------+-------------------------+
| \SERIAL3_ | \- -serial3= | GPS | Simulated GPS |
+-------------+----------------------+----------+-------------------------+
| \SERIAL4_ | \- -serial4= | GPS | Simulated GPS |
+-------------+----------------------+----------+-------------------------+
| \SERIAL5_ | \- -serial5= | | |
+-------------+----------------------+----------+-------------------------+
| \SERIAL6_ | \- -serial6= | | |
+-------------+----------------------+----------+-------------------------+
| \SERIAL7_ | \- -serial7= | | |
+-------------+----------------------+----------+-------------------------+
+-------------+----------------------+--------------+-------------------------+
| ParamPrefix | Sim_vehicle Cmd Line | Default Role | Default Connection |
+=============+======================+==============+=========================+
| \SERIAL0_ | \- -serial0= | Console | tcp:localhost:5760:wait |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL1_ | \- -serial1= | MAVLink | tcp:localhost:5762 |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL2_ | \- -serial2= | MAVLink | tcp:localhost:5763 |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL3_ | \- -serial3= | GPS | Simulated GPS |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL4_ | \- -serial4= | GPS | Simulated GPS |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL5_ | \- -serial5= | | |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL6_ | \- -serial6= | | |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL7_ | \- -serial7= | | |
+-------------+----------------------+--------------+-------------------------+

The following are options for connecting a SITL serial port:

Expand Down
38 changes: 19 additions & 19 deletions dev/source/docs/sitl-serial-mapping.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ Archived: SITL Serial Mapping

This document attempts to supply information about the virtual serial ports present in ArduPilot's SITL.

+-------------+----------------------+----------+-------------------------+
| ParamPrefix | Sim_vehicle Cmd Line | Def Role | Default Connection |
+=============+======================+==========+=========================+
| \SERIAL0_ | \- -serial0= | Console | tcp:localhost:5760:wait |
+-------------+----------------------+----------+-------------------------+
| \SERIAL1_ | \- -serial1= | MAVLink | tcp:localhost:5762 |
+-------------+----------------------+----------+-------------------------+
| \SERIAL2_ | \- -serial2= | MAVLink | tcp:localhost:5763 |
+-------------+----------------------+----------+-------------------------+
| \SERIAL3_ | \- -serial3= | GPS | Simulated GPS |
+-------------+----------------------+----------+-------------------------+
| \SERIAL4_ | \- -serial4= | GPS | Simulated GPS |
+-------------+----------------------+----------+-------------------------+
| \SERIAL5_ | \- -serial5= | | |
+-------------+----------------------+----------+-------------------------+
| \SERIAL6_ | \- -serial6= | | |
+-------------+----------------------+----------+-------------------------+
| \SERIAL7_ | \- -serial7= | | |
+-------------+----------------------+----------+-------------------------+
+-------------+----------------------+--------------+-------------------------+
| ParamPrefix | Sim_vehicle Cmd Line | Default Role | Default Connection |
+=============+======================+==============+=========================+
| \SERIAL0_ | \- -serial0= | Console | tcp:localhost:5760:wait |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL1_ | \- -serial1= | MAVLink | tcp:localhost:5762 |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL2_ | \- -serial2= | MAVLink | tcp:localhost:5763 |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL3_ | \- -serial3= | GPS | Simulated GPS |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL4_ | \- -serial4= | GPS | Simulated GPS |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL5_ | \- -serial5= | | |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL6_ | \- -serial6= | | |
+-------------+----------------------+--------------+-------------------------+
| \SERIAL7_ | \- -serial7= | | |
+-------------+----------------------+--------------+-------------------------+

0 comments on commit 5da61eb

Please sign in to comment.