Skip to content

Commit 64618ba

Browse files
makeecatmakeecat
committed
doc: avoid confusion of serial naming, remove duplicated serial config documentation from CRSF and MSP
1 parent 14390a7 commit 64618ba

2 files changed

Lines changed: 6 additions & 22 deletions

File tree

‎components/bridges/cu_crsf/README.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,13 @@ The bridge expects a `serial` resource (anything implementing `embedded_io` `Rea
1414

1515
Use `cu_linux_resources::LinuxResources` as the serial provider; it stores owned
1616
resources in fixed slots like `<bundle>.serial0` through `<bundle>.serial5`.
17-
18-
For example, to use `serial3`, configure serial slot `serial3_*`:
19-
20-
| Key | Type | Default | Description |
21-
| --- | --- | --- | --- |
22-
| `serial3_dev` | string | (required) | Device node for the `serial3` resource slot. |
23-
| `serial3_baudrate` | u32 | `115200` | UART baudrate for this slot. |
24-
| `serial3_parity` | string | `none` | Parity for this slot (`none`, `odd`, `even`). |
25-
| `serial3_stopbits` | u8 | `1` | Stop bits for this slot (`1` or `2`). |
26-
| `serial3_timeout_ms` | u64 | `50` | Read timeout for this slot in milliseconds. |
17+
For serial config keys (`serialN_dev`, `serialN_baudrate`, parity/stopbits/timeout), see
18+
[`cu_linux_resources` README: Config Keys / Serial](../../res/cu_linux_resources/README.md#serial).
2719

2820
```ron
2921
resources: [
3022
(
31-
id: "radio",
23+
id: "linux",
3224
provider: "cu_linux_resources::LinuxResources",
3325
config: { "serial3_dev": "/dev/ttyUSB0", "serial3_baudrate": 420000 },
3426
),
@@ -37,7 +29,7 @@ bridges: [
3729
(
3830
id: "crsf",
3931
type: "cu_crsf::CrsfBridgeStd",
40-
resources: { serial: "radio.serial3" },
32+
resources: { serial: "linux.serial3" },
4133
channels: [ Rx (id: "rc_rx"), Rx (id: "lq_rx") ],
4234
),
4335
],

‎components/bridges/cu_msp_bridge/README.md‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,8 @@ Bridge that combines the MSP source/sink tasks into one serial transport. It exp
77
The bridge expects a `serial` resource. For std targets, use
88
`cu_linux_resources::LinuxResources` as the provider. It opens serial devices
99
and exposes fixed serial slots such as `<bundle>.serial0` through `<bundle>.serial5`.
10-
11-
For example, to use `serial3`, configure serial slot `serial3_*` in the Linux bundle:
12-
13-
| Key | Type | Default | Description |
14-
| --- | --- | --- | --- |
15-
| `serial3_dev` | string | (required) | Device node for the `serial3` resource slot. |
16-
| `serial3_baudrate` | u32 | `115200` | UART baudrate for this slot. |
17-
| `serial3_parity` | string | `none` | Parity for this slot (`none`, `odd`, `even`). |
18-
| `serial3_stopbits` | u8 | `1` | Stop bits for this slot (`1` or `2`). |
19-
| `serial3_timeout_ms` | u64 | `50` | Read timeout for this slot in milliseconds. |
10+
For serial config keys (`serialN_dev`, `serialN_baudrate`, parity/stopbits/timeout), see
11+
[`cu_linux_resources` README: Config Keys / Serial](../../res/cu_linux_resources/README.md#serial).
2012

2113
```ron
2214
resources: [

0 commit comments

Comments
 (0)