Hardware-in-Loop¶

rio hwil¶

Manage Hardware-in-the-Loop (HWIL) devices.

Hardware-in-the-Loop (HWIL) devices are virtual devices that can be used to test devices on rapyuta.io. The set of commands provide a convenient way to manage these devices and access them.

rio hwil [OPTIONS] COMMAND [ARGS]...

create¶

Create a new hardware-in-the-loop device.

You can specify the parameters to create the kind of device you want using the –arch, –os and the –codename flags.

The –arch defines the architecture of the device, which can be either amd64 or arm64.

The –os defines the type of the OS, which can be either debian or ubuntu.

The –codename defines the code name of the OS, which can be either bionic, focal, jammy or bullseye.

Usage Example:

Create a new device with the name ‘my-device’ and the default

$ rio hwil create my-device

Create a new device with the name ‘my-device’ and custom parameters for example, arm64 architecture, debian OS and bullseye codename.

$ rio hwil create my-device –arch arm64 –os debian –codename bullseye

Note: All combinations of the –arch, –os and –codename flags may not always work. Please contact io-support for more information.

rio hwil create [OPTIONS] DEVICE_NAME

Options

--arch <arch>¶

Device architecture

Options:: amd64 | arm64

--os <os>¶

Type of the OS

Options:: debian | ubuntu

--codename <codename>¶

Code name of the OS

Options:: bionic | focal | jammy | noble | bullseye

--expire-after <expire_after>¶: Duration after which the device will expire. Example: 12h, 1d, 600s, 10m

Arguments

DEVICE_NAME¶: Required argument

delete¶

Delete one or more devices.

You can specify the device names to delete using the device names as arguments. If you want to delete multiple devices, you can specify multiple device names separated by spaces.

You can skip confirmation by using the --force or -f or the --silent flag.

Usage Examples:

Delete a single device by name

$ rio hwil delete my-device

Delete multiple devices by name

$ rio hwil delete my-device1 my-device2 my-device3

rio hwil delete [OPTIONS] [DEVICES]...

Options

-f, --force, --silent¶: Skip confirmation

Arguments

DEVICES¶: Optional argument(s)

execute¶

Execute a command on a hardware-in-the-loop device.

Ensure that you wrap the command in quotes to avoid any issues.

rio hwil execute [OPTIONS] DEVICE_NAME COMMAND

Arguments

DEVICE_NAME¶: Required argument

COMMAND¶: Required argument

inspect¶

Print the details of a hardware-in-the-loop device.

rio hwil inspect [OPTIONS] DEVICE_NAME

Options

-f, --format <format_type>¶

Options:: json | yaml

Arguments

DEVICE_NAME¶: Required argument

list¶

Lists hardware-in-loop devices.

rio hwil list [OPTIONS]

login¶

Authenticate with HWIL API.

This is mandatory to use the HWIL commands and also to create virtual devices with the device manifest.

You can choose to login non-interactively by providing –username and –password flags or interactively by not providing any flags.

rio hwil login [OPTIONS]

Options

--username <username>¶: Username for HWIL API

--password <password>¶: Password for HWIL API

--interactive, --interactive, --no-interactive, --silent¶: Make login interactive

ssh¶

SSH into a hardware-in-the-loop device.

This command acts as a wrapper on top of the ssh command. It fetches the static IP address of the device and logs you in using the username configured for the device at the time of its creation. You will be prompted for the password which is also presented to you on the terminal.

rio hwil ssh [OPTIONS] DEVICE_NAME

Arguments

DEVICE_NAME¶: Required argument