Skip to content

Commit

Permalink
Sidebar and tidy fixes (#583)
Browse files Browse the repository at this point in the history
* Fix up sidebar to include dialects and clear separation of important thingies

* Various typos
  • Loading branch information
hamishwillee authored Dec 10, 2024
1 parent 2d2e90a commit 00d2490
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 25 deletions.
36 changes: 21 additions & 15 deletions en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,11 @@
- [Defining XML Enums/Messages](guide/define_xml_element.md)
- [MAVLink CRC](guide/crc.md)
- [Debugging with Wireshark](guide/wireshark.md)
- [Dialects](messages/index.md)
- [ASLUAV.xml](messages/ASLUAV.md)
- [all.xml](messages/all.md)
- [ardupilotmega.xml](messages/ardupilotmega.md)
- [development.xml](messages/development.md)
- [icarous.xml](messages/icarous.md)
- [matrixpilot.xml](messages/matrixpilot.md)
- [minimal.xml](messages/minimal.md)
- [paparazzi.xml](messages/paparazzi.md)
- [python_array_test.xml](messages/python_array_test.md)
- [standard.xml](messages/standard.md)
- [test.xml](messages/test.md)
- [uAvionix.xml](messages/uAvionix.md)
- [ualberta.xml](messages/ualberta.md)
- [Messages (common)](messages/common.md)
- [Standard Messages/Commands](messages/index.md)
- [✔ common.xml](messages/common.md)
- [standard.xml](messages/standard.md)
- [minimal.xml](messages/minimal.md)
- [development.xml](messages/development.md)
- [Microservices](services/index.md)
- [Heartbeat/Connection Protocol](services/heartbeat.md)
- [Mission Protocol](services/mission.md)
Expand Down Expand Up @@ -79,5 +69,21 @@
- [Events Interface (WIP)](services/events.md)
- [Standard Flight Modes (WIP)](services/standard_modes.md)
- [Time Synchronization](services/timesync.md)
- [Dialects & Tests](messages/dialects.md)
- [ardupilotmega.xml](messages/ardupilotmega.md)
- [ASLUAV.xml](messages/ASLUAV.md)
- [AVSSUAS.xml](messages/AVSSUAS.md)
- [csAirLink.xml](messages/csAirLink.md)
- [cubepilot.xml](messages/cubepilot.md)
- [icarous.xml](messages/icarous.md)
- [loweheiser.xml](messages/loweheiser.md)
- [matrixpilot.xml](messages/matrixpilot.md)
- [paparazzi.xml](messages/paparazzi.md)
- [storm32.xml](messages/storm32.md)
- [uAvionix.xml](messages/uAvionix.md)
- [ualberta.xml](messages/ualberta.md)
- [all.xml](messages/all.md)
- [python_array_test.xml](messages/python_array_test.md)
- [test.xml](messages/test.md)
- [Contributing](contributing/contributing.md)
- [Support](about/support.md)
6 changes: 4 additions & 2 deletions en/mavgen_c/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,10 @@ This does not happen on most of the common architectures on which MAVLink is run

You can suppress the warnings using `-Wno-address-of-packed-member`.

> **Note:** The issue causes hard faults on [Cortex-M0](https://github.com/ArduPilot/pymavlink/issues/5) and other platforms [listed here](https://github.com/ArduPilot/pymavlink/issues/836#issue-1788623502).
> Please raise issues in [ArduPilot/pymavlink](https://github.com/ArduPilot/pymavlink/) if you find other hardware that is affected.
::: info
The issue causes hard faults on [Cortex-M0](https://github.com/ArduPilot/pymavlink/issues/5) and other platforms [listed here](https://github.com/ArduPilot/pymavlink/issues/836#issue-1788623502).
Please raise issues in [ArduPilot/pymavlink](https://github.com/ArduPilot/pymavlink/) if you find other hardware that is affected.
:::

## Upgrading Library from MAVLink 1

Expand Down
2 changes: 1 addition & 1 deletion en/mavgen_python/examples.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Examples (Pymavlink)
# Examples (Pymavlink)

Other examples:

Expand Down
2 changes: 1 addition & 1 deletion en/mavgen_python/howto_requestmessages.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#### How to Request & Stream Messages
# How to Request & Stream Messages

A remote system will typically stream a _default_ set of messages to a connected GCS, camera or other system.
This default set may be hard coded, and is necessarily limited to reduce traffic on the channel.
Expand Down
8 changes: 4 additions & 4 deletions en/mavgen_python/message_signing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Message Signing (Pymavlink)
# Message Signing (Pymavlink)

Pymavlink supports [Message Signing](../guide/message_signing.md) (authentication) when using [MAVLink 2](../guide/mavlink_2.md).

Expand All @@ -15,7 +15,7 @@ While not covered in this topic, you should also write code to:

:::

#### Signing using MAVLink Class
## Signing using MAVLink Class

If you are using the `MAVLink` class directly, you can use the **`MAVLink.signing`** attribute to access a `MAVLinkSigning` object and set the required attributes.

Expand All @@ -38,7 +38,7 @@ The initial timestamp should be based on current system time.
For more information see [Message Signing](../guide/message_signing.md#timestamp).
:::

#### Signing using mavutil
## Signing using mavutil

If you are using **mavutil** to manage the connection then you can set up/disable signing using the methods shown below:

Expand All @@ -55,7 +55,7 @@ The `setup_signing()` method sets up the `MAVLink` object owned by the connectio
- If `link_id` is not specified then internally the value is iterated.
- If `initial_timestamp` is not set then an appropriate value for current time is populated from the underlying OS.

#### Using allow_unsigned_callback
## Using allow_unsigned_callback

[Message Signing > Accepting Unsigned Packets](../guide/message_signing.md#accepting_unsigned_packets) and [Accepting Incorrectly Signed Packets](../guide/message_signing.md#accepting_incorrectly_signed_packets) specify that a message signing implementation should provide mechanisms such that library users can choose to conditionally accept unsigned or incorrectly signed packets.

Expand Down
4 changes: 2 additions & 2 deletions en/services/mission.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ Mission update must be robust!
A new mission should be fully uploaded and accepted before the old mission is replaced/removed.
:::

:::
Mission upload/download can be bandwidth intensive and time consuming
::: tip
Mission upload/download can be bandwidth intensive and time consuming.
[Check for plan changes](#detecting-missionplan-changes) before uploading (or downloading) a mission.
:::

Expand Down

0 comments on commit 00d2490

Please sign in to comment.