Project

General

Profile

Bug #7939 » ga510.py

Dan Smith, 09/08/2020 11:54 AM

 
import logging
import struct

from chirp import bitwise
from chirp import chirp_common
from chirp import directory
from chirp import errors
from chirp import memmap
from chirp.settings import RadioSetting, RadioSettingGroup, RadioSettings
from chirp.settings import RadioSettingValueBoolean, RadioSettingValueList
from chirp.settings import RadioSettingValueInteger, RadioSettingValueString

LOG = logging.getLogger(__name__)

try:
from builtins import bytes
has_future = True
except ImportError:
has_future = False
LOG.warning('python-future package is not available; '
'%s requires it' % __name__)


POWER_LEVELS = [
chirp_common.PowerLevel('H', watts=10),
chirp_common.PowerLevel('L', watts=1),
chirp_common.PowerLevel('M', watts=5)]
DTMFCHARS = '0123456789ABCD*#'


def reset(radio):
radio.pipe.write(b'E')


def start_program(radio):
reset(radio)
radio.pipe.read(256)
radio.pipe.write(b'PROGROMBFHU')
ack = radio.pipe.read(256)
if not ack.endswith(b'\x06'):
LOG.debug('Ack was %r' % ack)
raise errors.RadioError('Radio did not respond to clone request')

radio.pipe.write(b'F')

ident = radio.pipe.read(8)
LOG.debug('Radio ident string is %r' % ident)

return ident


def do_download(radio):
ident = start_program(radio)

s = chirp_common.Status()
s.msg = 'Downloading'
s.max = 0x1C00

data = bytes()
for addr in range(0, 0x1C40, 0x40):
cmd = struct.pack('>cHB', b'R', addr, 0x40)
LOG.debug('Reading block at %04x: %r' % (addr, cmd))
radio.pipe.write(cmd)

block = radio.pipe.read(0x44)
header = block[:4]
rcmd, raddr, rlen = struct.unpack('>BHB', header)
block = block[4:]
if raddr != addr:
raise errors.RadioError('Radio send address %04x, expected %04x' %
(raddr, addr))
if rlen != 0x40 or len(block) != 0x40:
raise errors.RadioError('Radio sent %02x (%02x) bytes, '
'expected %02x' % (rlen, len(block), 0x40))

data += block

s.cur = addr
radio.status_fn(s)

reset(radio)

return data


def do_upload(radio):
ident = start_program(radio)

s = chirp_common.Status()
s.msg = 'Uploading'
s.max = 0x1C00

# The factory software downloads 0x40 for the block
# at 0x1C00, but only uploads 0x20 there. Mimic that
# here.
for addr in range(0, 0x1C20, 0x20):
cmd = struct.pack('>cHB', b'W', addr, 0x20)
LOG.debug('Writing block at %04x: %r' % (addr, cmd))
block = radio._mmap[addr:addr + 0x20]
radio.pipe.write(cmd)
radio.pipe.write(block)

ack = radio.pipe.read(1)
if ack != b'\x06':
raise errors.RadioError('Radio refused block at addr %04x' % addr)

s.cur = addr
radio.status_fn(s)


MEM_FORMAT = """
struct {
lbcd rxfreq[4];
lbcd txfreq[4];
ul16 rxtone;
ul16 txtone;
u8 signal;
u8 unknown1:6,
pttid:2;
u8 unknown2:6,
power:2;
u8 unknown3_0:1,
narrow:1,
unknown3_1:2,
bcl:1,
scan:1,
unknown3_2:1,
fhss:1;
} memories[128];

#seekto 0x0C00;
struct {
char name[10];
u8 pad[6];
} names[128];

#seekto 0x1A00;
struct {
// 0x1A00
u8 squelch;
u8 savemode; // [off, mode1, mode2, mode3]
u8 vox; // off=0
u8 backlight;
u8 tdr; // bool
u8 timeout; // n*15 = seconds
u8 beep; // bool
u8 voice;

// 0x1A08
u8 language; // [eng, chin]
u8 dtmfst;
u8 scanmode; // [TO, CO, SE]
u8 pttid; // [off, BOT, EOT, Both]
u8 pttdelay; // 0-30
u8 cha_disp; // [ch-name, ch-freq]
u8 chb_disp;
u8 bcl; // bool

// 0x1A10
u8 autolock; // bool
u8 alarm_mode; // [site, tone, code]
u8 alarmsound; // bool
u8 txundertdr; // [off, bandA, bandB]
u8 tailnoiseclear; // [off, on]
u8 rptnoiseclr; // 10*ms, 0-1000
u8 rptnoisedet;
u8 roger; // bool

// 0x1A18
u8 unknown1a10;
u8 fmradio; // boolean, inverted
u8 workmode; // [vfo, chan]; 1A30-1A31 related?
u8 kblock; // boolean
} settings;

struct dtmfcode {
u8 code[5];
u8 ffpad[11]; // always 0xFF
};
#seekto 0x1B00;
struct dtmfcode dtmfgroup[15];
struct {
u8 code[5];
u8 groupcode; // 0->D, *, #
u8 nothing:6,
releasetosend:1,
presstosend:1;
u8 dtmfspeedon; // 80 + n*10, up to [194]
u8 dtmfspeedoff;
} anicode;

//dtmf on -> 90ms
//dtmf off-> 120ms
//group code *->0
//press 0->1
//release 1->0

"""


PTTID = ['Off', 'BOT', 'EOT', 'Both']
SIGNAL = [str(i) for i in range(1, 16)]


class TDH6Radio(chirp_common.Alias):
VENDOR = "TIDRADIO"
MODEL = "TD-H6"


@directory.register
class RadioddityGA510Radio(chirp_common.CloneModeRadio):
VENDOR = 'Radioddity'
MODEL = 'GA-510'
BAUD_RATE = 9600
NEEDS_COMPAT_SERIAL = False
ALIASES = [TDH6Radio]

def sync_in(self):
try:
data = do_download(self)
self._mmap = memmap.MemoryMapBytes(data)
except errors.RadioError:
raise
except Exception as e:
LOG.exception('General failure')
raise errors.RadioError('Failed to download from radio: %s' % e)
self.process_mmap()

def sync_out(self):
try:
do_upload(self)
except errors.RadioError:
raise
except Exception as e:
LOG.exception('General failure')
raise errors.RadioError('Failed to upload to radio: %s' % e)

def process_mmap(self):
self._memobj = bitwise.parse(MEM_FORMAT, self._mmap)

def get_features(self):
rf = chirp_common.RadioFeatures()
rf.memory_bounds = (0, 127)
rf.has_ctone = True
rf.has_cross = True
rf.has_tuning_step = False
rf.has_settings = True
rf.has_bank = False
rf.has_sub_devices = False
rf.has_dtcs_polarity = True
rf.has_rx_dtcs = True
rf.can_odd_split = True
rf.valid_tmodes = ['', 'Tone', 'TSQL', 'DTCS', 'Cross']
rf.valid_cross_modes = ['Tone->Tone', 'DTCS->', '->DTCS', 'Tone->DTCS',
'DTCS->Tone', '->Tone', 'DTCS->DTCS']
rf.valid_modes = ['FM', 'NFM']
rf.valid_tuning_steps = [2.5, 5.0, 6.25, 12.5, 10.0, 15.0, 20.0,
25.0, 50.0, 100.0]
rf.valid_duplexes = ['', '-', '+', 'split', 'off']
rf.valid_power_levels = POWER_LEVELS
rf.valid_name_length = 10
rf.valid_characters = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
'abcdefghijklmnopqrstuvwxyz'
'0123456789'
'!"#$%&\'()~+-,./:;<=>?@[\\]^`{}*| ')
rf.valid_bands = [(136000000, 174000000),
(400000000, 480000000)]
return rf

def get_raw_memory(self, num):
return repr(self._memobj.memories[num]) + repr(self._memobj.names[num])

@staticmethod
def _decode_tone(toneval):
if toneval in (0, 0xFFFF):
LOG.debug('no tone value: %s' % toneval)
return '', None, None
elif toneval < 670:
toneval = toneval - 1
index = toneval % len(chirp_common.DTCS_CODES)
if index != int(toneval):
pol = 'R'
#index -= 1
else:
pol = 'N'
return 'DTCS', chirp_common.DTCS_CODES[index], pol
else:
return 'Tone', toneval / 10.0, 'N'

@staticmethod
def _encode_tone(mode, val, pol):
if not mode:
return 0x0000
elif mode == 'Tone':
return int(val * 10)
elif mode == 'DTCS':
index = chirp_common.DTCS_CODES.index(val)
if pol == 'R':
index += len(chirp_common.DTCS_CODES)
index += 1
LOG.debug('Encoded dtcs %s/%s to %04x' % (val, pol, index))
return index
else:
raise errors.RadioError('Unsupported tone mode %r' % mode)

def _get_extra(self, _mem):
group = RadioSettingGroup('extra', 'Extra')

s = RadioSetting('bcl', 'Busy Channel Lockout',
RadioSettingValueBoolean(_mem.bcl))
group.append(s)

s = RadioSetting('fhss', 'FHSS',
RadioSettingValueBoolean(_mem.fhss))
group.append(s)

# pttid, signal

cur = PTTID[int(_mem.pttid)]
s = RadioSetting('pttid', 'PTTID',
RadioSettingValueList(PTTID, cur))
group.append(s)

cur = SIGNAL[int(_mem.signal)]
s = RadioSetting('signal', 'Signal',
RadioSettingValueList(SIGNAL, cur))
group.append(s)

return group

def _set_extra(self, _mem, mem):
_mem.bcl = int(mem.extra['bcl'].value)
_mem.fhss = int(mem.extra['fhss'].value)
_mem.pttid = int(mem.extra['pttid'].value)
_mem.signal = int(mem.extra['signal'].value)

def get_memory(self, num):
_mem = self._memobj.memories[num]
mem = chirp_common.Memory()
mem.number = num
if int(_mem.rxfreq) == 166666665:
mem.empty = True
return mem

mem.name = ''.join([str(c) for c in self._memobj.names[num].name
if ord(str(c)) < 127]).rstrip()
mem.freq = int(_mem.rxfreq) * 10
offset = (int(_mem.txfreq) - int(_mem.rxfreq)) * 10
if offset == 0:
mem.duplex = ''
elif abs(offset) < 100000000:
mem.duplex = offset < 0 and '-' or '+'
mem.offset = abs(offset)
else:
mem.duplex = 'split'
mem.offset = int(_mem.txfreq) * 10

mem.power = POWER_LEVELS[_mem.power]
mem.mode = 'NFM' if _mem.narrow else 'FM'
mem.skip = '' if _mem.scan else 'S'

LOG.debug('got txtone: %s' % repr(self._decode_tone(_mem.txtone)))
LOG.debug('got rxtone: %s' % repr(self._decode_tone(_mem.rxtone)))
chirp_common.split_tone_decode(mem,
self._decode_tone(_mem.txtone),
self._decode_tone(_mem.rxtone))
try:
mem.extra = self._get_extra(_mem)
except:
LOG.exception('Failed to get extra for %i' % num)
return mem

def set_memory(self, mem):
_mem = self._memobj.memories[mem.number]
_nam = self._memobj.names[mem.number]

if mem.empty:
_mem.set_raw(b'\xff' * 16)
_nam.set_raw(b'\xff' * 16)
return

if int(_mem.rxfreq) == 166666665:
LOG.debug('Initializing new memory %i' % mem.number)
_mem.set_raw(b'\x00' * 16)

_nam.name = mem.name.ljust(10)

_mem.rxfreq = mem.freq // 10
if mem.duplex == '':
_mem.txfreq = mem.freq // 10
elif mem.duplex == 'split':
_mem.txfreq = mem.offset // 10
elif mem.duplex == 'off':
_mem.txfreq.set_raw(b'\xff\xff\xff\xff')
elif mem.duplex == '-':
_mem.txfreq = (mem.freq - mem.offset) // 10
elif mem.duplex == '+':
_mem.txfreq = (mem.freq + mem.offset) // 10
else:
raise errors.RadioError('Unsupported duplex mode %r' % mem.duplex)

txtone, rxtone = chirp_common.split_tone_encode(mem)
LOG.debug('tx tone is %s' % repr(txtone))
LOG.debug('rx tone is %s' % repr(rxtone))
_mem.txtone = self._encode_tone(*txtone)
_mem.rxtone = self._encode_tone(*rxtone)

try:
_mem.power = POWER_LEVELS.index(mem.power)
except ValueError:
_mem.power = 0
_mem.narrow = mem.mode == 'NFM'
_mem.scan = mem.skip != 'S'
if mem.extra:
self._set_extra(_mem, mem)

def get_settings(self):
_set = self._memobj.settings

basic = RadioSettingGroup('basic', 'Basic')
adv = RadioSettingGroup('advanced', 'Advanced')
dtmf = RadioSettingGroup('dtmf', 'DTMF')

choice_settings = {
'savemode': ['Off', 'Mode 1', 'Mode 2', 'Mode 3'],
'vox': ['Off'] + ['%i' % i for i in range(1, 11)],
'backlight': ['Off'] + ['%i' % i for i in range(1, 11)],
'timeout': ['Off'] + ['%i' % i for i in range(15, 615, 15)],
'language': ['English', 'Chinese'],
'dtmfst': ['OFF', 'KB Side Tone', 'ANI Side Tone',
'KB ST+ANI ST', 'Both'],
'scanmode': ['TO', 'CO', 'SE'],
'pttid': ['Off', 'BOT', 'EOT', 'Both'],
'cha_disp': ['CH+Name', 'CH+Freq'],
'chb_disp': ['CH+Name', 'CH+Freq'],
'alarm_mode': ['Site', 'Tone', 'Code'],
'txundertdr': ['Off', 'Band A', 'Band B'],
'rptnoiseclr': ['Off'] + ['%i' % i for i in range(100, 1001, 100)],
'rptnoisedet': ['Off'] + ['%i' % i for i in range(100, 1001, 100)],
'workmode': ['VFO', 'Chan'],
}

basic_settings = ['timeout', 'vox', 'backlight', 'language',
'cha_disp', 'chb_disp', 'workmode']
titles = {
'savemode': 'Save Mode',
'vox': 'VOX',
'backlight': 'Auto Backlight',
'timeout': 'Time Out Timer (s)',
'language': 'Language',
'dtmfst': 'DTMF-ST',
'scanmode': 'Scan Mode',
'pttid': 'PTT-ID',
'cha_disp': 'Channel A Display',
'chb_disp': 'Channel B Display',
'alarm_mode': 'Alarm Mode',
'txundertdr': 'TX Under TDR',
'rptnoiseclr': 'RPT Noise Clear (ms)',
'rptnoisedet': 'RPT Noise Detect (ms)',
'workmode': 'Work Mode',
}

basic.append(
RadioSetting('squelch', 'Squelch Level',
RadioSettingValueInteger(0, 9, int(_set.squelch))))
adv.append(
RadioSetting('pttdelay', 'PTT Delay',
RadioSettingValueInteger(0, 30, int(_set.pttdelay))))
adv.append(
RadioSetting('tdr', 'TDR',
RadioSettingValueBoolean(
int(_set.tdr))))
adv.append(
RadioSetting('beep', 'Beep',
RadioSettingValueBoolean(
int(_set.beep))))
basic.append(
RadioSetting('voice', 'Voice Enable',
RadioSettingValueBoolean(
int(_set.voice))))
adv.append(
RadioSetting('bcl', 'BCL',
RadioSettingValueBoolean(
int(_set.bcl))))
adv.append(
RadioSetting('autolock', 'Auto Lock',
RadioSettingValueBoolean(
int(_set.autolock))))
adv.append(
RadioSetting('alarmsound', 'Alarm Sound',
RadioSettingValueBoolean(
int(_set.alarmsound))))
adv.append(
RadioSetting('tailnoiseclear', 'Tail Noise Clear',
RadioSettingValueBoolean(
int(_set.tailnoiseclear))))
adv.append(
RadioSetting('roger', 'Roger',
RadioSettingValueBoolean(
int(_set.roger))))
adv.append(
RadioSetting('fmradio', 'FM Radio Disabled',
RadioSettingValueBoolean(
int(_set.fmradio))))
adv.append(
RadioSetting('kblock', 'KB Lock',
RadioSettingValueBoolean(
int(_set.kblock))))

for key in sorted(choice_settings):
choices = choice_settings[key]
title = titles[key]
if key in basic_settings:
group = basic
else:
group = adv

val = int(getattr(_set, key))
try:
cur = choices[val]
except IndexError:
LOG.error('Value %i for %s out of range for list (%i): %s' % (
val, key, len(choices), choices))
raise
group.append(
RadioSetting(key, title,
RadioSettingValueList(
choices,
choices[val])))

for i in range(1, 16):
cur = ''.join(
DTMFCHARS[i]
for i in self._memobj.dtmfgroup[i - 1].code if int(i) < 0xF)
dtmf.append(
RadioSetting(
'dtmf.code@%i' % i, 'DTMF Group %i' % i,
RadioSettingValueString(0, 5, cur,
autopad=False,
charset=DTMFCHARS)))
cur = ''.join(
'%X' % i
for i in self._memobj.anicode.code if int(i) < 0xE)
dtmf.append(
RadioSetting(
'anicode.code', 'ANI Code',
RadioSettingValueString(0, 5, cur,
autopad=False,
charset=DTMFCHARS)))

anicode = self._memobj.anicode

dtmf.append(
RadioSetting(
'anicode.groupcode', 'Group Code',
RadioSettingValueList(
list(DTMFCHARS),
DTMFCHARS[int(anicode.groupcode)])))

dtmf.append(
RadioSetting(
'anicode.releasetosend', 'Release To Send',
RadioSettingValueBoolean(
int(anicode.releasetosend))))
dtmf.append(
RadioSetting(
'anicode.presstosend', 'Press To Send',
RadioSettingValueBoolean(
int(anicode.presstosend))))
cur = int(anicode.dtmfspeedon) * 10 + 80
dtmf.append(
RadioSetting(
'anicode.dtmfspeedon', 'DTMF Speed (on time in ms)',
RadioSettingValueInteger(60, 2000, cur, 10)))
cur = int(anicode.dtmfspeedoff) * 10 + 80
dtmf.append(
RadioSetting(
'anicode.dtmfspeedoff', 'DTMF Speed (off time in ms)',
RadioSettingValueInteger(60, 2000, cur, 10)))

top = RadioSettings(basic, adv, dtmf)
return top

def set_settings(self, settings):
for element in settings:
if element.get_name().startswith('anicode.'):
self._set_anicode(element)
elif element.get_name().startswith('dtmf.code'):
self._set_dtmfcode(element)
elif not isinstance(element, RadioSetting):
self.set_settings(element)
continue
else:
self._set_setting(element)

def _set_setting(self, setting):
key = setting.get_name()
val = setting.value

setattr(self._memobj.settings, key, int(val))

def _set_anicode(self, setting):
name = setting.get_name().split('.', 1)[1]
if name == 'code':
val = [DTMFCHARS.index(c) for c in str(setting.value)]
for i in range(0, 5):
try:
value = val[i]
except IndexError:
value = 0xFF
self._memobj.anicode.code[i] = value
elif name.startswith('dtmfspeed'):
setattr(self._memobj.anicode, name,
(int(setting.value) - 80) // 10)
else:
setattr(self._memobj.anicode, name, int(setting.value))


def _set_dtmfcode(self, setting):
index = int(setting.get_name().split('@', 1)[1]) - 1
val = [DTMFCHARS.index(c) for c in str(setting.value)]
for i in range(0, 5):
try:
value = val[i]
except IndexError:
value = 0xFF
self._memobj.dtmfgroup[index].code[i] = value

(3-3/3)