Add linky sensor #16468
Add linky sensor #16468
Conversation
ghost
added
the
There was a problem hiding this comment.
Would be nice to use and update release of pylinky when
Pirionfr/pyLinky#3 was addressed.
.coveragerc
Outdated
| @@ -180,6 +180,8 @@ omit = | |||
| homeassistant/components/lametric.py | |||
| homeassistant/components/*/lametric.py | |||
|
|
|||
| homeassistant/components/*/linky.py | |||
There was a problem hiding this comment.
Please move it to the others sensors below.
| password = config.get(CONF_PASSWORD) | ||
|
|
||
| from pylinky.client import LinkyClient | ||
| client = LinkyClient(username, password) |
There was a problem hiding this comment.
Please check if the credentials are valid. If not, make the platform setup fail with a log entry. Otherwise will the users end-up with a platform which is not working in their instance.
There was a problem hiding this comment.
Actually, the constructor is doing nothing except storing credentials.
fetch_data() is the only method that login the user and load its data, that's the reason why it's inside the try/catch block.
There was a problem hiding this comment.
You should make the first call in setup_platform in this case to ensure that the credentials are valid.
|
|
||
| _LOGGER.debug(json.dumps(self._client.get_data(), indent=2)) | ||
|
|
||
| if self._client.get_data(): |
There was a problem hiding this comment.
Handle this in the try-except block. Return as early as possible.
There was a problem hiding this comment.
get_data() is a getter, not an API call (fetch_data() is). Are you sure to want to put it into the try/catch block?
There was a problem hiding this comment.
If fetch_data() fails then it doesn't make sense to go on with update().
| REQUIREMENTS = ['pylinky==0.1.5'] | ||
| _LOGGER = logging.getLogger(__name__) | ||
|
|
||
| DOMAIN = 'linky' |
There was a problem hiding this comment.
Remove this. This platform belongs to the sensor domain.
| }) | ||
|
|
||
|
|
||
| def setup_platform(hass, config, add_devices, discovery_info=None): |
There was a problem hiding this comment.
Rename add_devices to add_entities.
|
|
||
| def setup_platform(hass, config, add_devices, discovery_info=None): | ||
| """Configure the platform and add the Linky sensor.""" | ||
| username = config.get(CONF_USERNAME) |
There was a problem hiding this comment.
Don't use dict.get use dict[key] for required config keys.
| """Fetch new state data for the sensor.""" | ||
| try: | ||
| self._client.fetch_data() | ||
| except BaseException as exp: |
There was a problem hiding this comment.
Please only except the exception we expect.
| # get the last past day data | ||
| self._state = self._client.get_data()['daily'][-2]['conso'] | ||
| else: | ||
| self._state = 0 |
There was a problem hiding this comment.
Unknown state should be represented with None.
| timeout = config[CONF_TIMEOUT] | ||
|
|
||
| from pylinky.client import LinkyClient | ||
| client = LinkyClient(username, password, None, timeout) |
There was a problem hiding this comment.
If the credentials are wrong make the platform setup fail.
There was a problem hiding this comment.
Did you mean "valid" data?
Otherwise, there is no public login function. Everything is done in the fetch_data function.
There was a problem hiding this comment.
You need to make the first request to the API during the platform setup and go for the PyLinkyError.
| except BaseException as exp: | ||
| _LOGGER.error(exp) | ||
|
|
||
| _LOGGER.debug(json.dumps(self._client.get_data(), indent=2)) |
There was a problem hiding this comment.
Again, return if you can't retrieve the data. The debug message will be empty, thus it will not be useful.
| except PyLinkyError as exp: | ||
| _LOGGER.error(exp) | ||
| return | ||
| except BaseException as exp: |
There was a problem hiding this comment.
Don't know if your read a bit about pylinky package, but most of the errors are not handled within PyLinkyError error. So it won't be handled.
There was a problem hiding this comment.
We should only catch specific expected errors, and not use broad except. If there is a specific error that we expect we can add an except block for that.
| except PyLinkyError as exp: | ||
| _LOGGER.error(exp) | ||
| return | ||
| except BaseException as exp: |
|
Hi, I get login errors although my username and password are ok (i can connect to the Enedis site). Is there any special operation I have to do ? I tried to write my username and pwd without quotes, between quotes, between simple quotes, I even tried several combinations (username between quotes, pwd without etc...) but it doesn't change anything. Am I missing something ? |
|
Please open an issue if you suspect a bug. If you need help please use our help channels: Merged PRs should not be used for support or bug reports. Thanks! |
Description:
It adds a component (sensor) showing the last day consumption of your home from the Linky electric meter.
Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#6214
Example entry for
configuration.yaml(if applicable):Checklist:
tox. Your PR cannot be merged unless tests passIf user exposed functionality or configuration variables are added/changed:
If the code communicates with devices, web services, or third-party tools:
REQUIREMENTSvariable (example).requirements_all.txtby runningscript/gen_requirements_all.py..coveragerc.