Devices
← Manual
The Devices section provides a unified view of all physical and virtual devices integrated into YachtAware. Operators can browse devices, inspect technical properties, manage notes, and configure per-device alarm trigger behaviour.
Page Structure
The section uses three tabs:
┌──────────────────────────────────────┐
│ [ Devices ] [ Device Notes ] [ Device Alarms ] ← Tab bar
├──────────────────────────────────────┤
│ Tab content │
└──────────────────────────────────────┘
Tab 1: Devices (/devices/devices)
┌──────────────────────────────┬──────────────────────┐
│ Device List (virtualised) │ Device Detail Panel │
│ - Type filter │ (shown when selected)│
│ - Search filter │ │
└──────────────────────────────┴──────────────────────┘
Device List
The list is virtualised for performance. A type filter dropdown lets you narrow the list by device category (camera, door, motion sensor, etc.). A text search field filters by device name.
Note: Internal device types (
server,presence-tracker,alarm,intercom-operator) are hidden from this list.
Device Availability (Online / Offline)
Devices that are offline or unreachable are greyed out - in this list and on Layout maps. This is a generic availability indicator used for every device type: cameras, doors, readers, motion sensors, panic buttons, intercom terminals and IO boards.
A device is shown as available only when all of the following are true:
| Condition | What it looks like when it fails |
|---|---|
| The device itself is reporting as connected | That one device is greyed out |
| Its controller is connected - when a device is controlled by another device (for example a door on an access control unit) | Every device under that controller is greyed out |
| Its integration (provider) is running | Every device from that integration is greyed out |
| The application is connected to the backend | Everything is greyed out, and an Offline chip appears next to the logo in the app bar |
Because one indicator covers all four cases, the pattern of what is greyed out tells you where the fault is. See Device - Greyed Out or Unavailable for the diagnostic steps.
Device Detail Panel
Selecting a device opens a right-side detail panel at /devices/devices/:id.
| Property | Editable | Notes |
|---|---|---|
| Name | ✅ | Custom display name (edit opens a dialog) |
| Provider Assigned Name | ❌ | Name reported by the integration |
| Aware ID | ❌ | Internal UUID |
| Device Type | ❌ | e.g. camera, door |
| Provider | ❌ | Integration source (e.g. aware-vms) |
| Provider ID | ❌ | Foreign reference ID |
| Notes | ✅ | Free-text notes field |
Dialogs (Devices Tab)
| Dialog | Trigger | Fields |
|---|---|---|
| Edit Device Name | Edit (✏) next to Name | Device name text |
| Edit Device Notes | Edit (✏) next to Notes | Notes textarea |
Tab 2: Device Notes (/devices/device-notes)
A management view for reviewing and editing notes across all devices at once.
┌───────────────────────────────┐
│ [ All Devices toggle ] │
│ Device List (filtered) │
│ - Type filter │
│ - Search filter │
│ - Per-device "Edit" button │
└───────────────────────────────┘
Toggle All Devices to switch between:
- Off (default): only devices that already have notes
- On: all devices including those without notes
Clicking the Edit button on any row opens the Edit Device Notes dialog for that device.
Tab 3: Device Alarms (/devices/device-alarms)
The Alarm Matrix maps every device (rows) against every possible event type (columns). Each cell indicates whether that device × event combination will trigger an alarm and what the configured behaviour is.
┌──────────────┬───────┬───────┬───────┐
│ Device Name │ Evt 1 │ Evt 2 │ Evt 3 │ ← Rotated column headers
├──────────────┼───────┼───────┼───────┤
│ Camera A │ 🔔 │ │ 🔔 │
│ Door B │ │ 🔔 │ │
└──────────────┴───────┴───────┴───────┘
Clicking any cell opens the Device Alarm Settings dialog where you configure the alarm behaviour for that device × event pair.
The three alarm behaviour options are explained in detail in the Alarms section of the Product Documentation.
Note: Some device types and event types are excluded from the matrix (e.g. displays, NVR recorders, and analytics event kinds like object-detection-updated).
Actions & Permissions
| Action | Permission |
|---|---|
| View Devices tab | /devices/devices route |
| View Device Notes tab | /devices/device-notes route |
| View Device Alarms tab | /devices/device-alarms route |
| Edit device name | Device update permission |
| Edit device notes | Device update permission |
| Configure alarm triggers | Alarm configuration permission |
Empty & Error States
| State | Display |
|---|---|
| Device not found | “Device not found” in detail panel |
| Device loading | Spinner |
| No notes (default filter) | Empty list — toggle “All Devices” to see all |