Schrolli91/BOSWatch
1
0
Fork 0
mirror of https://github.com/Schrolli91/BOSWatch.git synced 2026-01-10 02:20:09 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

edit plugin readme Issue #40

Browse source
This commit is contained in:
Schrolli 2015-07-07 14:24:41 +02:00
parent 1d65f9fb97
commit 3880227fc2
1 changed files with 56 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
plugins/README.md
View file

@ -2,20 +2,53 @@
More information and a little Tutorial coming soon!
### Plugin template
##### General
### 1. Plugin template
##### 1.1 General
You can find a little template plugin file in `plugins/template/template.py`
##### .onLoad()
This onLoad() routine is called one time for initialize the plugin
##### .run()
This onLoad() routine is called every time an alarm comes in
### Use Global Logging
##### Init and Use
##### Choose right Loglevel
##### 1.2 Plugin Init `.onLoad()`
This `.onLoad()` routine is called one time for initialize the plugin
### Use config file
##### Own configuration in config.ini
##### 1.3 Plugin call `.run()`
This `.run()` routine is called every time an alarm comes in
### 2. Use Global Logging
##### 2.1 Init and Use
First you must import the logging module
```python
import logging # Global logger
```
Now you can send log messages with:
```python
logging.LOGLEVEL("MESSAGE")
```
You must replace the word `LOGLEVEL` with one if the following `debug`, `info`, `warning`, `error`, `exception` or `critical`
To use the right loglevel see next section `2.2 Choose right Loglevel`
##### 2.2 Choose right Loglevel
`debug`
all messages to find errors and for the internal program flow
`info`
messages that serve only to inform the user
`warning`
`error`
error does not lead to the end of boswatch
`Exception`
`critical`
errors leading to the end of boswatch immediate - in plugins not allowed
### 3. Use config file
##### 3.1 Own configuration in config.ini
First you must set a new Section in `config.ini`
A section is between brackets. Its recommended to give the section the same name as the plugin. `[SECTION_NAME]`
@ -28,7 +61,7 @@ test1 = testString
test2 = 123456
```
##### Read data from config.ini
##### 3.2 Read data from config.ini
To read yout configuration data you must import the `globals.py` where the global config-object is located:
```python
from includes import globals # Global variables
@ -46,14 +79,18 @@ VALUE = globals.config.getboolean("SECTION", "OPTION") #Value must be an Boolean
```
### Global helper functions
##### timeHandler.py
##### wildcardHandler.py
### 4. Global helper functions
##### 4.1 timeHandler.py
##### 4.2 wildcardHandler.py
### Process the data from BOSWatch
### 5. Process the data from BOSWatch
Three parameters are passed during the alarm to the .run() method
##### typ
##### 5.1 typ
Thats the function of the alarm. Possible values are **FMS**, **ZVEI** or **POC**
##### freq
##### 5.2 freq
The reception frequency of the tuner in Hz
##### data[ ]
##### 5.3 data[ ]