Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions source/_integrations/opnsense.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: "OPNsense"
description: "Instructions on how to configure OPNsense integration"
logo: opnsense.png
ha_category:
- Hub
- Presence Detection
ha_release: "0.106"
---

[OPNsense](https://opnsense.org/) is an open source HardenedBSD based firewall
and routing platform. There is currently support for the following device types
within Home Assistant:

- [Presence Detection](#presence-detection)

## Configuration

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

```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](https://docs.opnsense.org/development/how-tos/api.html#creating-keys).

{% 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's 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.
Binary file added source/images/supported_brands/opnsense.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.