Getting Started

Getting started

Before installation

1. Update OSPy to a version that satisfies the plug-in's minimum OSPy requirement.
2. Create a backup before installing a plug-in that controls hardware, updates the system or changes stored data.
3. Open the plug-in's Wiki page and review its dependencies, hardware, required packages and permissions.
4. Confirm that fixed GPIO, I²C and serial resources do not conflict with an enabled plug-in.

Install from OSPy

1. Sign in as an administrator and open Plugins → Manage.
2. Select Install New Plugin.
3. Choose the official OSPy-plugins repository or upload a trusted custom ZIP.
4. Select master for stable use. Select beta only for intentional testing.
5. Review compatibility, Python packages, dependencies, hardware conflicts and requested permissions before approving activation.
6. Open the new plug-in settings page, configure only the required functions and save.
7. Check Diagnostics and perform a supervised real-device test.

Updates

An update with the same or fewer permissions keeps its approval. An update that adds a permission requires new administrator approval and is skipped by automatic update until reviewed. Read the plug-in page and repository changelog before updating safety-critical hardware.

Removal

Disable the plug-in first and confirm that outputs or background operations stop safely. Removing a plug-in can leave its data directory for recovery or migration depending on the OSPy operation used; back up data before permanent deletion.

Browse all plug-ins