Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
this should make it easier to build new or test applications.
- Loading branch information
Showing
1 changed file
with
143 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
#!/usr/bin/env python | ||
# | ||
############################################################################### | ||
# Copyright (C) 2020 Cortney T. Buffington, N0MJS <n0mjs@me.com> | ||
# | ||
# This program is free software; you can redistribute it and/or modify | ||
# it under the terms of the GNU General Public License as published by | ||
# the Free Software Foundation; either version 3 of the License, or | ||
# (at your option) any later version. | ||
# | ||
# This program is distributed in the hope that it will be useful, | ||
# but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
# GNU General Public License for more details. | ||
# | ||
# You should have received a copy of the GNU General Public License | ||
# along with this program; if not, write to the Free Software Foundation, | ||
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | ||
############################################################################### | ||
|
||
''' | ||
This is a blank application template to build on top of hblink.py. It contains | ||
only the things you need to, essentially, run hblink.py underneath and do nothing | ||
else. The expected behaviour is to override the dmrd_received function from | ||
hblink.py to do somethign meaningful, so that framework is completed, but as | ||
it stands, still does nothing with the DMRD packet. | ||
''' | ||
|
||
# Python modules we need | ||
import sys | ||
from bitarray import bitarray | ||
from time import time | ||
from importlib import import_module | ||
from types import ModuleType | ||
|
||
# Twisted is pretty important, so I keep it separate | ||
from twisted.internet.protocol import Factory, Protocol | ||
from twisted.protocols.basic import NetstringReceiver | ||
from twisted.internet import reactor, task | ||
|
||
# Things we import from the main hblink module | ||
from hblink import HBSYSTEM, OPENBRIDGE, systems, hblink_handler, reportFactory, REPORT_OPCODES, config_reports, mk_aliases, acl_check | ||
from dmr_utils3.utils import bytes_3, int_id, get_alias | ||
from dmr_utils3 import decode, bptc, const | ||
import config | ||
import log | ||
import const | ||
|
||
# The module needs logging logging, but handlers, etc. are controlled by the parent | ||
import logging | ||
logger = logging.getLogger(__name__) | ||
|
||
|
||
# Does anybody read this stuff? There's a PEP somewhere that says I should do this. | ||
__author__ = 'Cortney T. Buffington, N0MJS' | ||
__copyright__ = 'Copyright (c) 2020 Cortney T. Buffington' | ||
__credits__ = 'Colin Durbridge, G4EML, Steve Zingman, N4IRS; Mike Zingman, N4IRR; Jonathan Naylor, G4KLX; Hans Barthen, DL5DI; Torsten Shultze, DG1HT' | ||
__license__ = 'GNU GPLv3' | ||
__maintainer__ = 'Cort Buffington, N0MJS' | ||
__email__ = 'n0mjs@me.com' | ||
__status__ = 'pre-alpha' | ||
|
||
# Module gobal varaibles | ||
|
||
|
||
class blankSYSTEM(HBSYSTEM): | ||
|
||
def __init__(self, _name, _config, _report): | ||
HBSYSTEM.__init__(self, _name, _config, _report) | ||
|
||
def dmrd_received(self, _peer_id, _rf_src, _dst_id, _seq, _slot, _call_type, _frame_type, _dtype_vseq, _stream_id, _data): | ||
pass | ||
|
||
|
||
#************************************************ | ||
# MAIN PROGRAM LOOP STARTS HERE | ||
#************************************************ | ||
|
||
if __name__ == '__main__': | ||
import argparse | ||
import sys | ||
import os | ||
import signal | ||
from dmr_utils3.utils import try_download, mk_id_dict | ||
|
||
# Change the current directory to the location of the application | ||
os.chdir(os.path.dirname(os.path.realpath(sys.argv[0]))) | ||
|
||
# CLI argument parser - handles picking up the config file from the command line, and sending a "help" message | ||
parser = argparse.ArgumentParser() | ||
parser.add_argument('-c', '--config', action='store', dest='CONFIG_FILE', help='/full/path/to/config.file (usually hblink.cfg)') | ||
parser.add_argument('-l', '--logging', action='store', dest='LOG_LEVEL', help='Override config file logging level.') | ||
cli_args = parser.parse_args() | ||
|
||
# Ensure we have a path for the config file, if one wasn't specified, then use the default (top of file) | ||
if not cli_args.CONFIG_FILE: | ||
cli_args.CONFIG_FILE = os.path.dirname(os.path.abspath(__file__))+'/hblink.cfg' | ||
|
||
# Call the external routine to build the configuration dictionary | ||
CONFIG = config.build_config(cli_args.CONFIG_FILE) | ||
|
||
# Start the system logger | ||
if cli_args.LOG_LEVEL: | ||
CONFIG['LOGGER']['LOG_LEVEL'] = cli_args.LOG_LEVEL | ||
logger = log.config_logging(CONFIG['LOGGER']) | ||
logger.info('\n\nCopyright (c) 2013, 2014, 2015, 2016, 2018, 2019\n\tThe Regents of the K0USY Group. All rights reserved.\n') | ||
logger.debug('Logging system started, anything from here on gets logged') | ||
|
||
# Set up the signal handler | ||
def sig_handler(_signal, _frame): | ||
logger.info('SHUTDOWN: >>>BLANK APP<<< IS TERMINATING WITH SIGNAL %s', str(_signal)) | ||
hblink_handler(_signal, _frame) | ||
logger.info('SHUTDOWN: ALL SYSTEM HANDLERS EXECUTED - STOPPING REACTOR') | ||
reactor.stop() | ||
|
||
# Set signal handers so that we can gracefully exit if need be | ||
for sig in [signal.SIGTERM, signal.SIGINT]: | ||
signal.signal(sig, sig_handler) | ||
|
||
# Create the name-number mapping dictionaries | ||
peer_ids, subscriber_ids, talkgroup_ids = mk_aliases(CONFIG) | ||
|
||
|
||
# INITIALIZE THE REPORTING LOOP | ||
if CONFIG['REPORTS']['REPORT']: | ||
report_server = config_reports(CONFIG, reportFactory) | ||
else: | ||
report_server = None | ||
logger.info('(REPORT) TCP Socket reporting not configured') | ||
|
||
# HBlink instance creation | ||
logger.info('HBlink \'blank_app.py\' -- SYSTEM STARTING...') | ||
for system in CONFIG['SYSTEMS']: | ||
if CONFIG['SYSTEMS'][system]['ENABLED']: | ||
if CONFIG['SYSTEMS'][system]['MODE'] == 'OPENBRIDGE': | ||
systems[system] = OPENBRIDGE(system, CONFIG, report_server) | ||
else: | ||
systems[system] = HBSYSTEM(system, CONFIG, report_server) | ||
|
||
reactor.listenUDP(CONFIG['SYSTEMS'][system]['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['IP']) | ||
logger.debug('%s instance created: %s, %s', CONFIG['SYSTEMS'][system]['MODE'], system, systems[system]) | ||
|
||
reactor.run() |