Update Environment Canada platforms #24884

michaeldavie · 2019-07-01T01:59:19Z

Description:

External Library

Bump env_canada to 0.0.18
Split classes into separate modules to remove unnecessary imports (e.g. numpy for conditions)
Return data and labels in either English (default) or French
Improve processing of severe weather alerts
Separate metadata from conditions
Add forecast text summary to conditions (addresses You should add the text summaries michaeldavie/env_canada#1)

Sensor

Remove optional monitored_conditions from configuration, create sensors for all provided data
Remove optional name from configuration
Add optional language to configuration (addresses Add Language parameter michaeldavie/env_canada#2)
Use unique_id for each sensor (addresses Documentation is wrong michaeldavie/env_canada#3)
Remove hardcoded labels and units, use values supplied by env_canada instead (addresses Sensors titles are badly formatted in the UI michaeldavie/env_canada#5)
Change refresh period to 1 minute

Weather

Use first hourly forecast for missing temperature and condition values (addresses "Weather" element showing "Condition not observed" in card title michaeldavie/env_canada#4)

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#9747

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: environment_canada
    language: french

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

frenck · 2019-07-01T17:33:55Z

homeassistant/components/environment_canada/sensor.py


 MIN_TIME_BETWEEN_UPDATES = datetime.timedelta(minutes=10)

 SENSOR_TYPES = {
-    'temperature': {'name': 'Temperature',
+    'temperature': {'english': 'Temperature',


It feels counterproductive to me to put translations, hardcoded, in the backend.
A user can customize entities if he wants to, right?

Yes, they can. In this case the source data is available in both English and French, and I'd like a user to be able to select one of the two languages and have both the labels and the underlying data match. I'm not sure that hardcoding two sets of labels is that different from hardcoding one.

Is there a way to leverage the user selection for the front end language to drive this?

We shouldn't merge this, as translations are not stored inside the code.

Thanks for the feedback. I've moved the labels out to the env_canada library, which makes things cleaner. Please let me know what you think.

That is just working around the original concern raised!?

unique ID != entity_id

Are you saying that I should use something unique in the entity_id, e.g. sensor.env_canada.temperature? I used to have this and removed it based on a comment on the original PR for this platform: #21110 (comment)

unique_id is a property on the entity that can be implemented to activate the entity registry for the entity.

https://developers.home-assistant.io/docs/en/entity_index.html#generic-properties

https://developers.home-assistant.io/docs/en/entity_registry_index.html#unique-id-requirements

https://developers.home-assistant.io/docs/en/entity_registry_index.html

Sorry, I should have given more context. Thanks Martin.

Thanks for clarifying, I've switched this over.

michaeldavie · 2019-07-06T18:08:44Z

This update to the env_canada library also includes a lot of enhancements related to alerts for severe weather, so it would be great to get it merged. Please let me know if there are any outstanding concerns.

michaeldavie · 2019-07-06T21:02:20Z

I've updated the description to better describe the included changes.

homeassistant/components/environment_canada/sensor.py

michaeldavie · 2019-07-10T23:26:48Z

Should this be marked as a breaking change, since the entity_id values and the configuration are changing? I've updated the documentation to reflect the changes.

MartinHjelmare · 2019-07-12T06:26:19Z

homeassistant/components/environment_canada/sensor.py

-    vol.Required(CONF_MONITORED_CONDITIONS, default=list(SENSOR_TYPES)):
-        vol.All(cv.ensure_list, [vol.In(SENSOR_TYPES)]),
-    vol.Optional(CONF_NAME): cv.string,
+    vol.Required(CONF_LANGUAGE, default='english'):


Are we ok with this config option? @balloob?

I'd be happy to pull this value from the front end configuration, if that's possible.

On sensor, yes

But yeah, we should add a core language config flag

homeassistant/components/environment_canada/sensor.py

homeassistant added integration: environment_canada cla-signed labels Jul 1, 2019

ghost assigned michaeldavie Jul 1, 2019

michaeldavie mentioned this pull request Jul 1, 2019

Add French support and two sensors to Environment Canada. home-assistant/home-assistant.io#9747

Merged

2 tasks

michaeldavie changed the title ~~Add French support to Environment Canada sensor~~ Add French support, forecast period, and text summary to Environment Canada sensor Jul 1, 2019

frenck reviewed Jul 1, 2019

View reviewed changes

michaeldavie force-pushed the ec_updates branch 2 times, most recently from c943bdf to 4949354 Compare July 6, 2019 18:06

michaeldavie force-pushed the ec_updates branch from f0ad7b5 to c0b707a Compare July 6, 2019 20:15

This was referenced Jul 6, 2019

Documentation is wrong michaeldavie/env_canada#3

Closed

Sensors titles are badly formatted in the UI michaeldavie/env_canada#5

Closed

michaeldavie changed the title ~~Add French support, forecast period, and text summary to Environment Canada sensor~~ Updates to Environment Canada platforms Jul 6, 2019

MartinHjelmare changed the title ~~Updates to Environment Canada platforms~~ Update Environment Canada platforms Jul 7, 2019

pvizeli requested changes Jul 9, 2019

View reviewed changes

homeassistant/components/environment_canada/sensor.py Outdated Show resolved Hide resolved

michaeldavie force-pushed the ec_updates branch from 96222ab to b92bed9 Compare July 10, 2019 01:32

michaeldavie force-pushed the ec_updates branch from b92bed9 to 02e97a3 Compare July 12, 2019 04:18

MartinHjelmare added the breaking-change label Jul 12, 2019

MartinHjelmare requested changes Jul 12, 2019

View reviewed changes

michaeldavie mentioned this pull request Jul 12, 2019

"Weather" element showing "Condition not observed" in card title michaeldavie/env_canada#4

Closed

michaeldavie force-pushed the ec_updates branch from 747f031 to 3f8533f Compare July 13, 2019 00:34

pvizeli requested changes Jul 13, 2019

View reviewed changes

homeassistant/components/environment_canada/sensor.py Show resolved Hide resolved

michaeldavie added 6 commits July 13, 2019 08:04

Add support for French

63968b4

Move labels to env_canada

daa507f

Bump env_canada to 0.0.17, change update frequency to 1 minute

3dae2db

Update requirements_all.txt

2df1e17

Set entity IDs separate from labels

900b450

Flake error

042431e

michaeldavie added 6 commits July 13, 2019 08:04

Remove monitored conditions

73dde79

Use next hourly forecast for missing conditions

f5a5fe2

Switch sensors to unique_id

62aaa6b

Flake error

eb7085a

Requested changes

505c5d6

Simplify setting location parameters

9ce3752

michaeldavie force-pushed the ec_updates branch from 3f8533f to 9ce3752 Compare July 13, 2019 12:04

pvizeli approved these changes Jul 13, 2019

View reviewed changes

pvizeli merged commit a147a18 into home-assistant:dev Jul 13, 2019

michaeldavie deleted the ec_updates branch July 13, 2019 21:08

lock bot locked and limited conversation to collaborators Jul 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Environment Canada platforms #24884

Update Environment Canada platforms #24884

michaeldavie commented Jul 1, 2019 •

edited

Loading

frenck Jul 1, 2019

michaeldavie Jul 1, 2019 •

edited

Loading

balloob Jul 1, 2019

michaeldavie Jul 2, 2019

frenck Jul 2, 2019

balloob Jul 11, 2019

michaeldavie Jul 11, 2019 •

edited

Loading

MartinHjelmare Jul 11, 2019

balloob Jul 12, 2019

michaeldavie Jul 12, 2019

michaeldavie commented Jul 6, 2019

michaeldavie commented Jul 6, 2019

michaeldavie commented Jul 10, 2019

MartinHjelmare Jul 12, 2019 •

edited

Loading

michaeldavie Jul 12, 2019

pvizeli Jul 13, 2019

pvizeli Jul 13, 2019

Update Environment Canada platforms #24884

Update Environment Canada platforms #24884

Conversation

michaeldavie commented Jul 1, 2019 • edited Loading

Description:

External Library

Sensor

Weather

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

michaeldavie Jul 1, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaeldavie Jul 11, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaeldavie commented Jul 6, 2019

michaeldavie commented Jul 6, 2019

michaeldavie commented Jul 10, 2019

MartinHjelmare Jul 12, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michaeldavie commented Jul 1, 2019 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

michaeldavie Jul 1, 2019 •

edited

Loading

michaeldavie Jul 11, 2019 •

edited

Loading

MartinHjelmare Jul 12, 2019 •

edited

Loading