Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions __templates__/create_driver.sh
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ pip install jumpstarter-driver-${DRIVER_NAME}
Example configuration:

```yaml
interfaces:
export:
${DRIVER_NAME}:
driver: jumpstarter_driver_${DRIVER_NAME}.${DRIVER_CLASS}Driver
parameters:
# Add required parameters here
type: jumpstarter_driver_${DRIVER_NAME}.driver.${DRIVER_CLASS}
config:
# Add required config parameters here
```

## API Reference
Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-can/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-can
Example configuration:

```yaml
interfaces:
export:
can:
driver: jumpstarter_driver_can.CANDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_can.Can
config:
# Add required config parameters here
```

## API Reference
Expand Down
26 changes: 25 additions & 1 deletion packages/jumpstarter-driver-composite/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
# Jumpstarter Composite Driver
# Composite Driver

`jumpstarter-driver-composite` provides functionality for interacting with composite devices.

## Installation

```bash
pip install jumpstarter-driver-composite
```

## Configuration

Example configuration:

```yaml
export:
composite:
type: jumpstarter_driver_composite.driver.Composite
config:
# Add required config parameters here
```

## API Reference

Add API documentation here.
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-corellium/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-corellium
Example configuration:

```yaml
interfaces:
export:
corellium:
driver: jumpstarter_driver_corellium.driver.Corellium
parameters:
type: jumpstarter_driver_corellium.driver.Corellium
config:
project_id: "778f00af-5e9b-40e6-8e7f-c4f14b632e9c"
device_name: "jmp-rd1ae"
device_flavor: "kronos"
Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-dutlink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-dutlink
Example configuration:

```yaml
interfaces:
export:
dutlink:
driver: jumpstarter_driver_dutlink.DUTLinkDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_dutlink.driver.Dutlink
config:
# Add required config parameters here
```

## API Reference
Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-http/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-http
Example configuration:

```yaml
interfaces:
export:
http:
driver: jumpstarter_driver_http.HTTPDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_http.driver.HttpServer
config:
# Add required config parameters here
```

## API Reference
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-network/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-network
Example configuration:

```yaml
interfaces:
export:
network:
driver: jumpstarter_driver_network.NetworkDriver
parameters:
type: jumpstarter_driver_network.driver.TcpNetwork
config:
# Add required parameters here
```

Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-power/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-power
Example configuration:

```yaml
interfaces:
export:
power:
driver: jumpstarter_driver_power.PowerDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_power.driver.MockPower
config:
# Add required config parameters here
```

## API Reference
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-probe-rs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-probe-rs
Example configuration:

```yaml
interfaces:
export:
probe:
driver: jumpstarter_driver_probe_rs.driver.ProbeRs
parameters:
type: jumpstarter_driver_probe_rs.driver.ProbeRs
config:
probe: "2e8a:000c:5798DE5E500ACB60"
probe_rs_path: "/home/majopela/.cargo/bin/probe-rs"
chip: "RP2350"
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-pyserial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-pyserial
Example configuration:

```yaml
interfaces:
export:
serial:
driver: jumpstarter_driver_pyserial.driver.PySerial
parameters:
type: jumpstarter_driver_pyserial.driver.PySerial
config:
url: "/dev/ttyUSB0"
baudrate: 115200
```
Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-qemu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-qemu
Example configuration:

```yaml
interfaces:
export:
qemu:
driver: jumpstarter_driver_qemu.QEMUDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_qemu.driver.Qemu
config:
# Add required config parameters here
```

## API Reference
Expand Down
8 changes: 4 additions & 4 deletions packages/jumpstarter-driver-raspberrypi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ pip install jumpstarter-driver-raspberrypi
Example configuration:

```yaml
interfaces:
export:
raspberrypi:
driver: jumpstarter_driver_raspberrypi.RaspberryPiDriver
parameters:
# Add required parameters here
type: jumpstarter_driver_raspberrypi.driver.DigitalOutput
config:
# Add required config parameters here
```

## API Reference
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-shell/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-shell
Example configuration:

```yaml
interfaces:
export:
shell:
driver: jumpstarter_driver_shell.driver.Shell
parameters:
type: jumpstarter_driver_shell.driver.Shell
config:
methods:
ls: "ls"
method2: "echo 'Hello World 2'"
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-snmp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-snmp
Example configuration:

```yaml
interfaces:
export:
power:
driver: jumpstarter_driver_snmp.driver.SNMPServer
parameters:
type: jumpstarter_driver_snmp.driver.SNMPServer
config:
host: "pdu.mgmt.com"
user: "labuser"
plug: 32
Expand Down
6 changes: 3 additions & 3 deletions packages/jumpstarter-driver-tftp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ pip install jumpstarter-driver-tftp
Example configuration:

```yaml
interfaces:
export:
tftp:
driver: jumpstarter_driver_tftp.driver.Tftp
parameters:
type: jumpstarter_driver_tftp.driver.Tftp
config:
root_dir: /var/lib/tftpboot # Directory to serve files from
host: 192.168.1.100 # Host IP to bind to (optional)
port: 69 # Port to listen on (optional)
Expand Down
10 changes: 5 additions & 5 deletions packages/jumpstarter-driver-yepkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,16 @@ pip install jumpstarter-driver-yepkit
Example configuration:

```yaml
interfaces:
export:
power:
driver: jumpstarter_driver_yepkit.driver.Ykush
parameters:
type: jumpstarter_driver_yepkit.driver.Ykush
config:
serial: "YK25838"
port: "1"

power2:
driver: jumpstarter_driver_yepkit.driver.Ykush
parameters:
type: jumpstarter_driver_yepkit.driver.Ykush
config:
serial: "YK25838"
port: "2"
```
Expand Down