Rewrite of Trafikverket weather - Multiple sensor types supported by endor-force · Pull Request #15935 · home-assistant/core

endor-force · 2018-08-12T10:24:10Z

Description:

Rewritten with library pytrafikverket for retreiving data.

Breaking change, requires user to update configuration!
Instead of having multiple sensor configurations per station, add only one configuration per station and select the type of measurement data to subscribe to using monitored_conditions.
The configuration value type should no longer be used.

Supports more weather data from Trafikverket API.
(Text values returned from API is string in Swedish (wind_direction_text and precipitation).)

Related issue (if applicable): fixes N/A

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#6006

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

- sensor: 
   - platform: trafikverket_weatherstation
     name: Trafikverket Precipitation WeatherStation Upplid
     api_key: eXXcbXXXacXXXXc39XX3aXXX4aXX46XX
     station: Upplid
     monitored_conditions:
         - air_temp
         - road_temp
         - humidity
         - precipitation
         - wind_direction
         - wind_direction_text
         - wind_speed

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

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

Documentation added/updated in home-assistant.github.io

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

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc. N/A

If the code does not interact with devices:

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

Enables users to see type of precipitation. Value returned from API is a string in swedish.

endor-force · 2018-08-12T10:35:35Z

Moved from master to dev, tag "merging to master" can be cleared.

Correction of tox findings

houndci-bot · 2018-08-12T14:10:22Z

homeassistant/components/sensor/trafikverket_weatherstation.py

    add_devices([TrafikverketWeatherStation(
        sensor_name, sensor_api, sensor_station, sensor_type)], True)
-
+    


blank line contains whitespace

Travis tox failed due to problem with tox build process. Correcting in a comment to trigger retry in travis..

houndci-bot · 2018-08-13T07:08:11Z

homeassistant/components/sensor/trafikverket_weatherstation.py


-        # air_vs_road contains "Air" or "Road" depending on user input.
-        self._state = final[air_vs_road]["Temp"]
+        # air_vs_road contains "Air", "Road" or "Precipitation" depending on user input as well as suffix key.


line too long (110 > 79 characters)

houndci-bot · 2018-08-13T07:35:46Z

homeassistant/components/sensor/trafikverket_weatherstation.py


-        # air_vs_road contains "Air" or "Road" depending on user input.
-        self._state = final[air_vs_road]["Temp"]
+        # air_vs_road contains "Air", "Road" or "Precipitation" 


trailing whitespace

balloob · 2018-08-14T09:54:31Z

homeassistant/components/sensor/trafikverket_weatherstation.py

                          <EQ name="Name" value='""" + self._station + """' />
                    </FILTER>
-                    <INCLUDE>Measurement.""" + air_vs_road + """.Temp</INCLUDE>
+                    <INCLUDE>Measurement.""" + air_vs_road + """.""" + keytype + """</INCLUDE>


We cannot accept any PR for this platform until all protocol specific code has been extracted into a third party lib which is then used.

fabaff

Conflict

Superseded

endor-force · 2018-08-14T10:35:32Z

Sorry, rookie here, do you know any sensor that I can look at for reference on putting protocol code in separate library?

fabaff · 2018-08-14T15:43:57Z

luftnetz, pi_hole, shodan, swiss_public_transportation, thinkingcleaner, vasttrafik and some others.

MartinHjelmare · 2018-08-15T06:13:43Z

Maybe try to extend pytrafikverket:
https://github.com/AnderssonPeter/pytrafikverket

https://pypi.org/project/pytrafikverket/

endor-force · 2018-08-17T04:50:08Z

Sure, I will investigate the possibilities of using and extending pytrafikverket for this.

Extended pytrafikverket with weather sensor collction Changed behaviour of sensor component to use pytrafikverket. Added more sensors. User need to change config to use new version. [] Documentation needs to be updated

MartinHjelmare · 2018-08-26T17:10:47Z

homeassistant/components/sensor/trafikverket_weatherstation.py

    """Set up the Trafikverket sensor platform."""
+    from pytrafikverket.trafikverket_weather import TrafikverketWeather
+
    sensor_name = config.get(CONF_NAME)


Use dict[key] for required config keys.

MartinHjelmare · 2018-08-26T17:12:05Z

homeassistant/components/sensor/trafikverket_weatherstation.py



-def setup_platform(hass, config, add_entities, discovery_info=None):
+async def async_setup_platform(hass, config, async_add_devices,


Rename async_add_devices to async_add_entities.

MartinHjelmare · 2018-08-26T17:12:48Z

homeassistant/components/sensor/trafikverket_weatherstation.py

+        self._name = SENSOR_TYPES[sensor_type][0]
        self._type = sensor_type
-        self._state = None
+        self._state = STATE_UNKNOWN


Init state to None.

MartinHjelmare · 2018-08-26T17:13:40Z

homeassistant/components/sensor/trafikverket_weatherstation.py

-        # air_vs_road contains "Air" or "Road" depending on user input.
-        self._state = final[air_vs_road]["Temp"]
+            self._weather = await\
+                self._weather_api.async_get_weather(self._station)


Break the line after the parenthesis instead.

MartinHjelmare · 2018-08-26T17:15:17Z

homeassistant/components/sensor/trafikverket_weatherstation.py

-        self._state = None
+        self._state = STATE_UNKNOWN
+        self._unit = SENSOR_TYPES[sensor_type][1]
+        self._code = None


Appreciate the feedback

endor-force · 2018-08-26T17:56:47Z

Updated and smoke tested with some scenarios for errors.

[ ] Documentation needs to be updated since it is a change in how to configure
I will fix that within short

MartinHjelmare · 2018-08-26T18:40:48Z

Please also add a paragraph in the PR description about the breaking change for the release notes.

MartinHjelmare

Ping me when description is updated and docs done.

endor-force · 2018-08-26T19:56:04Z

@MartinHjelmare
I have updated existing PR for the doc and updated the description to accommodate for the changes.

MartinHjelmare · 2018-08-26T20:13:49Z

Please write what has changed regarding configuration.

endor-force · 2018-08-26T20:24:09Z

Done 👍

tubalainen · 2018-08-29T08:52:57Z

This is sooo great! Thanks guys! Cannot wait for the release! <3
Tack @MartinHjelmare !

Added precipitation type from API

fff5425

Enables users to see type of precipitation. Value returned from API is a string in swedish.

homeassistant added cla-signed merging-to-master This PR is merging into the master branch and should probably change the branch to `dev`. platform: sensor.trafikverket_weatherstation small-pr PRs with less than 30 lines. labels Aug 12, 2018

ghost added the in progress label Aug 12, 2018

endor-force mentioned this pull request Aug 12, 2018

Update for precipitation instructions home-assistant/home-assistant.io#5998

Closed

2 tasks

endor-force changed the base branch from master to dev August 12, 2018 10:34

MartinHjelmare removed the merging-to-master This PR is merging into the master branch and should probably change the branch to `dev`. label Aug 12, 2018

Corrected tox verification errors

b7ad9fc

Correction of tox findings

homeassistant added the cla-signed label Aug 12, 2018

Missed in tox - fixed

a936880

houndci-bot reviewed Aug 12, 2018

View reviewed changes

endor-force added 3 commits August 12, 2018 16:11

Hound witespace fix

e606b2a

Updated comment to trigger travis rebuild

d4c95bb

Travis tox failed due to problem with tox build process. Correcting in a comment to trigger retry in travis..

Try to retrigger travis/tox successful rebuild

5488703

houndci-bot reviewed Aug 13, 2018

View reviewed changes

Cleaning

f6db0dd

houndci-bot reviewed Aug 13, 2018

View reviewed changes

Cleaning more

269b571

endor-force mentioned this pull request Aug 13, 2018

Add multiple sensor types for Trafikverket home-assistant/home-assistant.io#6006

Merged

2 tasks

balloob requested changes Aug 14, 2018

View reviewed changes

fabaff previously approved these changes Aug 14, 2018

View reviewed changes

Trafikverket rebuilt for library

b9f4cfc

Extended pytrafikverket with weather sensor collction Changed behaviour of sensor component to use pytrafikverket. Added more sensors. User need to change config to use new version. [] Documentation needs to be updated

homeassistant added the cla-signed label Aug 26, 2018

Merge branch 'dev' into update_trafikverketsensor

9d38a34

MartinHjelmare reviewed Aug 26, 2018

View reviewed changes

Cleaned up based on Martins input

e189e02

Appreciate the feedback

MartinHjelmare added the breaking-change label Aug 26, 2018

MartinHjelmare approved these changes Aug 26, 2018

View reviewed changes

endor-force changed the title ~~Added precipitation type from API~~ Rewrite of Trafikverket weather - Multiple sensor types added Aug 26, 2018

endor-force changed the title ~~Rewrite of Trafikverket weather - Multiple sensor types added~~ Rewrite of Trafikverket weather - Multiple sensor types supported Aug 26, 2018

MartinHjelmare merged commit a439690 into home-assistant:dev Aug 27, 2018

ghost removed the in progress label Aug 27, 2018

endor-force deleted the update_trafikverketsensor branch August 27, 2018 10:32

balloob mentioned this pull request Sep 17, 2018

0.78.0 #16666

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost added integration: trafikverket_weatherstation and removed platform: sensor.trafikverket_weatherstation labels Mar 21, 2019

		add_devices([TrafikverketWeatherStation(
		sensor_name, sensor_api, sensor_station, sensor_type)], True)



		def setup_platform(hass, config, add_entities, discovery_info=None):
		async def async_setup_platform(hass, config, async_add_devices,

Uh oh!

Conversation

endor-force commented Aug 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

endor-force commented Aug 12, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

endor-force commented Aug 14, 2018

Uh oh!

fabaff commented Aug 14, 2018

Uh oh!

MartinHjelmare commented Aug 15, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

endor-force commented Aug 17, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

endor-force commented Aug 26, 2018

Uh oh!

MartinHjelmare commented Aug 26, 2018

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

endor-force commented Aug 26, 2018

Uh oh!

MartinHjelmare commented Aug 26, 2018

Uh oh!

endor-force commented Aug 26, 2018

Uh oh!

tubalainen commented Aug 29, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

endor-force commented Aug 12, 2018 •

edited

Loading

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

fabaff left a comment •

edited

Loading

MartinHjelmare commented Aug 15, 2018 •

edited

Loading