Schrolli91/BOSWatch
1
0
Fork 0
mirror of https://github.com/Schrolli91/BOSWatch.git synced 2026-04-21 06:13:39 +00:00
Code Issues Projects Releases Packages Wiki Activity

edit plugin readme Issue #40

Browse source
This commit is contained in:
Schrolli 2015-07-07 14:08:46 +02:00
parent 4ad5766f98
commit 1d65f9fb97
3 changed files with 73 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

57
plugins/README.md
View file

@ -2,7 +2,58 @@
More information and a little Tutorial coming soon!
##### Code your own Plugin
To code your own Plugin look at the litte example `/plugins/template/template.py`
### Plugin template
##### 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
In the text-file `plugins/interface.txt` are all relevant data, that your plugin can use.
### Use Global Logging
##### Init and Use
##### Choose right Loglevel
### Use config file
##### 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]`
Now you can an set a unlimited number of options with its own value in these format: `OPTION = VALUE`.
Here is the sample from the template plugin:
```python
[template]
test1 = testString
test2 = 123456
```
##### 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
```
Now you can get your configration data with:
```python
VALUE = globals.config.get("SECTION", "OPTION") #Gets any value
```
or better, use this:
```python
VALUE = globals.config.getint("SECTION", "OPTION") #Value must be an Integer
VALUE = globals.config.getfloat("SECTION", "OPTION") #Value must be an Float
VALUE = globals.config.getboolean("SECTION", "OPTION") #Value must be an Boolean
```
### Global helper functions
##### timeHandler.py
##### wildcardHandler.py
### Process the data from BOSWatch
Three parameters are passed during the alarm to the .run() method
##### typ
Thats the function of the alarm. Possible values are **FMS**, **ZVEI** or **POC**
##### freq
The reception frequency of the tuner in Hz
##### data[ ]