Commit Graph
4 Commits
Author SHA1 Message Date
PhilandHamish Willee b798249a61 feat(tools): add mavlink_serial_bridge.py reference bridge application (#28782)
* feat(tools): add mavlink_serial_bridge.py reference bridge application

Implements the SERIAL_CONTROL bridge application described in the Bridge Application section of docs/en/uart/serial_passthrough.md: it connects to the vehicle over MAVLink, exposes a virtual serial port (PTY), and translates traffic bidirectionally for any passthrough-capable port (TEL/GPS/ESC bitbang). Existing ESC configuration/flashing tools and GPS/RTK utilities can point at the exposed PTY without native MAVLink support.

Also updates serial_passthrough.md to reference this implementation instead of only describing the pattern in the abstract.

Signed-off-by: Phil-Engljaehringer <philipp.engljahringer@auterion.com>

* fix: add send_serial_control function

* docs: document mavlink_serial_bridge.py usage and limits

Explain what the bridge supports and how to run it safely: the example
connection string only listened on loopback, and --setup reboots the
flight controller with motor outputs disabled without saying so.

Restore the DShot ESC Serial Passthrough section, which was commented
out until a bridge existed, and update the v1.18 and main release notes
so v1.18 users know the bridge on main works with their firmware.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* fix: removed duplicated port-map

* fix: send_serial_control adjust padding

* fix: set target_system and target_component only once

* fix: implemented changes requested by alex

* fix: implemented changes requested by hamish

* fix: avoid indefinite loop waiting for heartbeat

* fix: no chunking in send function needed

* fix: add lock and avoid trailing 0x00 sent on shutdown

* docs: explained SWITCH <device_id> feature in docs

---------

Signed-off-by: Phil-Engljaehringer <philipp.engljahringer@auterion.com>
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-10-02 10:37:42 +02:00
Phil-EngljaehringerandHamish Willee dc3636eed0 docs(docs): serial passthrough (#27654)
* feat: added docs

* feat: some more documentation

* fix: worked on docs again

* fix: added doc to summary.md

* fix: adjusted docs to requests

* docs(docs): Subedit

* feat: added release notes to 1.18.md

* docs(docs): subedit

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-06-24 17:20:46 +10: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
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