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 entity translation strings for ScreenLogic #130708

Draft
wants to merge 5 commits into
base: dev
Choose a base branch
from
+202 −8
Draft

Add entity translation strings for ScreenLogic #130708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc255c5
Add translation strings for entities
dieselrabbit Nov 11, 2024
6752337
Translation key updates
dieselrabbit Nov 14, 2024
d44e556
Merge branch 'home-assistant:dev' into sl-translations
dieselrabbit Nov 15, 2024
5c4211e
Mach original name
dieselrabbit Nov 18, 2024
e8c0439
Remove state translations
dieselrabbit Nov 18, 2024
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
30 changes: 30 additions & 0 deletions homeassistant/components/screenlogic/binary_sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,26 +49,34 @@ class ScreenLogicPushBinarySensorDescription(
data_root=(DEVICE.CONTROLLER, GROUP.SENSOR),
key=VALUE.ACTIVE_ALERT,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="active_alert",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.STATUS_CHANGED,
data_root=(DEVICE.CONTROLLER, GROUP.SENSOR),
key=VALUE.CLEANER_DELAY,
translation_key="circuit_delay",
translation_placeholders={"circuit": "Cleaner"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.STATUS_CHANGED,
data_root=(DEVICE.CONTROLLER, GROUP.SENSOR),
key=VALUE.FREEZE_MODE,
translation_key="freeze_mode",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.STATUS_CHANGED,
data_root=(DEVICE.CONTROLLER, GROUP.SENSOR),
key=VALUE.POOL_DELAY,
translation_key="circuit_delay",
translation_placeholders={"circuit": "Pool"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.STATUS_CHANGED,
data_root=(DEVICE.CONTROLLER, GROUP.SENSOR),
key=VALUE.SPA_DELAY,
translation_key="circuit_delay",
translation_placeholders={"circuit": "Spa"},
),
]

Expand All @@ -85,82 +93,104 @@ class ScreenLogicPushBinarySensorDescription(
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.FLOW_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="flow_alarm",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.ORP_HIGH_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_high_alarm",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.ORP_LOW_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_low_alarm",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.ORP_SUPPLY_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_supply_alarm",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.PH_HIGH_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_high_alarm",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.PH_LOW_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_low_alarm",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.PH_SUPPLY_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="chem_supply_alarm",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALARM),
key=VALUE.PROBE_FAULT_ALARM,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="probe_fault_alarm",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALERT),
key=VALUE.ORP_LIMIT,
translation_key="chem_limit",
translation_placeholders={"chem": "ORP"},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's ORP? Should we write it out? Does pH have different translations for other languages? Maybe it would make sense to keep them as part of the translation string

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ORP stands for Oxidation Reduction Potential. Neither appear to be translated for other languages. Looking at the Pentair Europe site and cycling through the available languages, neither ORP or pH are ever referred to by their full name, or translated.

),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALERT),
key=VALUE.PH_LIMIT,
translation_key="chem_limit",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.ALERT),
key=VALUE.PH_LOCKOUT,
translation_key="ph_lockout",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.WATER_BALANCE),
key=VALUE.CORROSIVE,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="corosive",
),
ScreenLogicPushBinarySensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.WATER_BALANCE),
key=VALUE.SCALING,
device_class=BinarySensorDeviceClass.PROBLEM,
translation_key="scaling",
),
]

SUPPORTED_SCG_SENSORS = [
ScreenLogicBinarySensorDescription(
data_root=(DEVICE.SCG, GROUP.SENSOR),
key=VALUE.STATE,
translation_key="scg_state",
)
]

Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/screenlogic/climate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ async def async_setup_entry(
subscription_code=CODE.STATUS_CHANGED,
data_root=(DEVICE.BODY,),
key=body_index,
translation_key=f"body_{body_index}",
),
)
for body_index in gateway.get_data(DEVICE.BODY)
Expand Down Expand Up @@ -98,7 +99,6 @@ def __init__(self, coordinator, entity_description) -> None:

self._attr_min_temp = self.entity_data[ATTR.MIN_SETPOINT]
self._attr_max_temp = self.entity_data[ATTR.MAX_SETPOINT]
self._attr_name = self.entity_data[VALUE.HEAT_STATE][ATTR.NAME]
self._last_preset = None

@property
Expand Down
3 changes: 2 additions & 1 deletion homeassistant/components/screenlogic/entity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ def __init__(
self._data_path = (*self.entity_description.data_root, self._data_key)
mac = self.mac
self._attr_unique_id = f"{mac}_{generate_unique_id(*self._data_path)}"
self._attr_name = self.entity_data[ATTR.NAME]
if not entity_description.translation_key:
self._attr_name = self.entity_data[ATTR.NAME]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's this name?

Copy link
Contributor Author

@dieselrabbit dieselrabbit Nov 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently all entities get their name from the api. The referenced change leaves that convention in place for entities that get their name from the device (user named circuits/features), which as it applies to the integration, are switch and light entities, and sensor entities for the pump(s), which are named by the api after the first circuit associated with them in the device.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add some examples with what you want to achieve where? With translations set, you usually don't need to use _attr_name anymore, except for when the entity needs to be the device name

Copy link
Contributor Author

@dieselrabbit dieselrabbit Nov 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The api lib screenlogicpy (which I maintain) originally provided the majority of data that HA uses, for each value intended to be supported in HA.
Example of data provided by the api lib:

"air_temperature": {
  "name": "Air Temperature",
  "value": 62,
  "unit": "\u00b0F",
  "device_type": "temperature",
  "state_type": "measurement"
},
"ph": {
  "name": "pH",
  "value": 7.5,
  "unit": "pH",
  "state_type": "measurement"
},
"orp": {
  "name": "ORP",
  "value": 726,
  "unit": "mV",
  "state_type": "measurement"
},

Since moving to EntityDescriptions though, the majority of that extra data is no longer used, except for the name. Prior to this PR adding entity translations, all entities were sill using the name provided by the api lib. That's where the self._attr_name = self.entity_data[ATTR.NAME] came from.

Some of the entities this integration exposes (like the example above) are statically named, meaning the integration knows ahead of time what value it is exposing, but there are other entities that are created dynamically. Because the ScreenLogic gateway device supports various equipment configurations there can be different amounts of circuits, pumps, and heaters (along with other equipment either present or not). Additionally, the pool controller allows the user to custom name the individual circuits within the device. It is intended for entities that expose these circuits (switch, light, and some sensor) to use the name the user has set in the pool controller device.

Therefore for the entities known ahead of time I've provided translations for them, but for the ones not known ahead of time (where I haven't provided a translation_key), the integration "falls-back" to the name provided by the api lib, which is what the end user has set within the device itself.

Sorry it's a bit long-winded, but I thought it might be helpful to have a little context as to how the code got to where it is now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay this explains it well. I'll check the code on how we can do this the best. How do the devices currently look in HA? Is every pump its own device? Or is everything thrown under 1 device?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything is currently under one device.

There's a mix of conventions within the Pentair ScreenLogic system that made breaking out individual devices messy and in my opinion confusing. Some equipment is presented as a stand-alone device, some are only referenced through the central controller, and some are presented as multiple devices that are only active depending on what mode the central controller is in.

Because the official app presents as one point of connection/device I elected to start there.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we have one device per physical device. I don't think there's a big lack of user experience if we can't do that and just put it on the controller when that's not possible. How do you mean with the device being active?

Using devices is quite a nice way to not use a lot of placeholders. We can use via_device to neatly connect them to the main controller.

(Also, I don't see this as a must, if we can't do that and the user experience is worse, we shouldn't, I'm just exploring at this point :) )

assert mac is not None
self._attr_device_info = DeviceInfo(
connections={(dr.CONNECTION_NETWORK_MAC, mac)},
Expand Down
6 changes: 6 additions & 0 deletions homeassistant/components/screenlogic/number.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,27 +57,31 @@ class ScreenLogicPushNumberDescription(
key=VALUE.CALCIUM_HARDNESS,
entity_category=EntityCategory.CONFIG,
mode=NumberMode.BOX,
translation_key="calcium_hardness",
),
ScreenLogicPushNumberDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.CYA,
entity_category=EntityCategory.CONFIG,
mode=NumberMode.BOX,
translation_key="cya",
),
ScreenLogicPushNumberDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.TOTAL_ALKALINITY,
entity_category=EntityCategory.CONFIG,
mode=NumberMode.BOX,
translation_key="total_alkalinity",
),
ScreenLogicPushNumberDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.SALT_TDS_PPM,
entity_category=EntityCategory.CONFIG,
mode=NumberMode.BOX,
translation_key="salt_tds_ppm",
),
]

Expand All @@ -86,11 +90,13 @@ class ScreenLogicPushNumberDescription(
data_root=(DEVICE.SCG, GROUP.CONFIGURATION),
key=VALUE.POOL_SETPOINT,
entity_category=EntityCategory.CONFIG,
translation_key="pool_setpoint",
),
ScreenLogicNumberDescription(
data_root=(DEVICE.SCG, GROUP.CONFIGURATION),
key=VALUE.SPA_SETPOINT,
entity_category=EntityCategory.CONFIG,
translation_key="spa_setpoint",
),
]

Expand Down
32 changes: 32 additions & 0 deletions homeassistant/components/screenlogic/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,73 +97,91 @@ class ScreenLogicPushSensorDescription(
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.ORP_NOW,
state_class=SensorStateClass.MEASUREMENT,
translation_key="chem_now",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.PH_NOW,
state_class=SensorStateClass.MEASUREMENT,
translation_key="chem_now",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.ORP_SUPPLY_LEVEL,
state_class=SensorStateClass.MEASUREMENT,
value_mod=lambda val: int(val) - 1,
translation_key="chem_supply_level",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.PH_SUPPLY_LEVEL,
state_class=SensorStateClass.MEASUREMENT,
value_mod=lambda val: int(val) - 1,
translation_key="chem_supply_level",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.PH_PROBE_WATER_TEMP,
device_class=SensorDeviceClass.TEMPERATURE,
state_class=SensorStateClass.MEASUREMENT,
translation_key="ph_probe_water_temp",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.SENSOR),
key=VALUE.SATURATION,
state_class=SensorStateClass.MEASUREMENT,
translation_key="saturation",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.CALCIUM_HARDNESS,
entity_registry_enabled_default=False, # Superseded by number entity
translation_key="calcium_hardness",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.CYA,
entity_registry_enabled_default=False, # Superseded by number entity
translation_key="cya",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.ORP_SETPOINT,
translation_key="chem_setpoint",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.PH_SETPOINT,
translation_key="chem_setpoint",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.TOTAL_ALKALINITY,
entity_registry_enabled_default=False, # Superseded by number entity
translation_key="total_alkalinity",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.CONFIGURATION),
key=VALUE.SALT_TDS_PPM,
entity_registry_enabled_default=False, # Superseded by number entity
translation_key="salt_tds_ppm",
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
Expand All @@ -172,20 +190,26 @@ class ScreenLogicPushSensorDescription(
device_class=SensorDeviceClass.ENUM,
options=["Dosing", "Mixing", "Monitoring"],
value_mod=lambda val: DOSE_STATE(val).title,
translation_key="chem_dose_state",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.DOSE_STATUS),
key=VALUE.ORP_LAST_DOSE_TIME,
device_class=SensorDeviceClass.DURATION,
state_class=SensorStateClass.TOTAL_INCREASING,
translation_key="chem_last_dose_time",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.DOSE_STATUS),
key=VALUE.ORP_LAST_DOSE_VOLUME,
device_class=SensorDeviceClass.VOLUME,
state_class=SensorStateClass.TOTAL_INCREASING,
translation_key="chem_last_dose_volume",
translation_placeholders={"chem": "ORP"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
Expand All @@ -194,20 +218,26 @@ class ScreenLogicPushSensorDescription(
device_class=SensorDeviceClass.ENUM,
options=["Dosing", "Mixing", "Monitoring"],
value_mod=lambda val: DOSE_STATE(val).title,
translation_key="chem_dose_state",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.DOSE_STATUS),
key=VALUE.PH_LAST_DOSE_TIME,
device_class=SensorDeviceClass.DURATION,
state_class=SensorStateClass.TOTAL_INCREASING,
translation_key="chem_last_dose_time",
translation_placeholders={"chem": "pH"},
),
ScreenLogicPushSensorDescription(
subscription_code=CODE.CHEMISTRY_CHANGED,
data_root=(DEVICE.INTELLICHEM, GROUP.DOSE_STATUS),
key=VALUE.PH_LAST_DOSE_VOLUME,
device_class=SensorDeviceClass.VOLUME,
state_class=SensorStateClass.TOTAL_INCREASING,
translation_key="chem_last_dose_volume",
translation_placeholders={"chem": "pH"},
),
]

Expand All @@ -216,10 +246,12 @@ class ScreenLogicPushSensorDescription(
data_root=(DEVICE.SCG, GROUP.SENSOR),
key=VALUE.SALT_PPM,
state_class=SensorStateClass.MEASUREMENT,
translation_key="salt_ppm",
),
ScreenLogicSensorDescription(
data_root=(DEVICE.SCG, GROUP.CONFIGURATION),
key=VALUE.SUPER_CHLOR_TIMER,
translation_key="super_chlor_timer",
),
]

Expand Down
Loading