usb - USB Interaction¶

Interact with the USB interface of the DUT. USB Devices can be specified by id (VID:PID) or path. See USB Interaction for more details.

usb detect - USB Device Detection¶

Checks whether the specific USB device has been detected and enumerated by PLT.

Usage:

- command: usb detect
  [id: <usb_device_id>]
  [path: <usb_device_path>]
  [retry: <retryCount>]

Argument	Description
usb_device_id	Optional: USB device identifiers: `VID:PID`.
usb_device_path	Optional: USB device path: `port. ... .port`.
retryCount	Optional: Number of times to retry the test step.

Note

If neither usb_device_id or usb_device_path is set, path: “1” (The DUT USB-C Port) is used.

usb power - USB Port Power Control¶

Control USB port power.

Note

Turning off port power effectively disables the port. Even devices that don’t require power through the port will not work when port power is off.

Note

Port power can only be controlled if the port is on a hub (like the internal hubs in PLT-300A) that support power control. List of known compatible hubs.

Usage:

- command: usb power on|off
  [path: <usb_device_path>]
  [retry: <retryCount>]

Argument	Description
`on`	Enable port and turn on port power.
`off`	Disable port and turn off port power.
usb_device_path	Optional: USB device path: `port. ... .port`.
retryCount	Optional: Number of times to retry the test step.

Note

If neither usb_device_id or usb_device_path is set, path: “1” (The DUT USB-C Port) is used.

usb reset - USB Reset¶

Usage:

- command: usb reset
  [id: <usb_device_id>]
  [path: <usb_device_path>]
  [retry: <retryCount>]

Argument	Description
retryCount	Optional: Number of times to retry the test step.

Note

If neither usb_device_id or usb_device_path is set, path: “1” (The DUT USB-C Port) is used.

usb storage - USB Storage¶

Interact with USB Mass Storage Devices

usb storage mount - Mount USB Mass Storage Device¶

Mount a USB Mass Storage Device’s filesystem.

Usage:

- command: usb storage mount <handle>
  [id: <usb_device_id>]
  [path: <usb_device_path>]
  [retry: <retryCount>]

Argument	Description
handle	Used to refer to this device in further commands.
usb_device_id	Optional: USB device identifiers: `VID:PID`.
usb_device_path	Optional: USB device path: `port. ... .port`.
retryCount	Optional: Number of times to retry the test step.

Note

If neither usb_device_id or usb_device_path is set, path: “1” (The DUT USB-C Port) is used.

usb storage unmount - Unmount USB Mass Storage Device¶

Unmount a previously mounted USB Mass Storage filesystem.

Usage:

- command: usb storage unmount <handle>
  [retry: <retryCount>]

Argument	Description
handle	Handle of previously mounted USB Mass Storage device.
retryCount	Optional: Number of times to retry the test step.

usb storage write - Write to a USB Mass Storage Device¶

Write a file to a previously mounted USB Mass Storage Device.

Usage:

- command: usb storage write <handle> <file_name> [<file_path>] [decompress]
  [retry: <retryCount>]

Argument	Description
handle	Handle of previously mounted USB Mass Storage device.
file_name	Name of file to write to device.
file_path	Optional: Destination path in device filesystem. Default is `/`.
decompress	Optional: If this flag is set, the file will be decompressed to the destination instead of copied.
retryCount	Optional: Number of times to retry the test step.

Examples

USB Interaction