OPNsense

OPNsense is an open source FreeBSD based firewall and routing platform. There is currently support for the following device types within Home Assistant:

Configuration

To add the OPNsense hub to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select OPNsense.

  • Follow the instructions on screen to complete the setup.

URL

The full URL for the router API. For example, https://router.local:443/api

API key

The API key.

API secret

The secret that pairs with your API key and is required for authentication.

Verify SSL

Whether to verify the router’s SSL certificate. Keep this enabled unless your router uses a self-signed certificate in a trusted environment. Disabling certificate verification reduces security, because Home Assistant can no longer confirm that it is connecting to the correct router.

Tracker interfaces

Optionally restrict the interfaces used for device scanning.

The API key and API secret values are acquired from your OPNsense router using the web interface. For more information on this procedure, refer to the OPNsense documentation.

The API user requires the following privileges:

  • GUI Name: Diagnostics: ARP Table
  • GUI Name: Status: Interfaces
  • GUI Name: System: Firmware

Presence detection

This platform allows you to detect presence by looking at devices connected to an OPNsense router.