Add Smart Meter B Route integration #123446
Conversation
|
It is my first time working with serial communication. I am wondering if:
Which road should I follow ? Asked in: https://discord.com/channels/330944238910963714/1271130001995071561 |
|
I am making an integration to be able to access Smart Meter data using a USB dongle to communicate via Echonet Lite over Wisun (I think it is only for the Japanese market). The library I am using is https://github.com/nbtk/momonga?tab=readme-ov-file#ログを有効にした例 It basically exposes 3 loggers for which I can set up the logging level and formater. Should I just suppress the logs or is there a way to align the log level of the integration with the library ? Log samples
Asked in https://discord.com/channels/330944238910963714/1271127972103065695 |
|
@joostlek Thanks for the review ! Oh, I have also a question about the brand to use, it is not a brand per see but a standard. Do I need to create a brand in the core project and add a logo (which logo) in the brand project ? |
|
A brand is only used for grouping integrations for a brand (like with switchbot switchbot cloud). In this case it could be like |
|
Hum... the device, id and password are actually at the HA device level, not at the HA integration level, I need to change the config flow |
|
I fixed the previous issues:
The current issue is that in the dev container, |
|
You probably need to expose the USB port to the devcontainer |
It is exposed, I updated the Dockerfile.dev to add: .devcontainer/devcontainer.json to add And in the terminal in the dev container, I can see:
ttyUSB0 is present and I can use it in Home Assistant to do running tests but the discovery does not work after I deleted the integration from the UI, even after a HA reboot. |
|
And the logs of the used library are still noisy :D
|
|
Failing tests are outside my scope:
|
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
|
I discussed with the sellers of the USB dongle who contacted their manufacturer and they say they did not have any way to know if it is their device using the idVendor, idProduct, iManufacturer, iSerial or description so I will remove the device discovery. |
…/home-assistant-core into Smart-Meter-B-Route
| def is_duplicate( | ||
| hass: HomeAssistant, | ||
| entry: ConfigEntry, | ||
| ) -> bool: | ||
| """Filter duplicate entries.""" | ||
| existing_entries = hass.config_entries.async_entries( | ||
| DOMAIN, include_disabled=False, include_ignore=False | ||
| ) | ||
| entry_bid = entry.data[CONF_ID] | ||
| for existing_entry in existing_entries: | ||
| existing_entry_bid = existing_entry.data[CONF_ID] | ||
| if ( | ||
| existing_entry_bid == entry_bid | ||
| and existing_entry.unique_id != entry.unique_id | ||
| ): | ||
| _LOGGER.warning( | ||
| "Duplicate entry found (Skipping): existing_entry.unique_id=%s, entry.unique_id=%s, entry.runtime_data.bid=%s", | ||
| existing_entry.unique_id, | ||
| entry.unique_id, | ||
| entry_bid, | ||
| ) | ||
| return True | ||
| return False | ||
|
|
||
|
|
||
| async def async_setup_entry(hass: HomeAssistant, entry: BRouteConfigEntry) -> bool: | ||
| """Set up Smart Meter B Route from a config entry.""" | ||
| if is_duplicate(hass, entry): | ||
| return False |
There was a problem hiding this comment.
Right, instead we should have this check in the config_flow using self._abort_entries_match
| if not self.context.get("unique_id"): | ||
| await self.async_set_unique_id( | ||
| _generate_unique_id(device), raise_on_progress=False | ||
| ) | ||
| self._abort_if_unique_id_configured() |
There was a problem hiding this comment.
Why the
if not self.context.get("unique_id"):
| def __init__( | ||
| self, | ||
| hass: HomeAssistant, | ||
| entry: ConfigEntry, |
There was a problem hiding this comment.
| entry: ConfigEntry, | |
| entry: BRouteConfigEntry, |
| super().__init__( | ||
| hass, _LOGGER, name=DOMAIN, update_interval=DEFAULT_SCAN_INTERVAL | ||
| ) |
There was a problem hiding this comment.
we should also pass the entry to the coordinator
| assert result["type"] is FlowResultType.CREATE_ENTRY | ||
| assert result["title"] == ENTRY_TITLE | ||
| assert result["data"] == user_input |
There was a problem hiding this comment.
These tests are more like sensor tests tbh
| from tests.common import MockConfigEntry, async_fire_time_changed | ||
|
|
||
|
|
||
| async def test_async_setup_entry_with_non_existing_bid( |
There was a problem hiding this comment.
this is a test for test_init.py
| async def test_smart_meter_b_route_sensor_no_update( | ||
| hass: HomeAssistant, | ||
| mock_momonga, | ||
| freezer: FrozenDateTimeFactory, | ||
| ) -> None: | ||
| """Test SmartMeterBRouteSensor with no update.""" | ||
|
|
||
| entity_id = "sensor.smart_meter_b_route_b_route_id_instantaneous_current_r_phase" |
There was a problem hiding this comment.
you already have this test now
| @pytest.mark.parametrize( | ||
| ("index", "entity_id"), | ||
| [ | ||
| (0, "sensor.smart_meter_b_route_b_route_id_instantaneous_current_r_phase"), | ||
| (1, "sensor.smart_meter_b_route_b_route_id_instantaneous_current_t_phase"), | ||
| (2, "sensor.smart_meter_b_route_b_route_id_instantaneous_power"), | ||
| (3, "sensor.smart_meter_b_route_b_route_id_total_consumption"), | ||
| ], | ||
| ) | ||
| async def test_smart_meter_b_route_sensor_update( | ||
| hass: HomeAssistant, | ||
| index: int, | ||
| entity_id: str, | ||
| mock_momonga, | ||
| freezer: FrozenDateTimeFactory, | ||
| ) -> None: | ||
| """Test SmartMeterBRouteSensor update.""" | ||
| config_entry = configure_integration(hass) | ||
| await hass.config_entries.async_setup(config_entry.entry_id) | ||
| await hass.async_block_till_done() | ||
| freezer.tick(DEFAULT_SCAN_INTERVAL) | ||
| async_fire_time_changed(hass) | ||
| await hass.async_block_till_done(wait_background_tasks=True) | ||
|
|
||
| entity = hass.states.get(entity_id) | ||
| assert entity.state == str(index + 1) |
There was a problem hiding this comment.
I am not sure what this tests if you already have the snapshot test in the coordinator
Proposed change
This PR adds a new integration to use Bルートサービス (B Route Service) which uses Echonet Lite over Wi-Sun to provide readings from standard Smart Meters in Japan using a compatible serial device.
Type of change
Additional information
Checklist
ruff format homeassistant tests)If user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
Updated and included derived files by running:
python3 -m script.hassfest.requirements_all.txt.Updated by running
python3 -m script.gen_requirements_all.To help with the load of incoming pull requests: