module.geocoding.BoswatchModule Class Reference

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
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
	_cumTime
	_moduleTime
	_runCount
	_moduleErrorCount
Static Protected Attributes inherited from module.moduleBase.ModuleBase
list	_modulesActive = []

Detailed Description

Description of the Module.

Constructor & Destructor Documentation

__init__()

module.geocoding.BoswatchModule.__init__	(		self,
			config
	)

Do not change anything here!

Reimplemented from module.moduleBase.ModuleBase.

    def __init__(self, config):
        r"""!Do not change anything here!"""
        super().__init__(__name__, config)  # you can access the config class on 'self.config'
 

Member Function Documentation

doWork()

module.geocoding.BoswatchModule.doWork	(		self,
			bwPacket
	)

start an run of the module.

Parameters

bwPacket

A BOSWatch packet instance

Reimplemented from module.moduleBase.ModuleBase.

    def doWork(self, bwPacket):
        r"""!start an run of the module.
 
        @param bwPacket: A BOSWatch packet instance"""
        if bwPacket.get("mode") == "pocsag":
            self.geocode(bwPacket)
 
        return bwPacket
 

geocode()

module.geocoding.BoswatchModule.geocode	(		self,
			bwPacket
	)

find address in message and get latitude and longitude

Parameters

bwPacket

A BOSWatch packet instance

    def geocode(self, bwPacket):
        r"""!find address in message and get latitude and longitude
 
        @param bwPacket: A BOSWatch packet instance"""
        try:
            addressArray = re.search(self.config.get("regex"), bwPacket.get("message"))
            provider = self.config.get("apiProvider")
 
            if addressArray[1] is None:
                logging.info("No address found, skipping geocoding")
                return bwPacket
 
            address = addressArray[1]
            bwPacket.set("address", address)
            self.registerWildcard("{ADDRESS}", "address")
            logging.info("Found address: '" + address + "' in packet")
 
            if "mapbox" == provider:
                logging.info("Using Mapbox as provider")
                g = geocoder.mapbox(address, key=self.config.get("apiToken"))
            elif "google" == provider:
                logging.info("Using Google as provider")
                g = geocoder.google(address, key=self.config.get("apiToken"))
            else:
                return bwPacket
 
            (lat, lon) = g.latlng
            logging.info("Found following coordinates for address: [lat=" + str(lat) + ", lon=" + str(lon) + "]")
            bwPacket.set("lat", lat)
            bwPacket.set("lon", lon)
            self.registerWildcard("{LAT}", "lat")
            self.registerWildcard("{LON}", "lon")
 
            return bwPacket
        except Exception as e:
            logging.exception("Unknown Error while executing geocoding module: " + str(type(e).__name__) + ": " + str(e))
        return bwPacket