mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2026-01-02 22:59:56 +01:00
Add Divera24/7-Plugin
This commit is contained in:
Lars Gremme
parent
d018c7eb18
commit
18d2ff7e1f
|
|
@ -1,6 +1,15 @@
|
|||
# <center>Changelog</center>
|
||||
---
|
||||
|
||||
## Version [3.0.1] - date
|
||||
### Added
|
||||
* Divera24/7-Plugin
|
||||
### Changed
|
||||
### Deprecated
|
||||
### Removed
|
||||
### Fixed
|
||||
### Security
|
||||
|
||||
## Version [2.9.0] - date
|
||||
|
||||
Functions implemented in initial version:
|
||||
|
|
|
|||
67
docu/docs/plugin/divera.md
Normal file
67
docu/docs/plugin/divera.md
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
# <center>Divera 24/7</center>
|
||||
---
|
||||
|
||||
## Beschreibung
|
||||
Mit diesem Plugin ist es moeglich, Http-Anfragen für Alarmierungen an Divera 24/7 zu senden.
|
||||
Wildcards in den Urls werden automatisch ersetzt.
|
||||
|
||||
## Unterstütze Alarmtypen
|
||||
- Fms
|
||||
- Pocsag
|
||||
- Zvei
|
||||
- Msg
|
||||
|
||||
## Resource
|
||||
`divera`
|
||||
|
||||
## Konfiguration
|
||||
|Feld|Beschreibung|Default|
|
||||
|----|------------|-------|
|
||||
|accesskey|Web-API-Schlüssel von Divera24/7 ||
|
||||
|priority|Sonderrechte|false|
|
||||
|title| Titel der Meldung | s. Beispiel|
|
||||
|message| Nachrichteninhalt| s. Beispiel|
|
||||
|ric|Auszulösende RIC in Divera; Gruppen->Alarmierungs-RIC||
|
||||
|vehicle|Fahrzeug-Alarmierungs-RIC||
|
||||
|
||||
**Beispiel:**
|
||||
```yaml
|
||||
- type: plugin
|
||||
name: Divera Plugin
|
||||
res: divera
|
||||
config:
|
||||
accesskey: API-Key
|
||||
pocsag:
|
||||
priority: false
|
||||
title: "{RIC}({SRIC})\n{MSG}"
|
||||
message: "{MSG}"
|
||||
# RIC ist in Divera definiert
|
||||
ric: Probealarm
|
||||
fms:
|
||||
priority: false
|
||||
title: "{FMS}"
|
||||
message: "{FMS}"
|
||||
vehicle: MTF
|
||||
zvei:
|
||||
ric: Probealarm
|
||||
title: "{TONE}"
|
||||
message: "{TONE}"
|
||||
priority: false
|
||||
msg:
|
||||
priority: false
|
||||
title: "{MSG}"
|
||||
message: "{MSG}"
|
||||
# RIC ist in Divera definiert
|
||||
ric: Probealarm
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
## Modul Abhängigkeiten
|
||||
- keine
|
||||
|
||||
---
|
||||
## Externe Abhängigkeiten
|
||||
- asyncio
|
||||
- aiohttp
|
||||
- urllib
|
||||
138
plugin/divera.py
Normal file
138
plugin/divera.py
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""!
|
||||
____ ____ ______ __ __ __ _____
|
||||
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
||||
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
||||
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
||||
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
||||
German BOS Information Script
|
||||
by Bastian Schroll
|
||||
|
||||
@file: divera.py
|
||||
@date: 16.01.2022
|
||||
@author: Lars Gremme
|
||||
@description: Divera247 Plugin
|
||||
"""
|
||||
import logging
|
||||
from plugin.pluginBase import PluginBase
|
||||
|
||||
# ###################### #
|
||||
# Custom plugin includes #
|
||||
import asyncio
|
||||
from aiohttp import ClientSession
|
||||
import urllib
|
||||
# ###################### #
|
||||
|
||||
logging.debug("- %s loaded", __name__)
|
||||
|
||||
|
||||
class BoswatchPlugin(PluginBase):
|
||||
"""!Description of the Plugin"""
|
||||
def __init__(self, config):
|
||||
"""!Do not change anything here!"""
|
||||
super().__init__(__name__, config) # you can access the config class on 'self.config'
|
||||
|
||||
|
||||
def fms(self, bwPacket):
|
||||
"""!Called on FMS alarm
|
||||
|
||||
@param bwPacket: bwPacket instance
|
||||
Remove if not implemented"""
|
||||
fms_data = self.config.get("fms")
|
||||
apicall = urllib.parse.urlencode({
|
||||
"accesskey": self.config.get("accesskey", default=""),
|
||||
"vehicle_ric": self.parseWildcards(fms_data.get("vehicle", default="")),
|
||||
"status_id": bwPacket.get("status"),
|
||||
"status_note": bwPacket.get("directionText"),
|
||||
"title": self.parseWildcards(fms_data.get("title", default="{FMS}")),
|
||||
"text": self.parseWildcards(fms_data.get("message", default="{FMS}")),
|
||||
"priority": fms_data.get("priority", default="false"),
|
||||
})
|
||||
apipath = "/api/fms"
|
||||
self.makeRequests(apipath, apicall)
|
||||
|
||||
def pocsag(self, bwPacket):
|
||||
"""!Called on POCSAG alarm
|
||||
|
||||
@param bwPacket: bwPacket instance
|
||||
Remove if not implemented"""
|
||||
poc_data = self.config.get("pocsag")
|
||||
apicall = urllib.parse.urlencode({
|
||||
"accesskey": self.config.get("accesskey", default=""),
|
||||
"title": self.parseWildcards(poc_data.get("title", default="{RIC}({SRIC})\n{MSG}")),
|
||||
"ric": self.parseWildcards(poc_data.get("ric", default="")),
|
||||
"text": self.parseWildcards(poc_data.get("message", default="{MSG}")),
|
||||
"priority": poc_data.get("priority", default="false"),
|
||||
})
|
||||
apipath = "/api/alarm"
|
||||
self.makeRequests(apipath, apicall)
|
||||
|
||||
def zvei(self, bwPacket):
|
||||
"""!Called on ZVEI alarm
|
||||
|
||||
@param bwPacket: bwPacket instance
|
||||
Remove if not implemented"""
|
||||
zvei_data = self.config.get("zvei")
|
||||
apicall = urllib.parse.urlencode({
|
||||
"accesskey": self.config.get("accesskey", default=""),
|
||||
"title": self.parseWildcards(zvei_data.get("title", default="{TONE}")),
|
||||
"ric": self.parseWildcards(zvei_data.get("ric", default="{TONE}")),
|
||||
"text": self.parseWildcards(zvei_data.get("message", default="{TONE}")),
|
||||
"priority": zvei_data.get("priority", default="false"),
|
||||
})
|
||||
apipath = "/api/alarm"
|
||||
self.makeRequests(apipath, apicall)
|
||||
|
||||
def msg(self, bwPacket):
|
||||
"""!Called on MSG packet
|
||||
|
||||
@param bwPacket: bwPacket instance
|
||||
Remove if not implemented"""
|
||||
msg_data = self.config.get("msg")
|
||||
apicall = urllib.parse.urlencode({
|
||||
"accesskey": self.config.get("accesskey", default=""),
|
||||
"title": self.parseWildcards(msg_data.get("title", default="{MSG}")),
|
||||
"ric": self.parseWildcards(msg_data.get("ric", default="")),
|
||||
"text": self.parseWildcards(msg_data.get("message", default="{MSG}")),
|
||||
"priority": msg_data.get("priority", default="false"),
|
||||
})
|
||||
apipath = "/api/alarm"
|
||||
self.makeRequests(apipath, apicall)
|
||||
|
||||
def makeRequests(self, apipath, apicall):
|
||||
"""Parses wildcard urls and handles asynchronus requests
|
||||
|
||||
@param urls: array of urls"""
|
||||
url = "https://www.divera247.com"
|
||||
request = url + apipath + "?" + apicall
|
||||
|
||||
loop = asyncio.get_event_loop()
|
||||
|
||||
future = asyncio.ensure_future(self.asyncRequests(request))
|
||||
loop.run_until_complete(future)
|
||||
|
||||
async def asyncRequests(self, url):
|
||||
"""Handles asynchronus requests
|
||||
|
||||
@param urls: array of urls to send requests to"""
|
||||
tasks = []
|
||||
|
||||
async with ClientSession() as session:
|
||||
logging.debug("Generated URL: [{}]".format(url))
|
||||
task = asyncio.ensure_future(self.fetch(url, session))
|
||||
tasks.append(task)
|
||||
|
||||
responses = asyncio.gather(*tasks)
|
||||
await responses
|
||||
|
||||
async def fetch(self, url, session):
|
||||
"""Fetches requests
|
||||
|
||||
@param url: url
|
||||
|
||||
@param session: Clientsession instance"""
|
||||
logging.debug("Post URL: [{}]".format(url))
|
||||
async with session.post(url) as response:
|
||||
logging.info("{} returned [{}]".format(response.url, response.status))
|
||||
return await response.read()
|
||||
Loading…
Reference in a new issue