Create a new Config Flow with Stations List (#14)

* Create a new Config Flow with Stations List

Author: netsoft-ruidias

custom_components/precoscombustiveis/__init__.py

@@ -10,7 +10,7 @@
 from .dgeg import DGEG
 from .const import DOMAIN
 
-__version__ = "1.1.0"
+__version__ = "2.0.0"
 _LOGGER = logging.getLogger(__name__)
 
 PLATFORMS: list[str] = ["sensor"]
@@ -37,21 +37,6 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry):
     return True
 
 
-# async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry):
-#     """Unload a config entry."""
-#     unload_ok = await hass.config_entries.async_forward_entry_unload(
-#         entry, DOMAIN)
-
-#     if unload_ok:
-#         for unsub in hass.data[DOMAIN].listeners:
-#             unsub()
-#         hass.data.pop(DOMAIN)
-
-#         return True
-
-#     return False
-
-
 async def async_reload_entry(hass: HomeAssistant, entry: ConfigEntry) -> None:
     """Reload config entry."""
     # await async_unload_entry(hass, entry)

custom_components/precoscombustiveis/config_flow.py

@@ -1,15 +1,25 @@
 """Config flow for PrecosCombustiveis integration."""
 from __future__ import annotations
+from typing import Any, Dict, Optional
+import voluptuous as vol
 
 import logging
-import voluptuous as vol
 import async_timeout
 
 from homeassistant import config_entries
+from homeassistant.core import callback
+from homeassistant.data_entry_flow import FlowResult
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 
+from .const import (
+    DOMAIN,
+    CONF_STATIONID,
+    CONF_STATION_NAME,
+    CONF_STATION_BRAND,
+    CONF_STATION_ADDRESS,
+    DISTRITOS
+)
 from .dgeg import DGEG
-from .const import DOMAIN, CONF_STATIONID
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -26,34 +36,99 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
     VERSION = 1
     CONNECTION_CLASS = config_entries.CONN_CLASS_CLOUD_POLL
 
-    async def async_step_user(self, user_input=None):
-        """Handle a flow initialized by the user interface."""
-        _LOGGER.debug("Starting async_step_user...")
-        errors = {}
-
-        if user_input is not None:
-            await self.async_set_unique_id(user_input[CONF_STATIONID].lower())
-            self._abort_if_unique_id_configured()
-
-            stationName = await self._test_gas_station(user_input[CONF_STATIONID])
-            if stationName:
-                _LOGGER.debug("Config is valid!")
-                return self.async_create_entry(
-                    title=f"{user_input[CONF_STATIONID]}: {stationName}",
-                    data=user_input
-                ) 
-            else:
-                errors = {"base": "invalid_station"}
-
-        return self.async_show_form(
-            step_id="user", 
-            data_schema=DATA_SCHEMA, 
-            errors=errors,
-        )
-    
-    async def _test_gas_station(self, stationId):
-        """Return true if gas station exists."""
-        session = async_get_clientsession(self.hass, True)
-        async with async_timeout.timeout(10):
+    def __init__(self):
+        """Initialize flow."""
+        self._stations: list = []
+        self._selected_station: Dict[str, Any] = {}
+        self._distrito_id: int = None
+
+    async def async_step_user(
+        self, user_input: Optional[Dict[str, Any]] = None
+    ) -> FlowResult:
+        """Handle the initial step - select distrito."""
+        if user_input is None:
+            # Create distrito selection list
+            distritos_list = {
+                str(id): name for id, name in DISTRITOS.items()
+            }
+
+            return self.async_show_form(
+                step_id="user",
+                data_schema=vol.Schema({
+                    vol.Required("distrito_select"): vol.In(distritos_list)
+                })
+            )
+
+        # Store selected distrito and move to station selection
+        self._distrito_id = int(user_input["distrito_select"])
+        return await self.async_step_station()
+
+    async def async_step_station(
+        self, user_input: Optional[Dict[str, Any]] = None
+    ) -> FlowResult:
+        """Handle station selection."""
+        if user_input is None:
+            # Fetch stations list for selected distrito
+            session = async_get_clientsession(self.hass)
             api = DGEG(session)
-            return await api.testStation(stationId)
+            self._stations = await api.list_stations(self._distrito_id)
+
+            if not self._stations:
+                return self.async_abort(reason="no_stations")
+
+            # Create selection list
+            stations_list = {
+                str(station["Id"]): f"{station['Localidade']}: {station['Marca']} - {station['Nome']}"
+                for station in self._stations
+            }
+
+            return self.async_show_form(
+                step_id="station",
+                data_schema=vol.Schema({
+                    vol.Required("station_select"): vol.In(stations_list)
+                }),
+                description_placeholders={
+                    "stations_count": str(len(self._stations)),
+                    "distrito": DISTRITOS[self._distrito_id]
+                }
+            )
+
+        # Store selected station details
+        station_id = user_input["station_select"]
+        selected_station = next(
+            (station for station in self._stations if str(station["Id"]) == station_id),
+            None
+        )
+
+        if not selected_station:
+            return self.async_abort(reason="station_not_found")
+
+        self._selected_station = {
+            CONF_STATIONID: str(selected_station["Id"]),
+            CONF_STATION_NAME: selected_station["Nome"],
+            CONF_STATION_BRAND: selected_station["Marca"],
+            CONF_STATION_ADDRESS: selected_station["Morada"],
+        }
+
+        return await self.async_step_confirm()
+
+    async def async_step_confirm(
+        self, user_input: Optional[Dict[str, Any]] = None
+    ) -> FlowResult:
+        """Confirm the station selection."""
+        if user_input is None:
+            return self.async_show_form(
+                step_id="confirm",
+                description_placeholders={
+                    "name": self._selected_station[CONF_STATION_NAME],
+                    "brand": self._selected_station[CONF_STATION_BRAND],
+                    "address": self._selected_station[CONF_STATION_ADDRESS],
+                }
+            )
+
+        # Create the config entry
+        return self.async_create_entry(
+            title=f"{self._selected_station[CONF_STATION_NAME]} - {self._selected_station[CONF_STATION_BRAND]}",
+            data=self._selected_station,
+        )
+

custom_components/precoscombustiveis/const.py

@@ -7,6 +7,33 @@
 DEFAULT_ICON = "mdi:gas-station"
 UNIT_OF_MEASUREMENT = "€"
 
+CONF_STATIONID = "stationId"
+
+CONF_STATION_NAME = "station_name"
+CONF_STATION_BRAND = "station_brand"
+CONF_STATION_ADDRESS = "station_address"
+
+# API endpoints 
+API_STATIONS_LIST = "https://precoscombustiveis.dgeg.gov.pt/api/PrecoComb/PesquisarPostos?idDistrito={}&qtdPorPagina=99999&pagina=1"
 API_URI_TEMPLATE = "https://precoscombustiveis.dgeg.gov.pt/api/PrecoComb/GetDadosPosto?id={}"
 
-CONF_STATIONID = "stationId"
+DISTRITOS = {
+    1: "Aveiro",
+    2: "Beja",
+    3: "Braga", 
+    4: "Bragança",
+    5: "Castelo Branco",
+    6: "Coimbra",
+    7: "Évora",
+    8: "Faro",
+    9: "Guarda",
+    10: "Leiria", 
+    11: "Lisboa",
+    12: "Portalegre",
+    13: "Porto",
+    14: "Santarém",
+    15: "Setúbal",
+    16: "Viana do Castelo",
+    17: "Vila Real",
+    18: "Viseu"
+}

custom_components/precoscombustiveis/dgeg.py

@@ -1,16 +1,19 @@
 """API to DGEG."""
-import aiohttp
+from typing import Dict, Optional
+from datetime import datetime
+from aiohttp import ClientSession
 import logging
 
 from datetime import datetime
 
 from .const import (
-    API_URI_TEMPLATE
+    API_URI_TEMPLATE,
+    API_STATIONS_LIST,
+    DISTRITOS
 )
 
 _LOGGER = logging.getLogger(__name__)
 
-
 class Station:
     """Represents a STATION card."""
 
@@ -80,6 +83,34 @@ class DGEG:
     def __init__(self, websession):
         self.websession = websession
 
+    async def list_stations(self, distrito_id: str) -> list[Dict]:
+        """Get list of all stations."""
+        try:
+            _LOGGER.debug(f"Fetching stations list for distrito Id:{distrito_id} ({DISTRITOS[distrito_id]})...")
+            async with self.websession.get(
+                API_STATIONS_LIST.format(distrito_id), 
+                headers={ 
+                    "Content-Type": "application/json" 
+                }
+            ) as res:
+                if res.status == 200:
+                    json = await res.json()
+                    # Sort stations by name for better display
+                    return sorted(
+                        json['resultado'],
+                        key=lambda x: (
+                            x.get('Localidade', '').lower(),
+                            x.get('Marca', '').lower(), 
+                            x.get('Nome', '').lower()
+                        )
+                    )
+                else:
+                    _LOGGER.error("Failed to fetch stations list. Status: %s", res.status)
+                    return []
+        except Exception as ex:
+            _LOGGER.error("Error fetching stations list: %s", str(ex))
+            return []
+
     async def getStation(self, id: str) -> Station:
         """Issue GAS STATION requests."""
         try:

custom_components/precoscombustiveis/strings.json

@@ -3,21 +3,33 @@
     "config": {
         "step": {
             "user": {
-                "title": "Add Credentials (user)",
-                "description": "Some description (user)",
+                "title": "Select Your Location",
+                "description": "Select the primary location for your gas station.",
                 "data": {
-                    "stationId": "StationId"
-                },
-                "data_description": {
-                    "stationId": "Identificador da Estação de Combustível"
+                    "distrito_select": "District"
                 }
+            },
+            "station": {
+                "title": "Select Gas Station",
+                "description": "Found {stations_count} stations. Please select your station from the list.",
+                "data": {
+                    "station_select": "Gas Station"
+                }
+            },
+            "confirm": {
+                "title": "Confirm Station Selection",
+                "description": "Do you want to add the following station?\n\nName: {name}\nBrand: {brand}\nAddress: {address}"
             }
         },
         "error": {
-            "invalid_station": "Invalid StationId or gas station not found."
+            "cannot_connect": "Failed to connect",
+            "invalid_station": "Invalid station ID",
+            "unknown": "Unexpected error"
         },
         "abort": {
-            "already_configured": "Integration is already configured"
+            "no_stations": "No stations found. Please try again later.",
+            "station_not_found": "Selected station not found",
+            "already_configured": "This station is already configured"
         }
     }
 }

custom_components/precoscombustiveis/translations/en.json

@@ -3,21 +3,33 @@
     "config": {
         "step": {
             "user": {
-                "title": "Add Gas Station",
-                "description": "Please type the service station ID from which you want to obtain the prices. (Go to [dgeg](https://precoscombustiveis.dgeg.gov.pt/api/PrecoComb/ListarDadosPostos), search for the desired station and copy the `Id`)",
+                "title": "Select Your Location",
+                "description": "Select the primary location for your gas station.",
                 "data": {
-                    "stationId": "Station Id"
-                },
-                "data_description": {
-                    "stationId": "Station Id Identifier"
+                    "distrito_select": "Location"
                 }
+            },
+            "station": {
+                "title": "Select Gas Station",
+                "description": "Found {stations_count} stations. Please select your station from the list.",
+                "data": {
+                    "station_select": "Gas Station"
+                }
+            },
+            "confirm": {
+                "title": "Confirm Station Selection",
+                "description": "Do you want to add the following station?\n\nName: {name}\nBrand: {brand}\nAddress: {address}"
             }
         },
         "error": {
-            "invalid_station": "Invalid StationId or gas station not found."
+            "cannot_connect": "Failed to connect",
+            "invalid_station": "Invalid station ID",
+            "unknown": "Unexpected error"
         },
         "abort": {
-            "already_configured": "Integration is already configured"
+            "no_stations": "No stations found. Please try again later.",
+            "station_not_found": "Selected station not found",
+            "already_configured": "This station is already configured"
         }
     }
 }