CHIRP

# Quansheng UV-K5 driver (c) 2023 Jacek Lipkowski <sq5bpf@lipkowski.org>

#

# based on template.py Copyright 2012 Dan Smith <dsmith@danplanet.com>

#

#

# This is a preliminary version of a driver for the UV-K5

# It is based on my reverse engineering effort described here:

# https://github.com/sq5bpf/uvk5-reverse-engineering

#

# Warning: this driver is experimental, it may brick your radio,

# eat your lunch and mess up your configuration. Before even attempting

# to use it save a memory image from the radio using k5prog:

# https://github.com/sq5bpf/k5prog

#

#

# 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 2 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 struct

import logging

# import serial

from chirp import chirp_common, directory, bitwise, memmap, errors, util

from chirp.settings import RadioSetting, RadioSettingGroup, \

    RadioSettingValueBoolean, RadioSettingValueList, \

    RadioSettingValueInteger, RadioSettingValueString, \

    RadioSettings

# from chirp.settings import RadioSettingValueFloat, RadioSettingValueMap

LOG = logging.getLogger(__name__)

# Show the obfuscated version of commands. Not needed normally, but

# might be useful for someone who is debugging a similar radio

DEBUG_SHOW_OBFUSCATED_COMMANDS = False

# Show the memory being written/received. Not needed normally, because

# this is the same information as in the packet hexdumps, but

# might be useful for someone debugging some obscure memory issue

DEBUG_SHOW_MEMORY_ACTIONS = False

DRIVER_VERSION = "Quansheng UV-K5 driver v20230605 for modded firmware (c) Jacek Lipkowski SQ5BPF"

PRINT_CONSOLE = False

MEM_FORMAT = """

#seekto 0x0000;

struct {

  ul32 freq;

  ul32 offset;

  u8 rxcode;

  u8 txcode;

  u8 code_flag;

  u8 flags1;

  u8 flags2;

  u8 dtmf_flags;

  u8 step;

  u8 scrambler;

} channel[214];

#seekto 0xd60;

u8 channel_attributes[200];

#seekto 0xe40;

ul16 fmfreq[20];

#seekto 0xe70;

u8 call_channel;

u8 squelch;

u8 max_talk_time;

u8 noaa_autoscan;

u8 unknown1;

u8 unknown2;

u8 vox_level;

u8 mic_gain;

u8 unknown3;

u8 channel_display_mode;

u8 crossband;

u8 battery_save;

u8 dual_watch;

u8 tail_note_elimination;

u8 vfo_open;

#seekto 0xe90;

u8 beep_control;

#seekto 0xe95;

u8 scan_resume_mode;

u8 auto_keypad_lock;

u8 power_on_dispmode;

u8 password[4];

#seekto 0xea0;

u8 keypad_tone;

u8 language;

#seekto 0xea8;

u8 alarm_mode;

u8 reminding_of_end_talk;

u8 repeater_tail_elimination;

#seekto 0xeb0;

char logo_line1[16];

char logo_line2[16];

#seekto 0xf40;

u8 int_flock;

u8 int_350tx;

u8 int_unknown1;

u8 int_200tx;

u8 int_500tx;

u8 int_350en;

u8 int_screen;

#seekto 0xf50;

struct {

char name[16];

} channelname[200];

"""

# bits that we will save from the channel structure (mostly unknown)

SAVE_MASK_0A = 0b11001100

SAVE_MASK_0B = 0b11101100

SAVE_MASK_0C = 0b11100000

SAVE_MASK_0D = 0b11111000

SAVE_MASK_0E = 0b11110001

SAVE_MASK_0F = 0b11110000

# flags1

FLAGS1_OFFSET_MASK = 0b11

FLAGS1_OFFSET_NONE = 0b00

FLAGS1_OFFSET_MINUS = 0b10

FLAGS1_OFFSET_PLUS = 0b01

FLAGS1_ISSCANLIST = 0b100

FLAGS1_ISAM = 0b10000

# flags2

FLAGS2_BCLO = 0b10000

FLAGS2_POWER_MASK = 0b1100

FLAGS2_POWER_HIGH = 0b1000

FLAGS2_POWER_MEDIUM = 0b0100

FLAGS2_POWER_LOW = 0b0000

FLAGS2_BANDWIDTH = 0b10

FLAGS2_REVERSE = 0b1

# dtmf_flags

PTTID_LIST = ["off", "BOT", "EOT", "BOTH"]

FLAGS_DTMF_PTTID_MASK = 0b110  # PTTID: 00-disabled, 01-BOT, 10-EOT, 11-BOTH

FLAGS_DTMF_PTTID_DISABLED = 0b000

FLAGS_DTMF_PTTID_BOT = 0b010

FLAGS_DTMF_PTTID_EOT = 0b100

FLAGS_DTMF_PTTID_BOTH = 0b110

FLAGS_DTMF_DECODE = 0b1

# power

UVK5_POWER_LEVELS = [chirp_common.PowerLevel("Low",  watts=1.50),

                     chirp_common.PowerLevel("Med",  watts=3.00),

                     chirp_common.PowerLevel("High", watts=5.00),

                     ]

# scrambler

SCRAMBLER_LIST = ["off", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]

# channel display mode

CHANNELDISP_LIST = ["Frequency", "Channel No", "Channel Name"]

# battery save

BATSAVE_LIST = ["OFF", "1:1", "1:2", "1:3", "1:4"]

# Crossband receiving/transmitting

CROSSBAND_LIST = ["Off", "Band A", "Band B"]

DUALWATCH_LIST = CROSSBAND_LIST

# steps

STEPS = [2.5, 5.0, 6.25, 10.0, 12.5, 25.0, 8.33]

# ctcss/dcs codes

TMODES = ["", "Tone", "DTCS", "DTCS"]

TONE_NONE = 0

TONE_CTCSS = 1

TONE_DCS = 2

TONE_RDCS = 3

CTCSS_TONES = [

    67.0, 69.3, 71.9, 74.4, 77.0, 79.7, 82.5, 85.4,

    88.5, 91.5, 94.8, 97.4, 100.0, 103.5, 107.2, 110.9,

    114.8, 118.8, 123.0, 127.3, 131.8, 136.5, 141.3, 146.2,

    151.4, 156.7, 159.8, 162.2, 165.5, 167.9, 171.3, 173.8,

    177.3, 179.9, 183.5, 186.2, 189.9, 192.8, 196.6, 199.5,

    203.5, 206.5, 210.7, 218.1, 225.7, 229.1, 233.6, 241.8,

    250.3, 254.1

]

# lifted from ft4.py

DTCS_CODES = [

    23,  25,  26,  31,  32,  36,  43,  47,  51,  53,  54,

    65,  71,  72,  73,  74,  114, 115, 116, 122, 125, 131,

    132, 134, 143, 145, 152, 155, 156, 162, 165, 172, 174,

    205, 212, 223, 225, 226, 243, 244, 245, 246, 251, 252,

    255, 261, 263, 265, 266, 271, 274, 306, 311, 315, 325,

    331, 332, 343, 346, 351, 356, 364, 365, 371, 411, 412,

    413, 423, 431, 432, 445, 446, 452, 454, 455, 462, 464,

    465, 466, 503, 506, 516, 523, 526, 532, 546, 565, 606,

    612, 624, 627, 631, 632, 654, 662, 664, 703, 712, 723,

    731, 732, 734, 743, 754

]

FLOCK_LIST = ["Off", "FCC", "CE", "GB", "430", "438"]

SCANRESUME_LIST = ["TO: Resume after 5 seconds",

                   "CO: Resume after signal dissapears",

                   "SE: Stop scanning after receiving a signal"]

WELCOME_LIST = ["Full Screen", "Welcome Info", "Voltage"]

KEYPADTONE_LIST = ["Off", "Chinese", "English"]

LANGUAGE_LIST = ["Chinese", "English"]

ALARMMODE_LIST = ["SITE", "TONE"]

REMENDOFTALK_LIST = ["Off", "ROGER", "MDC"]

RTE_LIST = ["Off", "100ms", "200ms", "300ms", "400ms",

            "500ms", "600ms", "700ms", "800ms", "900ms"]

MEM_SIZE = 0x2000  # size of all memory

PROG_SIZE = 0x1d00  # size of the memory that we will write

MEM_BLOCK = 0x80  # largest block of memory that we can reliably write

# bands supported by the UV-K5

BANDS = {

        # 0: [50.0, 76.0],

        0: [18.0, 76.0],

        1: [108.0, 135.9999],

        2: [136.0, 199.9990],

        3: [200.0, 299.9999],

        4: [350.0, 399.9999],

        5: [400.0, 469.9999],

        6: [470.0, 1300.0]

        }

BANDMASK = 0b1111

VFO_CHANNEL_NAMES = ["F1(50M-76M)A", "F1(50M-76M)B",

                     "F2(108M-136M)A", "F2(108M-136M)B",

                     "F3(136M-174M)A", "F3(136M-174M)B",

                     "F4(174M-350M)A", "F4(174M-350M)B",

                     "F5(350M-400M)A", "F5(350M-400M)B",

                     "F6(400M-470M)A", "F6(400M-470M)B",

                     "F7(470M-600M)A", "F7(470M-600M)B"]

# the communication is obfuscated using this fine mechanism

def xorarr(data: bytes):

    tbl = [22, 108, 20, 230, 46, 145, 13, 64, 33, 53, 213, 64, 19, 3, 233, 128]

    x = b""

    r = 0

    for byte in data:

        x += bytes([byte ^ tbl[r]])

        r = (r+1) % len(tbl)

    return x

# if this crc was used for communication to AND from the radio, then it

# would be a measure to increase reliability.

# but it's only used towards the radio, so it's for further obfuscation

def calculate_crc16_xmodem(data: bytes):

    poly = 0x1021

    crc = 0x0

    for byte in data:

        crc = crc ^ (byte << 8)

        for i in range(8):

            crc = crc << 1

            if (crc & 0x10000):

                crc = (crc ^ poly) & 0xFFFF

    return crc & 0xFFFF

def _send_command(serport, data: bytes):

    """Send a command to UV-K5 radio"""

    LOG.debug("Sending command (unobfuscated) len=0x%4.4x:\n%s" %

              (len(data), util.hexprint(data)))

    crc = calculate_crc16_xmodem(data)

    data2 = data+bytes([crc & 0xff, (crc >> 8) & 0xff])

    command = b"\xAB\xCD"+bytes([len(data)])+b"\x00"+xorarr(data2)+b"\xDC\xBA"

    if DEBUG_SHOW_OBFUSCATED_COMMANDS:

        LOG.debug("Sending command (obfuscated):\n%s" % util.hexprint(command))

    try:

        result = serport.write(command)

    except Exception:

        raise errors.RadioError("Error writing data to radio")

    return result

def _receive_reply(serport):

    header = serport.read(4)

    if len(header) != 4:

        LOG.warning("Header short read: [%s] len=%i" %

                    (util.hexprint(header), len(header)))

        raise errors.RadioError("Header short read")

    if header[0] != 0xAB or header[1] != 0xCD or header[3] != 0x00:

        LOG.warning("Bad response header: %s len=%i" %

                    (util.hexprint(header), len(header)))

        raise errors.RadioError("Bad response header")

        return False

    cmd = serport.read(int(header[2]))

    if len(cmd) != int(header[2]):

        LOG.warning("Body short read: [%s] len=%i" %

                    (util.hexprint(cmd), len(cmd)))

        raise errors.RadioError("Command body short read")

    footer = serport.read(4)

    if len(footer) != 4:

        LOG.warning("Footer short read: [%s] len=%i" %

                    (util.hexprint(footer), len(footer)))

        raise errors.RadioError("Footer short read")

    if footer[2] != 0xDC or footer[3] != 0xBA:

        LOG.debug(

                "Reply before bad response footer (obfuscated)"

                "len=0x%4.4x:\n%s" % (len(cmd), util.hexprint(cmd)))

        LOG.warning("Bad response footer: %s len=%i" %

                    (util.hexprint(footer), len(footer)))

        raise errors.RadioError("Bad response footer")

        return False

    if DEBUG_SHOW_OBFUSCATED_COMMANDS:

        LOG.debug("Received reply (obfuscated) len=0x%4.4x:\n%s" %

                  (len(cmd), util.hexprint(cmd)))

    cmd2 = xorarr(cmd)

    LOG.debug("Received reply (unobfuscated) len=0x%4.4x:\n%s" %

              (len(cmd2), util.hexprint(cmd2)))

    return cmd2

def _getstring(data: bytes, begin, maxlen):

    tmplen = min(maxlen+1, len(data))

    s = [data[i] for i in range(begin, tmplen)]

    for key, val in enumerate(s):

        if val < ord(' ') or val > ord('~'):

            break

    return ''.join(chr(x) for x in s[0:key])

def _sayhello(serport):

    hellopacket = b"\x14\x05\x04\x00\x6a\x39\x57\x64"

    tries = 5

    while (True):

        LOG.debug("Sending hello packet")

        _send_command(serport, hellopacket)

        o = _receive_reply(serport)

        if (o):

            break

        tries -= 1

        if tries == 0:

            LOG.warning("Failed to initialise radio")

            raise errors.RadioError("Failed to initialize radio")

            return False

    firmware = _getstring(o, 5, 16)

    LOG.info("Found firmware: %s" % firmware)

    return firmware

def _readmem(serport, offset, length):

    LOG.debug("Sending readmem offset=0x%4.4x len=0x%4.4x" % (offset, length))

    readmem = b"\x1b\x05\x08\x00" + \

        bytes([offset & 0xff, (offset >> 8) & 0xff, length, 0]) + \

        b"\x6a\x39\x57\x64"

    _send_command(serport, readmem)

    o = _receive_reply(serport)

    if DEBUG_SHOW_MEMORY_ACTIONS:

        LOG.debug("readmem Received data len=0x%4.4x:\n%s" %

                  (len(o), util.hexprint(o)))

    return o[8:]

def _writemem(serport, data, offset):

    LOG.debug("Sending writemem offset=0x%4.4x len=0x%4.4x" %

              (offset, len(data)))

    if DEBUG_SHOW_MEMORY_ACTIONS:

        LOG.debug("writemem sent data offset=0x%4.4x len=0x%4.4x:\n%s" %

                  (offset, len(data), util.hexprint(data)))

    dlen = len(data)

    writemem = b"\x1d\x05"+bytes([dlen+8])+b"\x00" + \

        bytes([offset & 0xff, (offset >> 8) & 0xff, dlen, 1]) + \

        b"\x6a\x39\x57\x64"+data

    _send_command(serport, writemem)

    o = _receive_reply(serport)

    LOG.debug("writemem Received data: %s len=%i" % (util.hexprint(o), len(o)))

    if (o[0] == 0x1e

            and

            o[4] == (offset & 0xff)

            and

            o[5] == (offset >> 8) & 0xff):

        return True

    else:

        LOG.warning("Bad data from writemem")

        raise errors.RadioError("Bad response to writemem")

    return False

def _resetradio(serport):

    resetpacket = b"\xdd\x05\x00\x00"

    _send_command(serport, resetpacket)

def do_download(radio):

    serport = radio.pipe

    serport.timeout = 0.5

    status = chirp_common.Status()

    status.cur = 0

    status.max = MEM_SIZE

    status.msg = "Downloading from radio"

    radio.status_fn(status)

    eeprom = b""

    f = _sayhello(serport)

    if f:

        radio.FIRMWARE_VERSION = f

    else:

        return False

    addr = 0

    while addr < MEM_SIZE:

        o = _readmem(serport, addr, MEM_BLOCK)

        status.cur = addr

        radio.status_fn(status)

        if o and len(o) == MEM_BLOCK:

            eeprom += o

            addr += MEM_BLOCK

        else:

            raise errors.RadioError("Memory download incomplete")

    return memmap.MemoryMapBytes(eeprom)

def do_upload(radio):

    serport = radio.pipe

    serport.timeout = 0.5

    status = chirp_common.Status()

    status.cur = 0

    status.max = PROG_SIZE

    status.msg = "Uploading to radio"

    radio.status_fn(status)

    f = _sayhello(serport)

    if f:

        radio.FIRMWARE_VERSION = f

    else:

        return False

    addr = 0

    while addr < PROG_SIZE:

        o = radio.get_mmap()[addr:addr+MEM_BLOCK]

        _writemem(serport, o, addr)

        status.cur = addr

        radio.status_fn(status)

        if o:

            addr += MEM_BLOCK

        else:

            raise errors.RadioError("Memory upload incomplete")

    status.msg = "Uploaded OK"

    _resetradio(serport)

    return True

def _find_band(hz):

    mhz = hz/1000000.0

    for a in BANDS:

        if mhz >= BANDS[a][0] and mhz <= BANDS[a][1]:

            return a

    return False

@directory.register

class TemplateRadio(chirp_common.CloneModeRadio):

    """Quansheng UV-K5"""

    VENDOR = "Quansheng"

    MODEL = "UV-K5"

    BAUD_RATE = 38400

    NEEDS_COMPAT_SERIAL = False

    FIRMWARE_VERSION = ""

    def get_prompts(x=None):

        rp = chirp_common.RadioPrompts()

        rp.experimental = \

            ('This is an experimental driver for the Quanscheng UV-K5. '

             'It may harm your radio, or worse. Use at your own risk.\n\n'

             'Before attempting to do any changes please download'

             'the memory image from the radio with chirp or k5prog '

             'and keep it. This can be later used to recover the '

             'original settings. \n\n'

             'FM radio, DTMF settings and scanlists are not yet implemented')

        rp.pre_download = _(

            "1. Turn radio on.\n"

            "2. Connect cable to mic/spkr connector.\n"

            "3. Make sure connector is firmly connected.\n"

            "4. Click OK to download image from device.\n\n"

            "It will may not work if you turn o the radio "

            "with the cable already attached\n")

        rp.pre_upload = _(

            "1. Turn radio on.\n"

            "2. Connect cable to mic/spkr connector.\n"

            "3. Make sure connector is firmly connected.\n"

            "4. Click OK to upload the image to device.\n\n"

            "It will may not work if you turn o the radio "

            "with the cable already attached")

        return rp

    # Return information about this radio's features, including

    # how many memories it has, what bands it supports, etc

    def get_features(self):

        rf = chirp_common.RadioFeatures()

        rf.has_bank = False

        rf.valid_dtcs_codes = DTCS_CODES

        rf.has_rx_dtcs = True

        rf.has_ctone = True

        rf.has_settings = True

        rf.has_comment = False

        rf.valid_name_length = 16

        rf.valid_power_levels = UVK5_POWER_LEVELS

        # hack so we can input any frequency,

        # the 0.1 and 0.01 steps don't work unfortunately

        rf.valid_tuning_steps = [0.01, 0.1, 1.0] + STEPS

        rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS", "Cross"]

        rf.valid_cross_modes = ["Tone->Tone", "Tone->DTCS", "DTCS->Tone",

                                "->Tone", "->DTCS", "DTCS->", "DTCS->DTCS"]

        rf.valid_characters = chirp_common.CHARSET_ASCII

        rf.valid_modes = ["FM", "NFM", "AM", "NAM"]

        rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS", "Cross"]

        rf.valid_skips = [""]

        # This radio supports memories 1-200, 201-214 are the VFO memories

        rf.memory_bounds = (1, 214)

        # This is what the BK4819 chip supports

        # Will leave it in a comment, might be useful someday

        # rf.valid_bands = [(18000000,  620000000),

        #                  (840000000, 1300000000)

        #                  ]

        rf.valid_bands = []

        for a in BANDS:

            rf.valid_bands.append(

                    (int(BANDS[a][0]*1000000), int(BANDS[a][1]*1000000)))

        return rf

    # Do a download of the radio from the serial port

    def sync_in(self):

        self._mmap = do_download(self)

        self.process_mmap()

    # Do an upload of the radio to the serial port

    def sync_out(self):

        do_upload(self)

    # Convert the raw byte array into a memory object structure

    def process_mmap(self):

        self._memobj = bitwise.parse(MEM_FORMAT, self._mmap)

    # Return a raw representation of the memory object, which

    # is very helpful for development

    def get_raw_memory(self, number):

        return repr(self._memobj.channel[number-1])

    def validate_memory(self, mem):

        msgs = super().validate_memory(mem)

        return msgs

    def _set_tone(self, mem, _mem):

        ((txmode, txtone, txpol),

         (rxmode, rxtone, rxpol)) = chirp_common.split_tone_encode(mem)

        if txmode == "Tone":

            txtoval = CTCSS_TONES.index(txtone)

            txmoval = 0b01

        elif txmode == "DTCS":

            txmoval = txpol == "R" and 0b11 or 0b10

            txtoval = DTCS_CODES.index(txtone)

        else:

            txmoval = 0

            txtoval = 0

        if rxmode == "Tone":

            rxtoval = CTCSS_TONES.index(rxtone)

            rxmoval = 0b01

        elif rxmode == "DTCS":

            rxmoval = rxpol == "R" and 0b11 or 0b10

            rxtoval = DTCS_CODES.index(rxtone)

        else:

            rxmoval = 0

            rxtoval = 0

        _mem.code_flag = (_mem.code_flag & 0b11001100) | (

            txmoval << 4) | rxmoval

        _mem.rxcode = rxtoval

        _mem.txcode = txtoval

    def _get_tone(self, mem, _mem):

        rxtype = _mem.code_flag & 0x03

        txtype = (_mem.code_flag >> 4) & 0x03

        rx_tmode = TMODES[rxtype]

        tx_tmode = TMODES[txtype]

        rx_tone = tx_tone = None

        if tx_tmode == "Tone":

            if _mem.txcode < len(CTCSS_TONES):

                tx_tone = CTCSS_TONES[_mem.txcode]

            else:

                tx_tone = 0

                tx_tmode = ""

        elif tx_tmode == "DTCS":

            if _mem.txcode < len(DTCS_CODES):

                tx_tone = DTCS_CODES[_mem.txcode]

            else:

                tx_tone = 0

                tx_tmode = ""

        if rx_tmode == "Tone":

            if _mem.rxcode < len(CTCSS_TONES):

                rx_tone = CTCSS_TONES[_mem.rxcode]

            else:

                rx_tone = 0

                rx_tmode = ""

        elif rx_tmode == "DTCS":

            if _mem.rxcode < len(DTCS_CODES):

                rx_tone = DTCS_CODES[_mem.rxcode]

            else:

                rx_tone = 0

                rx_tmode = ""

        tx_pol = txtype == 0x03 and "R" or "N"

        rx_pol = rxtype == 0x03 and "R" or "N"

        chirp_common.split_tone_decode(mem, (tx_tmode, tx_tone, tx_pol),

                                       (rx_tmode, rx_tone, rx_pol))

    # Extract a high-level memory object from the low-level memory map

    # This is called to populate a memory in the UI

    def get_memory(self, number2):

        number = number2-1  # in the radio memories start with 0

        mem = chirp_common.Memory()

        # cutting and pasting configs from different radios

        # might try to set channel 0

        if number2 == 0:

            LOG.warning("Attempt to get channel 0")

            return mem

        _mem = self._memobj.channel[number]

        tmpcomment = ""

        mem.number = number2

        is_empty = False

        # We'll consider any blank (i.e. 0MHz frequency) to be empty

        if (_mem.freq == 0xffffffff) or (_mem.freq == 0):

            is_empty = True

        # We'll also look at the channel attributes if a memory has them

        if number < 200:

            _mem3 = self._memobj.channel_attributes[number]

            if _mem3 & 0x08 > 0:

                is_empty = True

        if is_empty:

            mem.empty = True

            # set some sane defaults:

            mem.power = UVK5_POWER_LEVELS[2]

            mem.extra = RadioSettingGroup("Extra", "extra")

            rs = RadioSetting("bclo", "BCLO", RadioSettingValueBoolean(False))

            mem.extra.append(rs)

            rs = RadioSetting("frev", "FreqRev",

                              RadioSettingValueBoolean(False))

            mem.extra.append(rs)

            rs = RadioSetting("pttid", "PTTID", RadioSettingValueList(

                PTTID_LIST, PTTID_LIST[0]))

            mem.extra.append(rs)

            rs = RadioSetting("dtmfdecode", "DTMF decode",

                              RadioSettingValueBoolean(False))

            mem.extra.append(rs)

            rs = RadioSetting("scrambler", "Scrambler", RadioSettingValueList(

                SCRAMBLER_LIST, SCRAMBLER_LIST[0]))

            mem.extra.append(rs)

            # actually the step and duplex are overwritten by chirp based on

            # bandplan. they are here to document sane defaults for IARU r1

            # mem.tuning_step = 25.0

            # mem.duplex = "off"

            return mem

        if number > 199:

            mem.name = VFO_CHANNEL_NAMES[number-200]

            mem.immutable = ["name"]

        else:

            _mem2 = self._memobj.channelname[number]

            for char in _mem2.name:

                if str(char) == "\xFF" or str(char) == "\x00":

                    break

                mem.name += str(char)

            mem.name = mem.name.rstrip()

        # Convert your low-level frequency to Hertz

        mem.freq = int(_mem.freq)*10

        mem.offset = int(_mem.offset)*10

        if (mem.offset == 0):

            mem.duplex = ''

        else:

            if (_mem.flags1 & FLAGS1_OFFSET_MASK) == FLAGS1_OFFSET_MINUS:

                mem.duplex = '-'

            elif (_mem.flags1 & FLAGS1_OFFSET_MASK) == FLAGS1_OFFSET_PLUS:

                mem.duplex = '+'

            else:

                mem.duplex = ''

        # tone data

        self._get_tone(mem, _mem)

        # mode

        if (_mem.flags1 & FLAGS1_ISAM) > 0:

            if (_mem.flags2 & FLAGS2_BANDWIDTH) > 0:

                mem.mode = "NAM"

            else:

                mem.mode = "AM"

        else:

            if (_mem.flags2 & FLAGS2_BANDWIDTH) > 0:

                mem.mode = "NFM"

            else:

                mem.mode = "FM"

        # tuning step

        tstep = _mem.step & 0x7

        if tstep < len(STEPS):

            mem.tuning_step = STEPS[tstep]

        else:

            mem.tuning_step = 2.5

        # power

        if (_mem.flags2 & FLAGS2_POWER_MASK) == FLAGS2_POWER_HIGH:

            mem.power = UVK5_POWER_LEVELS[2]

        elif (_mem.flags2 & FLAGS2_POWER_MASK) == FLAGS2_POWER_MEDIUM:

            mem.power = UVK5_POWER_LEVELS[1]

        else:

            mem.power = UVK5_POWER_LEVELS[0]

        # We'll consider any blank (i.e. 0MHz frequency) to be empty

        if (_mem.freq == 0xffffffff) or (_mem.freq == 0):

            mem.empty = True

        else:

            mem.empty = False

        mem.extra = RadioSettingGroup("Extra", "extra")

        # BCLO

        is_bclo = bool(_mem.flags2 & FLAGS2_BCLO > 0)

        rs = RadioSetting("bclo", "BCLO", RadioSettingValueBoolean(is_bclo))

        mem.extra.append(rs)

        tmpcomment += "BCLO:"+(is_bclo and "ON" or "off")+" "

        # Frequency reverse - whatever that means, don't see it in the manual

        is_frev = bool(_mem.flags2 & FLAGS2_REVERSE > 0)

        rs = RadioSetting("frev", "FreqRev", RadioSettingValueBoolean(is_frev))

        mem.extra.append(rs)

        tmpcomment += "FreqReverse:"+(is_frev and "ON" or "off")+" "

        # PTTID

        pttid = (_mem.dtmf_flags & FLAGS_DTMF_PTTID_MASK) >> 1

        rs = RadioSetting("pttid", "PTTID", RadioSettingValueList(

            PTTID_LIST, PTTID_LIST[pttid]))

        mem.extra.append(rs)

        tmpcomment += "PTTid:"+PTTID_LIST[pttid]+" "

        # DTMF DECODE

        is_dtmf = bool(_mem.dtmf_flags & FLAGS_DTMF_DECODE > 0)

        rs = RadioSetting("dtmfdecode", "DTMF decode",

                          RadioSettingValueBoolean(is_dtmf))

        mem.extra.append(rs)

        tmpcomment += "DTMFdecode:"+(is_dtmf and "ON" or "off")+" "

        # Scrambler

        if _mem.scrambler & 0x0f < len(SCRAMBLER_LIST):

            enc = _mem.scrambler & 0x0f

        else:

            enc = 0

        rs = RadioSetting("scrambler", "Scrambler", RadioSettingValueList(

            SCRAMBLER_LIST, SCRAMBLER_LIST[enc]))

        mem.extra.append(rs)

        tmpcomment += "Scrambler:"+SCRAMBLER_LIST[enc]+" "

        return mem

    def set_settings(self, settings):

        _mem = self._memobj

        for element in settings:

            if not isinstance(element, RadioSetting):

                self.set_settings(element)