# USB Relay

<!-- BEGIN GENERATED: __badges_usbrelay__ -->
<span class="badge stable">STABLE</span> <span class="badge origin-nymea">NYMEA</span> <span class="badge consumer">CONSUMER</span>

Control relays connected over USB.

<!-- END GENERATED -->

_Installation guide coming soon._

## Reference

<!-- BEGIN GENERATED: integrationpluginusbrelay.json -->
!!! info "Application labels"
    The keys and labels below are the ones the application shows,
    **in English**. They are left verbatim so that you find them
    word for word on screen.

**Manufacturer:** USB Relay  
**Plugin:** `UsbRelay`

#### Supported models
| Model | Role | Transport | Pairing | Quantities |
| --- | --- | --- | --- | --- |
| **USB Relay Connector** | gateway | — | Discovery | 1 |
| **USB Relay** | power | — | Auto | 2 |

#### Per-model detail
??? abstract "USB Relay Connector — `usbRelayConnector`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `path` | System path | QString | — | — | no |
    | `relayCount` | Relay count | uint | — | `2` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |

??? abstract "USB Relay — `usbRelay`"
    _Settings:_

    | Key | Label | Type | Range | Default | Read-only |
    | --- | --- | --- | --- | --- | --- |
    | `relayNumber` | Relay number | uint | — | `1` | no |

    _Measured quantities:_

    | Key | Quantity | Type | Unit |
    | --- | --- | --- | --- |
    | `connected` | Connected | bool | — |
    | `power` | Power | bool | — |

<!-- END GENERATED -->