134 Commits

Author SHA1 Message Date
Hamish Willee 9d859af40c ci(update): Add prettier, markdownlink, prettier, reviewdog (#717) 2026-06-11 09:58:40 +10:00
Hamish Willee a15ba6379d Fix up date format for WIP tag (#713) 2026-06-10 17:08:02 +10:00
İshak Gönül 61b2be4f10 docs: update Linux plugin directory path for Wireshark (#689) 2026-04-06 09:00:25 +10:00
pv42 b517d0e0eb update include schema description to allow nested includes (#681) 2026-03-11 09:18:26 +11:00
Hamish Willee be2cb3d920 Spelling and grammar plus a few link fixes (#676) 2026-03-05 09:22:01 +11:00
Hamish Willee 475730a44d UPdates to schema in guide: structure and superseded (#664) 2026-02-05 16:51:51 +11:00
Hamish Willee 709900b874 PROTOCOL_VERSION - deprecate in mav guide (#651) 2025-12-03 15:30:53 +11:00
Hamish Willee e00e8e5e67 MAVLink2 handshaking PROTOCOL_VERSION downgrade (#640) 2025-10-29 14:35:52 +11:00
Hamish Willee 37f7ecfdf9 mavlink_version.md use MAV_CMD_REQUEST_MESSAGE to get PROTOCOL_VERSION (#621)
* mavlink_version.md use MAV_CMD_REQUEST_MESSAGE to get PROTOCOL_VERSION

* Update mavlink_version.md - update mermaid diagram

* Update mavlink_version.md
2025-07-31 11:39:21 +10:00
Hamish Willee d828a29293 Add information about the bitmask attribute for enums (#596) 2025-03-20 17:23:18 +11:00
Hamish Willee 28e1d4d86b defining command names - clarify 2025-02-27 10:35:45 +11:00
Hamish Willee 63a111f366 Use native asides (#576)
* Use vitepress native asides - prettier screws up githu

* minor clean

* prettier_output
2024-11-28 10:09:22 +11:00
Hamish Willee b6c49b2cd1 Test migration to vitepress (#551)
* Add package/.vitepress folders - more work to be done

* Fix up config and add site/favicons

* Update styles for wide tables

* Rename English files from README.md to index.md

* Add root home page

* Update .gitignore for vitepress

* Delete unused: travis, book, redirects

* Fix up all Notes

* Warnings and notes - convert to github format

* Add running workflow

* Add yarn lock file

* Fix up links README.md to index.md

* Add lock files
2024-11-27 16:59:53 +11:00
Hamish Willee 91060ff8b9 Add docs on packet loss calculations (#542) 2024-07-03 11:08:20 +10:00
Hamish Willee 0633b9478e Add multiplier info to docs (#540) 2024-05-30 09:25:26 +10:00
Hamish Willee a28a5a4350 Update routing.md - update mavlink router link (#536) 2024-04-24 09:00:40 +10:00
Hamish Willee a737ad3e4d Prettier the docs except for messages (#528)
* Prettier the docs except for messages

* Fix broken link and tidy table
2024-02-29 09:53:04 +11:00
Hamish Willee 7ed4c3422b Offboard, redundant links, and prettier fixes (#527)
* Prettier mavgen c and python

* Add proper docs in offboard control

* Move offboard mode into a microservice doc

* Add section on deduplication

* Update en/guide/redundancy_deduplication.md
2024-02-29 09:11:00 +11:00
Antonio Sanjurjo C 305208b23e Update define_xml_element.md (#516)
Wrong Link reference
2023-08-09 09:00:56 +10:00
Hamish Willee e89c499764 Update wireshark.md 2023-07-05 15:46:05 +10:00
Hamish Willee 7b05772e11 Update define_xml_element.md - add link to all.xml with more ranges of values (#512) 2023-07-05 15:33:03 +10:00
Hamish Willee a2c52b963d Add missionOnly to docs (#505) 2023-06-08 11:59:26 +10:00
Hamish Willee 22df391366 Wireshark - update port for monitoring WSL2 2023-05-18 10:19:25 +10:00
Beat Küng 430bf2138e wireshark: update plugin directory for unix (#496) 2022-11-05 14:23:13 +11:00
Hamish Willee 2e6535ca99 Add note about endianness in serialisation (#491) 2022-10-26 18:26:59 +11:00
Hamish Willee 3f7ba3a6da Document that every message must have at least one field (#437)
* xml-schema - every message must have at least one field

* Also note fields required in defining xml element topic
2022-02-17 08:44:26 +11:00
Hamish Willee 15f29793a4 xml_scheme - clarify the invalid values again (#404) 2021-11-17 09:41:05 +11:00
Hamish Willee bf445b742d True to true for boolean 2021-11-04 11:37:08 +11:00
Hamish Willee 31080c0cc4 Update defn first element of array invalidates whole array 2021-10-11 08:58:26 +11:00
Hamish Willee 9d02f2607d Document invalid fields (#394) 2021-09-23 12:05:21 +10:00
Hamish Willee fd7cc20f3f [DO NOT MERGE] Clarify that empty byte trimming is required (#135)
* MAVLink 2 messages must be trimmed

* Clarify that empty by trimming is required

* Make it clear that the receiver must accept invalid input
2021-08-19 13:28:02 +10:00
Hamish Willee dbc1dda64b Add Wireshark MAVLink traffic docs (#366) 2021-06-17 17:59:38 +10:00
Hamish Willee 37ed6a2b2f improve packet index descripton
Addresses https://github.com/mavlink/mavlink-devguide/pull/343#issuecomment-833425669
2021-05-06 21:15:29 +10:00
Marek S. Ł 7520b50a28 Fix payload byte indices in serialization.md (#343)
* Fix payload byte indices in serialization.md

Current span of  payload for MAVLink v2 is described as `10 to (n+10)`, and I believe this is a typo.

For other multi-byte fields like v2 msg_id the byte indices in the left column are inclusive - both byte 7 and byte 9 are part of msg_id. So a payload of one byte should be from byte 10 to byte 10 inclusive. The formula to get one-byte payload then is actually `10 to (n+9)` because n = 1. This might feel a bit strange to programmers used to inclusive-exclusive array boundaries but is correct in this context.

A different explanation is that the byte (n+10) is actually the first byte of the checksum, not the last byte of payload. With current documentation it is unclear which part it belongs to.

This is also true for v1 packet.

* Proposal

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2021-05-06 11:26:03 +10:00
Hamish Willee 8e4f20387f Add mavlink crc topic (#334)
* Add mavlink crc section

* Update en/guide/crc.md

Co-authored-by: Julian Oes <julian@oes.ch>

* Fix up following feedback

Co-authored-by: Julian Oes <julian@oes.ch>
2021-03-24 09:44:16 +11:00
Julian Oes 70d2f5ac28 Fix CRC specification. (#290) 2020-12-28 17:29:26 +11:00
Hamish Willee ea78a698bc Schema: add instance field (#305)
* Schema: add instance field

* Update xml_schema.md

* Update xml_schema.md
2020-12-28 17:24:16 +11:00
Cedric Bös fdc4c11f1c Update serialization.md (#272)
Update of some indices which seem to be mixed up.
2020-09-09 09:31:32 +10:00
Hamish Willee 3a0e68ff0e serialisation: Fix incorrect starting point for signature bit 2020-08-27 10:31:24 +10:00
Hamish Willee 0e5acfccf9 Fix broken links (mostly internal) (#261) 2020-07-08 15:20:54 +10:00
numan ff2990ef94 target_system_ofs duplicate > target_component_ofs (#253) 2020-06-22 09:26:28 +10:00
Hamish Willee e21096919c mavlink-version - remove mermaid plugin dependency 2020-05-04 13:33:13 +10:00
Hamish Willee 4107a797d5 Update define_xml_element.md 2020-04-21 19:54:30 +10:00
Hamish Willee d14b07c170 mavlink_2 fix link 2020-04-06 08:16:09 +10:00
Hamish Willee c3b8752fc9 Serialisation: Mavlink 1 component/system source id non zero 2019-10-08 09:15:59 +11:00
Hamish Willee 98276d2872 serialisation: Clarify that 0 is invalid source id (#215) 2019-10-08 09:06:43 +11:00
Hamish Willee 3c4cfea868 Typo 2019-10-07 17:39:00 +11:00
Hamish Willee 126ad65b23 Update serialization.md 2019-08-20 08:43:36 +10:00
gswly 6b37a537be serialization: clarify empty-byte truncation in case of empty payloads 2019-08-19 20:26:49 +02:00
Brian Phillips 30cf62607e Corrected grammar mistake (#197)
removed an extra 'be'
2019-08-05 09:38:21 +10:00