mirror of
https://github.com/BOSWatch/BW3-Core.git
synced 2025-12-06 07:12:04 +01:00
d4dcc75711
Without this change, many warnings like this will be generated while running pytest:
```
test/test_template.py:3
/build/source/test/test_template.py:3: DeprecationWarning: invalid escape sequence '\/'
"""!
```
This can also be seen when manually running python with warnings enabled.
This happens because the comment uses a multiline string and Python interprets the backslash in the logo as an escape character and complains that \/ is not a valid escape sequence. To fix this, prepend the string with the letter r to indicate that the backslash should be treated as a literal character, see https://docs.python.org/3/reference/lexical_analysis.html#index-20.
I also applied this change to all the comment strings since that shouldn't break anything and to establish it as a pattern for the future so this problem hopefully never happens again.
This is what I did specifically:
- Change the comment at the top of bw_client.py and bw_server.py to start with `"""!` since that seems to be the pattern here
- Search-and-Replace all occurances of `"""!` with `r"""!`
- Manually change the strings in `logoToLog()` in boswatch/utils/header.py
162 lines
6.2 KiB
Python
162 lines
6.2 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
r"""!
|
|
____ ____ ______ __ __ __ _____
|
|
/ __ )/ __ \/ ___/ | / /___ _/ /______/ /_ |__ /
|
|
/ __ / / / /\__ \| | /| / / __ `/ __/ ___/ __ \ /_ <
|
|
/ /_/ / /_/ /___/ /| |/ |/ / /_/ / /_/ /__/ / / / ___/ /
|
|
/_____/\____//____/ |__/|__/\__,_/\__/\___/_/ /_/ /____/
|
|
German BOS Information Script
|
|
by Bastian Schroll
|
|
|
|
@file: bw_client.py
|
|
@date: 09.12.2017
|
|
@author: Bastian Schroll
|
|
@description: BOSWatch client application
|
|
"""
|
|
# pylint: disable=wrong-import-position
|
|
# pylint: disable=wrong-import-order
|
|
|
|
import sys
|
|
major_version = sys.version_info.major
|
|
assert major_version >= 3, "please use python3 to run BosWatch 3"
|
|
|
|
from boswatch.utils import paths
|
|
|
|
if not paths.makeDirIfNotExist(paths.LOG_PATH):
|
|
print("cannot find/create log directory: %s", paths.LOG_PATH)
|
|
exit(1)
|
|
|
|
import logging.config
|
|
logging.config.fileConfig(paths.CONFIG_PATH + "logger_client.ini")
|
|
logging.debug("")
|
|
logging.debug("######################## NEW LOG ############################")
|
|
logging.debug("BOSWatch client has started ...")
|
|
|
|
|
|
logging.debug("Import python modules")
|
|
import argparse
|
|
logging.debug("- argparse")
|
|
import queue
|
|
logging.debug("- queue")
|
|
import time
|
|
logging.debug("- time")
|
|
|
|
logging.debug("Import BOSWatch modules")
|
|
from boswatch.configYaml import ConfigYAML
|
|
from boswatch.network.client import TCPClient
|
|
from boswatch.network.broadcast import BroadcastClient
|
|
from boswatch.utils import header
|
|
from boswatch.utils import misc
|
|
from boswatch.inputSource.sdrInput import SdrInput
|
|
from boswatch.inputSource.lineInInput import LineInInput
|
|
from boswatch.inputSource.pulseaudioInput import PulseAudioInput
|
|
from boswatch.decoder.decoder import Decoder # for test mode
|
|
|
|
header.logoToLog()
|
|
header.infoToLog()
|
|
|
|
# With -h or --help you get the Args help
|
|
parser = argparse.ArgumentParser(prog="bw_client.py",
|
|
description="""BOSWatch is a Python Script to receive and
|
|
decode german BOS information with rtl_fm and multimon-NG""",
|
|
epilog="""More options you can find in the extern client.ini
|
|
file in the folder /config""")
|
|
parser.add_argument("-c", "--config", help="Name to configuration File", required=True)
|
|
parser.add_argument("-t", "--test", help="Start Client with testdata-set", action="store_true")
|
|
args = parser.parse_args()
|
|
|
|
bwConfig = ConfigYAML()
|
|
if not bwConfig.loadConfigFile(paths.CONFIG_PATH + args.config):
|
|
logging.error("cannot load config file")
|
|
exit(1)
|
|
|
|
# ========== CLIENT CODE ==========
|
|
bwClient = None
|
|
inputSource = None
|
|
inputQueue = queue.Queue()
|
|
|
|
try:
|
|
ip = bwConfig.get("server", "ip", default="127.0.0.1")
|
|
port = bwConfig.get("server", "port", default="8080")
|
|
|
|
if bwConfig.get("client", "useBroadcast", default=False):
|
|
broadcastClient = BroadcastClient()
|
|
if broadcastClient.getConnInfo():
|
|
ip = broadcastClient.serverIP
|
|
port = broadcastClient.serverPort
|
|
|
|
if not args.test:
|
|
logging.debug("loading input source: %s", bwConfig.get("client", "inputSource"))
|
|
if bwConfig.get("client", "inputSource") == "sdr":
|
|
inputSource = SdrInput(inputQueue, bwConfig.get("inputSource", "sdr"), bwConfig.get("decoder"))
|
|
elif bwConfig.get("client", "inputSource") == "lineIn":
|
|
inputSource = LineInInput(inputQueue, bwConfig.get("inputSource", "lineIn"), bwConfig.get("decoder"))
|
|
elif bwConfig.get("client", "inputSource") == "PulseAudio":
|
|
inputSource = PulseAudioInput(inputQueue, bwConfig.get("inputSource", "PulseAudio"), bwConfig.get("decoder"))
|
|
else:
|
|
logging.fatal("Invalid input source: %s", bwConfig.get("client", "inputSource"))
|
|
exit(1)
|
|
|
|
inputSource.start()
|
|
else:
|
|
logging.warning("STARTING TESTMODE!")
|
|
logging.debug("reading testdata from file")
|
|
testFile = open("test/testdata.list", mode="r", encoding="utf-8")
|
|
for testData in testFile:
|
|
if (len(testData.rstrip(' \t\n\r')) > 1) and ("#" not in testData[0]):
|
|
logging.info("Testdata: %s", testData.rstrip(' \t\n\r'))
|
|
bwPacket = Decoder.decode(testData.rstrip(' \t\n\r'))
|
|
inputQueue.put_nowait((bwPacket, time.time()))
|
|
logging.debug("finished reading testdata")
|
|
|
|
bwClient = TCPClient()
|
|
bwClient.connect(ip, port)
|
|
while 1:
|
|
|
|
if not bwClient.isConnected:
|
|
reconnectDelay = bwConfig.get("client", "reconnectDelay", default="3")
|
|
logging.warning("connection to server lost - sleep %d seconds", reconnectDelay)
|
|
time.sleep(reconnectDelay)
|
|
bwClient.connect(ip, port)
|
|
|
|
elif not inputQueue.empty():
|
|
data = inputQueue.get()
|
|
logging.info("get data from queue (waited %0.3f sec.)", time.time() - data[1])
|
|
logging.debug("%s packet(s) still waiting in queue", inputQueue.qsize())
|
|
bwPacket = data[0]
|
|
inputQueue.task_done()
|
|
|
|
bwPacket.printInfo()
|
|
misc.addClientDataToPacket(bwPacket, bwConfig)
|
|
|
|
for sendCnt in range(bwConfig.get("client", "sendTries", default="3")):
|
|
bwClient.transmit(str(bwPacket))
|
|
if bwClient.receive() == "[ack]":
|
|
logging.debug("ack ok")
|
|
break
|
|
sendDelay = bwConfig.get("client", "sendDelay", default="3")
|
|
logging.warning("cannot send packet - sleep %d seconds", sendDelay)
|
|
time.sleep(sendDelay)
|
|
|
|
else:
|
|
if args.test:
|
|
break
|
|
time.sleep(0.1) # reduce cpu load (wait 100ms)
|
|
# in worst case a packet have to wait 100ms until it will be processed
|
|
|
|
|
|
except KeyboardInterrupt: # pragma: no cover
|
|
logging.warning("Keyboard interrupt")
|
|
except SystemExit: # pragma: no cover
|
|
logging.error("BOSWatch interrupted by an error")
|
|
except: # pragma: no cover
|
|
logging.exception("BOSWatch interrupted by an error")
|
|
finally:
|
|
logging.debug("Starting shutdown routine")
|
|
if inputSource:
|
|
inputSource.shutdown()
|
|
if bwClient:
|
|
bwClient.disconnect()
|
|
logging.debug("BOSWatch client has stopped ...")
|