CHIRP

# Copyright 2016:

# * Jim Unroe KC9HI, <rock.unroe@gmail.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 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 time

import struct

import logging

import re

LOG = logging.getLogger(__name__)

from chirp import chirp_common, directory, memmap

from chirp import bitwise, errors, util

from chirp.settings import RadioSettingGroup, RadioSetting, \

RadioSettingValueBoolean, RadioSettingValueList, \

RadioSettingValueString, RadioSettingValueInteger, \

RadioSettingValueFloat, RadioSettings, \

InvalidValueError

from textwrap import dedent

##### MAGICS #########################################################

# Baofeng UV-6R magic string

MSTRING_UV6R = "\x50\xBB\xFF\x20\x14\x11\x22"

##### ID strings #####################################################

# Baofeng UV-6R

UV6R_fp1 = " BF230#1"

UV6R_fp2 = " BF230#2"

DTMF_CHARS = "0123456789 *#ABCD"

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

LIST_AB = ["A", "B"]

LIST_ALMOD = ["Site", "Tone", "Code"]

LIST_BANDWIDTH = ["Wide", "Narrow"]

LIST_COLOR = ["Off", "Blue", "Orange", "Purple"]

LIST_DTMFSPEED = ["%s ms" % x for x in range(50, 2010, 10)]

LIST_DTMFST = ["Off", "DT-ST", "ANI-ST", "DT+ANI"]

LIST_MODE = ["Channel", "Name", "Frequency"]

LIST_OFF1TO9 = ["Off"] + list("123456789")

LIST_OFF1TO10 = LIST_OFF1TO9 + ["10"]

LIST_OFFAB = ["Off"] + LIST_AB

LIST_RESUME = ["TO", "CO", "SE"]

LIST_PONMSG = ["Full", "Message"]

LIST_PTTID = ["Off", "BOT", "EOT", "Both"]

LIST_SCODE = ["%s" % x for x in range(1, 16)]

LIST_RPSTE = ["Off"] + ["%s" % x for x in range(1, 11)]

LIST_SAVE = ["Off", "1:1", "1:2", "1:3", "1:4"]

LIST_SHIFTD = ["Off", "+", "-"]

LIST_STEDELAY = ["Off"] + ["%s ms" % x for x in range(100, 1100, 100)]

LIST_STEP = [str(x) for x in STEPS]

LIST_TCALL = ["Off", "1000 Hz", "1450 Hz", "1750 Hz", "2100 Hz"]

LIST_TIMEOUT = ["%s sec" % x for x in range(15, 615, 15)]

LIST_TXPOWER = ["High", "Low"]

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

LIST_WORKMODE = ["Frequency", "Channel"]

def model_match(cls, data):

"""Match the opened/downloaded image to the correct version"""

match_rid1 = False

match_rid2 = False

rid1 = data[0x1FF8:0x2000]

if rid1 in cls._fileid:

match_rid1 = True

rid2 = data[0x1FD0:0x1FD5]

if rid2 == cls.MODEL:

match_rid2 = True

if match_rid1 and match_rid2:

return True

else:

return False

@directory.register

class UV6R(chirp_common.CloneModeRadio,

chirp_common.ExperimentalRadio):

"""Baofeng UV-6R"""

VENDOR = "Baofeng"

MODEL = "UV-6R"

_fileid = [UV6R_fp2, UV6R_fp1, ]

_magic = [MSTRING_UV6R, ]

_magic_response_length = 8

_fw_ver_start = 0x1FF0

_recv_block_size = 0x40

_mem_size = 0x2000

_ack_block = False

_ranges = [(0x0000, 0x1800),

(0x1F40, 0x1F50),

(0x1FC0, 0x1FD0),

(0x1FE0, 0x1FF0)]

_send_block_size = 0x10

MODES = ["FM", "NFM"]

VALID_CHARS = chirp_common.CHARSET_ALPHANUMERIC + \

"!@#$%^&*()+-=[]:\";'<>?,./"

LENGTH_NAME = 6

SKIP_VALUES = ["", "S"]

DTCS_CODES = sorted(chirp_common.DTCS_CODES + [645])

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

chirp_common.PowerLevel("Low", watts=1.00)]

VALID_BANDS = [(136000000, 174000000),

(400000000, 520000000)]

PTTID_LIST = LIST_PTTID

SCODE_LIST = LIST_SCODE

MEM_FORMAT = """

#seekto 0x0000;

struct {

lbcd rxfreq[4];

lbcd txfreq[4];

ul16 rxtone;

ul16 txtone;

u8 unknown0:4,

scode:4;

u8 unknown1;

u8 unknown2:7,

lowpower:1;

u8 unknown3:1,

wide:1,

unknown4:2,

bcl:1,

scan:1,

pttid:2;

} memory[128];

#seekto 0x0B00;

struct {

u8 code[5];

u8 unused[11];

} pttid[15];

#seekto 0x0CAA;

struct {

u8 code[5];

u8 unused:6,

aniid:2;

u8 unknown[2];

u8 dtmfon;

u8 dtmfoff;

} ani;

#seekto 0x0E20;

struct {

u8 unused00:4,

squelch:4;

u8 unused01:5,

step:3;

u8 unknown00;

u8 unused02:5,

save:3;

u8 unused03:4,

vox:4;

u8 unknown01;

u8 unused04:4,

abr:4;

u8 unused05:7,

tdr:1;

u8 unused06:7,

beep:1;

u8 unused07:2,

timeout:6;

u8 unused08:6,

tcall:2;

u8 unknown02[3];

u8 unused09:6,

voice:2;

u8 unknown03;

u8 unused10:6,

dtmfst:2;

u8 unknown04;

u8 unused11:6,

screv:2;

u8 unused12:6,

pttid:2;

u8 unused13:2,

pttlt:6;

u8 unused14:6,

mdfa:2;

u8 unused15:6,

mdfb:2;

u8 unknown05;

u8 unused16:7,

autolk:1;

u8 unknown06[4];

u8 unused17:6,

wtled:2;

u8 unused18:6,

rxled:2;

u8 unused19:6,

txled:2;

u8 unused20:6,

almod:2;

u8 unknown07[2];

u8 unused22:7,

ste:1;

u8 unused23:4,

rpste:4;

u8 unused24:4,

rptrl:4;

u8 unused25:7,

ponmsg:1;

u8 unused26:7,

roger:1;

u8 unused27:7,

reset:1;

u8 unknown08;

u8 displayab:1,

unknown09:2,

fmradio:1,

alarm:1,

unknown10:1,

menu:1;

u8 unknown11;

u8 unused29:7,

workmode:1;

u8 unused30:7,

keylock:1;

u8 cht;

} settings;

#seekto 0x0E76;

struct {

u8 unused0:1,

mrcha:7;

u8 unused1:1,

mrchb:7;

} wmchannel;

struct vfo {

u8 unknown0[8];

u8 freq[8];

u8 offset[6];

ul16 rxtone;

ul16 txtone;

u8 unused0:7,

band:1;

u8 unknown3;

u8 unknown4:2,

sftd:2,

scode:4;

u8 unknown5;

u8 unknown6:1,

step:3,

unknown7:4;

u8 txpower:1,

widenarr:1,

unknown8:6;

};

#seekto 0x0F00;

struct {

struct vfo a;

struct vfo b;

} vfo;

#seekto 0x0F4E;

u16 fm_presets;

#seekto 0x1000;

struct {

char name[6];

u8 unknown[10];

} names[128];

#seekto 0x1F40;

struct {

u8 sql0;

u8 sql1;

u8 sql2;

u8 sql3;

u8 sql4;

u8 sql5;

u8 sql6;

u8 sql7;

u8 sql8;

u8 sql9;

} squelch;

struct limit {

u8 enable;

bbcd lower[2];

bbcd upper[2];

};

#seekto 0x1FC0;

struct {

struct limit vhf;

struct limit uhf;

} limits;

#seekto 0x1FD0;

struct {

char line1[8];

char line2[8];

} sixpoweron_msg;

#seekto 0x1FE0;

struct {

char line1[7];

char line2[7];

} poweron_msg;

#seekto 0x1FF0;

struct {

char line1[8];

char line2[8];

} firmware_msg;

"""

@classmethod

def get_prompts(cls):

rp = chirp_common.RadioPrompts()

rp.experimental = \

('The BTech UV-6R driver is a beta version.\n'

'\n'

'Please save an unedited copy of your first successful\n'

'download to a CHIRP Radio Images(*.img) file.'

)

rp.pre_download = _(dedent("""\

Follow these instructions to download your info:

1 - Turn off your radio

2 - Connect your interface cable

3 - Turn on your radio

4 - Do the download of your radio data

"""))

rp.pre_upload = _(dedent("""\

Follow this instructions to upload your info:

1 - Turn off your radio

2 - Connect your interface cable

3 - Turn on your radio

4 - Do the upload of your radio data

"""))

return rp

def process_mmap(self):

"""Process the mem map into the mem object"""

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

def sync_in(self):

"""Download from radio"""

try:

data = _download(self)

except errors.RadioError:

# Pass through any real errors we raise

raise

except:

# If anything unexpected happens, make sure we raise

# a RadioError and log the problem

LOG.exception('Unexpected error during download')

raise errors.RadioError('Unexpected error communicating '

'with the radio')

self._mmap = memmap.MemoryMap(data)

self.process_mmap()

def sync_out(self):

"""Upload to radio"""

try:

_upload(self)

except errors.RadioError:

raise

except Exception, e:

# If anything unexpected happens, make sure we raise

# a RadioError and log the problem

LOG.exception('Unexpected error during upload')

raise errors.RadioError('Unexpected error communicating '

'with the radio')

def get_features(self):

"""Get the radio's features"""

rf = chirp_common.RadioFeatures()

rf.has_settings = True

rf.has_bank = False

rf.has_tuning_step = False

rf.can_odd_split = True

rf.has_name = True

rf.has_offset = True

rf.has_mode = True

rf.has_dtcs = True

rf.has_rx_dtcs = True

rf.has_dtcs_polarity = True

rf.has_ctone = True

rf.has_cross = True

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

rf.valid_characters = self.VALID_CHARS

rf.valid_name_length = 6

rf.valid_duplexes = ["", "-", "+", "split", "off"]

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

rf.valid_cross_modes = [

"Tone->Tone",

"DTCS->",

"->DTCS",

"Tone->DTCS",

"DTCS->Tone",

"->Tone",

"DTCS->DTCS"]

rf.valid_skips = ["", "S"]

rf.valid_dtcs_codes = self.DTCS_CODES

rf.memory_bounds = (0, 127)

rf.valid_power_levels = self.POWER_LEVELS

rf.valid_bands = self.VALID_BANDS

rf.valid_tuning_steps = STEPS

return rf

def get_raw_memory(self, number):

return repr(self._memobj.memory[number])

def _is_txinh(self, _mem):

raw_tx = ""

for i in range(0, 4):

raw_tx += _mem.txfreq[i].get_raw()

return raw_tx == "\xFF\xFF\xFF\xFF"

def get_memory(self, number):

_mem = self._memobj.memory[number]

_nam = self._memobj.names[number]

mem = chirp_common.Memory()

mem.number = number

if _mem.get_raw()[0] == "\xff":

mem.empty = True

return mem

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

if self._is_txinh(_mem):

mem.duplex = "off"

mem.offset = 0

elif abs(int(_mem.rxfreq) - int(_mem.txfreq)) < 7000000:

mem.duplex = "split"

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

elif int(_mem.rxfreq) < int(_mem.txfreq):

mem.duplex = "+"

mem.offset = abs(int(_mem.rxfreq) - int(_mem.txfreq)) * 10

elif int(_mem.rxfreq) > int(_mem.txfreq):

mem.duplex = "-"

mem.offset = abs(int(_mem.rxfreq) - int(_mem.txfreq)) * 10

else:

int(_mem.rxfreq) == int(_mem.txfreq) and ""

mem.offset = 0

for char in _nam.name:

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

char = " " # The OEM software may have 0xFF mid-name

mem.name += str(char)

mem.name = mem.name.rstrip()

dtcs_pol = ["N", "N"]

if _mem.txtone in [0, 0xFFFF]:

txmode = ""

elif _mem.txtone >= 0x0258:

txmode = "Tone"

mem.rtone = int(_mem.txtone) / 10.0

elif _mem.txtone <= 0x0258:

txmode = "DTCS"

if _mem.txtone > 0x69:

index = _mem.txtone - 0x6A

dtcs_pol[0] = "R"

else:

index = _mem.txtone - 1

mem.dtcs = self.DTCS_CODES[index]

else:

LOG.warn("Bug: txtone is %04x" % _mem.txtone)

if _mem.rxtone in [0, 0xFFFF]:

rxmode = ""

elif _mem.rxtone >= 0x0258:

rxmode = "Tone"

mem.ctone = int(_mem.rxtone) / 10.0

elif _mem.rxtone <= 0x0258:

rxmode = "DTCS"

if _mem.rxtone >= 0x6A:

index = _mem.rxtone - 0x6A

dtcs_pol[1] = "R"

else:

index = _mem.rxtone - 1

mem.rx_dtcs = self.DTCS_CODES[index]

else:

LOG.warn("Bug: rxtone is %04x" % _mem.rxtone)

if txmode == "Tone" and not rxmode:

mem.tmode = "Tone"

elif txmode == rxmode and txmode == "Tone" and mem.rtone == mem.ctone:

mem.tmode = "TSQL"

elif txmode == rxmode and txmode == "DTCS" and mem.dtcs == mem.rx_dtcs:

mem.tmode = "DTCS"

elif rxmode or txmode:

mem.tmode = "Cross"

mem.cross_mode = "%s->%s" % (txmode, rxmode)

mem.dtcs_polarity = "".join(dtcs_pol)

if not _mem.scan:

mem.skip = "S"

levels = self.POWER_LEVELS

try:

mem.power = levels[_mem.lowpower]

except IndexError:

LOG.error("Radio reported invalid power level %s (in %s)" %

(_mem.power, levels))

mem.power = levels[0]

mem.mode = _mem.wide and "FM" or "NFM"

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

rs = RadioSetting("bcl", "BCL",

RadioSettingValueBoolean(_mem.bcl))

mem.extra.append(rs)

rs = RadioSetting("pttid", "PTT ID",

RadioSettingValueList(self.PTTID_LIST,

self.PTTID_LIST[_mem.pttid]))

mem.extra.append(rs)

rs = RadioSetting("scode", "S-CODE",

RadioSettingValueList(self.SCODE_LIST,

self.SCODE_LIST[_mem.scode]))

mem.extra.append(rs)

return mem

def _set_mem(self, number):

return self._memobj.memory[number]

def _set_nam(self, number):

return self._memobj.names[number]

def set_memory(self, mem):

_mem = self._memobj.memory[mem.number]

_nam = self._memobj.names[mem.number]

if mem.empty:

_mem.set_raw("\xff" * 16)

_nam.set_raw("\xff" * 16)

return

was_empty = False

# same method as used in get_memory to find

# out whether a raw memory is empty

if _mem.get_raw()[0] == "\xff":

was_empty = True

LOG.debug

else:

# memorize old extra-values before erasing the whole memory

# used to solve issue 4121

LOG.debug("mem was not empty, memorize extra-settings")

prev_bcl = _mem.bcl.get_value()

prev_scode = _mem.scode.get_value()

prev_pttid = _mem.pttid.get_value()

_mem.set_raw("\x00" * 16)

_mem.rxfreq = mem.freq / 10

if mem.duplex == "off":

for i in range(0, 4):

_mem.txfreq[i].set_raw("\xFF")

elif mem.duplex == "split":

_mem.txfreq = mem.offset / 10

elif mem.duplex == "+":

_mem.txfreq = (mem.freq + mem.offset) / 10

elif mem.duplex == "-":

_mem.txfreq = (mem.freq - mem.offset) / 10

else:

_mem.txfreq = mem.freq / 10

_namelength = self.get_features().valid_name_length

for i in range(_namelength):

try:

_nam.name[i] = mem.name[i]

except IndexError:

_nam.name[i] = "\xFF"

rxmode = txmode = ""

if mem.tmode == "Tone":

_mem.txtone = int(mem.rtone * 10)

_mem.rxtone = 0

elif mem.tmode == "TSQL":

_mem.txtone = int(mem.ctone * 10)

_mem.rxtone = int(mem.ctone * 10)

elif mem.tmode == "DTCS":

rxmode = txmode = "DTCS"

_mem.txtone = self.DTCS_CODES.index(mem.dtcs) + 1

_mem.rxtone = self.DTCS_CODES.index(mem.dtcs) + 1

elif mem.tmode == "Cross":

txmode, rxmode = mem.cross_mode.split("->", 1)

if txmode == "Tone":

_mem.txtone = int(mem.rtone * 10)

elif txmode == "DTCS":

_mem.txtone = self.DTCS_CODES.index(mem.dtcs) + 1

else:

_mem.txtone = 0

if rxmode == "Tone":

_mem.rxtone = int(mem.ctone * 10)

elif rxmode == "DTCS":

_mem.rxtone = self.DTCS_CODES.index(mem.rx_dtcs) + 1

else:

_mem.rxtone = 0

else:

_mem.rxtone = 0

_mem.txtone = 0

if txmode == "DTCS" and mem.dtcs_polarity[0] == "R":

_mem.txtone += 0x69

if rxmode == "DTCS" and mem.dtcs_polarity[1] == "R":

_mem.rxtone += 0x69

_mem.scan = mem.skip != "S"

_mem.wide = mem.mode == "FM"

if mem.power:

_mem.lowpower = self.POWER_LEVELS.index(mem.power)

else:

_mem.lowpower = 0

if not was_empty:

# restoring old extra-settings (issue 4121

_mem.bcl.set_value(prev_bcl)

_mem.scode.set_value(prev_scode)

_mem.pttid.set_value(prev_pttid)

for setting in mem.extra:

setattr(_mem, setting.get_name(), setting.value)

def get_settings(self):

"""Translate the bit in the mem_struct into settings in the UI"""

_mem = self._memobj

basic = RadioSettingGroup("basic", "Basic Settings")

advanced = RadioSettingGroup("advanced", "Advanced Settings")

other = RadioSettingGroup("other", "Other Settings")

work = RadioSettingGroup("work", "Work Mode Settings")

fm_preset = RadioSettingGroup("fm_preset", "FM Preset")

dtmfe = RadioSettingGroup("dtmfe", "DTMF Encode Settings")

service = RadioSettingGroup("service", "Service Settings")

top = RadioSettings(basic, advanced, other, work, fm_preset, dtmfe,

service)

# Basic settings

if _mem.settings.squelch > 0x09:

val = 0x00

else:

val = _mem.settings.squelch

rs = RadioSetting("settings.squelch", "Squelch",

RadioSettingValueList(

LIST_OFF1TO9, LIST_OFF1TO9[val]))

basic.append(rs)

if _mem.settings.save > 0x04:

val = 0x00

else:

val = _mem.settings.save

rs = RadioSetting("settings.save", "Battery Saver",

RadioSettingValueList(

LIST_SAVE, LIST_SAVE[val]))

basic.append(rs)

if _mem.settings.vox > 0x0A:

val = 0x00

else:

val = _mem.settings.vox

rs = RadioSetting("settings.vox", "Vox",

RadioSettingValueList(

LIST_OFF1TO10, LIST_OFF1TO10[val]))

basic.append(rs)

if _mem.settings.abr > 0x0A:

val = 0x00

else:

val = _mem.settings.abr

rs = RadioSetting("settings.abr", "Backlight Timeout",

RadioSettingValueList(

LIST_OFF1TO10, LIST_OFF1TO10[val]))

basic.append(rs)

rs = RadioSetting("settings.tdr", "Dual Watch",

RadioSettingValueBoolean(_mem.settings.tdr))

basic.append(rs)

rs = RadioSetting("settings.beep", "Beep",

RadioSettingValueBoolean(_mem.settings.beep))

basic.append(rs)

if _mem.settings.timeout > 0x27:

val = 0x03

else:

val = _mem.settings.timeout

rs = RadioSetting("settings.timeout", "Timeout Timer",

RadioSettingValueList(

LIST_TIMEOUT, LIST_TIMEOUT[val]))

basic.append(rs)

if _mem.settings.voice > 0x02:

val = 0x01

else:

val = _mem.settings.voice

rs = RadioSetting("settings.voice", "Voice Prompt",

RadioSettingValueList(

LIST_VOICE, LIST_VOICE[val]))

basic.append(rs)

rs = RadioSetting("settings.dtmfst", "DTMF Sidetone",

RadioSettingValueList(LIST_DTMFST, LIST_DTMFST[

_mem.settings.dtmfst]))

basic.append(rs)

if _mem.settings.screv > 0x02:

val = 0x01

else:

val = _mem.settings.screv

rs = RadioSetting("settings.screv", "Scan Resume",

RadioSettingValueList(

LIST_RESUME, LIST_RESUME[val]))

basic.append(rs)

rs = RadioSetting("settings.pttid", "When to send PTT ID",

RadioSettingValueList(LIST_PTTID, LIST_PTTID[

_mem.settings.pttid]))

basic.append(rs)

if _mem.settings.pttlt > 0x1E:

val = 0x05

else:

val = _mem.settings.pttlt

rs = RadioSetting("pttlt", "PTT ID Delay",

RadioSettingValueInteger(0, 50, val))

basic.append(rs)

rs = RadioSetting("settings.mdfa", "Display Mode (A)",

RadioSettingValueList(LIST_MODE, LIST_MODE[

_mem.settings.mdfa]))

basic.append(rs)

rs = RadioSetting("settings.mdfb", "Display Mode (B)",

RadioSettingValueList(LIST_MODE, LIST_MODE[

_mem.settings.mdfb]))

basic.append(rs)

rs = RadioSetting("settings.autolk", "Auto Lock Keypad",

RadioSettingValueBoolean(_mem.settings.autolk))

basic.append(rs)

rs = RadioSetting("settings.wtled", "Standby LED Color",

RadioSettingValueList(

LIST_COLOR, LIST_COLOR[_mem.settings.wtled]))

basic.append(rs)

rs = RadioSetting("settings.rxled", "RX LED Color",

RadioSettingValueList(

LIST_COLOR, LIST_COLOR[_mem.settings.rxled]))

basic.append(rs)

rs = RadioSetting("settings.txled", "TX LED Color",

RadioSettingValueList(

LIST_COLOR, LIST_COLOR[_mem.settings.txled]))

basic.append(rs)

if _mem.settings.almod > 0x02:

val = 0x00

else:

val = _mem.settings.almod

rs = RadioSetting("settings.almod", "Alarm Mode",

RadioSettingValueList(

LIST_ALMOD, LIST_ALMOD[val]))

basic.append(rs)

if _mem.settings.tcall > 0x05:

val = 0x00

else:

val = _mem.settings.tcall

rs = RadioSetting("settings.tcall", "Tone Burst Frequency",

RadioSettingValueList(

LIST_TCALL, LIST_TCALL[val]))

basic.append(rs)

rs = RadioSetting("settings.ste", "Squelch Tail Eliminate (HT to HT)",

RadioSettingValueBoolean(_mem.settings.ste))

basic.append(rs)

if _mem.settings.rpste > 0x0A:

val = 0x00

else:

val = _mem.settings.rpste

rs = RadioSetting("settings.rpste",

"Squelch Tail Eliminate (repeater)",

RadioSettingValueList(

LIST_RPSTE, LIST_RPSTE[val]))

basic.append(rs)