Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Commit d9a6456

Browse files
authored
Merge pull request #406 from jumpstarter-dev/doc-fixup
Fixup configuration example in generated README.md
2 parents 563fac2 + b7284f2 commit d9a6456

16 files changed

Lines changed: 79 additions & 55 deletions

File tree

__templates__/create_driver.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,11 @@ pip install jumpstarter-driver-${DRIVER_NAME}
5050
Example configuration:
5151
5252
```yaml
53-
interfaces:
53+
export:
5454
${DRIVER_NAME}:
55-
driver: jumpstarter_driver_${DRIVER_NAME}.${DRIVER_CLASS}Driver
56-
parameters:
57-
# Add required parameters here
55+
type: jumpstarter_driver_${DRIVER_NAME}.driver.${DRIVER_CLASS}
56+
config:
57+
# Add required config parameters here
5858
```
5959
6060
## API Reference

packages/jumpstarter-driver-can/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ pip install jumpstarter-driver-can
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
can:
18-
driver: jumpstarter_driver_can.CANDriver
19-
parameters:
20-
# Add required parameters here
18+
type: jumpstarter_driver_can.Can
19+
config:
20+
# Add required config parameters here
2121
```
2222

2323
## API Reference
Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,25 @@
1-
# Jumpstarter Composite Driver
1+
# Composite Driver
2+
3+
`jumpstarter-driver-composite` provides functionality for interacting with composite devices.
4+
5+
## Installation
6+
7+
```bash
8+
pip install jumpstarter-driver-composite
9+
```
10+
11+
## Configuration
12+
13+
Example configuration:
14+
15+
```yaml
16+
export:
17+
composite:
18+
type: jumpstarter_driver_composite.driver.Composite
19+
config:
20+
# Add required config parameters here
21+
```
22+
23+
## API Reference
24+
25+
Add API documentation here.

packages/jumpstarter-driver-corellium/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ pip install jumpstarter-driver-corellium
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
corellium:
18-
driver: jumpstarter_driver_corellium.driver.Corellium
19-
parameters:
18+
type: jumpstarter_driver_corellium.driver.Corellium
19+
config:
2020
project_id: "778f00af-5e9b-40e6-8e7f-c4f14b632e9c"
2121
device_name: "jmp-rd1ae"
2222
device_flavor: "kronos"

packages/jumpstarter-driver-dutlink/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ pip install jumpstarter-driver-dutlink
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
dutlink:
18-
driver: jumpstarter_driver_dutlink.DUTLinkDriver
19-
parameters:
20-
# Add required parameters here
18+
type: jumpstarter_driver_dutlink.driver.Dutlink
19+
config:
20+
# Add required config parameters here
2121
```
2222

2323
## API Reference

packages/jumpstarter-driver-http/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ pip install jumpstarter-driver-http
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
http:
18-
driver: jumpstarter_driver_http.HTTPDriver
19-
parameters:
20-
# Add required parameters here
18+
type: jumpstarter_driver_http.driver.HttpServer
19+
config:
20+
# Add required config parameters here
2121
```
2222

2323
## API Reference

packages/jumpstarter-driver-network/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ pip install jumpstarter-driver-network
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
network:
18-
driver: jumpstarter_driver_network.NetworkDriver
19-
parameters:
18+
type: jumpstarter_driver_network.driver.TcpNetwork
19+
config:
2020
# Add required parameters here
2121
```
2222

packages/jumpstarter-driver-power/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ pip install jumpstarter-driver-power
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
power:
18-
driver: jumpstarter_driver_power.PowerDriver
19-
parameters:
20-
# Add required parameters here
18+
type: jumpstarter_driver_power.driver.MockPower
19+
config:
20+
# Add required config parameters here
2121
```
2222

2323
## API Reference

packages/jumpstarter-driver-probe-rs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ pip install jumpstarter-driver-probe-rs
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
probe:
18-
driver: jumpstarter_driver_probe_rs.driver.ProbeRs
19-
parameters:
18+
type: jumpstarter_driver_probe_rs.driver.ProbeRs
19+
config:
2020
probe: "2e8a:000c:5798DE5E500ACB60"
2121
probe_rs_path: "/home/majopela/.cargo/bin/probe-rs"
2222
chip: "RP2350"

packages/jumpstarter-driver-pyserial/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ pip install jumpstarter-driver-pyserial
1313
Example configuration:
1414

1515
```yaml
16-
interfaces:
16+
export:
1717
serial:
18-
driver: jumpstarter_driver_pyserial.driver.PySerial
19-
parameters:
18+
type: jumpstarter_driver_pyserial.driver.PySerial
19+
config:
2020
url: "/dev/ttyUSB0"
2121
baudrate: 115200
2222
```

0 commit comments

Comments
 (0)