404
+Page not found
+commit a387bfa03bfe07758c764d492d88d7d0fa5257c9 Author: <> Date: Wed Jun 11 08:24:09 2025 +0000 Deployed d4e9b63 with MkDocs version: 1.6.1 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/404.html b/404.html new file mode 100644 index 0000000..2df7f84 --- /dev/null +++ b/404.html @@ -0,0 +1,238 @@ + + +
+ + + + + + + +Page not found
+| ▼Nboswatch | |
| ▼NconfigYaml | |
| CConfigYAML | |
| ▼Ndecoder | |
| ▼Ndecoder | |
| CDecoder | |
| ▼NfmsDecoder | |
| CFmsDecoder | FMS decoder class |
| ▼NpocsagDecoder | |
| CPocsagDecoder | POCSAG decoder class |
| ▼NzveiDecoder | |
| CZveiDecoder | ZVEI decoder class |
| ▼NinputSource | |
| ▼NinputBase | |
| CInputBase | Base class for handling inout sources |
| ▼NlineInInput | |
| CLineInInput | Class for the line-in input source |
| ▼NpulseaudioInput | |
| CPulseAudioInput | Class for the PulseAudio input source |
| ▼NsdrInput | |
| CSdrInput | Class for the sdr input source |
| ▼Nnetwork | |
| ▼Nbroadcast | |
| CBroadcastClient | BroadcastClient class |
| CBroadcastServer | BroadcastServer class |
| ▼Nclient | |
| CTCPClient | TCP client class |
| ▼NnetCheck | |
| CNetCheck | Worker class to check internet connection |
| ▼Nserver | |
| C_ThreadedTCPRequestHandler | ThreadedTCPRequestHandler class for our TCPServer class |
| C_ThreadedTCPServer | ThreadedTCPServer class for our TCPServer class |
| CTCPServer | TCP server class |
| ▼Npacket | |
| CPacket | Class implementation of an BOSWatch packet |
| ▼NprocessManager | |
| CProcessManager | Class to manage a extern sub process |
| ▼Nrouter | |
| ▼Nroute | |
| CRoute | Class for single routing points |
| ▼Nrouter | |
| CRouter | Class for the Router |
| ▼NrouterManager | |
| CRouterManager | Class to manage all routers |
| ▼Ntimer | |
| CRepeatedTimer | |
| ▼Nmodule | |
| ▼Ndescriptor | |
| CBoswatchModule | Adds descriptions to bwPackets |
| ▼Nfilter | |
| ▼NdoubleFilter | |
| CBoswatchModule | Description of the Module |
| ▼NmodeFilter | |
| CBoswatchModule | Filter of specific bwPacket mode |
| ▼NregexFilter | |
| CBoswatchModule | Regex based filter mechanism |
| ▼Ngeocoding | |
| CBoswatchModule | Description of the Module |
| ▼NmoduleBase | |
| CModuleBase | Main module class |
| ▼Ntemplate_module | |
| CBoswatchModule | Description of the Module |
| ▼Nplugin | |
| ▼Ndivera | |
| CBoswatchPlugin | Description of the Plugin |
| ▼Nhttp | |
| CBoswatchPlugin | Description of the Plugin |
| ▼Nmysql | |
| CBoswatchPlugin | Description of the Plugin |
| ▼NpluginBase | |
| CPluginBase | Main plugin class |
| ▼Ntelegram | |
| CBoswatchPlugin | Description of the Plugin |
| CMQBot | |
| ▼Ntemplate_plugin | |
| CBoswatchPlugin | Description of the Plugin |
+Public Member Functions | |
| __init__ (self, config=None) | |
| __iter__ (self) | |
| __len__ (self) | |
| returns the length of an config element | |
| __str__ (self) | |
| Returns the string representation of the internal config dict. | |
| loadConfigFile (self, configPath) | |
| loads a given configuration file | |
| get (self, *args, default=None) | |
| Get a single value from the config or a value set in a new configYAML class instance. | |
+Protected Attributes | |
| _config = config | |
| boswatch.configYaml.ConfigYAML.__init__ | +( | +self, | +|
| + | + | config = None ) | +
| boswatch.configYaml.ConfigYAML.__iter__ | +( | +self | ) | ++ |
| boswatch.configYaml.ConfigYAML.__len__ | +( | +self | ) | ++ |
returns the length of an config element
+| boswatch.configYaml.ConfigYAML.__str__ | +( | +self | ) | ++ |
Returns the string representation of the internal config dict.
+| boswatch.configYaml.ConfigYAML.loadConfigFile | +( | +self, | +|
| + | + | configPath ) | +
loads a given configuration file
+| configPath | Path to the config file |
| boswatch.configYaml.ConfigYAML.get | +( | +self, | +|
| + | + | * | args, | +
| + | + | default = None ) | +
Get a single value from the config or a value set in a new configYAML class instance.
+| *args | Config section (one ore more strings) |
| default | Default value if section not found (None) |
+
|
+ +protected | +
+Static Public Member Functions | |
| decode (data) | |
| Choose the right decoder and return a bwPacket instance. | |
+
|
+ +static | +
Choose the right decoder and return a bwPacket instance.
+| data | data to decode |
FMS decoder class. + More...
++Static Public Member Functions | |
| decode (data) | |
| Decodes FMS. | |
FMS decoder class.
+This class decodes FMS data. First step is to validate the data and _check if the format is correct. In the last step a valid BOSWatch packet is created and returned
+
+
|
+ +static | +
Decodes FMS.
+| data | FMS for decoding |
POCSAG decoder class. + More...
++Static Public Member Functions | |
| decode (data) | |
| Decodes POCSAG. | |
+Static Protected Member Functions | |
| _getBitrateRicSubric (data) | |
| Gets the Bitrate, Ric and Subric from data. | |
POCSAG decoder class.
+This class decodes POCSAG data. First step is to validate the data and _check if the format is correct. In the last step a valid BOSWatch packet is created and returned
+
+
|
+ +static | +
Decodes POCSAG.
+| data | POCSAG for decoding |
+
|
+ +staticprotected | +
Gets the Bitrate, Ric and Subric from data.
+| data | POCSAG data string |
ZVEI decoder class. + More...
++Static Public Member Functions | |
| decode (data) | |
| Decodes ZVEI. | |
+Static Protected Member Functions | |
| _solveDoubleTone (data) | |
| Remove the doubleTone sign (here its the 'E') | |
ZVEI decoder class.
+This class decodes ZVEI data. First step is to validate the data and _check if the format is correct. After that the double-tone-sign 'E' is replaced. In the last step a valid BOSWatch packet is created and returned
+
+
|
+ +static | +
Decodes ZVEI.
+| data | ZVEI for decoding |
+
|
+ +staticprotected | +
Remove the doubleTone sign (here its the 'E')
+| data | ZVEI for double tone sign replacement |
Base class for handling inout sources. + More...
++Public Member Functions | |
| __init__ (self, inputQueue, inputConfig, decoderConfig) | |
| Build a new InputSource class. | |
| start (self) | |
| Start the input source thread. | |
| shutdown (self) | |
| Stop the input source thread. | |
| addToQueue (self, data) | |
| Decode and add alarm data to the queue for further processing during boswatch client. | |
| getDecoderInstance (self, decoderConfig, StdIn) | |
+Data Fields | |
| bool | _inputThread = True |
+Protected Member Functions | |
| _runThread (self, dataQueue, sdrConfig, decoderConfig) | |
| Thread routine of the input source has to be inherit. | |
+Protected Attributes | |
| _inputThread = None | |
| bool | _isRunning = False |
| _inputQueue = inputQueue | |
| _inputConfig = inputConfig | |
| _decoderConfig = decoderConfig | |
Base class for handling inout sources.
+| boswatch.inputSource.inputBase.InputBase.__init__ | +( | +self, | +|
| + | + | inputQueue, | +|
| + | + | inputConfig, | +|
| + | + | decoderConfig ) | +
Build a new InputSource class.
+| inputQueue | Python queue object to store input data |
| inputConfig | ConfigYaml object with the inoutSource config |
| decoderConfig | ConfigYaml object with the decoder config |
| boswatch.inputSource.inputBase.InputBase.start | +( | +self | ) | ++ |
Start the input source thread.
+
+
|
+ +protected | +
Thread routine of the input source has to be inherit.
+ +Reimplemented in boswatch.inputSource.lineInInput.LineInInput, boswatch.inputSource.pulseaudioInput.PulseAudioInput, and boswatch.inputSource.sdrInput.SdrInput.
+| boswatch.inputSource.inputBase.InputBase.shutdown | +( | +self | ) | ++ |
Stop the input source thread.
+| boswatch.inputSource.inputBase.InputBase.addToQueue | +( | +self, | +|
| + | + | data ) | +
Decode and add alarm data to the queue for further processing during boswatch client.
+| boswatch.inputSource.inputBase.InputBase.getDecoderInstance | +( | +self, | +|
| + | + | decoderConfig, | +|
| + | + | StdIn ) | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| bool boswatch.inputSource.inputBase.InputBase._inputThread = True | +
Class for the line-in input source. + More...
++Protected Member Functions | |
| _runThread (self, dataQueue, lineInConfig, decoderConfig) | |
| Thread routine of the input source has to be inherit. | |
Protected Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
+Protected Attributes | |
| _isRunning | |
Protected Attributes inherited from boswatch.inputSource.inputBase.InputBase | |
| _inputThread = None | |
| bool | _isRunning = False |
| _inputQueue = inputQueue | |
| _inputConfig = inputConfig | |
| _decoderConfig = decoderConfig | |
+Additional Inherited Members | |
Public Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
| __init__ (self, inputQueue, inputConfig, decoderConfig) | |
| Build a new InputSource class. | |
| start (self) | |
| Start the input source thread. | |
| shutdown (self) | |
| Stop the input source thread. | |
| addToQueue (self, data) | |
| Decode and add alarm data to the queue for further processing during boswatch client. | |
| getDecoderInstance (self, decoderConfig, StdIn) | |
Data Fields inherited from boswatch.inputSource.inputBase.InputBase | |
| bool | _inputThread = True |
Class for the line-in input source.
+
+
|
+ +protected | +
Thread routine of the input source has to be inherit.
+ +Reimplemented from boswatch.inputSource.inputBase.InputBase.
+
+
|
+ +protected | +
Class for the PulseAudio input source. + More...
++Protected Member Functions | |
| _runThread (self, dataQueue, PulseAudioConfig, decoderConfig) | |
| Thread routine of the input source has to be inherit. | |
Protected Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
+Protected Attributes | |
| _isRunning | |
Protected Attributes inherited from boswatch.inputSource.inputBase.InputBase | |
| _inputThread = None | |
| bool | _isRunning = False |
| _inputQueue = inputQueue | |
| _inputConfig = inputConfig | |
| _decoderConfig = decoderConfig | |
+Additional Inherited Members | |
Public Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
| __init__ (self, inputQueue, inputConfig, decoderConfig) | |
| Build a new InputSource class. | |
| start (self) | |
| Start the input source thread. | |
| shutdown (self) | |
| Stop the input source thread. | |
| addToQueue (self, data) | |
| Decode and add alarm data to the queue for further processing during boswatch client. | |
| getDecoderInstance (self, decoderConfig, StdIn) | |
Data Fields inherited from boswatch.inputSource.inputBase.InputBase | |
| bool | _inputThread = True |
Class for the PulseAudio input source.
+
+
|
+ +protected | +
Thread routine of the input source has to be inherit.
+ +Reimplemented from boswatch.inputSource.inputBase.InputBase.
+
+
|
+ +protected | +
Class for the sdr input source. + More...
++Protected Member Functions | |
| _runThread (self, dataQueue, sdrConfig, decoderConfig) | |
| Thread routine of the input source has to be inherit. | |
Protected Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
+Protected Attributes | |
| _isRunning | |
Protected Attributes inherited from boswatch.inputSource.inputBase.InputBase | |
| _inputThread = None | |
| bool | _isRunning = False |
| _inputQueue = inputQueue | |
| _inputConfig = inputConfig | |
| _decoderConfig = decoderConfig | |
+Additional Inherited Members | |
Public Member Functions inherited from boswatch.inputSource.inputBase.InputBase | |
| __init__ (self, inputQueue, inputConfig, decoderConfig) | |
| Build a new InputSource class. | |
| start (self) | |
| Start the input source thread. | |
| shutdown (self) | |
| Stop the input source thread. | |
| addToQueue (self, data) | |
| Decode and add alarm data to the queue for further processing during boswatch client. | |
| getDecoderInstance (self, decoderConfig, StdIn) | |
Data Fields inherited from boswatch.inputSource.inputBase.InputBase | |
| bool | _inputThread = True |
Class for the sdr input source.
+
+
|
+ +protected | +
Thread routine of the input source has to be inherit.
+ +Reimplemented from boswatch.inputSource.inputBase.InputBase.
+
+
|
+ +protected | +
BroadcastClient class. + More...
++Public Member Functions | |
| __init__ (self, port=5000) | |
| Create an BroadcastClient instance. | |
| getConnInfo (self, retry=0) | |
| Get the connection info from server over udp broadcast. | |
| serverIP (self) | |
| Property to get the server IP after successful broadcast. | |
| serverPort (self) | |
| Property to get the server Port after successful broadcast. | |
+Protected Attributes | |
| _broadcastPort = port | |
| str | _serverIP = "" |
| int | _serverPort = 0 |
| _socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) | |
BroadcastClient class.
+| boswatch.network.broadcast.BroadcastClient.__init__ | +( | +self, | +|
| + | + | port = 5000 ) | +
Create an BroadcastClient instance.
+| port | port to send broadcast packets (5000) |
| boswatch.network.broadcast.BroadcastClient.getConnInfo | +( | +self, | +|
| + | + | retry = 0 ) | +
Get the connection info from server over udp broadcast.
+This function will send broadcast package(s) to get connection info from the server.
+| retry | Count of retry - 0 is infinite (0) |
| boswatch.network.broadcast.BroadcastClient.serverIP | +( | +self | ) | ++ |
Property to get the server IP after successful broadcast.
+| boswatch.network.broadcast.BroadcastClient.serverPort | +( | +self | ) | ++ |
Property to get the server Port after successful broadcast.
+
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
BroadcastServer class. + More...
++Public Member Functions | |
| __init__ (self, servePort=8080, listenPort=5000) | |
| Create an BroadcastServer instance. | |
| __del__ (self) | |
| start (self) | |
| Start the broadcast server in a new thread. | |
| stop (self) | |
| Stop the broadcast server. | |
| isRunning (self) | |
| Property of broadcast server running state. | |
+Data Fields | |
| isRunning | |
| str | _serverThread = "BroadServ" |
+Protected Member Functions | |
| _listen (self) | |
| Broadcast server worker thread. | |
+Protected Attributes | |
| _socket = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) | |
| _serverThread = None | |
| bool | _serverShutdown = False |
| _servePort = servePort | |
BroadcastServer class.
+| boswatch.network.broadcast.BroadcastServer.__init__ | +( | +self, | +|
| + | + | servePort = 8080, | +|
| + | + | listenPort = 5000 ) | +
Create an BroadcastServer instance.
+| servePort | port to serve as connection info (8080) |
| listenPort | port to listen for broadcast packets (5000) |
| boswatch.network.broadcast.BroadcastServer.__del__ | +( | +self | ) | ++ |
| boswatch.network.broadcast.BroadcastServer.start | +( | +self | ) | ++ |
Start the broadcast server in a new thread.
+| boswatch.network.broadcast.BroadcastServer.stop | +( | +self | ) | ++ |
Stop the broadcast server.
+Due to the timeout of the socket, stopping the thread can be delayed by two seconds. But function returns immediately.
+
+
|
+ +protected | +
Broadcast server worker thread.
+This function listen for magic packets on broadcast address and send the connection info to the clients.
+| boswatch.network.broadcast.BroadcastServer.isRunning | +( | +self | ) | ++ |
Property of broadcast server running state.
+
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| boswatch.network.broadcast.BroadcastServer.isRunning | +
| str boswatch.network.broadcast.BroadcastServer._serverThread = "BroadServ" | +
TCP client class. + More...
++Public Member Functions | |
| __init__ (self, timeout=3) | |
| Create a new instance. | |
| connect (self, host="localhost", port=8080) | |
| Connect to the server. | |
| disconnect (self) | |
| Disconnect from the server. | |
| transmit (self, data) | |
| Send a data packet to the server. | |
| receive (self, timeout=1) | |
| Receive data from the server. | |
| isConnected (self) | |
| Property of client connected state. | |
+Data Fields | |
| isConnected | |
+Protected Attributes | |
| _sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
TCP client class.
+| boswatch.network.client.TCPClient.__init__ | +( | +self, | +|
| + | + | timeout = 3 ) | +
Create a new instance.
+| timeout | timeout for the client in sec. (3) |
| boswatch.network.client.TCPClient.connect | +( | +self, | +|
| + | + | host = "localhost", | +|
| + | + | port = 8080 ) | +
Connect to the server.
+| host | Server IP address ("localhost") |
| port | Server Port (8080) |
| boswatch.network.client.TCPClient.disconnect | +( | +self | ) | ++ |
Disconnect from the server.
+| boswatch.network.client.TCPClient.transmit | +( | +self, | +|
| + | + | data ) | +
Send a data packet to the server.
+| data | data to send to the server |
| boswatch.network.client.TCPClient.receive | +( | +self, | +|
| + | + | timeout = 1 ) | +
Receive data from the server.
+| timeout | to wait for incoming data in seconds |
| boswatch.network.client.TCPClient.isConnected | +( | +self | ) | ++ |
Property of client connected state.
+
+
|
+ +protected | +
| boswatch.network.client.TCPClient.isConnected | +
Worker class to check internet connection. + More...
++Public Member Functions | |
| __init__ (self, hostname="https://www.google.com/", timeout=1) | |
| Create a new NetCheck instance. | |
| checkConn (self) | |
| Check the connection. | |
+Data Fields | |
| bool | connectionState = False |
+Protected Attributes | |
| _hostname = hostname | |
| _timeout = timeout | |
Worker class to check internet connection.
+| boswatch.network.netCheck.NetCheck.__init__ | +( | +self, | +|
| + | + | hostname = "https://www.google.com/", | +|
| + | + | timeout = 1 ) | +
Create a new NetCheck instance.
+| hostname | host against connection check is running ("https://www.google.com/") |
| timeout | timeout for connection check in sec. (1) |
| boswatch.network.netCheck.NetCheck.checkConn | +( | +self | ) | ++ |
Check the connection.
+
+
|
+ +protected | +
+
|
+ +protected | +
| bool boswatch.network.netCheck.NetCheck.connectionState = False | +
ThreadedTCPRequestHandler class for our TCPServer class. + More...
++Public Member Functions | |
| handle (self) | |
| Handles the request from an single client in a own thread. | |
ThreadedTCPRequestHandler class for our TCPServer class.
+| boswatch.network.server._ThreadedTCPRequestHandler.handle | +( | +self | ) | ++ |
Handles the request from an single client in a own thread.
+Insert a request in the clients[] list and send a [ack]
+TCP server class. + More...
++Public Member Functions | |
| __init__ (self, alarmQueue, timeout=3) | |
| Create a new instance. | |
| __del__ (self) | |
| start (self, port=8080) | |
| Start a threaded TCP socket server. | |
| stop (self) | |
| Stops the TCP socket server. | |
| countClientsConnected (self) | |
| Number of currently connected Clients. | |
| getClientsConnected (self) | |
| A list of all connected clients with their IP address and last seen timestamp _clients[ThreadName] = {"address", "timestamp"}. | |
| isRunning (self) | |
| Property of server running state. | |
+Data Fields | |
| isRunning = False | |
| bool | isRunning = True |
| str | _server_thread = "Thread-BWServer" |
+Protected Attributes | |
| _server = None | |
| _server_thread = None | |
| _timeout = timeout | |
| _alarmQueue = alarmQueue | |
| # because our list is not threadsafe | _clientsConnectedLock = threading.Lock() |
| dict | _clientsConnected = {} |
TCP server class.
+| boswatch.network.server.TCPServer.__init__ | +( | +self, | +|
| + | + | alarmQueue, | +|
| + | + | timeout = 3 ) | +
Create a new instance.
+| alarmQueue | python queue instance |
| timeout | server timeout in sec (3) |
| boswatch.network.server.TCPServer.__del__ | +( | +self | ) | ++ |
| boswatch.network.server.TCPServer.start | +( | +self, | +|
| + | + | port = 8080 ) | +
Start a threaded TCP socket server.
+Start a TCP Socket Server in a new thread that will then start one more thread for each client request. The ip address for binding the server socket is always 'localhost'
+| port | Server Port (8080) |
| boswatch.network.server.TCPServer.stop | +( | +self | ) | ++ |
Stops the TCP socket server.
+| boswatch.network.server.TCPServer.countClientsConnected | +( | +self | ) | ++ |
Number of currently connected Clients.
+| boswatch.network.server.TCPServer.getClientsConnected | +( | +self | ) | ++ |
A list of all connected clients with their IP address and last seen timestamp _clients[ThreadName] = {"address", "timestamp"}.
+| boswatch.network.server.TCPServer.isRunning | +( | +self | ) | ++ |
Property of server running state.
+
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| bool boswatch.network.server.TCPServer.isRunning = False | +
| bool boswatch.network.server.TCPServer.isRunning = True | +
| str boswatch.network.server.TCPServer._server_thread = "Thread-BWServer" | +
Class implementation of an BOSWatch packet. + More...
++Public Member Functions | |
| __init__ (self, bwPacket=None) | |
| Build a new BOSWatch packet or copy existing data in it. | |
| __str__ (self) | |
| Return the intern _packet dict as string. | |
| set (self, fieldName, value) | |
| Set a field in the intern _packet dict. | |
| get (self, fieldName) | |
| Returns the value from a single field. | |
| printInfo (self) | |
| Print a info message to the log on INFO level. | |
+Protected Attributes | |
| dict | _packet = {"timestamp": time.time()} |
Class implementation of an BOSWatch packet.
+| boswatch.packet.Packet.__init__ | +( | +self, | +|
| + | + | bwPacket = None ) | +
Build a new BOSWatch packet or copy existing data in it.
+| bwPacket | Existing data to copy |
| boswatch.packet.Packet.__str__ | +( | +self | ) | ++ |
Return the intern _packet dict as string.
+| boswatch.packet.Packet.set | +( | +self, | +|
| + | + | fieldName, | +|
| + | + | value ) | +
Set a field in the intern _packet dict.
+| fieldName | Name of the data to set |
| value | Value to set |
| boswatch.packet.Packet.get | +( | +self, | +|
| + | + | fieldName ) | +
Returns the value from a single field.
+If field not existing None is returned
| fieldName | Name of the field |
| boswatch.packet.Packet.printInfo | +( | +self | ) | ++ |
Print a info message to the log on INFO level.
+Contains the most useful info about this packet.
+
|
+ +protected | +
class to manage a extern sub process + More...
++Public Member Functions | |
| __init__ (self, process, textMode=False) | |
| addArgument (self, arg) | |
| add a new argument | |
| clearArguments (self) | |
| clear all arguments | |
| start (self) | |
| start the new process | |
| stop (self) | |
| Stop the process by sending SIGTERM and wait for ending. | |
| readline (self) | |
| Read one line from stdout stream. | |
| skipLines (self, lineCount=1) | |
| Skip given number of lines from the output. | |
| skipLinesUntil (self, matchText) | |
| Skip lines from the output until the given string is in it. | |
| setStdin (self, stdin) | |
| Set the stdin stream instance. | |
| setStdout (self, stdout) | |
| Set the stdout stream instance. | |
| setStderr (self, stderr) | |
| Set the stderr stream instance. | |
| stdout (self) | |
| Property to get the stdout stream. | |
| stderr (self) | |
| Property to get the stderr stream. | |
| isRunning (self) | |
| Property to get process running state. | |
+Data Fields | |
| isRunning | |
+Protected Attributes | |
| list | _args = [] |
| _stdin = None | |
| _stdout = subprocess.PIPE | |
| _stderr = subprocess.STDOUT | |
| _processHandle = None | |
| _textMode = textMode | |
class to manage a extern sub process
+| boswatch.processManager.ProcessManager.__init__ | +( | +self, | +|
| + | + | process, | +|
| + | + | textMode = False ) | +
| boswatch.processManager.ProcessManager.addArgument | +( | +self, | +|
| + | + | arg ) | +
add a new argument
+| arg | argument to add as string |
| boswatch.processManager.ProcessManager.clearArguments | +( | +self | ) | ++ |
clear all arguments
+| boswatch.processManager.ProcessManager.start | +( | +self | ) | ++ |
start the new process
+| boswatch.processManager.ProcessManager.stop | +( | +self | ) | ++ |
Stop the process by sending SIGTERM and wait for ending.
+| boswatch.processManager.ProcessManager.readline | +( | +self | ) | ++ |
Read one line from stdout stream.
+| boswatch.processManager.ProcessManager.skipLines | +( | +self, | +|
| + | + | lineCount = 1 ) | +
Skip given number of lines from the output.
+| lineCount | number of lines to skip |
| boswatch.processManager.ProcessManager.skipLinesUntil | +( | +self, | +|
| + | + | matchText ) | +
Skip lines from the output until the given string is in it.
+| matchText | string to search for in output |
| boswatch.processManager.ProcessManager.setStdin | +( | +self, | +|
| + | + | stdin ) | +
Set the stdin stream instance.
+| boswatch.processManager.ProcessManager.setStdout | +( | +self, | +|
| + | + | stdout ) | +
Set the stdout stream instance.
+| boswatch.processManager.ProcessManager.setStderr | +( | +self, | +|
| + | + | stderr ) | +
Set the stderr stream instance.
+| boswatch.processManager.ProcessManager.stdout | +( | +self | ) | ++ |
Property to get the stdout stream.
+| boswatch.processManager.ProcessManager.stderr | +( | +self | ) | ++ |
Property to get the stderr stream.
+| boswatch.processManager.ProcessManager.isRunning | +( | +self | ) | ++ |
Property to get process running state.
+
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| boswatch.processManager.ProcessManager.isRunning | +
Class for single routing points. + More...
++Public Member Functions | |
| __init__ (self, name, callback, statsCallback=None, cleanupCallback=None) | |
| Create a instance of an route point. | |
+Data Fields | |
| name = name | |
| callback = callback | |
| statistics = statsCallback | |
| cleanup = cleanupCallback | |
Class for single routing points.
+| boswatch.router.route.Route.__init__ | +( | +self, | +|
| + | + | name, | +|
| + | + | callback, | +|
| + | + | statsCallback = None, | +|
| + | + | cleanupCallback = None ) | +
Create a instance of an route point.
+| name | name of the route point |
| callback | instance of the callback function |
| statsCallback | instance of the callback to get statistics (None) |
| cleanupCallback | instance of the callback to run a cleanup method (None) |
| boswatch.router.route.Route.name = name | +
| boswatch.router.route.Route.callback = callback | +
| boswatch.router.route.Route.statistics = statsCallback | +
| boswatch.router.route.Route.cleanup = cleanupCallback | +
Class for the Router. + More...
++Public Member Functions | |
| __init__ (self, name) | |
| Create a new router. | |
| addRoute (self, route) | |
| Adds a route point to the router. | |
| runRouter (self, bwPacket) | |
| Run the router. | |
+Data Fields | |
| name = name | |
| list | routeList = [] |
+Protected Member Functions | |
| _getStatistics (self) | |
| Returns statistical information's from last router run. | |
+Protected Attributes | |
| int | _cumTime = 0 |
| int | _routerTime = 0 |
| int | _runCount = 0 |
Class for the Router.
+| boswatch.router.router.Router.__init__ | +( | +self, | +|
| + | + | name ) | +
Create a new router.
+| name | name of the router |
| boswatch.router.router.Router.addRoute | +( | +self, | +|
| + | + | route ) | +
Adds a route point to the router.
+| route | instance of the Route class |
| boswatch.router.router.Router.runRouter | +( | +self, | +|
| + | + | bwPacket ) | +
Run the router.
+| bwPacket | instance of Packet class |
+
|
+ +protected | +
Returns statistical information's from last router run.
+| boswatch.router.router.Router.name = name | +
| list boswatch.router.router.Router.routeList = [] | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
Class to manage all routers. + More...
++Public Member Functions | |
| __init__ (self) | |
| Create new router. | |
| buildRouters (self, config) | |
| Initialize Routers from given config file. | |
| runRouters (self, routerRunList, bwPacket) | |
| Run given Routers. | |
| cleanup (self) | |
| Run cleanup routines for all loaded route points. | |
+Data Fields | |
| config = None | |
| bool | _routerDict = False): |
+Protected Member Functions | |
| _showRouterRoute (self) | |
| Show the routes of all routers. | |
| _saveStats (self) | |
| Save current statistics to file. | |
+Protected Attributes | |
| dict | _routerDict = {} |
| _startTime = int(time.time()) | |
Class to manage all routers.
+| boswatch.router.routerManager.RouterManager.__init__ | +( | +self | ) | ++ |
Create new router.
+| boswatch.router.routerManager.RouterManager.buildRouters | +( | +self, | +|
| + | + | config ) | +
Initialize Routers from given config file.
+| config | instance of ConfigYaml class |
| boswatch.router.routerManager.RouterManager.runRouters | +( | +self, | +|
| + | + | routerRunList, | +|
| + | + | bwPacket ) | +
Run given Routers.
+| routerRunList | string or list of router names in string form |
| bwPacket | instance of Packet class |
| boswatch.router.routerManager.RouterManager.cleanup | +( | +self | ) | ++ |
Run cleanup routines for all loaded route points.
+
+
|
+ +protected | +
Show the routes of all routers.
+
+
|
+ +protected | +
Save current statistics to file.
+| boswatch.router.routerManager.RouterManager.config = None | +
+
|
+ +protected | +
+
|
+ +protected | +
| bool boswatch.router.routerManager.RouterManager._routerDict = False): | +
+Public Member Functions | |
| __init__ (self, interval, targetFunction, *args, **kwargs) | |
| Create a new instance of the RepeatedTimer. | |
| start (self) | |
| Start a new timer worker thread. | |
| stop (self) | |
| Stop the timer worker thread. | |
| isRunning (self) | |
| Property for repeatedTimer running state. | |
| restTime (self) | |
| Property to get remaining time till next call. | |
+Data Fields | |
| int | overdueCount = 0 |
| int | lostEvents = 0 |
| str | _thread = "RepTim(" + str(self._interval) + ")" |
| restTime = time.time() | |
+Protected Member Functions | |
| _target (self) | |
| Runs the target function with his arguments in own thread. | |
+Protected Attributes | |
| _interval = interval | |
| _function = targetFunction | |
| _args = args | |
| _kwargs = kwargs | |
| int | _start = 0 |
| bool | _isRunning = False |
| _event = Event() | |
| _thread = None | |
| boswatch.timer.RepeatedTimer.__init__ | +( | +self, | +|
| + | + | interval, | +|
| + | + | targetFunction, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Create a new instance of the RepeatedTimer.
+| interval | interval in sec. to recall target function |
| targetFunction | function to call on timer event |
| *args | arguments for the called function |
| *kwargs | keyword arguments for the called function |
| boswatch.timer.RepeatedTimer.start | +( | +self | ) | ++ |
Start a new timer worker thread.
+| boswatch.timer.RepeatedTimer.stop | +( | +self | ) | ++ |
Stop the timer worker thread.
+
+
|
+ +protected | +
Runs the target function with his arguments in own thread.
+| boswatch.timer.RepeatedTimer.isRunning | +( | +self | ) | ++ |
Property for repeatedTimer running state.
+| boswatch.timer.RepeatedTimer.restTime | +( | +self | ) | ++ |
Property to get remaining time till next call.
+
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| int boswatch.timer.RepeatedTimer.overdueCount = 0 | +
| int boswatch.timer.RepeatedTimer.lostEvents = 0 | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
| str boswatch.timer.RepeatedTimer._thread = "RepTim(" + str(self._interval) + ")" | +
| boswatch.timer.RepeatedTimer.restTime = time.time() | +
Adds descriptions to bwPackets. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin. | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| onUnload (self) | |
| Called by destruction of the plugin. | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
+Data Fields | |
| config = bwPacket.get(descriptor.get("scanField")): | |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Adds descriptions to bwPackets.
+| module.descriptor.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.descriptor.BoswatchModule.onLoad | +( | +self | ) | ++ |
Called by import of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.descriptor.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.descriptor.BoswatchModule.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.descriptor.BoswatchModule.config = bwPacket.get(descriptor.get("scanField")): | +
Description of the Module. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin Remove if not implemented. | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| onUnload (self) | |
| Called by destruction of the plugin Remove if not implemented. | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
+Data Fields | |
| list | _filterLists = [] |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
+Protected Member Functions | |
| _check (self, bwPacket, filterFields) | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
+Protected Attributes | |
| dict | _filterLists = {} |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Description of the Module.
+| module.filter.doubleFilter.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.doubleFilter.BoswatchModule.onLoad | +( | +self | ) | ++ |
Called by import of the plugin Remove if not implemented.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.doubleFilter.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.doubleFilter.BoswatchModule.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin Remove if not implemented.
+ +Reimplemented from module.moduleBase.ModuleBase.
+
+
|
+ +protected | +
+
|
+ +protected | +
| list module.filter.doubleFilter.BoswatchModule._filterLists = [] | +
Filter of specific bwPacket mode. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin. | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| onUnload (self) | |
| Called by destruction of the plugin. | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Filter of specific bwPacket mode.
+| module.filter.modeFilter.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.modeFilter.BoswatchModule.onLoad | +( | +self | ) | ++ |
Called by import of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.modeFilter.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.modeFilter.BoswatchModule.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+Regex based filter mechanism. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin. | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| onUnload (self) | |
| Called by destruction of the plugin. | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
+Data Fields | |
| config | |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Regex based filter mechanism.
+| module.filter.regexFilter.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.regexFilter.BoswatchModule.onLoad | +( | +self | ) | ++ |
Called by import of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.regexFilter.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.regexFilter.BoswatchModule.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.filter.regexFilter.BoswatchModule.config | +
Description of the Module. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| geocode (self, bwPacket) | |
| find address in message and get latitude and longitude | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
| onLoad (self) | |
| Called by import of the module can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Description of the Module.
+| module.geocoding.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.geocoding.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.geocoding.BoswatchModule.geocode | +( | +self, | +|
| + | + | bwPacket ) | +
find address in message and get latitude and longitude
+| bwPacket | A BOSWatch packet instance |
Main module class. + More...
++Public Member Functions | |
| __init__ (self, moduleName, config) | |
| init preload some needed locals and then call onLoad() directly | |
| onLoad (self) | |
| Called by import of the module can be inherited. | |
| doWork (self, bwPacket) | |
| Called module run can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
+Static Public Member Functions | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
+Data Fields | |
| config = config | |
+Protected Member Functions | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
+Protected Attributes | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
+Static Protected Attributes | |
| list | _modulesActive = [] |
Main module class.
+| module.moduleBase.ModuleBase.__init__ | +( | +self, | +|
| + | + | moduleName, | +|
| + | + | config ) | +
init preload some needed locals and then call onLoad() directly
+ +Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.geocoding.BoswatchModule, and module.template_module.BoswatchModule.
+
+
|
+ +protected | +
Cleanup routine calls onUnload() directly.
+
+
|
+ +protected | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
+
|
+ +protected | +
Returns statistical information's from last module run.
+| module.moduleBase.ModuleBase.onLoad | +( | +self | ) | ++ |
Called by import of the module can be inherited.
+ +Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, and module.template_module.BoswatchModule.
+| module.moduleBase.ModuleBase.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
Called module run can be inherited.
+| bwPacket | bwPacket instance |
Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, module.geocoding.BoswatchModule, and module.template_module.BoswatchModule.
+| module.moduleBase.ModuleBase.onUnload | +( | +self | ) | ++ |
Called on shutdown of boswatch can be inherited.
+ +Reimplemented in module.descriptor.BoswatchModule, module.filter.doubleFilter.BoswatchModule, module.filter.modeFilter.BoswatchModule, module.filter.regexFilter.BoswatchModule, and module.template_module.BoswatchModule.
+
+
|
+ +static | +
Register a new wildcard.
+| newWildcard | wildcard where parser searching for |
| bwPacketField | field from bwPacket where holds replacement data |
+
|
+ +staticprotected | +
+
|
+ +protected | +
| module.moduleBase.ModuleBase.config = config | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
Description of the Module. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin Remove if not implemented. | |
| doWork (self, bwPacket) | |
| start an run of the module. | |
| onUnload (self) | |
| Called by destruction of the plugin Remove if not implemented. | |
Public Member Functions inherited from module.moduleBase.ModuleBase | |
+Additional Inherited Members | |
Static Public Member Functions inherited from module.moduleBase.ModuleBase | |
| registerWildcard (newWildcard, bwPacketField) | |
| Register a new wildcard. | |
Data Fields inherited from module.moduleBase.ModuleBase | |
| config = config | |
Protected Member Functions inherited from module.moduleBase.ModuleBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an run of the module. | |
| _getStatistics (self) | |
| Returns statistical information's from last module run. | |
Protected Attributes inherited from module.moduleBase.ModuleBase | |
| _moduleName = moduleName | |
| int | _cumTime = 0 |
| int | _moduleTime = 0 |
| int | _runCount = 0 |
| int | _moduleErrorCount = 0 |
Static Protected Attributes inherited from module.moduleBase.ModuleBase | |
| list | _modulesActive = [] |
Description of the Module.
+| module.template_module.BoswatchModule.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.template_module.BoswatchModule.onLoad | +( | +self | ) | ++ |
Called by import of the plugin Remove if not implemented.
+ +Reimplemented from module.moduleBase.ModuleBase.
+| module.template_module.BoswatchModule.doWork | +( | +self, | +|
| + | + | bwPacket ) | +
start an run of the module.
+| bwPacket | A BOSWatch packet instance |
Reimplemented from module.moduleBase.ModuleBase.
+| module.template_module.BoswatchModule.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin Remove if not implemented.
+ +Reimplemented from module.moduleBase.ModuleBase.
+Description of the Plugin. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| fms (self, bwPacket) | |
| Called on FMS alarm. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm. | |
| msg (self, bwPacket) | |
| Called on MSG packet. | |
Public Member Functions inherited from plugin.pluginBase.PluginBase | |
| onLoad (self) | |
| Called by import of the plugin can be inherited. | |
| setup (self) | |
| Called before alarm can be inherited. | |
| teardown (self) | |
| Called after alarm can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Protected Member Functions | |
| _makeRequests (self, apipath, apicall) | |
| _asyncRequests (self, url) | |
| _fetch (self, url, session) | |
Protected Member Functions inherited from plugin.pluginBase.PluginBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
+Additional Inherited Members | |
Data Fields inherited from plugin.pluginBase.PluginBase | |
| config = config | |
Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
Static Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| list | _pluginsActive = [] |
Description of the Plugin.
+| plugin.divera.BoswatchPlugin.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.divera.BoswatchPlugin.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.divera.BoswatchPlugin.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.divera.BoswatchPlugin.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.divera.BoswatchPlugin.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+
+
|
+ +protected | +
Parses wildcard urls and handles asynchronus requests + +@param urls: array of urls
+
|
+ +protected | +
Handles asynchronus requests + +@param urls: array of urls to send requests to
+
|
+ +protected | +
Fetches requests + +@param url: url + +@param session: Clientsession instance
Description of the Plugin. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| fms (self, bwPacket) | |
| Called on FMS alarm. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm. | |
| msg (self, bwPacket) | |
| Called on MSG packet. | |
Public Member Functions inherited from plugin.pluginBase.PluginBase | |
| onLoad (self) | |
| Called by import of the plugin can be inherited. | |
| setup (self) | |
| Called before alarm can be inherited. | |
| teardown (self) | |
| Called after alarm can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Protected Member Functions | |
| _makeRequests (self, urls) | |
| _asyncRequests (self, urls) | |
| _fetch (self, url, session) | |
Protected Member Functions inherited from plugin.pluginBase.PluginBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
+Additional Inherited Members | |
Data Fields inherited from plugin.pluginBase.PluginBase | |
| config = config | |
Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
Static Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| list | _pluginsActive = [] |
Description of the Plugin.
+| plugin.http.BoswatchPlugin.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.http.BoswatchPlugin.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.http.BoswatchPlugin.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.http.BoswatchPlugin.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.http.BoswatchPlugin.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+
+
|
+ +protected | +
Parses wildcard urls and handles asynchronus requests + +@param urls: array of urls
+
|
+ +protected | +
Handles asynchronus requests + +@param urls: array of urls to send requests to
+
|
+ +protected | +
Fetches requests + +@param url: url + +@param session: Clientsession instance
Description of the Plugin. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin Remove if not implemented. | |
| setup (self) | |
| Called before alarm Remove if not implemented. | |
| fms (self, bwPacket) | |
| Called on FMS alarm. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm. | |
| msg (self, bwPacket) | |
| Called on MSG packet. | |
| teardown (self) | |
| Called after alarm Remove if not implemented. | |
| onUnload (self) | |
| Called by destruction of the plugin Remove if not implemented. | |
Public Member Functions inherited from plugin.pluginBase.PluginBase | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Data Fields | |
| dict | sqlInserts |
| connection | |
| cursor = self.connection.cursor() | |
Data Fields inherited from plugin.pluginBase.PluginBase | |
| config = config | |
+Additional Inherited Members | |
Protected Member Functions inherited from plugin.pluginBase.PluginBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
Static Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| list | _pluginsActive = [] |
Description of the Plugin.
+| plugin.mysql.BoswatchPlugin.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.onLoad | +( | +self | ) | ++ |
Called by import of the plugin Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.setup | +( | +self | ) | ++ |
Called before alarm Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.teardown | +( | +self | ) | ++ |
Called after alarm Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.mysql.BoswatchPlugin.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| dict plugin.mysql.BoswatchPlugin.sqlInserts | +
| plugin.mysql.BoswatchPlugin.connection | +
| plugin.mysql.BoswatchPlugin.cursor = self.connection.cursor() | +
Main plugin class. + More...
++Public Member Functions | |
| __init__ (self, pluginName, config) | |
| init preload some needed locals and then call onLoad() directly | |
| onLoad (self) | |
| Called by import of the plugin can be inherited. | |
| setup (self) | |
| Called before alarm can be inherited. | |
| fms (self, bwPacket) | |
| Called on FMS alarm can be inherited. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm can be inherited. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm can be inherited. | |
| msg (self, bwPacket) | |
| Called on MSG packet can be inherited. | |
| teardown (self) | |
| Called after alarm can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Data Fields | |
| config = config | |
+Protected Member Functions | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
+Protected Attributes | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
+Static Protected Attributes | |
| list | _pluginsActive = [] |
Main plugin class.
+| plugin.pluginBase.PluginBase.__init__ | +( | +self, | +|
| + | + | pluginName, | +|
| + | + | config ) | +
init preload some needed locals and then call onLoad() directly
+ +Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+
+
|
+ +protected | +
Cleanup routine calls onUnload() directly.
+
+
|
+ +protected | +
start an complete running turn of an plugin.
+Calls setup(), alarm() and teardown() in this order. The alarm() method serves the BOSWatch packet to the plugin.
+| bwPacket | A BOSWatch packet instance |
+
|
+ +protected | +
Returns statistical information's from last plugin run.
+| plugin.pluginBase.PluginBase.onLoad | +( | +self | ) | ++ |
Called by import of the plugin can be inherited.
+ +Reimplemented in plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.setup | +( | +self | ) | ++ |
Called before alarm can be inherited.
+ +Reimplemented in plugin.mysql.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm can be inherited.
+| bwPacket | bwPacket instance |
Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm can be inherited.
+| bwPacket | bwPacket instance |
Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm can be inherited.
+| bwPacket | bwPacket instance |
Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet can be inherited.
+| bwPacket | bwPacket instance |
Reimplemented in plugin.divera.BoswatchPlugin, plugin.http.BoswatchPlugin, plugin.mysql.BoswatchPlugin, plugin.telegram.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.teardown | +( | +self | ) | ++ |
Called after alarm can be inherited.
+ +Reimplemented in plugin.mysql.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.onUnload | +( | +self | ) | ++ |
Called on shutdown of boswatch can be inherited.
+ +Reimplemented in plugin.mysql.BoswatchPlugin, and plugin.template_plugin.BoswatchPlugin.
+| plugin.pluginBase.PluginBase.parseWildcards | +( | +self, | +|
| + | + | msg ) | +
Return the message with parsed wildcards.
+
+
|
+ +staticprotected | +
+
|
+ +protected | +
| plugin.pluginBase.PluginBase.config = config | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
Description of the Plugin. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin. | |
| fms (self, bwPacket) | |
| Called on FMS alarm. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm. | |
| msg (self, bwPacket) | |
| Called on MSG packet. | |
Public Member Functions inherited from plugin.pluginBase.PluginBase | |
| setup (self) | |
| Called before alarm can be inherited. | |
| teardown (self) | |
| Called after alarm can be inherited. | |
| onUnload (self) | |
| Called on shutdown of boswatch can be inherited. | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Data Fields | |
| bot = MQBot(token=self.config.get("botToken", default=""), request=request, mqueue=q) | |
Data Fields inherited from plugin.pluginBase.PluginBase | |
| config = config | |
+Protected Member Functions | |
| _sendMessage (self, message) | |
| _sendLocation (self, lat, lon) | |
Protected Member Functions inherited from plugin.pluginBase.PluginBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
+Additional Inherited Members | |
Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
Static Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| list | _pluginsActive = [] |
Description of the Plugin.
+| plugin.telegram.BoswatchPlugin.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.telegram.BoswatchPlugin.onLoad | +( | +self | ) | ++ |
Called by import of the plugin.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.telegram.BoswatchPlugin.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm.
+| bwPacket | bwPacket instance |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.telegram.BoswatchPlugin.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm.
+| bwPacket | bwPacket instance |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.telegram.BoswatchPlugin.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm.
+| bwPacket | bwPacket instance |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.telegram.BoswatchPlugin.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet.
+| bwPacket | bwPacket instance |
Reimplemented from plugin.pluginBase.PluginBase.
+
+
|
+ +protected | +
+
|
+ +protected | +
| plugin.telegram.BoswatchPlugin.bot = MQBot(token=self.config.get("botToken", default=""), request=request, mqueue=q) | +
+Public Member Functions | |
| __init__ (self, *args, is_queued_def=True, mqueue=None, **kwargs) | |
| __del__ (self) | |
| send_message (self, *args, **kwargs) | |
+Protected Attributes | |
| _is_messages_queued_default = is_queued_def | |
| _msg_queue = mqueue or mq.MessageQueue() | |
A subclass of Bot which delegates send method handling to MQ
| plugin.telegram.MQBot.__init__ | +( | +self, | +|
| + | + | * | args, | +
| + | + | is_queued_def = True, | +|
| + | + | mqueue = None, | +|
| + | + | ** | kwargs ) | +
| plugin.telegram.MQBot.__del__ | +( | +self | ) | ++ |
| plugin.telegram.MQBot.send_message | +( | +self, | +|
| + | + | * | args, | +
| + | + | ** | kwargs ) | +
Wrapped method would accept new `queued` and `isgroup` +OPTIONAL arguments
+
|
+ +protected | +
+
|
+ +protected | +
Description of the Plugin. + More...
++Public Member Functions | |
| __init__ (self, config) | |
| Do not change anything here! | |
| onLoad (self) | |
| Called by import of the plugin Remove if not implemented. | |
| setup (self) | |
| Called before alarm Remove if not implemented. | |
| fms (self, bwPacket) | |
| Called on FMS alarm. | |
| pocsag (self, bwPacket) | |
| Called on POCSAG alarm. | |
| zvei (self, bwPacket) | |
| Called on ZVEI alarm. | |
| msg (self, bwPacket) | |
| Called on MSG packet. | |
| teardown (self) | |
| Called after alarm Remove if not implemented. | |
| onUnload (self) | |
| Called by destruction of the plugin Remove if not implemented. | |
Public Member Functions inherited from plugin.pluginBase.PluginBase | |
| parseWildcards (self, msg) | |
| Return the message with parsed wildcards. | |
+Additional Inherited Members | |
Data Fields inherited from plugin.pluginBase.PluginBase | |
| config = config | |
Protected Member Functions inherited from plugin.pluginBase.PluginBase | |
| _cleanup (self) | |
| Cleanup routine calls onUnload() directly. | |
| _run (self, bwPacket) | |
| start an complete running turn of an plugin. | |
| _getStatistics (self) | |
| Returns statistical information's from last plugin run. | |
Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| _pluginName = pluginName | |
| _bwPacket = None | |
| int | _sumTime = 0 |
| int | _cumTime = 0 |
| int | _setupTime = 0 |
| int | _alarmTime = 0 |
| int | _teardownTime = 0 |
| int | _runCount = 0 |
| int | _setupErrorCount = 0 |
| int | _alarmErrorCount = 0 |
| int | _teardownErrorCount = 0 |
Static Protected Attributes inherited from plugin.pluginBase.PluginBase | |
| list | _pluginsActive = [] |
Description of the Plugin.
+| plugin.template_plugin.BoswatchPlugin.__init__ | +( | +self, | +|
| + | + | config ) | +
Do not change anything here!
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.onLoad | +( | +self | ) | ++ |
Called by import of the plugin Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.setup | +( | +self | ) | ++ |
Called before alarm Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.fms | +( | +self, | +|
| + | + | bwPacket ) | +
Called on FMS alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.pocsag | +( | +self, | +|
| + | + | bwPacket ) | +
Called on POCSAG alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.zvei | +( | +self, | +|
| + | + | bwPacket ) | +
Called on ZVEI alarm.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.msg | +( | +self, | +|
| + | + | bwPacket ) | +
Called on MSG packet.
+| bwPacket | bwPacket instance Remove if not implemented |
Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.teardown | +( | +self | ) | ++ |
Called after alarm Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
+| plugin.template_plugin.BoswatchPlugin.onUnload | +( | +self | ) | ++ |
Called by destruction of the plugin Remove if not implemented.
+ +Reimplemented from plugin.pluginBase.PluginBase.
++Directories | |
| filter | |
+Directories | |
| decoder | |
| inputSource | |
| network | |
| router | |
| utils | |