agentCfg - Configure Agent

Added in version pltOS: v2.0

To facilitate SBC interaction during production, include an x86-64 PC or an additional SBC in the test fixture.

The agent is usually a Test Agent: an SBC running agentOS. See that page for more information on working with a test: its console session, file transfer to /run/pltagent/mnt, and the tools it ships with.

Interaction is configured based on how the agent is attached. The command auto-detects the connection type from the attached USB device (or from the identifier format given in id:) and configures it accordingly:

  • USB-CDC: Configures the UART (USB-CDC, 1,000,000 baud 8N1) for an SBC running an agentOS image (for example, a PLT Test Agent), then starts a console session and optionally transfers files to its RAMDISK over USB Mass Storage.

  • USB-NET or Ethernet: Derives an IPv6 link-local address from the agent’s MAC address (or uses an IPv4/IPv6 address given directly) and configures a PLT agent session over the link-local network, optionally transferring files.

If <handle> has not been configured yet, the first call to agentCfg creates it, resolving the USB device or network address described by id:/path:/interface:. A later agentCfg on the same handle reuses the existing agent; the UART port cannot be changed on an already-configured handle.

Usage:

- command: agentCfg <handle> [<uartPort>]
  [retry: <retryCount>]
  [id: <agentID>]
  [path: <usbDevicePath>]
  [interface: <usbDeviceInterface>]
  [extractKey: <key>]
  [with:
    [- <fileName>]
    ...]

Argument

Description

handle

Name you choose for this agent. Later commands (for example agentExec) use it to refer to the agent. Any name works, as long as it has no ., /, : or whitespace. Samples use descriptive names such as PROGSBC or CAMSBC.

uartPort

Optional: UART port to use, for example UART2. Defaults to the port already assigned to handle, or to the port auto-detected for a USB-CDC agent.

retryCount

Optional: Number of times to retry the test step

fileName

Optional: Name of file to write to the SBC. Files are placed on the agent’s RAMDISK, at /run/pltagent/mnt/<fileName> on the agent; use this path in future agentExec commands.

key

Optional: Key in which to store the UART port

agentID

Optional: Identifies the agent. Accepts a prefixed form or a bare legacy form (see below). Defaults to 6666:8001 (USB VID:PID) when omitted.

usbDevicePath

Optional: USB device path: port. … .port.

usbDeviceInterface

Optional: USB device interface: interface_number.

Agent ID formats

id: accepts either an explicit, prefixed form or a bare legacy form that is inferred heuristically. Prefixed forms are preferred, since the legacy heuristics can be ambiguous:

Form

Example / meaning

ip4:<address>

ip4:192.168.1.100

ip6:<address>

ip6:fe80::1

mac:<address>

mac:AA:BB:CC:DD:EE:FF — resolved to an IPv6 link-local address for USB-NET/Ethernet agents

vid:<VVVV>:<PPPP>

vid:6666:8001 — USB device selected by VID:PID

vid:<VVVV>:<PPPP>:mac:<address>

USB-Ethernet adapter selected by VID:PID, with its MAC validated against <address>

usb:<path>

usb:1.2.3 — equivalent to using path:

usb:<path>:mac:<address>

USB-Ethernet adapter selected by path, with its MAC validated against <address>

(bare) VVVV:PPPP

6666:8001 — heuristically detected as VID:PID

(bare) XX:XX:XX:XX:XX:XX

heuristically detected as a MAC address

(bare) dotted decimal

heuristically detected as an IPv4 address

(bare) containing :: or 7+ colons

heuristically detected as an IPv6 address

If id: cannot be parsed by any of the above, agentCfg falls back to treating it as a legacy raw USB device identifier.

PLT-200A / legacy id: forms

Note

These bare id: forms are the older way of identifying an agent, used on a PLT-200A and by test plans written before the prefixed Agent ID formats above were added. They are still parsed heuristically (see the (bare) rows in that table) and continue to work on a PLT-200A, but new test plans should prefer the prefixed vid:/mac: forms, since the bare heuristics can be ambiguous.

- command: agentCfg <handle> [<uartPort>]
  [retry: <retryCount>]
  [id: <usbDeviceID | macAddress>]
  [path: <usbDevicePath>]
  [extractKey: <key>]
  [with:
    [- <fileName>]
    ...]

Argument

Description

usbDeviceID

Optional: USB device identifiers: VID:PID.

macAddress

Optional: Ethernet MAC address: XX:XX:XX:XX:XX:XX.

Important

For Ethernet-based control, the PLT agent package must be installed on the Agent PC.

Examples

References

See also