Project

General

Profile

Download (19.3 KB)

New Model #10334 » iradio_uv_5118plus-v0.1.py

For downloading only. No Settings tabs. No uploading. - Jim Unroe, 03/03/2023 06:43 PM

 
# Copyright 2023 Jim Unroe <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 os
import struct
import re
import logging

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

LOG = logging.getLogger(__name__)

MEM_FORMAT = """
struct memory {
ul32 rxfreq; // RX Frequency 00-03
ul16 rx_tone; // PL/DPL Decode 04-05
ul32 txfreq; // TX Frequency 06-09
ul16 tx_tone; // PL/DPL Encode 0a-0b
ul24 mutecode; // Mute Code 0c-0e
u8 unknown_0:2, // 0f
mutetype:2, // Mute Type
unknown_1:4; //
u8 isnarrow:1, // Bandwidth 00
lowpower:1, // Power
scan:1, // Scan Add
bcl:2, // Busy Lock
unknown_2:1, //
unknown_3:1, //
unknown_4:1; //
u8 unknown_5; // 01
u8 unused_0:4, // 02
scno:4; // SC No.
u8 unknown_6[3]; // 03-05
char name[10]; // 06-0f
};

#seekto 0x1000;
struct memory channels[999];

#seekto 0x0000;
struct {
char startuplabel[32]; // Startup Label 0000-001f
char personalid[16]; // Personal ID 0020-002f
u8 displaylogo:1, // Display Startup Logo 0030
displayvoltage:1, // Display Voltage
displaylabel:1, // Display Startup Label
tailtone:1, // Tail Tone
startupringtone:1, // Startup Ringtone
voiceprompt:1, // Voice Prompt
keybeep:1, // Key Beep
unknown_0:1;
u8 txpriority:1, // TX Priority 0031
rogerbeep:2, // Roger Beep
savemode:1, // Save Mode
frequencystep:4; // Frequency Step
u8 squelch:4, // Squelch 0032
talkaround:2, // Talkaround
noaaalarm:1, // NOAA Alarm
dualdisplay:1; // Dual Display
u8 displaytimer; // Display Timer 0033
u8 locktimer; // Lock Timer 0034
u8 timeouttimer; // Timeout Timer 0035
u8 voxlevel:4, // VOX Level 0036
voxdelay:4; // Delay
ul16 tonefrequency; // Tone Frequency 0037-0038
ul16 fmfrequency; // FM Frequency 0039-003a
u8 fmstandby:1, // FM Standby 003b
dualstandby:1, // Dual Standby
standbyarea:1, // Standby Area
scandirection:1, // Scan Direction
unknown_2:2,
workmode:1, // Work Mode
unknown_3:1;
ul16 areaach; // Area A CH 003c-003d
ul16 areabch; // Area B CH 003e-003f
u8 unused_0:4, // 0040
key1long:4; // Key 1 Long
u8 unused_1:4, // 0041
key1short:4; // Key 1 Short
u8 unused_2:4, // 0042
key2long:4; // Key 2 Long
u8 unused_3:4, // 0043
key2short:4; // Key 2 Short
u8 unknown_4:4, // 0044
vox:1, // VOX
unknown_5:3;
u8 xposition; // X position (0-159) 0045
u8 yposition; // Y position (0-110) 0046
ul16 bordercolor; // Border Color 0047-0048
u8 unknown_6[9]; // 0x00 0049-0051
u8 unknown_7[2]; // 0xFF 0052-0053
u8 range174_240; // 174-240 MHz 0054
u8 range240_320; // 240-320 MHz 0055
u8 range320_400; // 320-400 MHz 0056
u8 range480_560; // 480-560 MHz 0057
u8 unused_4[7]; // 0xFF 0058-005e
u8 unknown_8; // 0x00 005f
u8 unused_5[12]; // 0xFF 0060-006b
u8 unknown_9[4]; // 0x00 006c-006f
ul16 quickch2; // Quick CH 2 0070-0071
ul16 quickch1; // Quick CH 1 0072-0073
ul16 quickch4; // Quick CH 4 0074-0075
ul16 quickch3; // Quick CH 3 0076-0077
} settings;

#seekto 0x8D20;
struct {
u8 senddelay; // Send Delay 8d20
u8 sendinterval; // Send Interval 8d21
u8 unused_0:6, // 8d22
sendmode:2; // Send Mode
u8 unused_2:4, // 8d23
sendselect:4; // Send Select
u8 unused_3:7, // 8d24
recvdisplay:1; // Recv Display
u8 encodegain; // Encode Gain 8d25
u8 decodeth; // Decode TH 8d26
} dtmf;

#seekto 0x8D30;
struct {
char code[14]; // DTMF code
u8 unused_ff;
u8 code_len; // DTMF code length
} dtmfcode[16];

#seekto 0x8E30;
struct {
char kill[14]; // Remotely Kill 8e30-8e3d
u8 unknown_0; // 8e3e
u8 kill_len; // Remotely Kill Length 83ef
char stun[14]; // Remotely Stun 8e40-834d
u8 unknown_1; // 8e4e
u8 stun_len; // Remotely Stun Length 8e4f
char wakeup[14]; // Wake Up 8e50-8e5d
u8 unknown_2; // 8e5e
u8 wakeup_len; // Wake Up Length 8e5f
} dtmf2;

"""

CMD_ACK = b"\x06"

DTCS_CODES = tuple(sorted(chirp_common.DTCS_CODES + (645,)))

_STEP_LIST = [0.25, 1.25, 2.5, 5., 6.25, 10., 12.5, 25., 50., 100., 500.,
1000., 5000.]

LIST_AB = ["A", "B"]
LIST_BCL = ["Off", "Carrier", "CTC/DCS"]
LIST_CHREPORT = ["CH Number", "CH Name"]
LIST_DELAY = ["%s ms" % x for x in range(0, 2100, 100)]
LIST_DIRECTION = ["Up", "Down"]
LIST_FREQSTEP = ["0.25K", "1.25K", "2.5K", "5K", "6.25K", "10K", "12.5K",
"20K", "25K", "50K", "100K", "500K", "1M", "5M"]
LIST_INTERVAL = ["%s ms" % x for x in range(30, 210, 10)]
LIST_MUTETYPE = ["Off", "-", "23b", "24b"]
LIST_ROGER = ["Off", "Roger 1", "Roger 2", "Send ID"]
LIST_SENDM = ["Off", "TX Start", "TX End", "Start and End"]
LIST_SENDS = ["DTMF %s" % x for x in range(1, 17)]
LIST_SKEY = ["None", "Monitor", "Frequency Detect", "Talkaround",
"Quick CH", "Local Alarm", "Remote Alarm", "Weather CH",
"Send Tone", "Roger Beep"]
LIST_REPEATER = ["Off", "Talkaround", "Frequency Reversal"]
LIST_TIMER = ["Off", "5 seconds", "10 seconds"] + [
"%s seconds" % x for x in range(15, 615, 15)]
LIST_TXPRI = ["Edit", "Busy"]
LIST_WORKMODE = ["Frequency", "Channel"]

TXALLOW_CHOICES = ["RX Only", "TX/RX"]
TXALLOW_VALUES = [0xFF, 0x00]

VALID_CHARS = chirp_common.CHARSET_ALPHANUMERIC + \
"`{|}!\"#$%&'()*+,-./:;<=>?@[]^_"
DTMF_CHARS = list("0123456789ABCD*#")


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


def _enter_programming_mode(radio):
serial = radio.pipe

# lengthen the timeout here as these radios are reseting due to timeout
radio.pipe.timeout = 0.75

exito = False
for i in range(0, 5):
serial.write(radio.magic)
ack = serial.read(1)

try:
if ack == CMD_ACK:
exito = True
break
except:
LOG.debug("Attempt #%s, failed, trying again" % i)
pass

# return timeout to default value
radio.pipe.timeout = 0.25

# check if we had EXITO
if exito is False:
msg = "The radio did not accept program mode after five tries.\n"
msg += "Check you interface cable and power cycle your radio."
raise errors.RadioError(msg)


def _exit_programming_mode(radio):
serial = radio.pipe
try:
serial.write(b"58" + b"\x05\xEE\x60")
except:
raise errors.RadioError("Radio refused to exit programming mode")


def _read_block(radio, block_addr, block_size):
serial = radio.pipe

cmd = struct.pack(">BH", ord(b'R'), block_addr + radio.READ_OFFSET)

ccs = bytes([_checksum(cmd)])

expectedresponse = b"R" + cmd[1:]

cmd = cmd + ccs

LOG.debug("Reading block %04x..." % block_addr)

try:
serial.write(cmd)
response = serial.read(3 + block_size + 1)

cs = _checksum(response[:-1])

if response[:3] != expectedresponse:
raise Exception("Error reading block %04x." % block_addr)

chunk = response[3:]

if chunk[-1] != cs:
raise Exception("Block failed checksum!")

block_data = chunk[:-1]
except:
raise errors.RadioError("Failed to read block at %04x" % block_addr)

return block_data


def _write_block(radio, block_addr, block_size):
serial = radio.pipe

# map the upload address to the mmap start and end addresses
start_addr = block_addr * block_size
end_addr = start_addr + block_size

data = radio.get_mmap()[start_addr:end_addr]

cmd = struct.pack(">BH", ord(b'I'), block_addr)

cs = bytes([_checksum(cmd + data)])
data += cs

LOG.debug("Writing Data:")
LOG.debug(util.hexprint(cmd + data))

try:
serial.write(cmd + data)
if serial.read(1) != CMD_ACK:
raise Exception("No ACK")
except:
raise errors.RadioError("Failed to send block "
"to radio at %04x" % block_addr)


def do_download(radio):
LOG.debug("download")
_enter_programming_mode(radio)

data = b""

status = chirp_common.Status()
status.msg = "Cloning from radio"

status.cur = 0
status.max = radio.END_ADDR

for addr in range(radio.START_ADDR, radio.END_ADDR, 1):
status.cur = addr
radio.status_fn(status)

block = _read_block(radio, addr, radio.BLOCK_SIZE)
data += block

LOG.debug("Address: %04x" % addr)
LOG.debug(util.hexprint(block))

_exit_programming_mode(radio)

return memmap.MemoryMapBytes(data)


def _split(rf, f1, f2):
"""Returns False if the two freqs are in the same band (no split)
or True otherwise"""

# determine if the two freqs are in the same band
for low, high in rf.valid_bands:
if f1 >= low and f1 <= high and \
f2 >= low and f2 <= high:
# if the two freqs are on the same Band this is not a split
return False

# if you get here is because the freq pairs are split
return True


class IradioUV5118plus(chirp_common.CloneModeRadio):
"""IRADIO UV5118plus"""
VENDOR = "Iradio"
MODEL = "UV-5118plus"
NAME_LENGTH = 10
BAUD_RATE = 115200
NEEDS_COMPAT_SERIAL = False

BLOCK_SIZE = 0x80
magic = b"58" + b"\x05\x10\x82"

airband = [108000000, 136000000]

VALID_BANDS = [(108000000, 136000000), # RX only (Air Band)
(136000000, 174000000), # TX/RX (VHF)
(174000000, 240000000), # TX/RX
(240000000, 320000000), # TX/RX
(320000000, 400000000), # TX/RX
(400000000, 480000000), # TX/RX (UHF)
(480000000, 560000000)] # TX/RX

POWER_LEVELS = [chirp_common.PowerLevel("High", watts=2.00),
chirp_common.PowerLevel("Low", watts=0.50)]

# Radio's write address starts at 0x0000
# Radio's write address ends at 0x0140
START_ADDR = 0
END_ADDR = 0x0140
# Radio's read address starts at 0x7820
# Radio's read address ends at 0x795F
READ_OFFSET = 0x7820

_ranges = [
(0x0000, 0x0140),
]
_memsize = 0xA000 # 0x0140 * 0x80

_upper = 999

def get_features(self):
rf = chirp_common.RadioFeatures()
rf.has_settings = False
rf.has_bank = False
rf.has_ctone = True
rf.has_cross = True
rf.has_rx_dtcs = True
rf.has_tuning_step = False
rf.can_odd_split = True
rf.has_name = True
rf.valid_name_length = self.NAME_LENGTH
rf.valid_characters = chirp_common.CHARSET_ASCII
rf.valid_skips = ["", "S"]
rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS", "Cross"]
rf.valid_cross_modes = ["Tone->Tone", "Tone->DTCS", "DTCS->Tone",
"->Tone", "->DTCS", "DTCS->", "DTCS->DTCS"]
rf.valid_power_levels = self.POWER_LEVELS
rf.valid_duplexes = ["", "-", "+", "split"]
rf.valid_modes = ["FM", "NFM"] # 25 KHz, 12.5 KHz.
rf.valid_dtcs_codes = DTCS_CODES
rf.memory_bounds = (1, self._upper)
rf.valid_tuning_steps = _STEP_LIST
rf.valid_bands = self.VALID_BANDS

return rf

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

def sync_in(self):
"""Download from radio"""
try:
data = do_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 = data
self.process_mmap()

def sync_out(self):
"""Upload to radio"""
try:
do_upload(self)
except:
# If anything unexpected happens, make sure we raise
# a RadioError and log the problem
LOG.exception('Uploading is not impleted')
raise errors.RadioError('Uploading is not impleted')

def get_raw_memory(self, number):
return repr(self._memobj.memory[number - 1])

@staticmethod
def _decode_tone(toneval):
# DCS examples:
# D023N - 1013 - 0001 0000 0001 0011
# ^-DCS
# D023I - 2013 - 0010 0000 0001 0100
# ^--DCS inverted
# D754I - 21EC - 0010 0001 1110 1100
# code in octal-------^^^^^^^^^^^

if toneval == 0x3000:
return '', None, None
elif toneval & 0x1000:
# DTCS N
code = int('%o' % (toneval & 0x1FF))
return 'DTCS', code, 'N'
elif toneval & 0x2000:
# DTCS R
code = int('%o' % (toneval & 0x1FF))
return 'DTCS', code, 'R'
else:
return 'Tone', toneval / 10.0, None

@staticmethod
def _encode_tone(mode, val, pol):
if not mode:
return 0x3000
elif mode == 'Tone':
return int(val * 10)
elif mode == 'DTCS':
code = int('%i' % val, 8)
if pol == 'N':
code |= 0x1800
if pol == 'R':
code |= 0x2800
return code
else:
raise errors.RadioError('Unsupported tone mode %r' % mode)

def get_memory(self, number):
mem = chirp_common.Memory()
_mem = self._memobj.channels[number - 1]
mem.number = number

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

# We'll consider any blank (i.e. 0MHz frequency) to be empty
if mem.freq == 0:
mem.empty = True
return mem

if _mem.rxfreq.get_raw() == "\xFF\xFF\xFF\xFF":
mem.freq = 0
mem.empty = True
return mem

#if _mem.get_raw() == ("\xFF" * 16):
# LOG.debug("Initializing empty memory")
# _mem.set_raw("\xFF" * 4 + "\x00\x30" + "\xFF" * 4 + "\x00\x30" +
# "\x00" * 4)

# Freq and offset
mem.freq = int(_mem.rxfreq) * 10
# TX freq set
offset = (int(_mem.txfreq) * 10) - mem.freq
if offset != 0:
if _split(self.get_features(), mem.freq, int(
_mem.txfreq) * 10):
mem.duplex = "split"
mem.offset = int(_mem.txfreq) * 10
elif offset < 0:
mem.offset = abs(offset)
mem.duplex = "-"
elif offset > 0:
mem.offset = offset
mem.duplex = "+"
else:
mem.offset = 0

mem.name = str(_mem.name).rstrip('\xFF ')

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

chirp_common.split_tone_decode(mem,
self._decode_tone(_mem.tx_tone),
self._decode_tone(_mem.rx_tone))

mem.power = self.POWER_LEVELS[_mem.lowpower]

if not _mem.scan:
mem.skip = "S"

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

rs = RadioSettingValueList(LIST_BCL, LIST_BCL[_mem.bcl])
rset = RadioSetting("bcl", "Busy Channel Lockout", rs)
mem.extra.append(rset)

rs = RadioSettingValueList(LIST_MUTETYPE, LIST_MUTETYPE[_mem.mutetype])
rset = RadioSetting("mutetype", "Mute Type", rs)
mem.extra.append(rset)

rs = RadioSettingValueInteger(0, 16777215, _mem.mutecode)
rset = RadioSetting("mutecode", "Mute Code", rs)
mem.extra.append(rset)

rs = RadioSettingValueInteger(0, 8, _mem.scno)
rset = RadioSetting("scno", "SC No.", rs)
mem.extra.append(rset)

return mem

def set_memory(self, mem):
LOG.debug("Setting %i(%s)" % (mem.number, mem.extd_number))
_mem = self._memobj.channels[mem.number - 1]

# if empty memmory
if mem.empty:
_mem.set_raw("\xFF" * 22 + "\20" * 10)
return

_mem.set_raw("\xFF" * 4 + "\x00\x30" + "\xFF" * 4 + "\x00\x30" +
"\x00" * 10 + "\x20" * 10)

_mem.rxfreq = mem.freq / 10

if 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

_mem.name = mem.name.rstrip(' ').ljust(10, '\xFF')

_mem.scan = mem.skip != "S"
_mem.isnarrow = mem.mode == "NFM"

dtcs_pol = ["N", "N"]

txtone, rxtone = chirp_common.split_tone_encode(mem)
_mem.tx_tone = self._encode_tone(*txtone)
_mem.rx_tone = self._encode_tone(*rxtone)

_mem.lowpower = mem.power == self.POWER_LEVELS[1]

for setting in mem.extra:
setattr(_mem, setting.get_name(), setting.value)

@classmethod
def match_model(cls, filedata, filename):
# This radio has always been post-metadata, so never do
# old-school detection
return False


@directory.register
class RuyageUV58PlusRadio(IradioUV5118plus):
"""Ruyage UV58Plus"""
VENDOR = "Ruyage"
MODEL = "UV58Plus"
(2-2/3)
Copyright 2023 CHIRP Software LLC