Plugin Issues

[joshuamiller627-AV]

When I load in a Plugin that I have built the icon shows and the plugin is an option in the UI but when I go the the Plug in it says Plugin not registered.

I am pretty new to this stuff so let me know if I am doing something wrong.

The plug in is in src/plugins and i have all the info right in the plugin-info.json file

[daveshenal]

The icon showing up and the "not registered" error might coming from two completely separate parts of the code. the UI list just scans for plugin-info.json files, while actually registering a plugin requires a few exact matches that are easy to get slightly wrong as a new plugin.

A few things worth checking, based on how the registration code works:

1. Does your plugin's folder name exactly match the "id" field in your plugin-info.json?
2. Inside that folder, is there a file named exactly <id>.py?
3. Inside that file, does your class name exactly match the "class" field in plugin-info.json (case sensitive)?

For reference, here's the pattern the built-in Weather plugin follows:

src/plugins/weather/
  ├── plugin-info.json   →  {"display_name": "Weather", "id": "weather", "class": "Weather"}
  └── weather.py          →  class Weather(BasePlugin): ...

My guess is it's most likely #3 if the class name doesn't match exactly, that failure happens silently with no error logged at all, which would explain why everything looks fine in the UI but breaks when you actually try to use it. Worth double checking your app logs too.. if you see "Could not find plugin directory" or "Could not find module path", that points to #1 or #2 instead.

[joshuamiller627-AV]

so looking everything seems correct

from plugins.base_plugin.base_plugin import BasePlugin
import os
import gspread
from oauth2client.service_account import ServiceAccountCredentials
from PIL import Image, ImageDraw, ImageFont

class audio_to_do(BasePlugin):

this is the beginning of my code

this is my info file

{
    "display_name": "Audio To Do",
    "id": "audio_to_do",
    "class": "audio_to_do",
    "description": "Displays a Google Sheets to-do list. Requires service account credentials and sheet name."
}

[joshuamiller627-AV]

here is the Log

Jun 26 11:36:30 PiZero inkypi[1072]: 11:36:30 - INFO - __main__ - Starting InkyPi in PRODUCTION mode on port 80
Jun 26 11:36:30 PiZero inkypi[1072]: 11:36:30 - INFO - display.waveshare_display - Initializing Waveshare display
Jun 26 11:36:30 PiZero inkypi[1072]: 11:36:30 - INFO - display.waveshare_display - Loading EPD display for epd7in3e display
Jun 26 11:37:43 PiZero inkypi[1072]: 11:37:43 - ERROR - root - Failed to import plugin module plugins.audio_to_do.audio_to_do: No module named 'gspread'
Jun 26 11:37:44 PiZero inkypi[1072]: 11:37:44 - INFO - refresh_task - Starting refresh task
Jun 26 11:37:44 PiZero inkypi[1072]: 11:37:44 - INFO - waitress - Serving on http://0.0.0.0:80
Jun 26 11:40:25 PiZero inkypi[1072]: 11:40:25 - ERROR - blueprints.plugin - EXCEPTION CAUGHT: Plugin 'audio_to_do' is not registered.
Jun 26 11:40:25 PiZero inkypi[1072]: Traceback (most recent call last):
Jun 26 11:40:25 PiZero inkypi[1072]:   File "/home/eink/InkyPi/src/blueprints/plugin.py", line 43, in plugin_page
Jun 26 11:40:25 PiZero inkypi[1072]:     plugin = get_plugin_instance(plugin_config)
Jun 26 11:40:25 PiZero inkypi[1072]:   File "/home/eink/InkyPi/src/plugins/plugin_registry.py", line 52, in get_plugin_instance
Jun 26 11:40:25 PiZero inkypi[1072]:     raise ValueError(f"Plugin '{plugin_id}' is not registered.")
Jun 26 11:40:25 PiZero inkypi[1072]: ValueError: Plugin 'audio_to_do' is not registered.
Jun 26 11:48:36 PiZero inkypi[1072]: 11:48:36 - ERROR - blueprints.plugin - EXCEPTION CAUGHT: Plugin 'audio_to_do' is not registered.
Jun 26 11:48:36 PiZero inkypi[1072]: Traceback (most recent call last):
Jun 26 11:48:36 PiZero inkypi[1072]:   File "/home/eink/InkyPi/src/blueprints/plugin.py", line 43, in plugin_page
Jun 26 11:48:36 PiZero inkypi[1072]:     plugin = get_plugin_instance(plugin_config)
Jun 26 11:48:36 PiZero inkypi[1072]:   File "/home/eink/InkyPi/src/plugins/plugin_registry.py", line 52, in get_plugin_instance
Jun 26 11:48:36 PiZero inkypi[1072]:     raise ValueError(f"Plugin '{plugin_id}' is not registered.")
Jun 26 11:48:36 PiZero inkypi[1072]: ValueError: Plugin 'audio_to_do' is not registered.

[saulob]

Hi @joshuamiller627-AV, the log shows the actual cause

The plugin is not being registered because its Python module fails to import on startup:

Failed to import plugin module plugins.audio_to_do.audio_to_do: No module named 'gspread'

So your folder name, plugin ID and class name appear to be matching correctly

The UI can still find the plugin-info.json, which is why the plugin appears in the list, but InkyPi cannot import the Python module, so it never gets registered

Try installing the dependencies inside the InkyPi virtual environment:

sudo su
source /usr/local/inkypi/venv_inkypi/bin/activate
pip install gspread oauth2client
deactivate
sudo systemctl restart inkypi.service

Then check the logs again

If gspread was the only missing dependency, the plugin should register after the restart

You may also want to eventually replace oauth2client with google-auth, since oauth2client is deprecated and newer versions of gspread recommend google.oauth2.service_account