2016-07-31 10:42:11 -04:00
#!/usr/bin/env python
#
# This work is licensed under the Creative Attribution-NonCommercial-ShareAlike
# 3.0 Unported License.To view a copy of this license, visit
# http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to
# Creative Commons, 444 Castro Street, Suite 900, Mountain View,
# California, 94041, USA.
from __future__ import print_function
# Python modules we need
import sys
2016-08-26 23:43:51 -04:00
from binascii import b2a_hex as h
2016-10-10 21:49:51 -04:00
from bitarray import bitarray
2016-11-01 20:49:13 -04:00
from time import time
2016-07-31 10:42:11 -04:00
# Debugging functions
from pprint import pprint
# Twisted is pretty important, so I keep it separate
from twisted . internet . protocol import DatagramProtocol
from twisted . internet import reactor
from twisted . internet import task
# Things we import from the main hblink module
2016-08-25 21:44:15 -04:00
from hblink import CONFIG , HBMASTER , HBCLIENT , logger , systems , hex_str_3 , int_id
2016-10-23 12:07:16 -04:00
import dec_dmr
2016-10-24 17:25:14 -04:00
import constants as const
2016-07-31 10:42:11 -04:00
# Import Bridging rules
# Note: A stanza *must* exist for any MASTER or CLIENT configured in the main
# configuration file and listed as "active". It can be empty,
# but it has to exist.
try :
from hb_routing_rules import RULES as RULES_FILE
logger . info ( ' Routing rules file found and rules imported ' )
except ImportError :
sys . exit ( ' Routing rules 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.
2016-08-25 21:44:15 -04:00
for _system in RULES_FILE :
2016-11-01 20:49:13 -04:00
RULES_FILE [ _system ] [ ' GROUP_HANGTIME ' ] = RULES_FILE [ _system ] [ ' GROUP_HANGTIME ' ] * 1000
2016-08-25 21:44:15 -04:00
for _rule in RULES_FILE [ _system ] [ ' GROUP_VOICE ' ] :
2016-07-31 10:42:11 -04:00
_rule [ ' SRC_GROUP ' ] = hex_str_3 ( _rule [ ' SRC_GROUP ' ] )
_rule [ ' DST_GROUP ' ] = hex_str_3 ( _rule [ ' DST_GROUP ' ] )
_rule [ ' SRC_TS ' ] = _rule [ ' SRC_TS ' ]
_rule [ ' DST_TS ' ] = _rule [ ' DST_TS ' ]
for i , e in enumerate ( _rule [ ' ON ' ] ) :
_rule [ ' ON ' ] [ i ] = hex_str_3 ( _rule [ ' ON ' ] [ i ] )
for i , e in enumerate ( _rule [ ' OFF ' ] ) :
_rule [ ' OFF ' ] [ i ] = hex_str_3 ( _rule [ ' OFF ' ] [ i ] )
2016-08-25 21:44:15 -04:00
if _system not in CONFIG [ ' SYSTEMS ' ] :
sys . exit ( ' ERROR: Routing rules found for system not configured main configuration ' )
for _system in CONFIG [ ' SYSTEMS ' ] :
if _system not in RULES_FILE :
sys . exit ( ' ERROR: Routing rules not found for all systems configured ' )
2016-07-31 10:42:11 -04:00
RULES = RULES_FILE
# TEMPORARY DEBUGGING LINE -- TO BE REMOVED LATER
2016-08-01 21:24:37 -04:00
#pprint(RULES)
2016-07-31 10:42:11 -04:00
# Does anybody read this stuff? There's a PEP somewhere that says I should do this.
__author__ = ' Cortney T. Buffington, N0MJS '
__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__ = ' Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported '
__maintainer__ = ' Cort Buffington, N0MJS '
__email__ = ' n0mjs@me.com '
__status__ = ' pre-alpha '
class routerMASTER ( HBMASTER ) :
2016-10-10 21:49:51 -04:00
def __init__ ( self , * args , * * kwargs ) :
HBMASTER . __init__ ( self , * args , * * kwargs )
2016-11-01 20:49:13 -04:00
self . ts1_state = {
' LSTREAM_ID ' : ' ' ,
2016-11-08 15:56:11 -05:00
' LTGID ' : ' ' ,
2016-11-01 20:49:13 -04:00
' LPKT_TIME ' : time ( ) ,
' LPKT_TYPE ' : const . HBPF_SLT_VTERM ,
' LC ' : ' ' ,
}
self . ts2_state = {
' LSTREAM_ID ' : ' ' ,
2016-11-08 15:56:11 -05:00
' LTGID ' : ' ' ,
2016-11-01 20:49:13 -04:00
' LPKT_TIME ' : time ( ) ,
' LPKT_TYPE ' : const . HBPF_SLT_VTERM ,
' LC ' : ' ' ,
}
2016-08-26 22:33:35 -04:00
2016-09-22 10:12:38 -04:00
def dmrd_received ( self , _radio_id , _rf_src , _dst_id , _seq , _slot , _call_type , _frame_type , _dtype_vseq , _stream_id , _data ) :
2016-11-01 20:49:13 -04:00
if _slot == 1 :
state = self . ts1_state
elif _slot == 2 :
state = self . ts2_state
else :
logger . error ( ' ( %s ) DMRD received with invalid Timeslot value: %s ' , self . _master , h ( _data ) )
pkt_time = time ( )
dmrpkt = _data [ 20 : 54 ]
2016-11-01 21:54:43 -04:00
_bits = int_id ( _data [ 15 ] )
if _call_type == ' group ' :
2016-11-01 20:49:13 -04:00
2016-11-01 21:54:43 -04:00
# Is this a new call stream?
if ( _stream_id != state [ ' LSTREAM_ID ' ] ) :
if ( ( state [ ' LPKT_TYPE ' ] != const . HBPF_SLT_VTERM ) or ( pkt_time < state [ ' LPKT_TIME ' ] + const . STREAM_TO ) ) :
logger . warning ( ' ( %s ) Packet received <FROM> SUB: %s REPEATER: %s <TO> TGID %s , SLOT %s collided with existing call ' , self . _master , int_id ( _rf_src ) , int_id ( _radio_id ) , int_id ( _dst_id ) , _slot )
return
2016-10-10 21:11:50 -04:00
2016-11-01 21:54:43 -04:00
# This is a new call stream
2016-11-08 15:56:11 -05:00
# Check to see if we're in group hangtime before accepting it
if ( _dst_id != state [ ' LTGID ' ] ) and ( pkt_time < state [ ' LPKT_TIME ' ] + RULE [ self . _master ] [ ' GROUP_HANGTIME ' ] ) :
logger . warning ( ' ( %s ) Packet received <FROM> SUB: %s REPEATER: %s <TO> TGID %s , SLOT %s whild in group hangtime for TGID %s ' , self . _master , int_id ( _rf_src ) , int_id ( _radio_id ) , int_id ( _dst_id ) , _slot , int_id ( state [ ' LTGID ' ] ) )
return
# This is actually a VALID new call stream
2016-11-01 21:54:43 -04:00
logger . info ( ' ( %s ) Call stream START <FROM> SUB: %s REPEATER: %s <TO> TGID %s , SLOT %s ' , self . _master , int_id ( _rf_src ) , int_id ( _radio_id ) , int_id ( _dst_id ) , _slot )
state [ ' LSTREAM_ID ' ] = _stream_id
state [ ' LPKT_TIME ' ] = pkt_time
2016-11-08 15:56:11 -05:00
state [ ' LTGID ' ] = _dst_id
2016-10-23 12:07:16 -04:00
2016-11-01 21:54:43 -04:00
# If we can, use the LC from the voice header as to keep all options intact
if _frame_type == const . HBPF_DATA_SYNC and _dtype_vseq == const . HBPF_SLT_VHEAD :
decoded = dec_dmr . voice_head_term ( dmrpkt )
state [ ' LC ' ] = decoded [ ' LC ' ]
# If we don't have a voice header then don't wait to decode it from the Embedded LC
# just make a new one from the HBP header.
else :
state [ ' LC ' ] = const . LC_OPT + _dst_id + _rf_src
2016-10-10 21:11:50 -04:00
2016-08-26 23:56:47 -04:00
_routed = False
2016-08-25 21:44:15 -04:00
for rule in RULES [ self . _master ] [ ' GROUP_VOICE ' ] :
2016-08-01 22:31:28 -04:00
_target = rule [ ' DST_NET ' ]
2016-08-26 22:33:35 -04:00
if ( rule [ ' SRC_GROUP ' ] == _dst_id and rule [ ' SRC_TS ' ] == _slot and rule [ ' ACTIVE ' ] == True ) :
2016-08-26 23:43:51 -04:00
if rule [ ' SRC_TS ' ] != rule [ ' DST_TS ' ] :
2016-08-26 22:33:35 -04:00
_tmp_bits = _bits ^ 1 << 7
2016-08-26 22:31:20 -04:00
else :
2016-08-26 22:33:35 -04:00
_tmp_bits = _bits
2016-09-03 06:05:54 -04:00
_tmp_data = _data [ : 8 ] + rule [ ' DST_GROUP ' ] + _data [ 11 : 15 ] + chr ( _tmp_bits ) + _data [ 16 : ]
2016-09-18 09:40:32 -04:00
#print(h(_data))
#print(h(_tmp_data))
2016-08-26 22:33:35 -04:00
systems [ _target ] . send_system ( _tmp_data )
2016-08-26 23:56:47 -04:00
_routed = True
2016-08-26 22:33:35 -04:00
2016-08-26 23:43:51 -04:00
logger . debug ( ' ( %s ) Packet routed to %s system: %s ' , self . _master , CONFIG [ ' SYSTEMS ' ] [ _target ] [ ' MODE ' ] , _target )
2016-08-26 23:56:47 -04:00
if not _routed :
logger . debug ( ' ( %s ) Packet router no target TS/TGID %s / %s ' , self . _master , _slot , int_id ( _dst_id ) )
2016-11-01 21:54:43 -04:00
# Final actions - Is this a voice terminator? and set the last packet type
if ( _frame_type == const . HBPF_DATA_SYNC ) and ( _dtype_vseq == const . HBPF_SLT_VTERM ) and ( state [ ' LPKT_TYPE ' ] != const . HBPF_SLT_VTERM ) :
state [ ' LC ' ] = ' '
logger . info ( ' ( %s ) Call stream END <FROM> SUB: %s REPEATER: %s <TO> TGID %s , SLOT %s ' , self . _master , int_id ( _rf_src ) , int_id ( _radio_id ) , int_id ( _dst_id ) , _slot )
state [ ' LPKT_TYPE ' ] = _dtype_vseq
2016-07-31 10:42:11 -04:00
class routerCLIENT ( HBCLIENT ) :
2016-08-26 22:33:35 -04:00
2016-10-10 21:49:51 -04:00
def __init__ ( self , * args , * * kwargs ) :
HBCLIENT . __init__ ( self , * args , * * kwargs )
2016-10-20 21:56:19 -04:00
self . embeddec_lc_rx = { ' B ' : ' ' , ' C ' : ' ' , ' D ' : ' ' , ' E ' : ' ' , ' F ' : ' ' }
self . embeddec_lc_tx = { ' B ' : ' ' , ' C ' : ' ' , ' D ' : ' ' , ' E ' : ' ' , ' F ' : ' ' }
2016-10-10 21:49:51 -04:00
2016-09-22 10:12:38 -04:00
def dmrd_received ( self , _radio_id , _rf_src , _dst_id , _seq , _slot , _call_type , _frame_type , _dtype_vseq , _stream_id , _data ) :
2016-08-26 22:33:35 -04:00
_bits = int_id ( _data [ 15 ] )
if _call_type == ' group ' :
2016-08-26 23:56:47 -04:00
_routed = False
2016-08-25 21:44:15 -04:00
for rule in RULES [ self . _client ] [ ' GROUP_VOICE ' ] :
2016-08-01 22:31:28 -04:00
_target = rule [ ' DST_NET ' ]
2016-08-26 22:33:35 -04:00
if ( rule [ ' SRC_GROUP ' ] == _dst_id and rule [ ' SRC_TS ' ] == _slot and rule [ ' ACTIVE ' ] == True ) :
2016-08-26 23:43:51 -04:00
if rule [ ' SRC_TS ' ] != rule [ ' DST_TS ' ] :
2016-08-26 22:33:35 -04:00
_tmp_bits = _bits ^ 1 << 7
2016-08-26 22:31:20 -04:00
else :
2016-08-26 22:33:35 -04:00
_tmp_bits = _bits
2016-08-26 23:43:51 -04:00
_tmp_data = _data [ : 8 ] + rule [ ' DST_GROUP ' ] + _data [ 11 : 15 ] + chr ( _bits ) + _data [ 16 : ]
2016-09-18 09:40:32 -04:00
#print(h(_data))
#print(h(_tmp_data))
2016-08-26 22:33:35 -04:00
systems [ _target ] . send_system ( _tmp_data )
2016-08-26 23:56:47 -04:00
_routed = True
2016-08-01 22:31:28 -04:00
2016-08-26 23:43:51 -04:00
logger . debug ( ' ( %s ) Packet routed to %s system: %s ' , self . _client , CONFIG [ ' SYSTEMS ' ] [ _target ] [ ' MODE ' ] , _target )
2016-08-26 22:33:35 -04:00
2016-08-26 23:56:47 -04:00
if not _routed :
logger . debug ( ' ( %s ) Packet router no target TS/TGID %s / %s ' , self . _client , _slot , int_id ( _dst_id ) )
2016-07-31 10:42:11 -04:00
#************************************************
# MAIN PROGRAM LOOP STARTS HERE
#************************************************
if __name__ == ' __main__ ' :
logger . info ( ' HBlink \' hb_router.py \' (c) 2016 N0MJS & the K0USY Group - SYSTEM STARTING... ' )
2016-08-25 21:44:15 -04:00
# HBlink instance creation
for system in CONFIG [ ' SYSTEMS ' ] :
if CONFIG [ ' SYSTEMS ' ] [ system ] [ ' ENABLED ' ] :
if CONFIG [ ' SYSTEMS ' ] [ system ] [ ' MODE ' ] == ' MASTER ' :
2016-08-25 22:27:10 -04:00
systems [ system ] = routerMASTER ( system )
2016-08-25 21:44:15 -04:00
elif CONFIG [ ' SYSTEMS ' ] [ system ] [ ' MODE ' ] == ' CLIENT ' :
2016-08-25 22:27:10 -04:00
systems [ system ] = routerCLIENT ( system )
2016-08-25 21:44:15 -04:00
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 ] )
2016-07-31 10:42:11 -04:00
reactor . run ( )