diff --git a/__templates__/create_driver.sh b/__templates__/create_driver.sh index 4c399d70c..a9bb28753 100755 --- a/__templates__/create_driver.sh +++ b/__templates__/create_driver.sh @@ -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 diff --git a/packages/jumpstarter-driver-can/README.md b/packages/jumpstarter-driver-can/README.md index 571fdcfdd..4d48582ac 100644 --- a/packages/jumpstarter-driver-can/README.md +++ b/packages/jumpstarter-driver-can/README.md @@ -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 diff --git a/packages/jumpstarter-driver-composite/README.md b/packages/jumpstarter-driver-composite/README.md index 8b8344e69..f00c44aac 100644 --- a/packages/jumpstarter-driver-composite/README.md +++ b/packages/jumpstarter-driver-composite/README.md @@ -1 +1,25 @@ -# Jumpstarter Composite Driver \ No newline at end of file +# 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. diff --git a/packages/jumpstarter-driver-corellium/README.md b/packages/jumpstarter-driver-corellium/README.md index 0303b325d..fb72879f2 100644 --- a/packages/jumpstarter-driver-corellium/README.md +++ b/packages/jumpstarter-driver-corellium/README.md @@ -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" diff --git a/packages/jumpstarter-driver-dutlink/README.md b/packages/jumpstarter-driver-dutlink/README.md index a8cd77c0e..7c28cdffe 100644 --- a/packages/jumpstarter-driver-dutlink/README.md +++ b/packages/jumpstarter-driver-dutlink/README.md @@ -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 diff --git a/packages/jumpstarter-driver-http/README.md b/packages/jumpstarter-driver-http/README.md index 4a05aa647..78b5221fb 100644 --- a/packages/jumpstarter-driver-http/README.md +++ b/packages/jumpstarter-driver-http/README.md @@ -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 diff --git a/packages/jumpstarter-driver-network/README.md b/packages/jumpstarter-driver-network/README.md index a138f832b..ce972ce92 100644 --- a/packages/jumpstarter-driver-network/README.md +++ b/packages/jumpstarter-driver-network/README.md @@ -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 ``` diff --git a/packages/jumpstarter-driver-power/README.md b/packages/jumpstarter-driver-power/README.md index 1b440dbb5..4cad4211f 100644 --- a/packages/jumpstarter-driver-power/README.md +++ b/packages/jumpstarter-driver-power/README.md @@ -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 diff --git a/packages/jumpstarter-driver-probe-rs/README.md b/packages/jumpstarter-driver-probe-rs/README.md index 00fc5acfb..fa0e6a6b5 100644 --- a/packages/jumpstarter-driver-probe-rs/README.md +++ b/packages/jumpstarter-driver-probe-rs/README.md @@ -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" diff --git a/packages/jumpstarter-driver-pyserial/README.md b/packages/jumpstarter-driver-pyserial/README.md index 42ea3adbd..1ea378aad 100644 --- a/packages/jumpstarter-driver-pyserial/README.md +++ b/packages/jumpstarter-driver-pyserial/README.md @@ -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 ``` diff --git a/packages/jumpstarter-driver-qemu/README.md b/packages/jumpstarter-driver-qemu/README.md index dce106570..388ff1823 100644 --- a/packages/jumpstarter-driver-qemu/README.md +++ b/packages/jumpstarter-driver-qemu/README.md @@ -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 diff --git a/packages/jumpstarter-driver-raspberrypi/README.md b/packages/jumpstarter-driver-raspberrypi/README.md index 185d0faf2..fa47ba740 100644 --- a/packages/jumpstarter-driver-raspberrypi/README.md +++ b/packages/jumpstarter-driver-raspberrypi/README.md @@ -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 diff --git a/packages/jumpstarter-driver-shell/README.md b/packages/jumpstarter-driver-shell/README.md index 827add1de..eab6a067f 100644 --- a/packages/jumpstarter-driver-shell/README.md +++ b/packages/jumpstarter-driver-shell/README.md @@ -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'" diff --git a/packages/jumpstarter-driver-snmp/README.md b/packages/jumpstarter-driver-snmp/README.md index 71756d5c6..c7b72d605 100644 --- a/packages/jumpstarter-driver-snmp/README.md +++ b/packages/jumpstarter-driver-snmp/README.md @@ -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 diff --git a/packages/jumpstarter-driver-tftp/README.md b/packages/jumpstarter-driver-tftp/README.md index 9dd891a3a..3728e5e29 100644 --- a/packages/jumpstarter-driver-tftp/README.md +++ b/packages/jumpstarter-driver-tftp/README.md @@ -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) diff --git a/packages/jumpstarter-driver-yepkit/README.md b/packages/jumpstarter-driver-yepkit/README.md index d23b9c9de..fdc2c9ca2 100644 --- a/packages/jumpstarter-driver-yepkit/README.md +++ b/packages/jumpstarter-driver-yepkit/README.md @@ -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" ```