Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Home Assistant entity description for interval #571

Merged
merged 1 commit into from
May 24, 2023
Merged

Add Home Assistant entity description for interval #571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions ecowitt2mqtt/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
DATA_POINT_HUMIDITY_ABS: Final = "humidityabs"
DATA_POINT_HUMIDITY_ABS_IN: Final = "humidityabsin"
DATA_POINT_HUMI_CO2: Final = "humi_co2"
DATA_POINT_INTERVAL: Final = "interval"
DATA_POINT_LIGHTNING: Final = "lightning"
DATA_POINT_LIGHTNING_NUM: Final = "lightning_num"
DATA_POINT_LIGHTNING_TIME: Final = "lightning_time"
Expand Down
8 changes: 7 additions & 1 deletion ecowitt2mqtt/data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
DATA_POINT_HUMIDITY,
DATA_POINT_HUMIDITY_ABS,
DATA_POINT_HUMIDITY_ABS_IN,
DATA_POINT_INTERVAL,
DATA_POINT_LIGHTNING,
DATA_POINT_LIGHTNING_NUM,
DATA_POINT_LIGHTNING_TIME,
Expand Down Expand Up @@ -101,7 +102,11 @@
ThermalPerceptionCalculator,
WindChillCalculator,
)
from ecowitt2mqtt.helpers.calculator.time import EpochCalculator, RuntimeCalculator
from ecowitt2mqtt.helpers.calculator.time import (
EpochCalculator,
RuntimeCalculator,
UpdateIntervalCalculator,
)
from ecowitt2mqtt.helpers.calculator.uv import SafeExposureCalculator, UVIndexCalculator
from ecowitt2mqtt.helpers.calculator.wind import (
BeaufortScaleCalculator,
Expand Down Expand Up @@ -143,6 +148,7 @@
DATA_POINT_HUMIDITY_ABS: AbsoluteHumidityCalculator,
DATA_POINT_HUMIDITY_ABS_IN: AbsoluteHumidityCalculator,
DATA_POINT_HUMI_CO2: RelativeHumidityCalculator,
DATA_POINT_INTERVAL: UpdateIntervalCalculator,
DATA_POINT_LIGHTNING: LightningStrikeDistanceCalculator,
DATA_POINT_LIGHTNING_NUM: LightningStrikeCountCalculator,
DATA_POINT_LIGHTNING_TIME: EpochCalculator,
Expand Down
13 changes: 13 additions & 0 deletions ecowitt2mqtt/helpers/calculator/time.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,16 @@ def output_unit(self) -> str:
A unit string.
"""
return TIME_SECONDS


class UpdateIntervalCalculator(SimpleCalculator):
"""Define a data update interval calculator."""

@property
def output_unit(self) -> str:
"""Get the output unit of measurement for this calculation.

Returns:
A unit string.
"""
return TIME_SECONDS
5 changes: 5 additions & 0 deletions ecowitt2mqtt/helpers/publisher/hass.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
DATA_POINT_HUMIDEX_PERCEPTION,
DATA_POINT_HUMIDITY_ABS,
DATA_POINT_HUMIDITY_ABS_IN,
DATA_POINT_INTERVAL,
DATA_POINT_LIGHTNING,
DATA_POINT_LIGHTNING_NUM,
DATA_POINT_LIGHTNING_TIME,
Expand Down Expand Up @@ -287,6 +288,10 @@ class HassDiscoveryPayload:
icon="mdi:water-percent",
state_class=StateClass.MEASUREMENT,
),
DATA_POINT_INTERVAL: EntityDescription(
icon="mdi:water-percent",
entity_category=EntityCategory.DIAGNOSTIC,
),
DATA_POINT_LIGHTNING: EntityDescription(
icon="mdi:map-marker-distance",
state_class=StateClass.MEASUREMENT,
Expand Down
7 changes: 7 additions & 0 deletions tests/data/test_data_processing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3653,6 +3653,13 @@ def test_precision(device_data: dict[str, Any], ecowitt: Ecowitt) -> None:
attributes={},
data_type=DataPointType.NON_BOOLEAN,
),
"interval": CalculatedDataPoint(
data_point_key="interval",
value=16.0,
unit=TIME_SECONDS,
attributes={},
data_type=DataPointType.NON_BOOLEAN,
),
},
),
(
Expand Down
3 changes: 2 additions & 1 deletion tests/fixtures/payload_gw2000a_2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,6 @@
"co2_batt": "6",
"wh90batt": "3.22",
"freq": "868M",
"model": "GW2000A"
"model": "GW2000A",
"interval": "16"
}
80 changes: 80 additions & 0 deletions tests/helpers/publisher/test_hass_discovery.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1674,6 +1674,26 @@ async def test_publish(
payload=b"3.22",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes", "name": "interval", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_interval", "unit_of_measurement": "s", "entity_category": "diagnostic", "icon": "mdi:water-percent"}',
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability",
payload=b"online",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes",
payload=b"{}",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state",
payload=b"16.0",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/attributes", "name": "beaufortscale", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_beaufortscale", "icon": "mdi:weather-windy", "state_class": "measurement"}',
Expand Down Expand Up @@ -3788,6 +3808,26 @@ async def test_publish_custom_entity_id_prefix(
payload=b"3.22",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes", "name": "test_prefix_interval", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_interval", "unit_of_measurement": "s", "entity_category": "diagnostic", "icon": "mdi:water-percent"}',
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability",
payload=b"online",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes",
payload=b"{}",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state",
payload=b"16.0",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/attributes", "name": "test_prefix_beaufortscale", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_beaufortscale", "icon": "mdi:weather-windy", "state_class": "measurement"}',
Expand Down Expand Up @@ -5928,6 +5968,26 @@ async def test_publish_numeric_battery_strategy(
payload=b"3.22",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes", "name": "interval", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_interval", "unit_of_measurement": "s", "entity_category": "diagnostic", "icon": "mdi:water-percent"}',
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability",
payload=b"online",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes",
payload=b"{}",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state",
payload=b"16.0",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/attributes", "name": "beaufortscale", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/beaufortscale/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_beaufortscale", "icon": "mdi:weather-windy", "state_class": "measurement"}',
Expand Down Expand Up @@ -8038,6 +8098,26 @@ async def test_no_entity_description(
payload=b"3.22",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes", "name": "interval", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_interval", "unit_of_measurement": "s", "entity_category": "diagnostic", "icon": "mdi:water-percent"}',
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/availability",
payload=b"online",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/attributes",
payload=b"{}",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/interval/state",
payload=b"16.0",
retain=False,
),
call(
"homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/random/config",
payload=b'{"availability_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/random/availability", "device": {"identifiers": ["xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], "manufacturer": "Ecowitt", "model": "GW2000A", "name": "GW2000", "sw_version": "GW2000A_V2.1.4"}, "json_attributes_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/random/attributes", "name": "random", "qos": 1, "retain": false, "state_topic": "homeassistant/sensor/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/random/state", "unique_id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx_random"}',
Expand Down