Skip to content

Commit

Permalink
Add zeroconf discovery to Freebox (home-assistant#47045)
Browse files Browse the repository at this point in the history
* Add zeroconf discovery to Freebox

- remove deprecated discovery
- tried with SSDP too but the presentation URL is not the same (*.fbxos.fr for zeroconf, http://mafreebox.freebox.fr/ for SSDP)
- so config entry unique_id should be the MAC (included into SSDP, but not zeroconf, can be retrieve from `fbx.system.get_config()`)
- DHCP discovery might be added in the future too

* host and port are required on zeroconf

* cleanup in other PR
  • Loading branch information
Quentame authored Feb 25, 2021
1 parent 5bba532 commit 125206a
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 17 deletions.
2 changes: 0 additions & 2 deletions homeassistant/components/discovery/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
SERVICE_DAIKIN = "daikin"
SERVICE_DLNA_DMR = "dlna_dmr"
SERVICE_ENIGMA2 = "enigma2"
SERVICE_FREEBOX = "freebox"
SERVICE_HASS_IOS_APP = "hass_ios"
SERVICE_HASSIO = "hassio"
SERVICE_HEOS = "heos"
Expand Down Expand Up @@ -67,7 +66,6 @@
SERVICE_DAIKIN,
"denonavr",
"esphome",
SERVICE_FREEBOX,
"google_cast",
SERVICE_HASS_IOS_APP,
SERVICE_HASSIO,
Expand Down
22 changes: 8 additions & 14 deletions homeassistant/components/freebox/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,20 @@


async def async_setup(hass, config):
"""Set up the Freebox component."""
conf = config.get(DOMAIN)

if conf is None:
return True

for freebox_conf in conf:
hass.async_create_task(
hass.config_entries.flow.async_init(
DOMAIN,
context={"source": SOURCE_IMPORT},
data=freebox_conf,
"""Set up the Freebox integration."""
if DOMAIN in config:
for entry_config in config[DOMAIN]:
hass.async_create_task(
hass.config_entries.flow.async_init(
DOMAIN, context={"source": SOURCE_IMPORT}, data=entry_config
)
)
)

return True


async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
"""Set up Freebox component."""
"""Set up Freebox entry."""
router = FreeboxRouter(hass, entry)
await router.setup()

Expand Down
6 changes: 6 additions & 0 deletions homeassistant/components/freebox/config_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,3 +105,9 @@ async def async_step_link(self, user_input=None):
async def async_step_import(self, user_input=None):
"""Import a config entry."""
return await self.async_step_user(user_input)

async def async_step_zeroconf(self, discovery_info: dict):
"""Initialize flow from zeroconf."""
host = discovery_info["properties"]["api_domain"]
port = discovery_info["properties"]["https_port"]
return await self.async_step_user({CONF_HOST: host, CONF_PORT: port})
32 changes: 31 additions & 1 deletion tests/components/freebox/test_config_flow.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,33 @@

from homeassistant import data_entry_flow
from homeassistant.components.freebox.const import DOMAIN
from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER
from homeassistant.config_entries import SOURCE_IMPORT, SOURCE_USER, SOURCE_ZEROCONF
from homeassistant.const import CONF_HOST, CONF_PORT

from tests.common import MockConfigEntry

HOST = "myrouter.freeboxos.fr"
PORT = 1234

MOCK_ZEROCONF_DATA = {
"host": "192.168.0.254",
"port": 80,
"hostname": "Freebox-Server.local.",
"type": "_fbx-api._tcp.local.",
"name": "Freebox Server._fbx-api._tcp.local.",
"properties": {
"api_version": "8.0",
"device_type": "FreeboxServer1,2",
"api_base_url": "/api/",
"uid": "b15ab20debb399f95001a9ca207d2777",
"https_available": "1",
"https_port": f"{PORT}",
"box_model": "fbxgw-r2/full",
"box_model_name": "Freebox Server (r2)",
"api_domain": HOST,
},
}


@pytest.fixture(name="connect")
def mock_controller_connect():
Expand Down Expand Up @@ -66,6 +85,17 @@ async def test_import(hass):
assert result["step_id"] == "link"


async def test_zeroconf(hass):
"""Test zeroconf step."""
result = await hass.config_entries.flow.async_init(
DOMAIN,
context={"source": SOURCE_ZEROCONF},
data=MOCK_ZEROCONF_DATA,
)
assert result["type"] == data_entry_flow.RESULT_TYPE_FORM
assert result["step_id"] == "link"


async def test_link(hass, connect):
"""Test linking."""
result = await hass.config_entries.flow.async_init(
Expand Down

0 comments on commit 125206a

Please sign in to comment.