Project

General

Profile

Bug #4743 » anytone.py

Modified Anytone driver w/support for a dozen settings - Craig Jones, 03/13/2020 04:21 AM

 
# Copyright 2013 Dan Smith <dsmith@danplanet.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, see <http://www.gnu.org/licenses/>.

import os
import struct
import time
import logging

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


LOG = logging.getLogger(__name__)

STEPS = [2.5, 5.0, 10.0, 12.5, 20.0, 25.0, 30.0, 50.0, 100.0]

_mem_format = """
#seekto 0x0100;
struct {
u8 even_unknown:2,
even_pskip:1,
even_skip:1,
odd_unknown:2,
odd_pskip:1,
odd_skip:1;
} flags[379];
"""

# NOTE: The "#seekto 0x0700;" below used to be 0x0280, but I had to change it to get the settings to work for the Powerwerx DB-750X.
# I don't know if it was just wrong before, or if 0x0280 is the correct location for the settings in the other make/model variants.
# I do know that the get_settings in the PowerwerxDB750XRadio class variant was overridden to nothing for some reason, which prevented the settings from being displayed/edited.
# // Craig K6NNL <craig@k6nnl.com>

mem_format = _mem_format + """
struct memory {
bbcd freq[4];
bbcd offset[4];
u8 unknownA:4,
tune_step:4;
u8 rxdcsextra:1,
txdcsextra:1,
rxinv:1,
txinv:1,
channel_width:2,
unknownB:2;
u8 unknown8:3,
is_am:1,
power:2,
duplex:2;
u8 unknown4:4,
rxtmode:2,
txtmode:2;
u8 unknown5:2,
txtone:6;
u8 unknown6:2,
rxtone:6;
u8 txcode;
u8 rxcode;
u8 unknown7[2];
u8 unknown2[5];
char name[7];
u8 unknownZ[2];
};

#seekto 0x0030;
struct {
char serial[16];
} serial_no;

#seekto 0x0050;
struct {
char date[16];
} version;

#seekto 0x0700;
struct {
u8 unknown1:6,
display:2;
u8 unknown2[5];
u8 red;
u8 green;
u8 blue;
u8 unknownAfterRBG[3];
u8 unknown3:3,
apo:5;
u8 unknown4a[2];
u8 unknown4b:6,
mute:2;
u8 unknownBeforeLocked:2,
locked:1,
unknownAfterLocked:5;
u8 unknown5:5,
beep:1,
unknown6:2;
u8 unknown7[3];
u8 keya;
u8 keyb;
u8 keyc;
u8 keyd;
u8 unknown8[455];
char welcome[8];

} settings;



#seekto 0x0540;
struct memory memblk1[12];

#seekto 0x2000;
struct memory memory[758];

#seekto 0x7ec0;
struct memory memblk2[10];
"""


class FlagObj(object):
def __init__(self, flagobj, which):
self._flagobj = flagobj
self._which = which

def _get(self, flag):
return getattr(self._flagobj, "%s_%s" % (self._which, flag))

def _set(self, flag, value):
return setattr(self._flagobj, "%s_%s" % (self._which, flag), value)

def get_skip(self):
return self._get("skip")

def set_skip(self, value):
self._set("skip", value)

skip = property(get_skip, set_skip)

def get_pskip(self):
return self._get("pskip")

def set_pskip(self, value):
self._set("pskip", value)

pskip = property(get_pskip, set_pskip)

def set(self):
self._set("unknown", 3)
self._set("skip", 1)
self._set("pskip", 1)

def clear(self):
self._set("unknown", 0)
self._set("skip", 0)
self._set("pskip", 0)

def get(self):
return (self._get("unknown") << 2 |
self._get("skip") << 1 |
self._get("pskip"))

def __repr__(self):
return repr(self._flagobj)


def _is_loc_used(memobj, loc):
return memobj.flags[loc / 2].get_raw() != "\xFF"


def _addr_to_loc(addr):
return (addr - 0x2000) / 32


def _should_send_addr(memobj, addr):
if addr < 0x2000 or addr >= 0x7EC0:
return True
else:
return _is_loc_used(memobj, _addr_to_loc(addr))


def _echo_write(radio, data):
try:
radio.pipe.write(data)
radio.pipe.read(len(data))
except Exception, e:
LOG.error("Error writing to radio: %s" % e)
raise errors.RadioError("Unable to write to radio")


def _read(radio, length):
try:
data = radio.pipe.read(length)
except Exception, e:
LOG.error("Error reading from radio: %s" % e)
raise errors.RadioError("Unable to read from radio")

if len(data) != length:
LOG.error("Short read from radio (%i, expected %i)" %
(len(data), length))
LOG.debug(util.hexprint(data))
raise errors.RadioError("Short read from radio")
return data

valid_model = ['QX588UV', 'HR-2040', 'DB-50M\x00', 'DB-750X']


def _ident(radio):
radio.pipe.timeout = 1
_echo_write(radio, "PROGRAM")
response = radio.pipe.read(3)
if response != "QX\x06":
LOG.debug("Response was:\n%s" % util.hexprint(response))
raise errors.RadioError("Unsupported model or bad connection")
_echo_write(radio, "\x02")
response = radio.pipe.read(16)
LOG.debug(util.hexprint(response))
if response[1:8] not in valid_model:
LOG.debug("Response was:\n%s" % util.hexprint(response))
raise errors.RadioError("Unsupported model")


def _finish(radio):
endframe = "\x45\x4E\x44"
_echo_write(radio, endframe)
result = radio.pipe.read(1)
if result != "\x06":
LOG.debug("Got:\n%s" % util.hexprint(result))
raise errors.RadioError("Radio did not finish cleanly")


def _checksum(data):
cs = 0
for byte in data:
cs += ord(byte)
return cs % 256


def _send(radio, cmd, addr, length, data=None):
frame = struct.pack(">cHb", cmd, addr, length)
if data:
frame += data
frame += chr(_checksum(frame[1:]))
frame += "\x06"
_echo_write(radio, frame)
LOG.debug("Sent:\n%s" % util.hexprint(frame))
if data:
result = radio.pipe.read(1)
if result != "\x06":
LOG.debug("Ack was: %s" % repr(result))
raise errors.RadioError(
"Radio did not accept block at %04x" % addr)
return
result = _read(radio, length + 6)
LOG.debug("Got:\n%s" % util.hexprint(result))
header = result[0:4]
data = result[4:-2]
ack = result[-1]
if ack != "\x06":
LOG.debug("Ack was: %s" % repr(ack))
raise errors.RadioError("Radio NAK'd block at %04x" % addr)
_cmd, _addr, _length = struct.unpack(">cHb", header)
if _addr != addr or _length != _length:
LOG.debug("Expected/Received:")
LOG.debug(" Length: %02x/%02x" % (length, _length))
LOG.debug(" Addr: %04x/%04x" % (addr, _addr))
raise errors.RadioError("Radio send unexpected block")
cs = _checksum(result[1:-2])
if cs != ord(result[-2]):
LOG.debug("Calculated: %02x" % cs)
LOG.debug("Actual: %02x" % ord(result[-2]))
raise errors.RadioError("Block at 0x%04x failed checksum" % addr)
return data


def _download(radio):
_ident(radio)

memobj = None

data = ""
for start, end in radio._ranges:
for addr in range(start, end, 0x10):
if memobj is not None and not _should_send_addr(memobj, addr):
block = "\xFF" * 0x10
else:
block = _send(radio, 'R', addr, 0x10)
data += block

status = chirp_common.Status()
status.cur = len(data)
status.max = end
status.msg = "Cloning from radio"
radio.status_fn(status)

if addr == 0x19F0:
memobj = bitwise.parse(_mem_format, data)

_finish(radio)

return memmap.MemoryMap(data)


def _upload(radio):
_ident(radio)

for start, end in radio._ranges:
for addr in range(start, end, 0x10):
if addr < 0x0100:
continue
if not _should_send_addr(radio._memobj, addr):
continue
block = radio._mmap[addr:addr + 0x10]
_send(radio, 'W', addr, len(block), block)

status = chirp_common.Status()
status.cur = addr
status.max = end
status.msg = "Cloning to radio"
radio.status_fn(status)

_finish(radio)


TONES = [62.5] + list(chirp_common.TONES)
TMODES = ['', 'Tone', 'DTCS', '']
DUPLEXES = ['', '-', '+', '']
MODES = ["FM", "FM", "NFM"]
POWER_LEVELS = [chirp_common.PowerLevel("High", watts=50),
chirp_common.PowerLevel("Mid1", watts=25),
chirp_common.PowerLevel("Mid2", watts=10),
chirp_common.PowerLevel("Low", watts=5)]


@directory.register
class AnyTone5888UVRadio(chirp_common.CloneModeRadio,
chirp_common.ExperimentalRadio):
"""AnyTone 5888UV"""
VENDOR = "AnyTone"
MODEL = "5888UV"
BAUD_RATE = 9600
_file_ident = "QX588UV"

# May try to mirror the OEM behavior later
_ranges = [
(0x0000, 0x8000),
]

@classmethod
def get_prompts(cls):
rp = chirp_common.RadioPrompts()
rp.experimental = ("The Anytone driver is currently experimental. "
"There are no known issues with it, but you should "
"proceed with caution.")
return rp

def get_features(self):
rf = chirp_common.RadioFeatures()
rf.has_settings = True
rf.has_bank = False
rf.has_cross = True
rf.has_tuning_step = False
rf.valid_tuning_steps = STEPS
rf.has_rx_dtcs = True
rf.valid_skips = ["", "S", "P"]
rf.valid_modes = ["FM", "NFM", "AM"]
rf.valid_tmodes = ['', 'Tone', 'TSQL', 'DTCS', 'Cross']
rf.valid_cross_modes = ['Tone->DTCS', 'DTCS->Tone',
'->Tone', '->DTCS', 'Tone->Tone']
rf.valid_dtcs_codes = chirp_common.ALL_DTCS_CODES
rf.valid_bands = [(108000000, 500000000)]
rf.valid_characters = chirp_common.CHARSET_UPPER_NUMERIC + "-"
rf.valid_name_length = 7
rf.valid_power_levels = POWER_LEVELS
rf.memory_bounds = (1, 758)
return rf

def sync_in(self):
self._mmap = _download(self)
self.process_mmap()

def sync_out(self):
_upload(self)

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

def _get_memobjs(self, number):
number -= 1
_mem = self._memobj.memory[number]
_flg = FlagObj(self._memobj.flags[number / 2],
number % 2 and "even" or "odd")
return _mem, _flg

def _get_dcs_index(self, _mem, which):
base = getattr(_mem, '%scode' % which)
extra = getattr(_mem, '%sdcsextra' % which)
return (int(extra) << 8) | int(base)

def _set_dcs_index(self, _mem, which, index):
base = getattr(_mem, '%scode' % which)
extra = getattr(_mem, '%sdcsextra' % which)
base.set_value(index & 0xFF)
extra.set_value(index >> 8)

def get_raw_memory(self, number):
_mem, _flg = self._get_memobjs(number)
return repr(_mem) + repr(_flg)

def get_memory(self, number):
_mem, _flg = self._get_memobjs(number)
mem = chirp_common.Memory()
mem.number = number

if _flg.get() == 0x0F:
mem.empty = True
return mem

mem.freq = int(_mem.freq) * 100
mem.offset = int(_mem.offset) * 100
mem.name = str(_mem.name).rstrip()
mem.duplex = DUPLEXES[_mem.duplex]
mem.mode = _mem.is_am and "AM" or MODES[_mem.channel_width]

rxtone = txtone = None
rxmode = TMODES[_mem.rxtmode]
txmode = TMODES[_mem.txtmode]
if txmode == "Tone":
txtone = TONES[_mem.txtone]
elif txmode == "DTCS":
txtone = chirp_common.ALL_DTCS_CODES[self._get_dcs_index(_mem,
'tx')]
if rxmode == "Tone":
rxtone = TONES[_mem.rxtone]
elif rxmode == "DTCS":
rxtone = chirp_common.ALL_DTCS_CODES[self._get_dcs_index(_mem,
'rx')]

rxpol = _mem.rxinv and "R" or "N"
txpol = _mem.txinv and "R" or "N"

chirp_common.split_tone_decode(mem,
(txmode, txtone, txpol),
(rxmode, rxtone, rxpol))

mem.skip = _flg.get_skip() and "S" or _flg.get_pskip() and "P" or ""
mem.power = POWER_LEVELS[_mem.power]

return mem

def set_memory(self, mem):
_mem, _flg = self._get_memobjs(mem.number)
if mem.empty:
_flg.set()
return
_flg.clear()
_mem.set_raw("\x00" * 32)

_mem.freq = mem.freq / 100
_mem.offset = mem.offset / 100
_mem.name = mem.name.ljust(7)
_mem.is_am = mem.mode == "AM"
_mem.duplex = DUPLEXES.index(mem.duplex)

try:
_mem.channel_width = MODES.index(mem.mode)
except ValueError:
_mem.channel_width = 0

((txmode, txtone, txpol),
(rxmode, rxtone, rxpol)) = chirp_common.split_tone_encode(mem)

_mem.txtmode = TMODES.index(txmode)
_mem.rxtmode = TMODES.index(rxmode)
if txmode == "Tone":
_mem.txtone = TONES.index(txtone)
elif txmode == "DTCS":
self._set_dcs_index(_mem, 'tx',
chirp_common.ALL_DTCS_CODES.index(txtone))
if rxmode == "Tone":
_mem.rxtone = TONES.index(rxtone)
elif rxmode == "DTCS":
self._set_dcs_index(_mem, 'rx',
chirp_common.ALL_DTCS_CODES.index(rxtone))

_mem.txinv = txpol == "R"
_mem.rxinv = rxpol == "R"

_flg.set_skip(mem.skip == "S")
_flg.set_pskip(mem.skip == "P")

if mem.power:
_mem.power = POWER_LEVELS.index(mem.power)
else:
_mem.power = 0

def get_settings(self):
_settings = self._memobj.settings
basic_group = RadioSettingGroup("basic_group", "Basic Settings")
audio_group = RadioSettingGroup("audio_group", "Audio Options")
keys_group = RadioSettingGroup("keys_group", "Programmable Keys")
display_group = RadioSettingGroup("display_group", "Display Options")
settings = RadioSettings(basic_group, audio_group, keys_group, display_group)

############ Basic Group

rs = RadioSetting("locked", "Keypad locked",
RadioSettingValueBoolean(_settings.locked))
basic_group.append(rs)



display = ["Frequency", "Channel", "Name"]
rs = RadioSetting("display", "Memory Display",
RadioSettingValueList(display, display[_settings.display]))
basic_group.append(rs)



apo = ["Off"] + ['%.1f hour(s)' % (0.5 * x) for x in range(1, 25)]
rs = RadioSetting("apo", "Automatic Power Off",
RadioSettingValueList(apo, apo[_settings.apo]))
basic_group.append(rs)


############ Audio Group

rs = RadioSetting("beep", "Beep Enabled",
RadioSettingValueBoolean(_settings.beep))
audio_group.append(rs)

mute = ["Off", "TX", "RX", "TX/RX"]
rs = RadioSetting("mute", "Sub Band Mute",
RadioSettingValueList(mute, mute[_settings.mute]))
audio_group.append(rs)


############ Keys Group

progkey = ["Off", "RPTR offset direction", "PRI priority", "LOW power", "TONE", "MHZ", "REV", "HOME", "MAIN A/B", "VFO/MR", "SCAN", "SQLOFF/ON", "TBST tone burst", "CALLOUT", "COMP Compander on/off", "SCR scrambler on/off", "TONEDEC", "Wide/Nar", "TALK-around"]
rs = RadioSetting("keya", "Programmable Key A",
RadioSettingValueList(progkey, progkey[_settings.keya]))
keys_group.append(rs)
rs = RadioSetting("keyb", "Programmable Key B",
RadioSettingValueList(progkey, progkey[_settings.keyb]))
keys_group.append(rs)
rs = RadioSetting("keyc", "Programmable Key C",
RadioSettingValueList(progkey, progkey[_settings.keyc]))
keys_group.append(rs)
rs = RadioSetting("keyd", "Programmable Key D",
RadioSettingValueList(progkey, progkey[_settings.keyd]))
keys_group.append(rs)

############ Display Group

def filter(s):
s_ = ""
for i in range(0, 8):
c = str(s[i])
s_ += (c if c in chirp_common.CHARSET_ASCII else "")
return s_
rs = RadioSetting("welcome", "Welcome Message",
RadioSettingValueString(0, 8, filter(_settings.welcome)))
display_group.append(rs)

rs = RadioSetting("red", "Background Brightness: Red",
RadioSettingValueInteger(0,31,_settings.red))
display_group.append(rs)
rs = RadioSetting("green", "Background Brightness: Green",
RadioSettingValueInteger(0,31,_settings.green))
display_group.append(rs)
rs = RadioSetting("blue", "Background Brightness: Blue",
RadioSettingValueInteger(0,31,_settings.blue))
display_group.append(rs)


return settings

def set_settings(self, settings):
_settings = self._memobj.settings
for element in settings:
if not isinstance(element, RadioSetting):
self.set_settings(element)
continue
name = element.get_name()
setattr(_settings, name, element.value)

@classmethod
def match_model(cls, filedata, filename):
return cls._file_ident in filedata[0x20:0x40]


@directory.register
class IntekHR2040Radio(AnyTone5888UVRadio):
"""Intek HR-2040"""
VENDOR = "Intek"
MODEL = "HR-2040"
_file_ident = "HR-2040"


@directory.register
class PolmarDB50MRadio(AnyTone5888UVRadio):
"""Polmar DB-50M"""
VENDOR = "Polmar"
MODEL = "DB-50M"
_file_ident = "DB-50M"


@directory.register
class PowerwerxDB750XRadio(AnyTone5888UVRadio):
"""Powerwerx DB-750X"""
VENDOR = "Powerwerx"
MODEL = "DB-750X"
_file_ident = "DB-750X"

# def get_settings(self):
# return {}
(3-3/3)