home-assistant.io/source/_integrations/opnsense.markdown

title, description, logo, ha_category, ha_release, ha_codeowners

title	description	logo	ha_category	ha_release	ha_codeowners
OPNSense	Instructions on how to configure OPNsense integration	opnsense.png	Hub Presence Detection	0.105	@mtreinish

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

• Presence Detection

Configuration

To configure OPNsense integration with Home Assistant add the following section to your configuration.yaml:

opnsense:
  url: http://router/api
  api_secret: API_SECRET
  api_key: API_KEY

Where 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.

{% configuration %} url: description: The URL for the OPNsense API endpoint of your router. type: string required: true api_key: description: The API key used to authenticate with your OPNsense API endpoint. type: string required: true api_secret: description: The API secret used to authenticate with your OPNsense API endpoint. type: string required: true verify_ssl: description: Set to true to enable the validation of the OPNsense API SSL. type: boolean required: false default: false tracker_interfaces: description: List of the OPNsense router's interfaces to use for tracking devices. type: list required: false default: [] {% endconfiguration %}

Presence detection

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