homeassistant.components.opnsense Namespace Reference

Namespaces
	device_tracker

Functions
bool	setup (HomeAssistant hass, ConfigType config)

Variables
	_LOGGER = logging.getLogger(__name__)
string	CONF_API_SECRET = "api_secret"
string	CONF_TRACKER_INTERFACE = "tracker_interfaces"
	CONFIG_SCHEMA
string	DOMAIN = "opnsense"
string	OPNSENSE_DATA = DOMAIN

Detailed Description

Support for OPNSense Routers.

Function Documentation

setup()

bool homeassistant.components.opnsense.setup	(	HomeAssistant	hass,
		ConfigType	config
	)

Set up the opnsense component.

Definition at line 42 of file __init__.py.

Variable Documentation

_LOGGER

homeassistant.components.opnsense._LOGGER = logging.getLogger(__name__)

private

Definition at line 15 of file __init__.py.

CONF_API_SECRET

string homeassistant.components.opnsense.CONF_API_SECRET = "api_secret"

Definition at line 17 of file __init__.py.

CONF_TRACKER_INTERFACE

string homeassistant.components.opnsense.CONF_TRACKER_INTERFACE = "tracker_interfaces"

Definition at line 18 of file __init__.py.

CONFIG_SCHEMA

homeassistant.components.opnsense.CONFIG_SCHEMA

Initial value:

=  vol.Schema(
    {
        DOMAIN: vol.Schema(
            {
                vol.Required(CONF_URL): cv.url,
                vol.Required(CONF_API_KEY): cv.string,
                vol.Required(CONF_API_SECRET): cv.string,
                vol.Optional(CONF_VERIFY_SSL, default=False): cv.boolean,
                vol.Optional(CONF_TRACKER_INTERFACE, default=[]): vol.All(
                    cv.ensure_list, [cv.string]
                ),
            }
        )
    },
    extra=vol.ALLOW_EXTRA,
)

Definition at line 24 of file __init__.py.

DOMAIN

string homeassistant.components.opnsense.DOMAIN = "opnsense"

Definition at line 20 of file __init__.py.

OPNSENSE_DATA

string homeassistant.components.opnsense.OPNSENSE_DATA = DOMAIN

Definition at line 22 of file __init__.py.