cphipps/NetAlertX
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Plugins 0.1 - Readme update

Browse Source
This commit is contained in:
Jokob-sk
2023-02-12 17:45:49 +11:00
parent 97f7494c34
commit d16dd95d65
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
front/plugins/README.md
View File

@@ -1,3 +1,7 @@
# ⚠ Disclaimer
Highly experimental feature. Follow the below very carefully and check example plugin(s). Plugin UI is not my priority right now, happy to approve PRs if you are interested in extending/improvintg the UI experience.
## Overview ## Overview
PiAlert comes with a simple plugin system to feed events from third-party scripts into the UI and then send notifications if desired. PiAlert comes with a simple plugin system to feed events from third-party scripts into the UI and then send notifications if desired.
@@ -8,7 +12,7 @@ If you wish to develop a plugin, please check the existing plugin structure.
| File | Required | Description | | File | Required | Description |
|----------------------|----------------------|----------------------| |----------------------|----------------------|----------------------|
| `config.json` | yes | Contains the plugin configuration including the settings available to the user. | | `config.json` | yes | Contains the plugin configuration (manifest) including the settings available to the user. |
| `script.py` | yes | The Python script itself | | `script.py` | yes | The Python script itself |
| `last_result.log` | yes | The file used to interface between PiAlert and the plugin (script). | | `last_result.log` | yes | The file used to interface between PiAlert and the plugin (script). |
| `script.log` | no | Logging output (recommended) | | `script.log` | no | Logging output (recommended) |