Configuration
4 minute read
Adding the Integration
After installing the plugin, add the integration to Home Assistant:
- Go to Settings > Devices & Services
- Click + Add Integration (bottom right)
- Search for Exaviz
- Select Exaviz PoE
- The integration will automatically detect your board type and PoE hardware
- Click Submit to complete setup
The integration requires no manual configuration. It automatically detects:
- Board type (Cruiser or Interceptor)
- Compute module (Raspberry Pi CM4, CM5, etc.)
- PoE controller and available ports
- Installed Exaviz packages and versions
Entities Created
The integration creates several entity types for monitoring and controlling your PoE ports. All entities are grouped under a single device named after your board (e.g., “Exaviz Cruiser” or “Exaviz Interceptor”).
Board-Level Entities
These entities provide overall board status and system information.
| Entity | Type | Description |
|---|---|---|
sensor.board_status | Sensor | Board operational status with detailed attributes |
sensor.board_temperature | Sensor | SoC temperature in degrees Celsius |
The sensor.board_status entity carries many attributes. See
Board Status Attributes below for the full list.
Per-Port Entities
For each PoE port, the integration creates the following entities. The entity ID prefix depends on the board type and PoE set:
| Board Setup | Entity Prefix | Example |
|---|---|---|
| Cruiser (built-in) | onboard | switch.onboard_port0 |
| Interceptor (first PoE board) | addon_0 | switch.addon_0_port0 |
| Interceptor (second PoE board) | addon_1 | switch.addon_1_port0 |
| Cruiser (add-on board) | addon_0 | switch.addon_0_port0 |
For each port, the integration creates these entities (shown with the onboard
prefix as an example – substitute addon_0 or addon_1 for your board):
| Entity Pattern | Type | Description |
|---|---|---|
sensor.{prefix}_portN_current | Sensor | Power consumption in watts |
switch.{prefix}_portN | Switch | Enable or disable PoE power |
binary_sensor.{prefix}_portN_powered | Binary Sensor | Whether the port is delivering power |
binary_sensor.{prefix}_portN_plug | Binary Sensor | Whether a device is detected |
button.{prefix}_portN_reset | Button | Power-cycle the port (disable then re-enable) |
Where {prefix} is the PoE set name (onboard, addon_0, or addon_1) and
N is the port number (0-7).
Example for an 8-port board:
The integration creates 5 entities per port, plus 2 board-level entities, for a total of 42 entities on an 8-port system. A dual-board Interceptor (16 ports) creates 82 entities.
Per-Port Sensor Attributes
Each port’s current sensor (e.g., sensor.onboard_port0_current or
sensor.addon_0_port0_current) includes these attributes:
| Attribute | Description | Example |
|---|---|---|
status | Port PoE status | active, empty, disabled, fault |
enabled | Whether the port is administratively enabled | true / false |
power_watts | Current power draw in watts | 5.2 |
power_allocated_watts | Maximum allocated power | 15.4 |
voltage | Port voltage | 48.0 |
current_ma | Current in milliamps | 108 |
device_manufacturer | Detected device manufacturer (if available) | Bosch |
device_mac | MAC address of connected device | 00:07:5F:01:23:45 |
poe_class | PoE class of connected device | Class 3 |
Board Status Attributes
The sensor.board_status entity provides comprehensive system information as
attributes. Available attributes vary by board type.
Common Attributes (All Boards)
| Attribute | Description | Example |
|---|---|---|
board_model_esp32 | Exaviz board name | Cruiser, Interceptor |
compute_module | Compute module type | Raspberry Pi CM5, Raspberry Pi CM4, Banana Pi CM4 |
cm_model | Full CM model number | CM4102000, CM5108032 |
total_ram_gb | Total RAM (nearest standard tier) | 2 GB, 4 GB, 8 GB |
has_wifi | WiFi/Bluetooth present | Yes, No |
emmc_storage | eMMC storage size | 32 GB, None (Lite) |
os_version | Operating system version | Debian GNU/Linux 13 (trixie) |
kernel_version | Linux kernel version | 6.12.19-v8 |
poe_controller | PoE controller chip | TPS23861 (Texas Instruments) |
netplan_version | Exaviz Netplan package version | 1.0.14+e755185 |
total_poe_ports | Total number of PoE ports | 8 |
total_enabled_ports | Number of enabled ports | 8 |
total_power_watts | Total power draw across all ports | 42.5 |
Need RAM or CPU monitoring? Home Assistant’s System Monitor integration provides real-time memory, CPU, and disk usage sensors. The Exaviz plugin reports hardware identity (model, RAM tier, WiFi, eMMC) but does not duplicate live system monitoring that HA already supports.
Cruiser-Only Attributes
These attributes are available on Cruiser boards with ESP32 firmware:
| Attribute | Description | Example |
|---|---|---|
board_hw_version | Board hardware revision | 1.0 |
board_serial | Board serial number | EXA-CRU-00123 |
esp32_firmware_version | ESP32 firmware version | 1.0.2+21230d7 |
dkms_driver_version | Exaviz DKMS driver version | 1.0.4 |
Interceptor-Only Attributes
These attributes are available on Interceptor boards:
| Attribute | Description | Example |
|---|---|---|
poe_driver_version | Kernel PoE driver version | 2.0 |
board_identifier | Device tree board identifier | interceptor-raspberrypi-cm4 |
Auto-Detection
The integration uses several sources to detect your hardware:
| Information | Source | Notes |
|---|---|---|
| Board type | /proc/device-tree/chosen/board, device tree overlays | Cruiser or Interceptor |
| Compute module | /proc/device-tree/compatible | CM4, CM5, BPi CM4 |
| PoE status | /proc/pse or /dev/pse | Board-dependent |
| Temperature | /sys/class/thermal/thermal_zone0/temp | SoC temperature |
| OS version | /etc/os-release | Debian version |
| Packages | dpkg-query | Installed Exaviz packages |
No manual configuration of board type, port count, or hardware details is needed.
Data Update Interval
The integration polls PoE port status every 10 seconds by default. Board-level system information (OS version, firmware, etc.) is gathered once at startup and does not change during operation.
Next Steps
- Dashboard – Set up monitoring and control cards
- Troubleshooting – If entities aren’t appearing as expected
- FAQ – Common questions about the integration
Last modified February 25, 2026