Skip to content

Plugin relay

Martin Pihrt edited this page Oct 13, 2026 · 1 revision

Relay Test

Runs a bounded test of the OSPy relay output.

At a glance

Item Value
Version 1.0.0
Category Hardware, displays and outputs
Author Rimco
License GPL-3.0
OSPy 3.0.211 or newer
Python 3.8 or newer
Permissions system
Hardware interfaces: relay_output
Dependencies None
Python/OS packages None
Interfaces No provider or mobile API declared
Source Open the plug-in directory

What it is for

Runs a bounded test of the OSPy relay output.

How it works and how to configure it

Tested in Python 3+

Example plugin to demonstrate OSPY on-board relay. The plug-in switches the relay on for 3 seconds and then switches it off.

The plug-in includes an OSPy plugin.json manifest, registers its test worker with the shared plug-in runtime, and implements health(). Diagnostics reports the worker state, physical relay command state, and test duration.

The hardware should be connected as follows:

Example use relay test plugin: Control Your garage door from OSPy webpages.

Support

Check OSPy → Diagnostics first and remove passwords, tokens, private addresses and other secrets before sharing logs. Report reproducible plug-in problems in the OSPy-plugins issue tracker.

Back to the plug-in catalog

Clone this wiki locally