Update the Panasonic Viera component #33433

joogps · 2020-03-30T14:37:54Z

Breaking change

If your TV needs encryption, just remove the entity and restart Home Assistant. The configurator will them show up in notifications asking you to start the pairing process (very much like the webostv integration).

Proposed change

Add encryption support for the Panasonic Viera integration (through configurator) with persistent data and a send_key service to easily send key presses to the TV. It also prevents HTTP errors by renewing the connection at every update and updates manifest.json and requirements_all.txt to require the latest panasonic-viera library version (0.3.4).

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml (same as documentation)
media_player:
  - platform: panasonic_viera
    host: 192.168.0.10

# Service data example for the send_key service
entity_id: media_player.living_room_tv
key: left

Additional information

There are still some changes that need to be made, such as preventing the entity from not being created and adding sources support.

This PR fixes or closes issue: fixes Panasonic GX800 series with Panasonic Viera TV integration doesn't works #29088
This PR is related to issue:
Link to documentation pull request: to-do

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for www.home-assistant.io

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

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

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

joogps · 2020-03-30T14:54:07Z

For some reason, the update of requirements_all.txt fails the CI tests. It's the first time I contribute to HA (actually probably the first time I contribute to such a big project), am I doing something wrong?

springstan

Please format your code with black and take a look at the flake8 errors on Azure DevOps.

springstan · 2020-03-31T06:31:58Z

homeassistant/components/panasonic_viera/manifest.json

@@ -2,7 +2,7 @@
  "domain": "panasonic_viera",
  "name": "Panasonic Viera TV",
  "documentation": "https://www.home-assistant.io/integrations/panasonic_viera",
-  "requirements": ["panasonic_viera==0.3.2", "wakeonlan==1.1.6"],
+  "requirements": ["panasonic_viera==0.3.4", "wakeonlan==1.1.6", "configurator"],


"configurator" is rather a dependency than a requirement since it is HA internal, therefore please move it to the dependencies.

MartinHjelmare

The access mode has changed for some of the files. Eg:
homeassistant/components/panasonic_viera/init.py 100644 → 100755

Please revert those changes.

MartinHjelmare · 2020-03-31T07:34:58Z

homeassistant/components/panasonic_viera/media_player.py

@@ -1,7 +1,7 @@
 """Support for interface with a Panasonic Viera TV."""
 import logging

-from panasonic_viera import RemoteControl
+from panasonic_viera import *


Please import names explicitly. Don't use a star.

MartinHjelmare · 2020-03-31T07:37:23Z

homeassistant/components/panasonic_viera/media_player.py

+                    needs_pairing = False
+
+        if needs_pairing:
+            configurator = hass.components.configurator


The configurator is legacy and should not be used for new code. Please create a config flow instead.

We have a scaffolding script to help you get started with that.

https://developers.home-assistant.io/docs/creating_component_index

MartinHjelmare · 2020-03-31T07:39:46Z

homeassistant/components/panasonic_viera/media_player.py

@@ -117,6 +177,14 @@ def __init__(self, mac, name, remote, host, broadcast, app_power, uuid=None):
        self._volume = 0
        self._app_power = app_power

+        hass.services.async_register(


We don't want side effects in init method. Please move the service registration out of init.

Also, we should limit this pull request to one thing. A new service can be added in a different PR.

ramondunker · 2020-03-31T11:39:06Z

If all tests pass, will it automatically be included in the Home Assistant Core?

joogps · 2020-04-01T00:47:08Z

Hi!
I'm just saw this (I spent the entire day doing school stuff), and I'll try to fix some of these errors when I have some extra time available. @ramondunker you are welcome to help if you want to!

(Also, I'm sorry for doing so many things wrong, it's the first time I contribute to Home Assistant and I probably didn't read the guidelines right.)

joogps · 2020-04-05T17:43:35Z

Working on it!

sgthree · 2020-04-05T22:33:31Z

Not sure if this is helpful, but there appears to be an issue with the Panasonic_viera 0.3.4 library that needs to be taken into account with this integration. If a command is sent to a tv when it is off, an HTTPError exception is thrown. Once this happens, the remote will not work any more. This is because the library code decrements _session_seq_num when an exception is thrown, but does not take into account the possibility that the exception occurs before _session_seq_num is incremented.
The remote therefore gets out of sync. Testing for the exception, and incrementing _session_seq_num when it occurs ensures that the remote still works.
You can use this to test whether the tv is on or off by issuing a get_mute command, which returns true or false if the tv is on, or throws and exception if it is off.

joogps · 2020-04-06T17:35:40Z

Thanks, @sgthree, I will investigate that!

I'll be creating a new pull request soon.

joogps added 2 commits March 30, 2020 11:17

Updating the Panasonic Viera component

4ddec6d

Updating requirements_all.txt

f5b950a

homeassistant added the cla-signed label Mar 30, 2020

probot-home-assistant bot added the integration: panasonic_viera label Mar 30, 2020

springstan added the breaking-change label Mar 30, 2020

springstan reviewed Mar 31, 2020

View reviewed changes

MartinHjelmare requested changes Mar 31, 2020

View reviewed changes

springstan changed the title ~~Updating the Panasonic Viera component~~ Update the Panasonic Viera component Mar 31, 2020

joogps closed this Apr 6, 2020

joogps mentioned this pull request Apr 8, 2020

Add config flow to panasonic_viera component #33829

Merged

20 tasks

lock bot locked and limited conversation to collaborators Apr 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update the Panasonic Viera component #33433

Update the Panasonic Viera component #33433

joogps commented Mar 30, 2020 •

edited

Loading

joogps commented Mar 30, 2020 •

edited

Loading

springstan left a comment

springstan Mar 31, 2020

MartinHjelmare left a comment

MartinHjelmare Mar 31, 2020

MartinHjelmare Mar 31, 2020

MartinHjelmare Mar 31, 2020

ramondunker commented Mar 31, 2020

joogps commented Apr 1, 2020 •

edited

Loading

joogps commented Apr 5, 2020

sgthree commented Apr 5, 2020

joogps commented Apr 6, 2020

Update the Panasonic Viera component #33433

Update the Panasonic Viera component #33433

Conversation

joogps commented Mar 30, 2020 • edited Loading

Breaking change

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

joogps commented Mar 30, 2020 • edited Loading

springstan left a comment

Choose a reason for hiding this comment

springstan Mar 31, 2020

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

MartinHjelmare Mar 31, 2020

Choose a reason for hiding this comment

MartinHjelmare Mar 31, 2020

Choose a reason for hiding this comment

MartinHjelmare Mar 31, 2020

Choose a reason for hiding this comment

ramondunker commented Mar 31, 2020

joogps commented Apr 1, 2020 • edited Loading

joogps commented Apr 5, 2020

sgthree commented Apr 5, 2020

joogps commented Apr 6, 2020

joogps commented Mar 30, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

joogps commented Mar 30, 2020 •

edited

Loading

joogps commented Apr 1, 2020 •

edited

Loading