-
-
Notifications
You must be signed in to change notification settings - Fork 33.2k
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.
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
Remove "meter" from entity names of rainforest_raven
sensors
#141487
Conversation
The three sensors - power_demand - total_energy_delivered - total_energy_received currently add "meter" in their friendly names. This does not provide any useful information and is rather irritating instead – it sounds like these are the power demands or consumption of the meter itself. But they are the measured values. This commit removes "meter" from the names making them simpler and more precise, too. In addition the sentence-casing of "MAC addresses" is fixed.
Hey there @cottsay, mind taking a look at this pull request as it has been labeled with an integration ( Code owner commandsCode owners of
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What about "Meter price"?
"Meter price" has the key So we would have to come up with a replacement for both. |
For context, some of the "meter" nomenclature stems from the idea that a RAVEn device like the EMU-2 can be connected to multiple meters simultaneously, so the measurement doesn't stem from the device itself, but rather each meter it's connected to. Maybe the name doesn't effectively communicate that, but I wanted to mention it. |
@cottsay I understand your reasoning for the current naming. But as Home Assistant automatically prefixes each entity name with the device name when creating the ID the (chosen) name of each meter will be part of that anyhow. But you see no problem in making the suggested change for consistency within Home Assistant? |
I have no specific objections, no. |
I am not sure I understand the reasoning. On the PR description you mention:
So, is "Meter Price" the price of the meter? I think that independently of the translation key, the string should make sense and be consistent with the other strings, even if the key has "meter" in the name. |
@abmantis I'm not against your suggestion, let's fix this as well. I was just saying that, contrary to the strings I already addressed, this one contains "meter" in its key name. too. So how about changing |
@cottsay I assume that the |
The meter, RAVEn device, and upstream coordinator all have unique mac addresses. That's intentionally plural, as the RAVEn device can be connected to multiple meters with unique MACs. There's an argument that the key itself should be plural, but I'm not sure if there are implications to changing that now. When we request data from the RAVEn device, we need to be specific about what meter we're talking about, and the MAC address is how we differentiate them. |
OK, then the name "Meter MAC addresses" makes complete sense and we should keep it that way. So the remaining question is if we should change I think that @abmantis has a point that "Meter price" sounds like the price of the meter and not the total for received minus delivered energy. |
Applied all changes as discussed. |
rainforest_raven
sensorsrainforest_raven
sensors
Proposed change
In
rainforest_raven
the four sensorspower_demand
total_energy_delivered
total_energy_received
signal_strength
currently add "meter" in their friendly names.
This does not provide any useful information and is rather irritating instead – it sounds like these are the power demands or consumption of the meter itself. But they are the measured values.
This commit removes "meter" from the names making them simpler and more precise, too.
For consistency the naming of
meter_price
is changed toenergy_price
.In addition the sentence-casing of "MAC addresses" is fixed.
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: