search

homebridge / verified

Plugins Verified by Homebridge
https://homebridge.io/w/Verified-Plugins
362 stars 16 forks source link

Verification Request: homebridge-pichler-pkom4 #721

Closed jtasoftware closed 1 month ago

jtasoftware commented 2 months ago

Plugin Name

homebridge-pichler-pkom4

Link To GitHub Repo

https://github.com/jtasoftware/homebridge-pkom4-plugin

Plugin Icon (Optional)

No response

The plugin does not offer the same nor less functionality than that of any existing verified plugin.

🟢 Yes

The plugin successfully installs and does not start unless it is configured.

🟢 Yes

The plugin does not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.

🟢 Yes

The plugin does not contain any analytics or calls that enable you to track the user.

🟢 Yes

If the plugin needs to write files to disk (cache, keys, etc.), it stores them inside the Homebridge storage directory.

🟢 Yes

The plugin does not throw unhandled exceptions, the plugin must catch and log its own errors.

🟢 Yes

More Information

No response

github-actions[bot] commented 2 months ago

🔴 The following pre-checks failed:

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

jtasoftware commented 2 months ago

You will see a warning stating that dioxyde characteristic is not part of mandatory or optional air quality sensor. This is a misleading warning for two reasons :

jtasoftware commented 2 months ago

🔴 The following pre-checks failed:

  • Installation: failed to install [127]
  • Failed to install

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

Can you please provide details on how the installation is tested ? Just tried 2 installations (on MacBook and brand new Raspberry) and both installed fluently.

jtasoftware commented 2 months ago

/check

github-actions[bot] commented 2 months ago

🔴 The following pre-checks failed:

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

jtasoftware commented 2 months ago

/check

github-actions[bot] commented 2 months ago

🔴 The following pre-checks failed:

🟢 The following pre-checks passed:

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

jtasoftware commented 2 months ago

/check

github-actions[bot] commented 2 months ago

🟢 The following pre-checks passed:

🎉 All pre-checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

bwp91 commented 2 months ago

Hi @jtasoftware just a couple of points from me.

  1. Could you update your bugs URL to use https://? I think I will add another check to the verification script to check this!
  2. I installed your plugin on my pi and I get these logs:
...
[26/04/2024, 00:34:22] [PKOM 4] Modbus session is busy operation will be ignored
[26/04/2024, 00:34:22] [PKOM 4] Modbus status loaded (total duration 11 ms)
[26/04/2024, 00:34:22] [PKOM 4] Available PKOM model: PKOM4 Classic
[26/04/2024, 00:34:22] [PKOM 4] Available PKOM sensors: humidity & dioxide
[26/04/2024, 00:34:22] [PKOM 4] Available PKOM options: water resist. & duct battery
[26/04/2024, 00:34:22] [PKOM 4] Initial Modbus status load done
[26/04/2024, 00:34:22] [PKOM 4] Accessories characteristics initializing…
[26/04/2024, 00:34:22] [PKOM 4] Accessories characteristics init done
[26/04/2024, 00:34:22] [PKOM 4] Modbus recurrent checking is on
[26/04/2024, 00:34:22] [PKOM 4] Modbus session is busy operation will be ignored
[26/04/2024, 00:34:22] [PKOM 4] Modbus session is busy operation will be ignored
[26/04/2024, 00:34:22] [PKOM 4] Modbus status saved (total duration 2 ms)
[26/04/2024, 00:34:22] [PKOM 4] Error installing modbus module Error: [Errno 13] Permission denied: '/usr/local/lib/node_modules/homebridge-pichler-pkom4/scripts/include'
...

Would these logs seem normal to you? Im really referring to the last line. It's not really a verification-issue, but just thought I would 'report' this. Great that it doesn't crash the homebridge process!

bwp91 commented 2 months ago

/check

github-actions[bot] commented 2 months ago

🔴 The following pre-checks failed:

🟢 The following pre-checks passed:

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

bwp91 commented 2 months ago

^ was using this verification request as a guinea pig for changes I just made!

jtasoftware commented 2 months ago

/check

github-actions[bot] commented 2 months ago

🟢 The following pre-checks passed:

🎉 All pre-checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

jtasoftware commented 2 months ago
  1. I installed your plugin on my pi and I get these logs:
...
[26/04/2024, 00:34:22] [PKOM 4] Modbus session is busy operation will be ignored
[26/04/2024, 00:34:22] [PKOM 4] Modbus status saved (total duration 2 ms)
[26/04/2024, 00:34:22] [PKOM 4] Error installing modbus module Error: [Errno 13] Permission denied: '/usr/local/lib/node_modules/homebridge-pichler-pkom4/scripts/include'
...

Would these logs seem normal to you? Im really referring to the last line. It's not really a verification-issue, but just thought I would 'report' this. Great that it doesn't crash the homebridge process!

Thanks for notifying. Just to troubleshoot, could you please confirm if the latest log lines show message 'serial bus is not connected' or 'serial bus is not installed' ?

If it's 'not connected' everything is fine. If it's 'not installed' I would need extra check:

Do you see the same error ?

bwp91 commented 2 months ago

please bear in mind that on my pi all I have done is install the plugin and enabled the 'simulation' mode in the config

[27/04/2024, 20:01:18] [PKOM 4] Child bridge process ended
[27/04/2024, 20:01:18] [PKOM 4] Process Ended. Code: 143, Signal: null
[27/04/2024, 20:01:25] [PKOM 4] Restarting Process...
[27/04/2024, 20:01:26] [PKOM 4] Launched child bridge with PID 13435
[27/04/2024, 20:01:27] [PKOM 4] Loaded homebridge-pichler-pkom4 v1.1.6-beta.2 child bridge successfully
[27/04/2024, 20:01:27] [PKOM 4] Copyright © 2022/2024 by J. Tarantino, released under EUPL license
[27/04/2024, 20:01:27] [PKOM 4] Loading accessory from cache: PKOM 4
[27/04/2024, 20:01:27] [PKOM 4] Pichler-PKOM4 platform finished initializing
[27/04/2024, 20:01:27] [PKOM 4] Restoring existing accessory from cache: PKOM 4
[27/04/2024, 20:01:27] [PKOM 4] Platform config: simulate
[27/04/2024, 20:01:27] [PKOM 4] Hardware informations for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Mechanical ventilation for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Filter maintenance for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Air quality sensor for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Air purifier for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Dehumidifier for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Air conditioner for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Water heater for 'PKOM 4' created
[27/04/2024, 20:01:27] [PKOM 4] Modbus session created with log level: 0
[27/04/2024, 20:01:27] [PKOM 4] Installing modbus module in homebridge storage zone
[27/04/2024, 20:01:27] [PKOM 4] Initial Modbus status loading…
[27/04/2024, 20:01:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:01:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:01:27] [PKOM 4] Modbus status loaded (total duration 12 ms)
[27/04/2024, 20:01:27] [PKOM 4] Available PKOM model: PKOM4 Classic
[27/04/2024, 20:01:27] [PKOM 4] Available PKOM sensors: humidity & dioxide
[27/04/2024, 20:01:27] [PKOM 4] Available PKOM options: water resist. & duct battery
[27/04/2024, 20:01:27] [PKOM 4] Initial Modbus status load done
[27/04/2024, 20:01:27] [PKOM 4] Accessories characteristics initializing…
[27/04/2024, 20:01:27] [PKOM 4] Accessories characteristics init done
[27/04/2024, 20:01:27] [PKOM 4] Modbus recurrent checking is on
[27/04/2024, 20:01:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:01:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:01:27] [PKOM 4] Modbus status saved (total duration 2 ms)
[27/04/2024, 20:01:27] [PKOM 4] Error installing modbus module Error: [Errno 13] Permission denied: '/usr/local/lib/node_modules/homebridge-pichler-pkom4/scripts/include'
[27/04/2024, 20:02:27] [PKOM 4] Modbus recurrent checking ongoing…
[27/04/2024, 20:02:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:02:27] [PKOM 4] Modbus status loaded (total duration 1 ms)
[27/04/2024, 20:02:27] [PKOM 4] Simulation - air quality modulating (∆h:0.010000000000000002, ∆d:1)
[27/04/2024, 20:02:27] [PKOM 4] Modbus session is busy operation will be ignored
[27/04/2024, 20:02:27] [PKOM 4] Modbus status saved (total duration 1 ms)
[27/04/2024, 20:02:27] [PKOM 4] Modbus recurrent checking done

these logs are bearing in mind I have not performed those steps

bwp91 commented 2 months ago

is there a post install script that needs to be run?

jtasoftware commented 2 months ago

To respect rules of verified plugins, post-install script is now run during startup. It will create a virtual python env. inside plugin folders and install a specific module in this venv.

bwp91 commented 2 months ago

is this what the /usr/local/lib/node_modules/homebridge-pichler-pkom4/scripts/include does?

jtasoftware commented 2 months ago

/include is one of the sub-folder created for private python virtual env.

I assume that the installation has been interrupted initially and then left a corrupted structure.

Latest beta tries to auto-repair a corrupted venv.

jtasoftware commented 1 month ago

I’ve tried to restart during startup on multiple test sessions to interrupt startup and was able to reproduce the problem. Version 1.1.6 now auto-cleanup corrupted cache.

Obviously this process generates logs but do not generate any exception.

bwp91 commented 1 month ago

With 1.1.7-beta I just reinstalled the plugin and got this:

[04/05/2024, 13:21:46] [PKOM 4] Error installing modbus module /bin/rm: cannot remove '/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/lib/python3.9/site-packages/serial/serialcli.py': Permission denied
/bin/rm: cannot remove '/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/lib/python3.9/site-packages/serial/threaded/__init__.py': Permission denied
/bin/rm: cannot remove '/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/lib/python3.9/site-packages/serial/rs485.py': Permission denied
/bin/rm: cannot remove '/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/lib/python3.9/site-packages/serial/serialwin32.py': Permission denied
...REMOVED FOR BREVITY
/bin/rm: cannot remove '/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/bin/activate.csh': Permission denied
Error: [Errno 13] Permission denied: '/usr/local/lib/node_modules/homebridge-pichler-pkom4/scripts/include'
/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/install.sh: 46: /usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/bin/pip: not found
/usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/install.sh: 48: /usr/local/lib/node_modules/homebridge-pichler-pkom4/dist/../scripts/bin/pip: not found

I'm passing these messages on more as an FYI.

It is correct that it does not throw any errors

github-actions[bot] commented 1 month ago
github-actions[bot] commented 1 month ago

Congratulations! Your plugin has been verified!

You can now add one of the Verified by Homebridge badges to your plugin's README:

verified-by-homebridge

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

verified-by-homebridge

[![verified-by-homebridge](https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)

Your plugin is now also eligible to display a :heart: Donate button on its tile in the Homebridge UI. See https://github.com/homebridge/homebridge/wiki/Donation-Links for instructions.

If for any reason in the future you can no longer maintain your plugin, please consider transferring it to our unmaintained plugins repo. We can take ownership until another willing developer comes along.

Don't forget to join the official Homebridge Discord server, where plugin developers can get tips and advice from other developers and the Homebridge project team in the #plugin-development channel!

As a verified plugin, you can request a channel in the Discord server to discuss your plugin with users and other developers. Just ask in the #plugin-development channel.

Thank you for your contribution to the Homebridge community.

jtasoftware commented 1 month ago

Thanks for the verification