2018-12-27 15:31:08 -05:00
#!/usr/bin/env python
#
###############################################################################
# Copyright (C) 2016-2018 Cortney T. Buffington, N0MJS <n0mjs@me.com> (and Mike Zingman N4IRR)
#
# 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
###############################################################################
'''
'''
from __future__ import print_function
# Python modules we need
import sys
from bitarray import bitarray
from time import time , sleep
from importlib import import_module
# 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 , systems , hblink_handler , reportFactory , REPORT_OPCODES , config_reports , mk_aliases
2019-01-04 16:32:13 -05:00
from dmr_utils . utils import bytes_3 , int_id , get_alias
2018-12-27 15:31:08 -05:00
from dmr_utils import decode , bptc , const
import hb_config
import hb_log
import hb_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 and Mike Zingman, N4IRR '
__copyright__ = ' Copyright (c) 2016 Cortney T. Buffington, N0MJS and the K0USY Group '
__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 parrot ( HBSYSTEM ) :
def __init__ ( self , _name , _config , _report ) :
HBSYSTEM . __init__ ( self , _name , _config , _report )
# Status information for the system, TS1 & TS2
# 1 & 2 are "timeslot"
# In TX_EMB_LC, 2-5 are burst B-E
self . STATUS = {
1 : {
' RX_START ' : time ( ) ,
' RX_SEQ ' : ' \x00 ' ,
' RX_RFS ' : ' \x00 ' ,
' TX_RFS ' : ' \x00 ' ,
' RX_STREAM_ID ' : ' \x00 ' ,
' TX_STREAM_ID ' : ' \x00 ' ,
' RX_TGID ' : ' \x00 \x00 \x00 ' ,
' TX_TGID ' : ' \x00 \x00 \x00 ' ,
' RX_TIME ' : time ( ) ,
' TX_TIME ' : time ( ) ,
' RX_TYPE ' : hb_const . HBPF_SLT_VTERM ,
' RX_LC ' : ' \x00 ' ,
' TX_H_LC ' : ' \x00 ' ,
' TX_T_LC ' : ' \x00 ' ,
' TX_EMB_LC ' : {
1 : ' \x00 ' ,
2 : ' \x00 ' ,
3 : ' \x00 ' ,
4 : ' \x00 ' ,
}
} ,
2 : {
' RX_START ' : time ( ) ,
' RX_SEQ ' : ' \x00 ' ,
' RX_RFS ' : ' \x00 ' ,
' TX_RFS ' : ' \x00 ' ,
' RX_STREAM_ID ' : ' \x00 ' ,
' TX_STREAM_ID ' : ' \x00 ' ,
' RX_TGID ' : ' \x00 \x00 \x00 ' ,
' TX_TGID ' : ' \x00 \x00 \x00 ' ,
' RX_TIME ' : time ( ) ,
' TX_TIME ' : time ( ) ,
' RX_TYPE ' : hb_const . HBPF_SLT_VTERM ,
' RX_LC ' : ' \x00 ' ,
' TX_H_LC ' : ' \x00 ' ,
' TX_T_LC ' : ' \x00 ' ,
' TX_EMB_LC ' : {
1 : ' \x00 ' ,
2 : ' \x00 ' ,
3 : ' \x00 ' ,
4 : ' \x00 ' ,
}
}
}
self . CALL_DATA = [ ]
def dmrd_received ( self , _peer_id , _rf_src , _dst_id , _seq , _slot , _call_type , _frame_type , _dtype_vseq , _stream_id , _data ) :
pkt_time = time ( )
dmrpkt = _data [ 20 : 53 ]
_bits = int_id ( _data [ 15 ] )
if _call_type == ' group ' :
# Is this is a new call stream?
if ( _stream_id != self . STATUS [ _slot ] [ ' RX_STREAM_ID ' ] ) :
self . STATUS [ ' RX_START ' ] = pkt_time
logger . info ( ' ( %s ) *CALL START* STREAM ID: %s SUB: %s ( %s ) REPEATER: %s ( %s ) TGID %s ( %s ), TS %s ' , \
self . _system , int_id ( _stream_id ) , get_alias ( _rf_src , subscriber_ids ) , int_id ( _rf_src ) , get_alias ( _peer_id , peer_ids ) , int_id ( _peer_id ) , get_alias ( _dst_id , talkgroup_ids ) , int_id ( _dst_id ) , _slot )
# Final actions - Is this a voice terminator?
if ( _frame_type == hb_const . HBPF_DATA_SYNC ) and ( _dtype_vseq == hb_const . HBPF_SLT_VTERM ) and ( self . STATUS [ _slot ] [ ' RX_TYPE ' ] != hb_const . HBPF_SLT_VTERM ) :
call_duration = pkt_time - self . STATUS [ ' RX_START ' ]
logger . info ( ' ( %s ) *CALL END* STREAM ID: %s SUB: %s ( %s ) REPEATER: %s ( %s ) TGID %s ( %s ), TS %s , Duration: %s ' , \
self . _system , int_id ( _stream_id ) , get_alias ( _rf_src , subscriber_ids ) , int_id ( _rf_src ) , get_alias ( _peer_id , peer_ids ) , int_id ( _peer_id ) , get_alias ( _dst_id , talkgroup_ids ) , int_id ( _dst_id ) , _slot , call_duration )
self . CALL_DATA . append ( _data )
sleep ( 2 )
logger . info ( ' ( %s ) Playing back transmission from subscriber: %s ' , self . _system , int_id ( _rf_src ) )
for i in self . CALL_DATA :
self . send_system ( i )
sleep ( 0.06 )
self . CALL_DATA = [ ]
else :
if not self . CALL_DATA :
logger . info ( ' ( %s ) Receiving transmission to be played back from subscriber: %s ' , self . _system , int_id ( _rf_src ) )
self . CALL_DATA . append ( _data )
# Mark status variables for use later
self . STATUS [ _slot ] [ ' RX_RFS ' ] = _rf_src
self . STATUS [ _slot ] [ ' RX_TYPE ' ] = _dtype_vseq
self . STATUS [ _slot ] [ ' RX_TGID ' ] = _dst_id
self . STATUS [ _slot ] [ ' RX_TIME ' ] = pkt_time
self . STATUS [ _slot ] [ ' RX_STREAM_ID ' ] = _stream_id
#************************************************
# MAIN PROGRAM LOOP STARTS HERE
#************************************************
if __name__ == ' __main__ ' :
import argparse
import sys
import os
import signal
from dmr_utils . 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 = hb_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 = hb_log . config_logging ( CONFIG [ ' LOGGER ' ] )
logger . info ( ' \n \n Copyright (c) 2013, 2014, 2015, 2016, 2018 \n \t The Founding Members 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: HBROUTER 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 )
# ID ALIAS CREATION
# Download
if CONFIG [ ' ALIASES ' ] [ ' TRY_DOWNLOAD ' ] == True :
# Try updating peer aliases file
result = try_download ( CONFIG [ ' ALIASES ' ] [ ' PATH ' ] , CONFIG [ ' ALIASES ' ] [ ' PEER_FILE ' ] , CONFIG [ ' ALIASES ' ] [ ' PEER_URL ' ] , CONFIG [ ' ALIASES ' ] [ ' STALE_TIME ' ] )
logger . info ( result )
# Try updating subscriber aliases file
result = try_download ( CONFIG [ ' ALIASES ' ] [ ' PATH ' ] , CONFIG [ ' ALIASES ' ] [ ' SUBSCRIBER_FILE ' ] , CONFIG [ ' ALIASES ' ] [ ' SUBSCRIBER_URL ' ] , CONFIG [ ' ALIASES ' ] [ ' STALE_TIME ' ] )
logger . info ( result )
# Create the name-number mapping dictionaries
peer_ids , subscriber_ids , talkgroup_ids = mk_aliases ( CONFIG )
# INITIALIZE THE REPORTING LOOP
report_server = config_reports ( CONFIG , reportFactory )
# HBlink instance creation
logger . info ( ' HBlink \' hb_parrot.py \' (c) 2017 Mike Zingman, N4IRR -- SYSTEM STARTING... ' )
for system in CONFIG [ ' SYSTEMS ' ] :
if CONFIG [ ' SYSTEMS ' ] [ system ] [ ' ENABLED ' ] :
if CONFIG [ ' SYSTEMS ' ] [ system ] [ ' MODE ' ] == ' OPENBRIDGE ' :
logger . critical ( ' %s FATAL: Instance is mode \' OPENBRIDGE \' , \n \t \t ...Which would be tragic for parrot, since it carries multiple call \n \t \t streams simultaneously. hb_parrot.py onlyl works with MMDVM-based systems ' , system )
sys . exit ( ' hb_parrot.py cannot function with systems that are not MMDVM devices. System {} is configured as an OPENBRIDGE ' . format ( system ) )
else :
systems [ system ] = parrot ( 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 ( )