# LAA cli (aka. laacli)

laacli is a command line application, running on the LAA, allowing to control
the LAA hardware.

```shell
$ laacli --help
Linaro Automation Appliance CLI

Usage: laacli <COMMAND>

Commands:
  button   Virtual buttons
  led      User LED
  power    Power rails
  rev      LAA Revision
  temp     Query temperature (°C)
  usb      USB Hub
  usbg-ms  USB Gadet Mass storage
  watt     Power consumption
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version
```

## Commands

### button

Control the virtual buttons via the
[optocouplers](/hardware/sib-header.md#optocouplers).

```shell
$ laacli button --help
Virtual buttons

Usage: laacli button <BUTTON> <STATE>

Arguments:
  <BUTTON>  Virtual button [possible values: 1, 2, power, reset]
  <STATE>   Desired state [possible values: on, off]
```

### led

Control the color of the user led.

```shell
$ laacli led --help
User LED

Usage: laacli led <COLOR>

Arguments:
  <COLOR>  Desired color [possible values: green, off, yellow]
```

### power

Control the state of the different [power rails](/hardware/sib-header.md#power-rails).

```shell
$ laacli power --help
Power rails

Usage: laacli power <VBUS> <STATE>

Arguments:
  <VBUS>   VBus rail [possible values: 1v8, 3v3, 5v, 12v]
  <STATE>  Desired state [possible values: on, off, reset]
```

### rev

Print the [LAA hardware revision](/hardware/revisions.md).

```shell
$ laacli rev
LAA rev 1.01
```

### temp

Print the [thermal probe values](/hardware/peripherals.md#thermal-probes).

```shell
$ laacli temp --help
Query temperature (in °C)

Usage: laacli temp <PROBE>

Arguments:
  <PROBE>  Probe name [possible values: amb, dut, sys]
```

### usb

Control the [DUT USB ports](/hardware/peripherals.md#dut-usb) state.

```shell
$ laacli usb --help
USB Hub

Usage: laacli usb <PORT> <STATE>

Arguments:
  <PORT>   USB port
  <STATE>  Desired state [possible values: on, off, reset, start]
```

### usbg-ms

Control the [USB OTG port](/hardware/peripherals.md#laa-usb) to act as a USB mass storage device using USB gadget mode (USB mass storage emulation).

```shell
$ laacli usbg-ms --help
USB Gadget Mass storage emulation

Usage: laacli usbg-ms <STATE> [FILENAME]

Arguments:
  <STATE>     Desired state [possible values: on, off, status]
  [FILENAME]  filename [default: ]
```

```{admonition} Calling On or Off twice
:class: tip
If you call `laacli usbg-ms on <FILE>` or `laacli usbg-ms off` twice in a
row, the second call will fail and return 1.

This is expected, using `laacli usbg-ms status` will print the current state
(`On` or `Off`).
```

### watt

Print the [instant power
consuption](/hardware/sib-header.md#power-rails-power) of the power rails.

```shell
$ laacli watt --help
Power consumption

Usage: laacli watt <VBUS>

Arguments:
  <VBUS>  VBus rail [possible values: 1v8, 3v3, 5v, 12v]
```

laacli will return:

```shell
$ laacli watt 5v
4.968V
0.433A
2.14344W
```