Plugin signaling examples

Signaling Examples

Demonstrates OSPy and plug-in signal subscriptions and records received events.

At a glance

Item	Value
Version	1.0.0
Category	Utilities and development examples
Author	Martin Pihrt
License	GPL-3.0
OSPy	3.0.211 or newer
Python	3.8 or newer
Permissions	system
Hardware	No dedicated hardware requirement declared
Dependencies	None
Python/OS packages	blinker (required)
Interfaces	No provider or mobile API declared
Source	Open the plug-in directory

What it is for

Demonstrates OSPy and plug-in signal subscriptions and records received events.

How it works and how to configure it

Tested in Python 3+

This is Example signal plugin provides functions triggered by signals from core program. Example signals from: webpages.py, scheduler.py, stations.py, plugins:

The plug-in includes an OSPy plugin.json manifest and implements health(). Signal receivers are registered directly during plug-in startup and fully disconnected during shutdown; no background thread is required. Diagnostics reports the registered receiver count and last received signal.

• signal('loggedin')
  
• signal('value_change')
  
• signal('option_change')
  
• signal('rebooted')
  
• signal('restarted')
  
• signal('station_names')
  
• signal('program_change')
  
• signal('program_deleted')
  
• signal('program_toggled')
  
• signal('program_runnow')
  
• signal('zone_change')
  
• signal('rain_active')
  
• signal('rain_not_active')
  
• signal('master_one_on')
  
• signal('master_one_off')
  
• signal('master_two_on')
  
• signal('master_two_off')
  
• signal('pressurizer_master_relay_on')
  
• signal('pressurizer_master_relay_off')
  
• signal('poweroff')
  
• signal('ospyupdate')
  
• signal('station_on')
  
• signal('station_off')
  
• signal('station_clear')
  
• signal('internet_available')
  
• signal('internet_not_available')
  
• signal('rain_delay_set')
  
• signal('rain_delay_remove')
  
• signal('hass_plugin_update')
  
• signal('core_30_sec_tick')
  
• signal('air_temp_humi_plugin_update')
  

In-app help and settings notes

The following notes are generated from the help page shipped with this plug-in. Field names are also explained directly in the OSPy settings page.

This is Example signal plugin provides functions triggered by signals from core program.

Example signals

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