Project

General

Profile

Bug #374 » alinco.py

Dan Smith, 12/24/2012 01:39 PM

 
1
# Copyright 2011 Dan Smith <dsmith@danplanet.com>
2
#
3
# This program is free software: you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation, either version 3 of the License, or
6
# (at your option) any later version.
7
#
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
12
#
13
# You should have received a copy of the GNU General Public License
14
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
15

    
16
from chirp import chirp_common, bitwise, memmap, errors, directory, util
17
from chirp.settings import RadioSettingGroup, RadioSetting
18
from chirp.settings import RadioSettingValueBoolean
19

    
20
import time
21

    
22
DRX35_MEM_FORMAT = """
23
#seekto 0x0120;
24
u8 used_flags[25];
25

    
26
#seekto 0x0200;
27
struct {
28
  u8 new_used:1,
29
     unknown1:1,
30
     isnarrow:1,
31
     isdigital:1,
32
     ishigh:1,
33
     unknown2:3;
34
  u8 unknown3:6,
35
     duplex:2;
36
  u8 unknown4:4,
37
     tmode:4;
38
  u8 unknown5:4,
39
     step:4;
40
  bbcd freq[4];
41
  u8 unknown6[1];
42
  bbcd offset[3];
43
  u8 rtone;
44
  u8 ctone;
45
  u8 dtcs_tx;
46
  u8 dtcs_rx;
47
  u8 name[7];
48
  u8 unknown8[2];
49
  u8 unknown9:6,
50
     power:2;
51
  u8 unknownA[6];
52
} memory[100];
53

    
54
#seekto 0x0130;
55
u8 skips[25];
56
"""
57

    
58
# 0000 0111
59
# 0000 0010
60

    
61
# Response length is:
62
# 1. \r\n
63
# 2. Four-digit address, followed by a colon
64
# 3. 16 bytes in hex (32 characters)
65
# 4. \r\n
66
RLENGTH = 2 + 5 + 32 + 2
67

    
68
STEPS = [5.0, 10.0, 12.5, 15.0, 20.0, 25.0, 30.0]
69

    
70
def isascii(data):
71
    for byte in data:
72
        if (ord(byte) < ord(" ") or ord(byte) > ord("~")) and \
73
                byte not in "\r\n":
74
            return False
75
    return True
76

    
77
def tohex(data):
78
    if isascii(data):
79
        return repr(data)
80
    string = ""
81
    for byte in data:
82
        string += "%02X" % ord(byte)
83
    return string
84

    
85
class AlincoStyleRadio(chirp_common.CloneModeRadio):
86
    """Base class for all known Alinco radios"""
87
    _memsize = 0
88
    _model = "NONE"
89

    
90
    def _send(self, data):
91
        print "PC->R: (%2i) %s" % (len(data), tohex(data))
92
        self.pipe.write(data)
93
        self.pipe.read(len(data))
94

    
95
    def _read(self, length):
96
        data = self.pipe.read(length)
97
        print "R->PC: (%2i) %s" % (len(data), tohex(data))
98
        return data
99

    
100
    def _download_chunk(self, addr):
101
        if addr % 16:
102
            raise Exception("Addr 0x%04x not on 16-byte boundary" % addr)
103

    
104
        cmd = "AL~F%04XR\r\n" % addr
105
        self._send(cmd)
106

    
107
        resp = self._read(RLENGTH).strip()
108
        if len(resp) == 0:
109
            raise errors.RadioError("No response from radio")
110
        if ":" not in resp:
111
            raise errors.RadioError("Unexpected response from radio")
112
        addr, _data = resp.split(":", 1)
113
        data = ""
114
        for i in range(0, len(_data), 2):
115
            data += chr(int(_data[i:i+2], 16))
116

    
117
        if len(data) != 16:
118
            print "Response was:"
119
            print "|%s|"
120
            print "Which I converted to:"
121
            print util.hexprint(data)
122
            raise Exception("Radio returned less than 16 bytes")
123

    
124
        return data
125

    
126
    def _download(self, limit):
127
        self._identify()
128

    
129
        data = ""
130
        for addr in range(0, limit, 16):
131
            data += self._download_chunk(addr)
132
            time.sleep(0.1)
133

    
134
            if self.status_fn:
135
                status = chirp_common.Status()
136
                status.cur = addr + 16
137
                status.max = self._memsize
138
                status.msg = "Downloading from radio"
139
                self.status_fn(status)
140

    
141
        self._send("AL~E\r\n")
142
        self._read(20)
143

    
144
        return memmap.MemoryMap(data)
145

    
146
    def _identify(self):
147
        for _i in range(0, 3):
148
            self._send("%s\r\n" % self._model)
149
            resp = self._read(6)
150
            if resp.strip() == "OK":
151
                return True
152
            time.sleep(1)
153

    
154
        return False
155

    
156
    def _upload_chunk(self, addr):
157
        if addr % 16:
158
            raise Exception("Addr 0x%04x not on 16-byte boundary" % addr)
159

    
160
        _data = self._mmap[addr:addr+16]
161
        data = "".join(["%02X" % ord(x) for x in _data])
162

    
163
        cmd = "AL~F%04XW%s\r\n" % (addr, data)
164
        self._send(cmd)
165

    
166
    def _upload(self, limit):
167
        if not self._identify():
168
            raise Exception("I can't talk to this model")
169

    
170
        for addr in range(0x100, limit, 16):
171
            self._upload_chunk(addr)
172
            time.sleep(0.1)
173

    
174
            if self.status_fn:
175
                status = chirp_common.Status()
176
                status.cur = addr + 16
177
                status.max = self._memsize
178
                status.msg = "Uploading to radio"
179
                self.status_fn(status)
180

    
181
        self._send("AL~E\r\n")
182
        self.pipe._read(20)
183

    
184
    def process_mmap(self):
185
        self._memobj = bitwise.parse(DRX35_MEM_FORMAT, self._mmap)
186

    
187
    def sync_in(self):
188
        try:
189
            self._mmap = self._download(self._memsize)
190
        except errors.RadioError:
191
            raise
192
        except Exception, e:
193
            raise errors.RadioError("Failed to communicate with radio: %s" % e)
194
        self.process_mmap()
195

    
196
    def sync_out(self):
197
        try:
198
            self._upload(self._memsize)
199
        except errors.RadioError:
200
            raise
201
        except Exception, e:
202
            raise errors.RadioError("Failed to communicate with radio: %s" % e)
203

    
204
    def get_raw_memory(self, number):
205
        return repr(self._memobj.memory[number])
206

    
207
DUPLEX = ["", "-", "+"]
208
TMODES = ["", "Tone", "", "TSQL"] + [""] * 12
209
TMODES[12] = "DTCS"
210
DCS_CODES = {
211
    "Alinco" : chirp_common.DTCS_CODES,
212
    "Jetstream" : [17] + chirp_common.DTCS_CODES,
213
}
214

    
215
CHARSET = (["\x00"] * 0x30) + \
216
    [chr(x + ord("0")) for x in range(0, 10)] + \
217
    [chr(x + ord("A")) for x in range(0, 26)] + [" "] + \
218
    list("\x00" * 128)
219

    
220
def _get_name(_mem):
221
    name = ""
222
    for i in _mem.name:
223
        if i in [0x00, 0xFF]:
224
            break
225
        name += CHARSET[i]
226
    return name
227

    
228
def _set_name(mem, _mem):
229
    name = [0x00] * 7
230
    j = 0
231
    for i in range(0, 7):
232
        try:
233
            name[j] = CHARSET.index(mem.name[i])
234
            j += 1
235
        except IndexError:
236
            pass
237
        except ValueError:
238
            pass
239
    return name
240

    
241
ALINCO_TONES = list(chirp_common.TONES)
242
ALINCO_TONES.remove(159.8)
243
ALINCO_TONES.remove(165.5)
244
ALINCO_TONES.remove(171.3)
245
ALINCO_TONES.remove(177.3)
246
ALINCO_TONES.remove(183.5)
247
ALINCO_TONES.remove(189.9)
248
ALINCO_TONES.remove(196.6)
249
ALINCO_TONES.remove(199.5)
250
ALINCO_TONES.remove(206.5)
251
ALINCO_TONES.remove(229.1)
252
ALINCO_TONES.remove(254.1)
253

    
254
class DRx35Radio(AlincoStyleRadio):
255
    """Base class for the DR-x35 radios"""
256
    _range = [(118000000, 155000000)]
257
    _power_levels = []
258
    _valid_tones = ALINCO_TONES
259

    
260
    def get_features(self):
261
        rf = chirp_common.RadioFeatures()
262
        rf.valid_tmodes = ["", "Tone", "TSQL", "DTCS"]
263
        rf.valid_modes = ["FM", "NFM"]
264
        rf.valid_skips = ["", "S"]
265
        rf.valid_bands = self._range
266
        rf.memory_bounds = (0, 99)
267
        rf.has_ctone = True
268
        rf.has_bank = False
269
        rf.has_dtcs_polarity = False
270
        rf.valid_tuning_steps = STEPS
271
        rf.valid_name_length = 7
272
        rf.valid_power_levels = self._power_levels
273
        return rf
274

    
275
    def _get_used(self, number):
276
        _usd = self._memobj.used_flags[number / 8]
277
        bit = (0x80 >> (number % 8))
278
        return _usd & bit
279

    
280
    def _set_used(self, number, is_used):
281
        _usd = self._memobj.used_flags[number / 8]
282
        bit = (0x80 >> (number % 8))
283
        if is_used:
284
            _usd |= bit
285
        else:
286
            _usd &= ~bit
287

    
288
    def _get_power(self, _mem):
289
        if self._power_levels:
290
            return self._power_levels[_mem.ishigh]
291
        return None
292

    
293
    def _set_power(self, _mem, mem):
294
        if self._power_levels:
295
            _mem.ishigh = mem.power is None or \
296
                mem.power == self._power_levels[1]
297

    
298
    def _get_extra(self, _mem, mem):
299
        mem.extra = RadioSettingGroup("Extra", "extra")
300
        dig = RadioSetting("Digital", "isdigital",
301
                           RadioSettingValueBoolean(bool(_mem.isdigital)))
302
        dig.set_doc("Digital/Packet mode enabled")
303
        mem.extra.append(dig)
304

    
305
    def _set_extra(self, _mem, mem):
306
        for setting in mem.extra:
307
            setattr(_mem, setting.get_shortname(), setting.value)
308

    
309
    def get_memory(self, number):
310
        _mem = self._memobj.memory[number]
311
        _skp = self._memobj.skips[number / 8]
312
        _usd = self._memobj.used_flags[number / 8]
313
        bit = (0x80 >> (number % 8))
314

    
315
        mem = chirp_common.Memory()
316
        mem.number = number
317
        if not self._get_used(number) and self.MODEL != "JT220M":
318
            mem.empty = True
319
            return mem
320

    
321
        mem.freq = int(_mem.freq) * 100
322
        mem.rtone = self._valid_tones[_mem.rtone]
323
        mem.ctone = self._valid_tones[_mem.ctone]
324
        mem.duplex = DUPLEX[_mem.duplex]
325
        mem.offset = int(_mem.offset) * 100
326
        mem.tmode = TMODES[_mem.tmode]
327
        mem.dtcs = DCS_CODES[self.VENDOR][_mem.dtcs_tx]
328
        mem.tuning_step = STEPS[_mem.step]
329

    
330
        if _mem.isnarrow:
331
            mem.mode = "NFM"
332

    
333
        mem.power = self._get_power(_mem)
334

    
335
        if _skp & bit:
336
            mem.skip = "S"
337

    
338
        mem.name = _get_name(_mem).rstrip()
339

    
340
        self._get_extra(_mem, mem)
341

    
342
        return mem
343

    
344
    def set_memory(self, mem):
345
        _mem = self._memobj.memory[mem.number]
346
        _skp = self._memobj.skips[mem.number / 8]
347
        _usd = self._memobj.used_flags[mem.number / 8]
348
        bit = (0x80 >> (mem.number % 8))
349

    
350
        if self._get_used(mem.number) and not mem.empty:
351
            # Initialize the memory
352
            _mem.set_raw("\x00" * 32)
353

    
354
        self._set_used(mem.number, not mem.empty)
355
        if mem.empty:
356
            return
357

    
358
        _mem.freq = mem.freq / 100
359

    
360
        try:
361
            _tone = mem.rtone
362
            _mem.rtone = self._valid_tones.index(mem.rtone)
363
            _tone = mem.ctone
364
            _mem.ctone = self._valid_tones.index(mem.ctone)
365
        except ValueError:
366
            raise errors.UnsupportedToneError("This radio does not support " +
367
                                              "tone %.1fHz" % _tone)
368

    
369
        _mem.duplex = DUPLEX.index(mem.duplex)
370
        _mem.offset = mem.offset / 100
371
        _mem.tmode = TMODES.index(mem.tmode)
372
        _mem.dtcs_tx = DCS_CODES[self.VENDOR].index(mem.dtcs)
373
        _mem.dtcs_rx = DCS_CODES[self.VENDOR].index(mem.dtcs)
374
        _mem.step = STEPS.index(mem.tuning_step)
375

    
376
        _mem.isnarrow = mem.mode == "NFM"
377
        self._set_power(_mem, mem)
378

    
379
        if mem.skip:
380
            _skp |= bit
381
        else:
382
            _skp &= ~bit
383

    
384
        _mem.name = _set_name(mem, _mem)
385

    
386
        self._set_extra(_mem, mem)
387

    
388
@directory.register
389
class DR03Radio(DRx35Radio):
390
    """Alinco DR03"""
391
    VENDOR = "Alinco"
392
    MODEL = "DR03T"
393

    
394
    _model = "DR135"
395
    _memsize = 4096
396
    _range = [(28000000, 29695000)]
397

    
398
    @classmethod
399
    def match_model(cls, filedata, filename):
400
        return len(filedata) == cls._memsize and \
401
            filedata[0x64] == chr(0x00) and filedata[0x65] == chr(0x28)
402

    
403
@directory.register
404
class DR06Radio(DRx35Radio):
405
    """Alinco DR06"""
406
    VENDOR = "Alinco"
407
    MODEL = "DR06T"
408

    
409
    _model = "DR435"
410
    _memsize = 4096
411
    _range = [(50000000, 53995000)]
412

    
413
    @classmethod
414
    def match_model(cls, filedata, filename):
415
        return len(filedata) == cls._memsize and \
416
            filedata[0x64] == chr(0x00) and filedata[0x65] == chr(0x50)
417
            
418
@directory.register
419
class DR135Radio(DRx35Radio):
420
    """Alinco DR135"""
421
    VENDOR = "Alinco"
422
    MODEL = "DR135T"
423

    
424
    _model = "DR135"
425
    _memsize = 4096
426
    _range = [(118000000, 173000000)]
427

    
428
    @classmethod
429
    def match_model(cls, filedata, filename):
430
        return len(filedata) == cls._memsize and \
431
            filedata[0x64] == chr(0x01) and filedata[0x65] == chr(0x44)
432

    
433
@directory.register
434
class DR235Radio(DRx35Radio):
435
    """Alinco DR235"""
436
    VENDOR = "Alinco"
437
    MODEL = "DR235T"
438

    
439
    _model = "DR235"
440
    _memsize = 4096
441
    _range = [(216000000, 280000000)]
442

    
443
    @classmethod
444
    def match_model(cls, filedata, filename):
445
        return len(filedata) == cls._memsize and \
446
            filedata[0x64] == chr(0x02) and filedata[0x65] == chr(0x22)
447

    
448
@directory.register
449
class DR435Radio(DRx35Radio):
450
    """Alinco DR435"""
451
    VENDOR = "Alinco"
452
    MODEL = "DR435T"
453

    
454
    _model = "DR435"
455
    _memsize = 4096
456
    _range = [(350000000, 511000000)]
457

    
458
    @classmethod
459
    def match_model(cls, filedata, filename):
460
        return len(filedata) == cls._memsize and \
461
            filedata[0x64] == chr(0x04) and filedata[0x65] == chr(0x00)
462

    
463
@directory.register
464
class DJ596Radio(DRx35Radio):
465
    """Alinco DJ596"""
466
    VENDOR = "Alinco"
467
    MODEL = "DJ596"
468

    
469
    _model = "DJ596"
470
    _memsize = 4096
471
    _range = [(136000000, 174000000), (400000000, 511000000)]
472
    _power_levels = [chirp_common.PowerLevel("Low", watts=1.00),
473
                     chirp_common.PowerLevel("High", watts=5.00)]
474

    
475
    @classmethod
476
    def match_model(cls, filedata, filename):
477
        return len(filedata) == cls._memsize and \
478
            filedata[0x64] == chr(0x45) and filedata[0x65] == chr(0x01)
479

    
480
@directory.register
481
class JT220MRadio(DRx35Radio):
482
    """Jetstream JT220"""
483
    VENDOR = "Jetstream"
484
    MODEL = "JT220M"
485

    
486
    _model = "DR136"
487
    _memsize = 8192
488
    _range = [(216000000, 280000000)]
489

    
490
    @classmethod
491
    def match_model(cls, filedata, filename):
492
        return len(filedata) == cls._memsize and \
493
            filedata[0x60:0x64] == "2009"
494

    
495
@directory.register
496
class DJ175Radio(DRx35Radio):
497
    """Alinco DJ175"""
498
    VENDOR = "Alinco"
499
    MODEL = "DJ175"
500

    
501
    _model = "DJ175"
502
    _memsize = 6896
503
    _range = [(136000000, 174000000), (400000000, 511000000)]
504
    _power_levels = [
505
        chirp_common.PowerLevel("Low", watts=0.50),
506
        chirp_common.PowerLevel("Mid", watts=2.00),
507
        chirp_common.PowerLevel("High", watts=5.00),
508
        ]
509

    
510
    @classmethod
511
    def match_model(cls, filedata, filename):
512
        return len(filedata) == cls._memsize
513

    
514
    def _get_used(self, number):
515
        return self._memobj.memory[number].new_used
516

    
517
    def _set_used(self, number, is_used):
518
        self._memobj.memory[number].new_used = is_used
519

    
520
    def _get_power(self, _mem):
521
        return self._power_levels[_mem.power]
522

    
523
    def _set_power(self, _mem, mem):
524
        if mem.power in self._power_levels:
525
            _mem.power = self._power_levels.index(mem.power)
526

    
527
    def _download_chunk(self, addr):
528
        if addr % 16:
529
            raise Exception("Addr 0x%04x not on 16-byte boundary" % addr)
530

    
531
        cmd = "AL~F%04XR\r\n" % addr
532
        self._send(cmd)
533

    
534
        _data = self._read(34).strip()
535
        if len(_data) == 0:
536
            raise errors.RadioError("No response from radio")
537

    
538
        data = ""
539
        for i in range(0, len(_data), 2):
540
            data += chr(int(_data[i:i+2], 16))
541

    
542
        if len(data) != 16:
543
            print "Response was:"
544
            print "|%s|"
545
            print "Which I converted to:"
546
            print util.hexprint(data)
547
            raise Exception("Radio returned less than 16 bytes")
548

    
549
        return data
(5-5/5)