optional displaying the sensors location on the map

[c7h]

Description:

the sensor is now using the correct attributes (latitued and longitued) which enables them to show up on the map.

Breaking change

The sensor attributes for GPS location used to be lat and long. This has been changed to latitude and longitude respectively.

Related issue (if applicable): fixes #

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

Example entry for configuration.yaml (if applicable):

Checklist:

• The code change is tested and works locally.

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:

• Local tests with tox run successfully. Your PR cannot be merged unless tests pass
• New dependencies have been added to the REQUIREMENTS variable (example).
• New dependencies are only imported inside functions that use them (example).
• New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
• New files were added to .coveragerc.

[tinloaf]

Looks good! This is, however, a breaking change. Could you write a 1-2 sentences describing this in a special "Breaking Change" paragraph in your original PR text?

[fabaff]

Showing a sensor on the map needs to be an optional feature because if the sensor isn't around the corner of your location the map will be loaded with a zoom level that everything fits.

We discussed this for the iss platform already deeply and agreed on using show_on_map.

[tinloaf]

Makes sense. The "airvisual" sensor seems to use the same config option. Perhaps it would be beneficial to extract that into const.py.

[c7h]

@fabaff I've implemented the requested change. It makes sense to give the user an option to exclude the sensor from the map. The documentation will require an update now as well.

[tinloaf]

Now it technically has less features than before if CONF_SHOW_ON_MAP = False, because the coordinates are not part of the attributes anymore. The iss platform solves this by setting the lat and lon attributes if CONF_SHOW_ON_MAP = False, and the ATTR_LATITUDE and ATTR_LONGITUDE if CONF_SHOW_ON_MAP = True.

If you were to implement it in the same way, and set the default for CONF_SHOW_ON_MAP to false, it even wouldn't be a breaking change anymore.

[c7h]

That's a valid point. I will change it accordingly. Not breaking things is good 👍

[tinloaf]

Looks good now. 👍

[fabaff]

If show_on_map is True then we will have duplicate entries in the state card (lat/ and long/longitude). It should be either lat and long or latitude and longitude.

[c7h]

OK - didn't know that that's a problem. I thought this way it will be always non-breaking.

[fabaff]

It's not a problem but looks wired and could confuse people because the same data is shown twice. [ATTR_LATITUDE] and [ATTR_LONGITUDE] are exposed by default. Don't append it to the existing attributes, just make two different dict in regard of the configuration.

[c7h]

ok, agreed! 👍

[c7h]

@fabaff anything else? :)

[fabaff]

Thanks 🐦