Preparing for confbridge app. WARNING - CONFIG ADDITION!!!
This commit is contained in:
parent
8f724d1f51
commit
f566cce1ca
438
confbridge.py
Executable file
438
confbridge.py
Executable file
@ -0,0 +1,438 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
#
|
||||||
|
###############################################################################
|
||||||
|
# Copyright (C) 2016 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 sample application to bridge traffic between IPSC systems. it uses
|
||||||
|
# one required (bridge_rules.py) and one optional (known_bridges.py) additional
|
||||||
|
# configuration files. Both files have their own documentation for use.
|
||||||
|
#
|
||||||
|
# "bridge_rules" contains the IPSC network, Timeslot and TGID matching rules to
|
||||||
|
# determine which voice calls are bridged between IPSC systems and which are
|
||||||
|
# not.
|
||||||
|
#
|
||||||
|
# "known_bridges" contains DMR radio ID numbers of known bridges. This file is
|
||||||
|
# used when you want bridge.py to be "polite" or serve as a backup bridge. If
|
||||||
|
# a known bridge exists in either a source OR target IPSC network, then no
|
||||||
|
# bridging between those IPSC systems will take place. This behavior is
|
||||||
|
# dynamic and updates each keep-alive interval (main configuration file).
|
||||||
|
# For faster failover, configure a short keep-alive time and a low number of
|
||||||
|
# missed keep-alives before timout. I recommend 5 sec keep-alive and 3 missed.
|
||||||
|
# That gives a worst-case scenario of 15 seconds to fail over. Recovery will
|
||||||
|
# typically happen with a single "blip" in the transmission up to about 5
|
||||||
|
# seconds.
|
||||||
|
#
|
||||||
|
# While this file is listed as Beta status, K0USY Group depends on this code
|
||||||
|
# for the bridigng of it's many repeaters. We consider it reliable, but you
|
||||||
|
# get what you pay for... as usual, no guarantees.
|
||||||
|
#
|
||||||
|
# Use to make test strings: #print('PKT:', "\\x".join("{:02x}".format(ord(c)) for c in _data))
|
||||||
|
|
||||||
|
from __future__ import print_function
|
||||||
|
from twisted.internet import reactor
|
||||||
|
from twisted.internet import task
|
||||||
|
from binascii import b2a_hex as ahex
|
||||||
|
from time import time
|
||||||
|
from importlib import import_module
|
||||||
|
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from dmr_utils.utils import hex_str_3, hex_str_4, int_id
|
||||||
|
|
||||||
|
from dmrlink import IPSC, systems, config_reports
|
||||||
|
from ipsc.ipsc_const import BURST_DATA_TYPE
|
||||||
|
|
||||||
|
|
||||||
|
__author__ = 'Cortney T. Buffington, N0MJS'
|
||||||
|
__copyright__ = 'Copyright (c) 2013 - 2016 Cortney T. Buffington, N0MJS and the K0USY Group'
|
||||||
|
__credits__ = 'Adam Fast, KC0YLK; Dave Kierzkowski, KD8EYF; Steve Zingman, N4IRS; Mike Zingman, N4IRR'
|
||||||
|
__license__ = 'GNU GPLv3'
|
||||||
|
__maintainer__ = 'Cort Buffington, N0MJS'
|
||||||
|
__email__ = 'n0mjs@me.com'
|
||||||
|
|
||||||
|
|
||||||
|
# Minimum time between different subscribers transmitting on the same TGID
|
||||||
|
#
|
||||||
|
TS_CLEAR_TIME = .2
|
||||||
|
|
||||||
|
# Import Bridging rules
|
||||||
|
# Note: A stanza *must* exist for any IPSC configured in the main
|
||||||
|
# configuration file and listed as "active". It can be empty,
|
||||||
|
# but it has to exist.
|
||||||
|
#
|
||||||
|
def make_bridges(_confbridge_rules):
|
||||||
|
try:
|
||||||
|
bridge_file = import_module(_confbridge_rules)
|
||||||
|
logger.info('Bridge configuration file found and imported')
|
||||||
|
except ImportError:
|
||||||
|
sys.exit('Bridge configuration file not found or invalid')
|
||||||
|
|
||||||
|
# Convert integer GROUP ID numbers from the config into hex strings
|
||||||
|
# we need to send in the actual data packets.
|
||||||
|
#
|
||||||
|
|
||||||
|
for _bridge in bridge_file.BRIDGES:
|
||||||
|
for _system in bridge_file.BRIDGES[_bridge]:
|
||||||
|
from pprint import pprint
|
||||||
|
#pprint(CONFIG['SYSTEMS'])
|
||||||
|
if _system['SYSTEM'] not in CONFIG['SYSTEMS']:
|
||||||
|
print(_system['SYSTEM'])
|
||||||
|
sys.exit('ERROR: Conference bridges found for system not configured main configuration')
|
||||||
|
|
||||||
|
_system['TGID'] = hex_str_3(_system['TGID'])
|
||||||
|
for i, e in enumerate(_system['ON']):
|
||||||
|
_system['ON'][i] = hex_str_3(_system['ON'][i])
|
||||||
|
for i, e in enumerate(_system['OFF']):
|
||||||
|
_system['OFF'][i] = hex_str_3(_system['OFF'][i])
|
||||||
|
_system['TIMEOUT'] = _system['TIMEOUT']*60
|
||||||
|
_system['TIMER'] = time() + _system['TIMEOUT']
|
||||||
|
|
||||||
|
return bridge_file.BRIDGES
|
||||||
|
|
||||||
|
|
||||||
|
# Import subscriber ACL
|
||||||
|
# ACL may be a single list of subscriber IDs
|
||||||
|
# Global action is to allow or deny them. Multiple lists with different actions and ranges
|
||||||
|
# are not yet implemented.
|
||||||
|
def build_acl(_sub_acl):
|
||||||
|
try:
|
||||||
|
acl_file = import_module(_sub_acl)
|
||||||
|
for i, e in enumerate(acl_file.ACL):
|
||||||
|
acl_file.ACL[i] = hex_str_3(acl_file.ACL[i])
|
||||||
|
logger.info('ACL file found and ACL entries imported')
|
||||||
|
ACL_ACTION = acl_file.ACL_ACTION
|
||||||
|
ACL = acl_file.ACL_ACTION
|
||||||
|
except ImportError:
|
||||||
|
logger.info('ACL file not found or invalid - all subscriber IDs are valid')
|
||||||
|
ACL_ACTION = 'NONE'
|
||||||
|
ACL = []
|
||||||
|
|
||||||
|
# Depending on which type of ACL is used (PERMIT, DENY... or there isn't one)
|
||||||
|
# define a differnet function to be used to check the ACL
|
||||||
|
global allow_sub
|
||||||
|
if ACL_ACTION == 'PERMIT':
|
||||||
|
def allow_sub(_sub):
|
||||||
|
if _sub in ACL:
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
elif ACL_ACTION == 'DENY':
|
||||||
|
def allow_sub(_sub):
|
||||||
|
if _sub not in ACL:
|
||||||
|
return True
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
else:
|
||||||
|
def allow_sub(_sub):
|
||||||
|
return True
|
||||||
|
|
||||||
|
return ACL
|
||||||
|
|
||||||
|
|
||||||
|
# Run this every minute for rule timer updates
|
||||||
|
def rule_timer_loop():
|
||||||
|
logger.info('(ALL IPSC SYSTEMS) Rule timer loop started')
|
||||||
|
_now = time()
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
if _system['TO_TYPE'] == 'ON':
|
||||||
|
if _system['ACTIVE'] == True:
|
||||||
|
if _system['TIMER'] < _now:
|
||||||
|
_system['ACTIVE'] = False
|
||||||
|
logger.info('Conference Bridge TIMEOUT: DEACTIVATE System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
timeout_in = _system['TIMER'] - _now
|
||||||
|
logger.info('Conference Bridge ACTIVE (ON timer running): System: %s Bridge: %s, TS: %s, TGID: %s, Timeout in: %ss,', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']), timeout_in)
|
||||||
|
elif _system['ACTIVE'] == False:
|
||||||
|
logger.debug('Conference Bridge INACTIVE (no change): System: %s Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
elif _system['TO_TYPE'] == 'OFF':
|
||||||
|
if _system['ACTIVE'] == False:
|
||||||
|
if _system['TIMER'] < _now:
|
||||||
|
_system['ACTIVE'] = True
|
||||||
|
logger.info('Conference Bridge TIMEOUT: ACTIVATE System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
timeout_in = _system['TIMER'] - _now
|
||||||
|
logger.info('Conference Bridge INACTIVE (OFF timer running): System: %s Bridge: %s, TS: %s, TGID: %s, Timeout in: %ss,', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']), timeout_in)
|
||||||
|
elif _system['ACTIVE'] == True:
|
||||||
|
logger.debug('Conference Bridge ACTIVE (no change): System: %s Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
else:
|
||||||
|
logger.debug('Conference Bridge NO ACTION: System: %s, Bridge: %s, TS: %s, TGID: %s', _system['SYSTEM'], _bridge, _system['TS'], int_id(_system['TGID']))
|
||||||
|
|
||||||
|
|
||||||
|
class confbridgeIPSC(IPSC):
|
||||||
|
def __init__(self, _name, _config, _logger):
|
||||||
|
IPSC.__init__(self, _name, _config, _logger)
|
||||||
|
|
||||||
|
self.STATUS = {
|
||||||
|
1: {'RX_TGID':'\x00', 'TX_TGID':'\x00', 'RX_TIME':0, 'TX_TIME':0, 'RX_SRC_SUB':'\x00', 'TX_SRC_SUB':'\x00'},
|
||||||
|
2: {'RX_TGID':'\x00', 'TX_TGID':'\x00', 'RX_TIME':0, 'TX_TIME':0, 'RX_SRC_SUB':'\x00', 'TX_SRC_SUB':'\x00'}
|
||||||
|
}
|
||||||
|
|
||||||
|
self.last_seq_id = '\x00'
|
||||||
|
self.call_start = 0
|
||||||
|
|
||||||
|
#************************************************
|
||||||
|
# CALLBACK FUNCTIONS FOR USER PACKET TYPES
|
||||||
|
#************************************************
|
||||||
|
#
|
||||||
|
def group_voice(self, _src_sub, _dst_group, _ts, _end, _peerid, _data):
|
||||||
|
|
||||||
|
# Check for ACL match, and return if the subscriber is not allowed
|
||||||
|
if allow_sub(_src_sub) == False:
|
||||||
|
self._logger.warning('(%s) Group Voice Packet ***REJECTED BY ACL*** From: %s, IPSC Peer %s, Destination %s', self._system, int_id(_src_sub), int_id(_peerid), int_id(_dst_group))
|
||||||
|
return
|
||||||
|
|
||||||
|
# Process the packet
|
||||||
|
self._logger.debug('(%s) Group Voice Packet Received From: %s, IPSC Peer %s, Destination %s', self._system, int_id(_src_sub), int_id(_peerid), int_id(_dst_group))
|
||||||
|
_burst_data_type = _data[30] # Determine the type of voice packet this is (see top of file for possible types)
|
||||||
|
_seq_id = _data[5]
|
||||||
|
|
||||||
|
now = time() # Mark packet arrival time -- we'll need this for call contention handling
|
||||||
|
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
|
||||||
|
if (_system['SYSTEM'] == self._system and _system['TGID'] == _dst_group and _system['TS'] == _ts and _system['ACTIVE'] == True):
|
||||||
|
|
||||||
|
for _target in BRIDGES[_bridge]:
|
||||||
|
if _target['SYSTEM'] != self._system:
|
||||||
|
_target_status = systems[_target['SYSTEM']].STATUS
|
||||||
|
|
||||||
|
# BEGIN CONTENTION HANDLING
|
||||||
|
#
|
||||||
|
# The rules for each of the 4 "ifs" below are listed here for readability. The Frame To Send is:
|
||||||
|
# From a different group than last RX from this IPSC, but it has been less than Group Hangtime
|
||||||
|
# From a different group than last TX to this IPSC, but it has been less than Group Hangtime
|
||||||
|
# From the same group as the last RX from this IPSC, but from a different subscriber, and it has been less than TS Clear Time
|
||||||
|
# From the same group as the last TX to this IPSC, but from a different subscriber, and it has been less than TS Clear Time
|
||||||
|
# The "continue" at the end of each means the next iteration of the for loop that tests for matching rules
|
||||||
|
#
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['RX_TGID']) and ((now - _target_status[_target['TS']]['RX_TIME']) < self._CONFIG['SYSTEMS'][_target['SYSTEM']]['LOCAL']['GROUP_HANGTIME'])):
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_HEAD']:
|
||||||
|
self._logger.info('(%s) Call not bridged to TGID%s, target active or in group hangtime: IPSC: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['_TS'], int_id(_target_status[_target['TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if ((_target['TGID'] != _target_status[_target['TS']]['TX_TGID']) and ((now - _target_status[_target['TS']]['TX_TIME']) < self._CONFIG['SYSTEMS'][_target['SYSTEM']]['LOCAL']['GROUP_HANGTIME'])):
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_HEAD']:
|
||||||
|
self._logger.info('(%s) Call not bridged to TGID%s, target in group hangtime: IPSC: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[_target['TS']]['TX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['RX_TGID']) and ((now - _target_status[_target['TS']]['RX_TIME']) < TS_CLEAR_TIME):
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_HEAD']:
|
||||||
|
self._logger.info('(%s) Call not bridged to TGID%s, matching call already active on target: IPSC: %s, TS: %s, TGID: %s', self._system, int_id(_target['TGID']), _target['SYSTEM'], _target['TS'], int_id(_target_status[rule['DST_TS']]['RX_TGID']))
|
||||||
|
continue
|
||||||
|
if (_target['TGID'] == _target_status[_target['TS']]['TX_TGID']) and (_src_sub != _target_status[_target['TS']]['TX_SRC_SUB']) and ((now - _target_status[_target['TS']]['TX_TIME']) < TS_CLEAR_TIME):
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_HEAD']:
|
||||||
|
self._logger.info('(%s) Call not bridged for subscriber %s, call bridge in progress on target: IPSC: %s, TS: %s, TGID: %s SUB: %s', self._system, int_id(_src_sub), _target['SYSTEM'], _target['TGID'], int_id(_target_status[_target['TS']]['TX_TGID']), int_id(_target_status[_target['TS']]['TX_SRC_SUB']))
|
||||||
|
continue
|
||||||
|
#
|
||||||
|
# END CONTENTION HANDLING
|
||||||
|
#
|
||||||
|
|
||||||
|
#
|
||||||
|
# BEGIN FRAME FORWARDING
|
||||||
|
#
|
||||||
|
# Make a copy of the payload
|
||||||
|
_tmp_data = _data
|
||||||
|
|
||||||
|
# Re-Write the IPSC SRC to match the target network's ID
|
||||||
|
_tmp_data = _tmp_data.replace(_peerid, self._CONFIG['SYSTEMS'][_target['SYSTEM']]['LOCAL']['RADIO_ID'])
|
||||||
|
|
||||||
|
# Re-Write the destination Group ID
|
||||||
|
_tmp_data = _tmp_data.replace(_dst_group, _target['TGID'])
|
||||||
|
|
||||||
|
# Re-Write IPSC timeslot value
|
||||||
|
_call_info = int_id(_data[17:18])
|
||||||
|
if _target['TS'] == 1:
|
||||||
|
_call_info &= ~(1 << 5)
|
||||||
|
elif _target['TS'] == 2:
|
||||||
|
_call_info |= 1 << 5
|
||||||
|
_call_info = chr(_call_info)
|
||||||
|
_tmp_data = _tmp_data[:17] + _call_info + _tmp_data[18:]
|
||||||
|
|
||||||
|
# Re-Write DMR timeslot value
|
||||||
|
# Determine if the slot is present, so we can translate if need be
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['SLOT1_VOICE'] or _burst_data_type == BURST_DATA_TYPE['SLOT2_VOICE']:
|
||||||
|
_slot_valid = True
|
||||||
|
else:
|
||||||
|
_slot_valid = False
|
||||||
|
# Re-Write timeslot if necessary...
|
||||||
|
if _slot_valid:
|
||||||
|
if _target['TS'] == 1:
|
||||||
|
_burst_data_type = BURST_DATA_TYPE['SLOT1_VOICE']
|
||||||
|
elif _target['TS'] == 1:
|
||||||
|
_burst_data_type = BURST_DATA_TYPE['SLOT2_VOICE']
|
||||||
|
_tmp_data = _tmp_data[:30] + _burst_data_type + _tmp_data[31:]
|
||||||
|
|
||||||
|
# Send the packet to all peers in the target IPSC
|
||||||
|
systems[_target['SYSTEM']].send_to_ipsc(_tmp_data)
|
||||||
|
#
|
||||||
|
# END FRAME FORWARDING
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
# Set values for the contention handler to test next time there is a frame to forward
|
||||||
|
_target_status[_ts]['TX_GROUP'] = _target['TGID']
|
||||||
|
_target_status[_ts]['TX_TIME'] = now
|
||||||
|
_target_status[_ts]['TX_SRC_SUB'] = _src_sub
|
||||||
|
|
||||||
|
|
||||||
|
# Mark the group and time that a packet was recieved for the contention handler to use later
|
||||||
|
self.STATUS[_ts]['RX_TGID'] = _dst_group
|
||||||
|
self.STATUS[_ts]['RX_TIME'] = now
|
||||||
|
|
||||||
|
|
||||||
|
#
|
||||||
|
# BEGIN IN-BAND SIGNALING BASED ON TGID & VOICE TERMINATOR FRAME
|
||||||
|
#
|
||||||
|
# Activate/Deactivate rules based on group voice activity -- PTT or UA for you c-Bridge dorks.
|
||||||
|
# This will ONLY work for symmetrical rules!!!
|
||||||
|
|
||||||
|
# Action happens on key up
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_HEAD']:
|
||||||
|
if self.last_seq_id != _seq_id:
|
||||||
|
self.last_seq_id = _seq_id
|
||||||
|
self.call_start = time()
|
||||||
|
self._logger.info('(%s) GROUP VOICE START: CallID: %s PEER: %s, SUB: %s, TS: %s, TGID: %s', self._system, int_id(_seq_id), int_id(_peerid), int_id(_src_sub), _ts, int_id(_dst_group))
|
||||||
|
|
||||||
|
# Action happens on un-key
|
||||||
|
if _burst_data_type == BURST_DATA_TYPE['VOICE_TERM']:
|
||||||
|
if self.last_seq_id == _seq_id:
|
||||||
|
self.call_duration = time() - self.call_start
|
||||||
|
self._logger.info('(%s) GROUP VOICE END: CallID: %s PEER: %s, SUB: %s, TS: %s, TGID: %s Duration: %.2fs', self._system, int_id(_seq_id), int_id(_peerid), int_id(_src_sub), _ts, int_id(_dst_group), self.call_duration)
|
||||||
|
else:
|
||||||
|
self._logger.warning('(%s) GROUP VOICE END WITHOUT MATCHING START: CallID: %s PEER: %s, SUB: %s, TS: %s, TGID: %s', self._system, int_id(_seq_id), int_id(_peerid), int_id(_src_sub), _ts, int_id(_dst_group),)
|
||||||
|
|
||||||
|
# Iterate the rules dictionary
|
||||||
|
for _bridge in BRIDGES:
|
||||||
|
for _system in BRIDGES[_bridge]:
|
||||||
|
if _system['SYSTEM'] == self._system:
|
||||||
|
|
||||||
|
# TGID matches a rule source, reset its timer
|
||||||
|
if _ts == _system['TS'] and _dst_group == _system['TGID'] and ((_system['TO_TYPE'] == 'ON' and (_system['ACTIVE'] == True)) or (_system['TO_TYPE'] == 'OFF' and _system['ACTIVE'] == False)):
|
||||||
|
_system['TIMER'] = now + _system['TIMEOUT']
|
||||||
|
self._logger.info('(%s) Transmission match for Bridge: %s. Reset timeout to %s', self._system, _bridge, _system['TIMER'])
|
||||||
|
|
||||||
|
# TGID matches an ACTIVATION trigger
|
||||||
|
if _dst_group in _system['ON']:
|
||||||
|
# Set the matching rule as ACTIVE
|
||||||
|
_system['ACTIVE'] = True
|
||||||
|
_system['TIMER'] = now + _system['TIMEOUT']
|
||||||
|
self._logger.info('(%s) Bridge: %s, connection changed to state: %s', self._system, _bridge, _system['ACTIVE'])
|
||||||
|
|
||||||
|
# TGID matches an DE-ACTIVATION trigger
|
||||||
|
if _dst_group in _system['OFF']:
|
||||||
|
# Set the matching rule as ACTIVE
|
||||||
|
_system['ACTIVE'] = False
|
||||||
|
self._logger.info('(%s) Bridge: %s, connection changed to state: %s', self._system, _bridge, _system['ACTIVE'])
|
||||||
|
|
||||||
|
#
|
||||||
|
# END IN-BAND SIGNALLING
|
||||||
|
#
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
import argparse
|
||||||
|
import os
|
||||||
|
import signal
|
||||||
|
from dmr_utils.utils import try_download, mk_id_dict
|
||||||
|
|
||||||
|
import dmrlink_log
|
||||||
|
import dmrlink_config
|
||||||
|
|
||||||
|
# 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='CFG_FILE', help='/full/path/to/config.file (usually dmrlink.cfg)')
|
||||||
|
cli_args = parser.parse_args()
|
||||||
|
|
||||||
|
if not cli_args.CFG_FILE:
|
||||||
|
cli_args.CFG_FILE = os.path.dirname(os.path.abspath(__file__))+'/dmrlink.cfg'
|
||||||
|
|
||||||
|
# Call the external routine to build the configuration dictionary
|
||||||
|
CONFIG = dmrlink_config.build_config(cli_args.CFG_FILE)
|
||||||
|
|
||||||
|
# Call the external routing to start the system logger
|
||||||
|
logger = dmrlink_log.config_logging(CONFIG['LOGGER'])
|
||||||
|
|
||||||
|
config_reports(CONFIG)
|
||||||
|
|
||||||
|
logger.info('DMRlink \'confbridge.py\' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING...')
|
||||||
|
|
||||||
|
# Shut ourselves down gracefully with the IPSC peers.
|
||||||
|
def sig_handler(_signal, _frame):
|
||||||
|
logger.info('*** DMRLINK IS TERMINATING WITH SIGNAL %s ***', str(_signal))
|
||||||
|
|
||||||
|
for system in systems:
|
||||||
|
this_ipsc = systems[system]
|
||||||
|
logger.info('De-Registering from IPSC %s', system)
|
||||||
|
de_reg_req_pkt = this_ipsc.hashed_packet(this_ipsc._local['AUTH_KEY'], this_ipsc.DE_REG_REQ_PKT)
|
||||||
|
this_ipsc.send_to_ipsc(de_reg_req_pkt)
|
||||||
|
reactor.stop()
|
||||||
|
|
||||||
|
# Set signal handers so that we can gracefully exit if need be
|
||||||
|
for sig in [signal.SIGTERM, signal.SIGINT, signal.SIGQUIT]:
|
||||||
|
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)
|
||||||
|
|
||||||
|
# Make Dictionaries
|
||||||
|
peer_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['PEER_FILE'])
|
||||||
|
if peer_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: peer_ids dictionary is available')
|
||||||
|
|
||||||
|
subscriber_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['SUBSCRIBER_FILE'])
|
||||||
|
if subscriber_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: subscriber_ids dictionary is available')
|
||||||
|
|
||||||
|
talkgroup_ids = mk_id_dict(CONFIG['ALIASES']['PATH'], CONFIG['ALIASES']['TGID_FILE'])
|
||||||
|
if talkgroup_ids:
|
||||||
|
logger.info('ID ALIAS MAPPER: talkgroup_ids dictionary is available')
|
||||||
|
|
||||||
|
# Build the routing rules file
|
||||||
|
BRIDGES = make_bridges('confbridge_rules')
|
||||||
|
|
||||||
|
# Build the Access Control List
|
||||||
|
ACL = build_acl('sub_acl')
|
||||||
|
|
||||||
|
# INITIALIZE AN IPSC OBJECT (SELF SUSTAINING) FOR EACH CONFIGUED IPSC
|
||||||
|
for system in CONFIG['SYSTEMS']:
|
||||||
|
if CONFIG['SYSTEMS'][system]['LOCAL']['ENABLED']:
|
||||||
|
systems[system] = confbridgeIPSC(system, CONFIG, logger)
|
||||||
|
reactor.listenUDP(CONFIG['SYSTEMS'][system]['LOCAL']['PORT'], systems[system], interface=CONFIG['SYSTEMS'][system]['LOCAL']['IP'])
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP IF CONFIGURED
|
||||||
|
if CONFIG['REPORTS']['REPORT_NETWORKS']:
|
||||||
|
reporting_loop = config_reports(CONFIG)
|
||||||
|
reporting = task.LoopingCall(reporting_loop, logger)
|
||||||
|
reporting.start(CONFIG['REPORTS']['REPORT_INTERVAL'])
|
||||||
|
|
||||||
|
# INITIALIZE THE REPORTING LOOP IF CONFIGURED
|
||||||
|
rule_timer = task.LoopingCall(rule_timer_loop)
|
||||||
|
rule_timer.start(60)
|
||||||
|
|
||||||
|
reactor.run()
|
48
confbridge_rules-SAMPLE.py
Normal file
48
confbridge_rules-SAMPLE.py
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
'''
|
||||||
|
THIS EXAMPLE WILL NOT WORK AS IT IS - YOU MUST SPECIFY YOUR OWN VALUES!!!
|
||||||
|
|
||||||
|
This file is organized around the "Conference Bridges" that you wish to use. If you're a c-Bridge
|
||||||
|
person, think of these as "bridge groups". You might also liken them to a "reflector". If a particular
|
||||||
|
system is "ACTIVE" on a particular conference bridge, any traffid from that system will be sent
|
||||||
|
to any other system that is active on the bridge as well. This is not an "end to end" method, because
|
||||||
|
each system must independently be activated on the bridge.
|
||||||
|
|
||||||
|
The first level (e.g. "WORLDWIDE" or "STATEWIDE" in the examples) is the name of the conference
|
||||||
|
bridge. This is any arbitrary ASCII text string you want to use. Under each conference bridge
|
||||||
|
definition are the following items -- one line for each HBSystem as defined in the main HBlink
|
||||||
|
configuration file.
|
||||||
|
|
||||||
|
* SYSTEM - The name of the sytem as listed in the main dmrlink configuration file (e.g.dmrlink.cfg)
|
||||||
|
This MUST be the exact same name as in the main config file!!!
|
||||||
|
* TS - Timeslot used for matching traffic to this confernce bridge
|
||||||
|
* TGID - Talkgroup ID used for matching traffic to this conference bridge
|
||||||
|
* ON and OFF are LISTS of Talkgroup IDs used to trigger this system off and on. Even if you
|
||||||
|
only want one (as shown in the ON example), it has to be in list format. None can be
|
||||||
|
handled with an empty list, such as " 'ON': [] ".
|
||||||
|
* TO_TYPE is timeout type. If you want to use timers, ON means when it's turned on, it will
|
||||||
|
turn off afer the timout period and OFF means it will turn back on after the timout
|
||||||
|
period. If you don't want to use timers, set it to anything else, but 'NONE' might be
|
||||||
|
a good value for documentation!
|
||||||
|
* TIMOUT is a value in minutes for the timout timer. No, I won't make it 'seconds', so don't
|
||||||
|
ask. Timers are performance "expense".
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
BRIDGES = {
|
||||||
|
'WORLDWIDE': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 1, 'TGID': 1, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'ON', 'ON': [2,], 'OFF': [9,10]},
|
||||||
|
{'SYSTEM': 'CLIENT-1', 'TS': 1, 'TGID': 3100, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'ON', 'ON': [2,], 'OFF': [9,10]},
|
||||||
|
],
|
||||||
|
'ENGLISH': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,10]},
|
||||||
|
{'SYSTEM': 'CLIENT-2', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,10]},
|
||||||
|
],
|
||||||
|
'STATEWIDE': [
|
||||||
|
{'SYSTEM': 'MASTER-1', 'TS': 2, 'TGID': 3129, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,10]},
|
||||||
|
{'SYSTEM': 'CLIENT-2', 'TS': 2, 'TGID': 3129, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,10]},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
from pprint import pprint
|
||||||
|
pprint(BRIDGES)
|
25
confbridge_rules.py
Normal file
25
confbridge_rules.py
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
'''
|
||||||
|
THIS EXAMPLE WILL NOT WORK AS IT IS - YOU MUST SPECIFY YOUR OWN VALUES!!!
|
||||||
|
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
BRIDGES = {
|
||||||
|
'KANSAS': [
|
||||||
|
{'SYSTEM': 'LAWRENCE', 'TS': 2, 'TGID': 3120, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'ON', 'ON': [2,], 'OFF': [9,]},
|
||||||
|
{'SYSTEM': 'C-BRIDGE', 'TS': 2, 'TGID': 3120, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'OFF', 'ON': [2,], 'OFF': [9,]},
|
||||||
|
{'SYSTEM': 'BRANDMEISTER', 'TS': 2, 'TGID': 3120, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [2,], 'OFF': [9,]},
|
||||||
|
],
|
||||||
|
'BYRG': [
|
||||||
|
{'SYSTEM': 'LAWRENCE', 'TS': 1, 'TGID': 3100, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,]},
|
||||||
|
{'SYSTEM': 'BRANDMEISTER', 'TS': 2, 'TGID': 31201, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [3,], 'OFF': [8,]},
|
||||||
|
],
|
||||||
|
'ENGLISH': [
|
||||||
|
#{'SYSTEM': 'LAWRENCE', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,]},
|
||||||
|
{'SYSTEM': 'C-BRIDGE', 'TS': 1, 'TGID': 13, 'ACTIVE': True, 'TIMEOUT': 2, 'TO_TYPE': 'NONE', 'ON': [4,], 'OFF': [7,]},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
from pprint import pprint
|
||||||
|
pprint(BRIDGES)
|
@ -85,41 +85,42 @@ STALE_DAYS: 7
|
|||||||
# Please read these closely - catastrophic results could result by setting
|
# Please read these closely - catastrophic results could result by setting
|
||||||
# certain flags for things DMRlink cannot do.
|
# certain flags for things DMRlink cannot do.
|
||||||
#
|
#
|
||||||
# [NAME] The name you want to use to identify the IPSC instance (use
|
# [NAME] The name you want to use to identify the IPSC instance (use
|
||||||
# something better than "IPSC1"...)
|
# something better than "IPSC1"...)
|
||||||
# ENABLED: Should we communiate with this network? Handy if you need to
|
# ENABLED: Should we communiate with this network? Handy if you need to
|
||||||
# shut one down but don't want to lose the config
|
# shut one down but don't want to lose the config
|
||||||
# RADIO_ID: This is the radio ID that DMRLink should use to communicate
|
# RADIO_ID: This is the radio ID that DMRLink should use to communicate
|
||||||
# IP: This is the local IPv4 address to listen on. It may be left
|
# IP: This is the local IPv4 address to listen on. It may be left
|
||||||
# blank if you do not need or wish to specify. It is mostly
|
# blank if you do not need or wish to specify. It is mostly
|
||||||
# useful when DMRlink uses multiple interfaces to serve as an
|
# useful when DMRlink uses multiple interfaces to serve as an
|
||||||
# application gatway/proxy from private and/or VPN networks
|
# application gatway/proxy from private and/or VPN networks
|
||||||
# to the real world.
|
# to the real world.
|
||||||
# PORT: This is the UDP source port for DMRLink to use for this
|
# PORT: This is the UDP source port for DMRLink to use for this
|
||||||
# IPSC network, must be unique!!!
|
# PSC network, must be unique!!!
|
||||||
# ALIVE_TIMER: Seconds between keep-alive transmissions
|
# ALIVE_TIMER: Seconds between keep-alive transmissions
|
||||||
# MAX_MISSED: How many missed keep-alives before we remove a peer
|
# MAX_MISSED: How many missed keep-alives before we remove a peer
|
||||||
# PEER_OPER: This signals the master and peers whether or not we are
|
# PEER_OPER: This signals the master and peers whether or not we are
|
||||||
# operational. True is the only thing that makes sense.
|
# operational. True is the only thing that makes sense.
|
||||||
# IPSC_MODE: May be 'DIGITAL', 'ANALOG', or 'NONE'. Digital is really the
|
# IPSC_MODE: May be 'DIGITAL', 'ANALOG', or 'NONE'. Digital is really the
|
||||||
# only thing that makes sense.
|
# only thing that makes sense.
|
||||||
# TSx_LINK: Is this time slot linked?
|
# TSx_LINK: Is this time slot linked?
|
||||||
# CSBK_CALL: Should be False, we cannot process these, but may be useful
|
# CSBK_CALL: Should be False, we cannot process these, but may be useful
|
||||||
# for debugging.
|
# for debugging.
|
||||||
# RCM: Repeater Call Monitoring - don't unable unless you plan to
|
# RCM: Repeater Call Monitoring - don't unable unless you plan to
|
||||||
# actually use it, this craetes extra network traffic.
|
# actually use it, this craetes extra network traffic.
|
||||||
# CON_APP: Third Party Console App - exactly what DMRlink is, should
|
# CON_APP: Third Party Console App - exactly what DMRlink is, should
|
||||||
# be set to True.
|
# be set to True.
|
||||||
# XNL_CALL: Can cause problems if not set to False, DMRlink does not
|
# XNL_CALL: Can cause problems if not set to False, DMRlink does not
|
||||||
# process XCMP/XNL calls.
|
# process XCMP/XNL calls.
|
||||||
# XNL_MASTER: Obviously, should also be False, see XNL_CALL.
|
# XNL_MASTER: Obviously, should also be False, see XNL_CALL.
|
||||||
# DATA_CALL: Process data calls. True if you want to process data calls
|
# DATA_CALL: Process data calls. True if you want to process data calls
|
||||||
# VOICE_CALL: Process voice calls. True if you want to process voice calls
|
# VOICE_CALL: Process voice calls. True if you want to process voice calls
|
||||||
# MASTER_PEER: True if DMRlink will be the master, False if we're a peer
|
# MASTER_PEER: True if DMRlink will be the master, False if we're a peer
|
||||||
# AUTH_ENABLED: Do we use authenticated IPSC?
|
# AUTH_ENABLED: Do we use authenticated IPSC?
|
||||||
# AUTH_KEY: The Authentication key (up to 40 hex characters)
|
# AUTH_KEY: The Authentication key (up to 40 hex characters)
|
||||||
# MASTER_IP: IP address of the IPSC master (ignored if DMRlink is the master)
|
# MASTER_IP: IP address of the IPSC master (ignored if DMRlink is the master)
|
||||||
# MASTER_PORT: UDP port of the IPSC master (ignored if DMRlinkn is the master)
|
# MASTER_PORT: UDP port of the IPSC master (ignored if DMRlinkn is the master)
|
||||||
|
# GROUP_HANGTIME: Group hangtime, per DMR configuration
|
||||||
#
|
#
|
||||||
# ...Repeat the block for each IPSC network to join.
|
# ...Repeat the block for each IPSC network to join.
|
||||||
#
|
#
|
||||||
@ -147,6 +148,7 @@ AUTH_ENABLED: True
|
|||||||
AUTH_KEY: 1A2B3C
|
AUTH_KEY: 1A2B3C
|
||||||
MASTER_IP: 1.2.3.4
|
MASTER_IP: 1.2.3.4
|
||||||
MASTER_PORT: 50000
|
MASTER_PORT: 50000
|
||||||
|
GROUP_HANGTIME: 5
|
||||||
|
|
||||||
|
|
||||||
[SAMPLE_MASTER]
|
[SAMPLE_MASTER]
|
||||||
@ -173,3 +175,4 @@ AUTH_KEY: 1A2B3C
|
|||||||
# Below not used for a Master
|
# Below not used for a Master
|
||||||
# MASTER_IP: 1.2.3.4
|
# MASTER_IP: 1.2.3.4
|
||||||
# MASTER_PORT: 50000
|
# MASTER_PORT: 50000
|
||||||
|
GROUP_HANGTIME: 5
|
@ -113,6 +113,7 @@ def build_config(_config_file):
|
|||||||
'ALIVE_TIMER': config.getint(section, 'ALIVE_TIMER'),
|
'ALIVE_TIMER': config.getint(section, 'ALIVE_TIMER'),
|
||||||
'MAX_MISSED': config.getint(section, 'MAX_MISSED'),
|
'MAX_MISSED': config.getint(section, 'MAX_MISSED'),
|
||||||
'AUTH_KEY': (config.get(section, 'AUTH_KEY').rjust(40,'0')).decode('hex'),
|
'AUTH_KEY': (config.get(section, 'AUTH_KEY').rjust(40,'0')).decode('hex'),
|
||||||
|
'GROUP_HANGTIME': config.getint(section, 'GROUP_HANGTIME'),
|
||||||
'NUM_PEERS': 0,
|
'NUM_PEERS': 0,
|
||||||
})
|
})
|
||||||
# Master means things we need to know about the master peer of the network
|
# Master means things we need to know about the master peer of the network
|
||||||
|
Loading…
x
Reference in New Issue
Block a user