Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

All plugins: Update your plugins to enable parameter check by admin interface #345

Closed
13 tasks
bmxp opened this issue Apr 11, 2020 · 7 comments
Closed
13 tasks
Milestone

Comments

@bmxp
Copy link
Member

bmxp commented Apr 11, 2020

Dear plugin developers, maintainers and testers. I have reviewed the plugins available as of April 11th, 2020 and found a bunch of them to not use the latest developments and findings in plugin technology ;-)

It is not needed anymore to pass the plugin parameters to a smart plugins via parameter of init function. It is however good practice to use the self.get_parameter_value() function instead of passing arguments. This enables the admin interface to configure the plugins during runtime and provide error checking.

Furthermore it is advised to update all meta data. Please revise the section of tester, maintainer and especially the state of development. Is the plugin doing fine the it should be communicated in the plugin.yaml.
Check to see if there is a support thread in knx user forum and please fill in the keywords as well.
Did you also check for a logo to use in gui and webinterface?

Plugins (that are not deprecated) to overhaul:

  • plugins/comfoair/init.py # Stefan Kals
  • plugins/helios/init.py # Tom-Bom-badil
  • plugins/intercom_2n/init.py # @Pfischi
  • plugins/jvcproj/init.py # Nico P.
  • plugins/kostal/init.py # @ohinckel, Wenger Florian
  • plugins/luxtronic2/init.py
  • plugins/plex/init.py # @rthill
  • plugins/rcswitch/init.py # Daniel Frank
  • plugins/roomba_980/init.py
  • plugins/sma/init.py # @robert-budde
  • plugins/smarttv/init.py
  • plugins/sml/init.py # @ohinckel
  • plugins/systemair/init.py # @robert-budde
@msinn
Copy link
Member

msinn commented Jun 26, 2020

The Issue title is a bit misleading. parameters are checked though lib.metadata and this is done even if self.get_parameter_value() is not used. The Admin Interface uses only the metadata from plugin.yaml to check entered config data.

The list above seems to reflect only, if get_parameter_value() is used in the plugin.

@msinn msinn added this to the Version 1.9 milestone Dec 31, 2020
@msinn msinn changed the title Update your plugins to enable parameter check by admin interface All plugins: Update your plugins to enable parameter check by admin interface Dec 23, 2021
@msinn msinn modified the milestones: Version 1.9, Version 1.10 Mar 9, 2023
@msinn
Copy link
Member

msinn commented Aug 29, 2023

Almost nothing happens with this issue. In the last year from the to to list only two plugins have been modified, one was retired and one was deprecated.

I removed the 22 plugins that have been done and the 21 deprecated/retired plugins from the first post to make it more managable.

@Morg42
Copy link
Member

Morg42 commented Nov 24, 2023

checked and modified some plugins in PR #857

As I can't test any of those plugins, please test them if you can - @maintainers?

@Morg42
Copy link
Member

Morg42 commented Nov 24, 2023

All listed plugins are checked and modified, please test.

@Morg42
Copy link
Member

Morg42 commented Nov 25, 2023

addendum: i "migrated" all plugins to the SmartPlugin call syntax of init, tried to make them restartable, moved scheduler calls from sh to SmartPlugin, removed superfluous logging imports and cleaned up the code a bit (visually mostly, to (mostly) comply with PEP8 (e.g. for flake8).

As I do not own any of the devices, I can not really test the plugins short of "run up to unfinished init"...

@Morg42
Copy link
Member

Morg42 commented Dec 7, 2023

If no one wants to test, we could just merge the PR and have it tested publicly... ;)

@Morg42
Copy link
Member

Morg42 commented Jan 18, 2024

As the PR is merged, this seems to be done.

@Morg42 Morg42 closed this as completed Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants