-
Notifications
You must be signed in to change notification settings - Fork 0
/
wireless.transceiver.cc1101.spin2
1151 lines (1009 loc) · 40.3 KB
/
wireless.transceiver.cc1101.spin2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
--------------------------------------------
Filename: wireless.transceiver.cc1101.spin2
Author: Jesse Burt
Description: Driver for TI's CC1101 ISM-band transceiver (P2 version)
Copyright (c) 2023
Started Mar 25, 2019
Updated Apr 22, 2023
See end of file for terms of use.
--------------------------------------------
}
CON
' -- User-modifiable constants
{
Do not adjust these here. Instead, override them using the constant override feature in the
parent object.
Example CC1101-App.spin2:
OBJ
cc1101: "wireless.transceiver.cc1101" | PPB = 30_000
' or
cc1101: "wireless.transceiver.cc1101" | F_XOSC = 25_999_220
NOTE:
If the actual resulting frequency synthesized by the chip is lower than the value
set/returned by e.g., carrier_freq(), PPB should be set to a positive number.
If it's higher, however, PPB should be a negative number.
}
PPB = 0 ' parts-per-billion (PPB/1000 = PPM)
{ crystal freq: adjust from nominal 26MHz: calculate offset using PPB figure }
F_XOSC = round(26_000_000-(26_000_000 * (float(PPB) / float(1_000_000_000))))
' --
TWO13 = 1 << 13 ' 2^13
TWO14 = 1 << 14 ' 2^14
TWO16 = 1 << 16 ' 2^16
TWO17 = 1 << 17 ' 2^17
TWO18 = 1 << 18 ' 2^18
TWO20 = 1 << 20 ' 2^20
TWO28 = 1 << 28 ' 2^28
U64SCALE = 1_000_000_000 ' Unsigned math scale
U64_FREQ_RES = round((float(F_XOSC) / float(TWO16))*1_000_000)
CHANSPC_RES = round((float(F_XOSC) / float(TWO18))*1_000_000)
' Auto-calibration state
NEVER = 0
IDLE_RXTX = 1
RXTX_IDLE = 2
RXTX_IDLE4 = 3
' RXOff states
RXOFF_IDLE = 0
RXOFF_FSTXON = 1
RXOFF_TX = 2
RXOFF_RX = 3
' TXOff states
TXOFF_IDLE = 0
TXOFF_FSTXON = 1
TXOFF_TX = 2
TXOFF_RX = 3
' Modulation formats
FSK2 = %000
GFSK = %001
ASKOOK = %011
FSK4 = %100
MSK = %111
' CC1101 I/O pin output signals
TRIG_RXTHRESH = $00
TRIG_RXTHRESH_END_PKT = $01
TRIG_RXOVERFLOW = $04
TRIG_TXUNDERFLOW = $05
TRIG_SYNCWORD_TXRX = $06
TRIG_PREAMBLE_QUALITY = $08
TRIG_CARRIER = $0E
IO_CHIP_RDYn = $29
IO_XOSC_STABLE = $2B
IO_HI_Z = $2E
IO_CLK_XODIV1 = $30
IO_CLK_XODIV192 = $3F
' Packet Length configuration modes
PKTLEN_FIXED = 0
PKTLEN_VAR = 1
PKTLEN_INF = 2
' Syncword qualifier modes
SYNCMODE_NONE = 0
SYNCMODE_1516 = 1
SYNCMODE_1616 = 2
SYNCMODE_3032 = 3
SYNCMODE_CS_ONLY = 4
SYNCMODE_1516_CS = 5
SYNCMODE_1616_CS = 6
SYNCMODE_3032_CS = 7
' Address check modes
ADRCHK_NONE = 0
ADRCHK_CHK_NO_BCAST = 1
ADRCHK_CHK_00_BCAST = 2
ADRCHK_CHK_00_FF_BCAST = 3
' AGC modes
AGC_NORMAL = %00
AGC_FREEZE_ON_SYNC = %01
AGC_FREEZE_A_AUTO_D = %10
AGC_OFF = %11
VAR
byte _CS
byte _status
OBJ
spi : "com.spi.25mhz"
core : "core.con.cc1101"
PUB null()
' This is not a top-level object
PUB startx(CS_PIN, SCK_PIN, MOSI_PIN, MISO_PIN, SCK_FREQ=6_500_000): status
if lookdown(CS_PIN: 0..63) and lookdown(SCK_PIN: 0..63) and {
} lookdown(MOSI_PIN: 0..63) and lookdown(MISO_PIN: 0..63) and {
} SCK_FREQ <= core.SCK_MAX_FREQ
if (status := spi.init(SCK_PIN, MOSI_PIN, MISO_PIN, core.SPI_MODE, {
} SCK_FREQ))
waitus(core.T_POR)
_CS := CS_PIN
pinh(_CS)
if lookdown(dev_id(): $04, $14..$FE) ' validate device
reset()
return
' if this point is reached, something above failed
' Double check I/O pin assignments, connections, power
' Lastly - make sure you have at least one free core/cog
return FALSE
PUB stop()
' Stop the driver
spi.deinit()
_CS := _status := 0
PUB defaults()
' Factory default settings
' This is what _would_ be called:
{
node_addr($00)
addr_check(ADRCHK_NONE)
payld_status_ena(TRUE)
carrier_freq(800_000_000)
channel(0)
crc_auto_flush_ena(FALSE)
crc_check_ena(TRUE)
data_rate(115_200)
dc_block_ena(TRUE)
freq_dev(47_607)
fec_ena(FALSE)
gpio0(IO_CLK_XODIV192)
gpio1(IO_HI_Z)
gpio2(IO_CHIP_RDYn)
interm_freq(380_859)
manchester_enc(FALSE)
modulation(FSK2)
payld_len(255)
payld_len_cfg(PKTLEN_VAR)
preamble_len(2)
preamble_qual(0)
rx_bw(203)
rx_fifo_thresh(32)
syncwd_mode(SYNCMODE_1616)
set_syncwd($D391)
data_whiten_ena(TRUE)
}
' but to save code space, just call reset(), instead
reset()
PUB preset_fixed_pkt_len()
' Like preset_robust1(), but sets packet length config mode to fixed-length
preset_robust1()
payld_len_cfg(PKTLEN_FIXED)
PUB preset_robust1()
' Like defaults, but with some basic improvements in robustness:
' * check/filter address field in payload (2nd byte), ignore broadcast address
' * perform oscillator auto-cal when transitioning from idle to RX or TX
' * reject packets with a bad CRC (i.e., flush from receive buffer)
' * turn off oscillator output on GPIO0 (GDO0)
reset()
addr_check(ADRCHK_CHK_NO_BCAST)
auto_cal_mode(IDLE_RXTX)
crc_auto_flush_ena(TRUE)
gpio0(IO_HI_Z)
PUB addr_check(mode=-2): curr_mode
' Enable address checking/matching/filtering
' Valid values:
' *ADRCHK_NONE (0): No address check
' ADRCHK_CHK_NO_BCAST (1): Check address, but ignore broadcast addresses
' ADRCHK_CHK_00_BCAST (2): Check address, and also respond to $00 broadcast address
' ADRCHK_CHK_00_FF_BCAST (3): Check address, and also respond to both $00 and $FF broadcast addresses
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.PKTCTRL1, 1, @curr_mode)
case mode
0..3:
mode := mode & core.ADR_CHK_BITS
other:
return curr_mode & core.ADR_CHK_BITS
mode := ((curr_mode & core.ADR_CHK_MASK) | mode) & core.PKTCTRL1_MASK
writereg(core.PKTCTRL1, 1, @mode)
PUB after_rx(next_state=-2): curr_set
' Defines the state the radio transitions to after a packet is successfully received
' Valid values:
' *RXOFF_IDLE (0) - Idle state
' RXOFF_FSTXON (1) - Turn frequency synth on and ready at TX freq. To transmit, call TX
' RXOFF_TX (2) - Start sending preamble
' RXOFF_RX (3) - Wait for more packets
' Any other value polls the chip and returns the current setting
curr_set := 0
readreg(core.MCSM1, 1, @curr_set)
case next_state
0..3:
next_state := next_state << core.RXOFF_MODE
other:
return (curr_set >> core.RXOFF_MODE) & core.RXOFF_MODE_BITS
next_state := ((curr_set & core.RXOFF_MODE_MASK) | next_state)
writereg(core.MCSM1, 1, @next_state)
PUB after_tx(next_state=-2): curr_set
' Defines the state the radio transitions to after a packet is successfully transmitted
' Valid values:
' *TXOFF_IDLE (0) - Idle state
' TXOFF_FSTXON (1) - Turn frequency synth on and ready at TX freq. To transmit, call TX
' TXOFF_TX (2) - Start sending preamble
' TXOFF_RX (3) - Wait for packets (RX)
' Any other value polls the chip and returns the current setting
curr_set := 0
readreg(core.MCSM1, 1, @curr_set)
case next_state
0..3:
next_state := next_state << core.TXOFF_MODE
other:
return (curr_set >> core.TXOFF_MODE) & core.TXOFF_MODE_BITS
next_state := ((curr_set & core.TXOFF_MODE_MASK) | next_state)
writereg(core.MCSM1, 1, @next_state)
PUB agc_filt_len(len=-2): curr_len
' For 2FSK, 4FSK, MSK, set averaging length for amplitude from the channel filter, in samples
' For OOK/ASK, set decision boundary for reception
' Valid values:
' FSK/MSK OOK/ASK
' Samples decision boundary
' 8 4dB
' 16 8dB
' 32 12dB
' 64 16dB
' Any other value polls the chip and returns the current setting
curr_len := 0
readreg(core.AGCCTRL0, 1, @curr_len)
case len
8, 16, 32, 64:
len := lookdownz(len: 8, 16, 32, 64) & core.FILT_LEN_BITS
other:
curr_len := curr_len & core.FILT_LEN_BITS
return lookupz(curr_len: 8, 16, 32, 64)
len := ((curr_len & core.FILT_LEN_MASK) | len) & core.AGCCTRL0_MASK
writereg(core.AGCCTRL0, 1, @len)
PUB agc_mode(mode=-2): curr_mode
' Set AGC mode
' Valid values:
' *AGC_NORMAL (0): Always adjust gain when required
' AGC_FREEZE_ON_SYNC (1): Gain setting is frozen when a sync word has been found
' AGC_FREEZE_A_AUTO_D (2): Freeze analog gain, but autmatically adjust digital gain
' AGC_OFF (3): Freeze both analog and digital gain settings
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.AGCCTRL0, 1, @curr_mode)
case mode
AGC_NORMAL, AGC_FREEZE_ON_SYNC, AGC_FREEZE_A_AUTO_D, AGC_OFF:
mode <<= core.AGC_FREEZE
other:
return (curr_mode >> core.AGC_FREEZE) & core.AGC_FREEZE_BITS
mode := ((curr_mode & core.AGC_FREEZE_MASK) | mode) & core.AGCCTRL0_MASK
writereg(core.AGCCTRL0, 1, @mode)
PUB auto_cal_mode(mode=-2): curr_mode
' When to perform auto-calibration
' Valid values:
' *NEVER (0) - Never (manually calibrate)
' IDLE_RXTX (1) - When transitioning from IDLE to RX/TX
' RXTX_IDLE (2) - When transitioning from RX/TX to IDLE
' RXTX_IDLE4 (3) - Every 4th time mode transitioning from RX/TX to IDLE (power-saving)
curr_mode := 0
readreg(core.MCSM0, 1, @curr_mode)
case mode
NEVER, IDLE_RXTX, RXTX_IDLE, RXTX_IDLE4:
mode := mode << core.FS_AUTOCAL
other:
return (curr_mode >> core.FS_AUTOCAL) & core.FS_AUTOCAL_BITS
mode := ((curr_mode & core.FS_AUTOCAL_MASK) | mode)
writereg(core.MCSM0, 1, @mode)
PUB cal_freq_synth()
' Calibrate the frequency synthesizer
writereg(core.CS_SCAL, 0, 0)
PUB carrier_freq(freq=-2): curr_freq
' Set carrier/center frequency, in Hz
' Valid values:
' 300_000_000..348_000_000, 387_000_000..464_000_000, 779_000_000..928_000_000
' Default value: Approx 800_000_000
' Any other value polls the chip and returns the current setting
' NOTE: The actual set frequency has a resolution of fXOSC/2^16 (i.e., approx 397Hz)
curr_freq := 0
readreg(core.FREQ2, 3, @curr_freq)
case freq
300_000_000..348_000_000, 387_000_000..464_000_000, 779_000_000..928_000_000:
freq := muldiv64(F_XOSC, U64SCALE, freq)
freq := muldiv64(TWO16, U64SCALE, freq)
other:
return muldiv64(curr_freq, U64_FREQ_RES, 1_000_000)
writereg(core.FREQ2, 3, @freq)
PUB carrier_sense_thresh(thresh=-2): curr_thr
' Set relative change threshold for asserting carrier sense, in dB
' Valid values:
' *0: Disabled
' 6: 6dB increase in RSSI
' 10: 10dB increase in RSSI
' 14: 14dB increase in RSSI
' Any other value polls the chip and returns the current setting
curr_thr := 0
readreg(core.AGCCTRL1, 1, @curr_thr)
case thresh
0, 6, 10, 14:
thresh := lookdownz(thresh: 0, 6, 10, 14) << core.CSENSE_REL_THR
other:
curr_thr := (curr_thr >> core.CSENSE_REL_THR) & core.CSENSE_REL_THR_BITS
return lookupz(curr_thr: 0, 6, 10, 14)
thresh := ((curr_thr & core.CSENSE_REL_THR_MASK) | thresh) & core.AGCCTRL1_MASK
writereg(core.AGCCTRL1, 1, @thresh)
PUB carrier_sense_abs_thresh(thresh=-2): curr_thr
' Set absolute change threshold for asserting carrier sense, in dB
' Valid values:
' %0000..%1111
' Default value: %0000
' Any other value polls the chip and returns the current setting
curr_thr := 0
readreg(core.AGCCTRL1, 1, @curr_thr)
case thresh
%0000..%1111:
thresh := thresh & core.CSENSE_ABS_THR_BITS
other:
return curr_thr & core.CSENSE_ABS_THR_BITS
thresh := ((curr_thr & core.CSENSE_ABS_THR_MASK) | thresh) & core.AGCCTRL1_MASK
writereg(core.AGCCTRL1, 1, @thresh)
PUB channel(number=-2): curr_chan
' Set channel number
' Valid values: 0..255
' Default value: 0
' Any other value polls the chip and returns the current setting
' NOTE: Resulting frequency = (channel number * channel spacing) + base freq
curr_chan := 0
readreg(core.CHANNR, 1, @curr_chan)
case number
0..255:
other:
return curr_chan
number &= core.CHANNR_MASK
writereg(core.CHANNR, 1, @number)
PUB channel_spacing(width=-2): curr_wid | chanspc_e, chanspc_m
' Set channel spacing, in Hz
' Valid values: 25_390..405_456 (default: 199_951)
' Any other value polls the chip and returns the current setting
longfill(@chanspc_e, 0, 3)
readreg(core.MDMCFG1, 2, @curr_wid)
case width
25_390..405_456:
repeat chanspc_e from 0 to 3
chanspc_m := (width / (99 * (1 << chanspc_e)) - 256)
if chanspc_m >= 0 and chanspc_m < 256
quit
other:
chanspc_e := curr_wid.byte[0] & core.CHANSPC_E_BITS
chanspc_m := curr_wid.byte[1]
curr_wid := (256 + chanspc_m) * (1 << chanspc_e)
return muldiv64(CHANSPC_RES, curr_wid, 1_000_000)
width.byte[0] &= core.CHANSPC_E_MASK
width.byte[0] |= chanspc_e
width.byte[1] := chanspc_m
writereg(core.MDMCFG1, 2, @width)
PUB crc_check_ena(mode=-2): curr_mode
' Enable CRC calc (TX mode) and check (RX mode)
' Valid values:
' *TRUE (-1 or 1)
' FALSE (0)
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.PKTCTRL0, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.CRC_EN
other:
return ((curr_mode >> core.CRC_EN) & %1) == 1
mode := ((curr_mode & core.CRC_EN_MASK) | mode) & core.PKTCTRL0_MASK
writereg(core.PKTCTRL0, 1, @mode)
PUB crc_auto_flush_ena(mode=-2): curr_mode
' Enable automatic flush of RX FIFO when CRC check fails
' Valid values:
' TRUE (-1 or 1)
' *FALSE (0)
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.PKTCTRL1, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.CRC_AUTOFLUSH
other:
return ((curr_mode >> core.CRC_AUTOFLUSH) & %1) == 1
mode := ((curr_mode & core.CRC_AUTOFLUSH_MASK) | mode) & core.PKTCTRL1_MASK
writereg(core.PKTCTRL1, 1, @mode)
PUB data_rate(rate=-2): curr_rate | curr_exp, curr_mant, dr_exp, dr_mant
' Set on-air data rate, in bps
' Valid values: 600..500_000
' Default value: 115_051
' Any other value polls the chip and returns the current setting
longfill(@curr_exp, 0, 4)
readreg(core.MDMCFG4, 1, @curr_exp)
readreg(core.MDMCFG3, 1, @curr_mant)
case rate
600..500_000:
dr_exp := encod( muldiv64(rate, TWO20, F_XOSC) )
dr_mant := (muldiv64(rate, TWO28, muldiv64(F_XOSC, {
} (1 << dr_exp), 1_000) )-256_000) / 1_000
if (dr_mant > 255) ' mantissa overflow?
dr_mant := 0 ' clear and carry it into
dr_exp := (dr_exp + 1) <# $0E ' the exponent
other:
curr_exp &= core.DRATE_E_BITS
curr_rate := muldiv64( (256+curr_mant) * (1 << curr_exp), {
} U64SCALE, TWO28)
return muldiv64(curr_rate, F_XOSC, U64SCALE)
curr_exp &= core.DRATE_E_MASK
curr_exp := (curr_exp | dr_exp)
writereg(core.MDMCFG4, 1, @curr_exp)
writereg(core.MDMCFG3, 1, @dr_mant)
PUB data_whiten_ena(mode=-2): curr_mode
' Enable data whitening
' Valid values: *TRUE (-1 or 1), FALSE (0)
' Any other value polls the chip and returns the current setting
' NOTE: Applies to all data, except the preamble and sync word.
curr_mode := 0
readreg(core.PKTCTRL0, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.WHITE_DATA
other:
return ((curr_mode >> core.WHITE_DATA) & %1) == 1
mode := ((curr_mode & core.WHITE_DATA_MASK) | mode)
writereg(core.PKTCTRL0, 1, @mode)
PUB dc_block_ena(mode=-2): curr_mode
' Enable digital DC blocking filter (before demod)
' Valid values: *TRUE (-1 or 1), FALSE
' Any other value polls the chip and returns the current setting
' NOTE: Enable for better sensitivity (default).
' Disable for optimizing current usage. Only for data rates 250kBaud and lower
curr_mode := 0
readreg(core.MDMCFG2, 1, @curr_mode)
case mode := abs(mode)
0, 1:
mode := ((mode ^ 1) << core.DCFILT_OFF)
other:
return (((curr_mode >> core.DCFILT_OFF) & %1) ^ 1) == 1
mode := ((curr_mode & core.DCFILT_OFF_MASK) | mode)
writereg(core.MDMCFG2, 1, @mode)
PUB dev_id(): id
' Chip version number
' Returns: $04 (Rev. E), $14 (Rev. I)
' NOTE: Datasheet states this value is subject to change without notice
id := 0
readreg(core.VERSION, 1, @id)
PUB dvga_gain(gain=-255): curr_gain
' Set Digital Variable Gain Amplifier gain maximum level
' Valid values:
' *0 - Highest gain setting
' -1 - Highest gain setting-1
' -2 - Highest gain setting-2
' -3 - Highest gain setting-3
' Any other value polls the chip and returns the current setting
curr_gain := 0
readreg(core.AGCCTRL2, 1, @curr_gain)
case gain
-3..0:
gain := abs(gain) << core.MAX_DVGA_GAIN
other:
curr_gain := (curr_gain >> core.MAX_DVGA_GAIN) & core.MAX_DVGA_GAIN_BITS
return curr_gain * -1
gain := ((curr_gain & core.MAX_DVGA_GAIN_MASK) | gain)
writereg(core.AGCCTRL2, 1, @gain)
PUB fec_ena(mode=-2): curr_mode
' Enable forward error correction with interleaving
' Valid values: TRUE (-1 or 1), *FALSE (0)
' Any other value polls the chip and returns the current setting
' NOTE: Only supported when payld_len_cfg() == PKTLEN_FIXED
curr_mode := 0
readreg(core.MDMCFG1, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.FEC_EN
other:
return ((curr_mode >> core.FEC_EN) & %1) == 1
mode := ((curr_mode & core.FEC_EN_MASK) | mode) & core.MDMCFG1_MASK
writereg(core.MDMCFG1, 1, @mode)
PUB fifo_rx_bytes(): nr_bytes
' Returns number of bytes in RX FIFO
' NOTE: The MSB indicates if the RX FIFO has overflowed.
nr_bytes := 0
readreg(core.RXBYTES, 1, @nr_bytes)
PUB fifo_tx_bytes(): nr_bytes
' Returns number of bytes in TX FIFO
' NOTE: The MSB indicates if the TX FIFO is underflowed.
nr_bytes := 0
readreg(core.TXBYTES, 1, @nr_bytes)
PUB flush_rx()
' Flush receive FIFO/buffer
writereg(core.CS_SFRX, 0, 0)
PUB flush_tx()
' Flush transmit FIFO/buffer
writereg(core.CS_SFTX, 0, 0)
PUB freq_dev(freq=-2): curr_freq | tmp, deviat_m, deviat_e, tmp_m
' Set frequency deviation from carrier, in Hz
' Valid values:
' 1_586..380_859 (default: 47_607)
' NOTE: This setting has no effect when Modulation format is ASK/OOK.
' NOTE: This setting applies to both TX and RX roles. When role is RX, setting must be
' approximately correct for reliable demodulation.
' Any other value polls the chip and returns the current setting
longfill(@tmp, 0, 4)
readreg(core.DEVIATN, 1, @tmp)
case freq
1_587..380_859:
deviat_e := muldiv64(freq, TWO14, F_XOSC)
deviat_e := encod(deviat_e)
tmp_m := F_XOSC * (1 << deviat_e)
deviat_m := muldiv64(freq, TWO17, tmp_m)
freq := (deviat_e << core.DEVIAT_E) | deviat_m
other:
deviat_m := tmp & core.DEVIAT_M_BITS
deviat_e := (tmp >> core.DEVIAT_E) & core.DEVIAT_E_BITS
return F_XOSC / TWO17 * (8 + deviat_m) * (1 << deviat_e)
freq &= core.DEVIATN_MASK
writereg(core.DEVIATN, 1, @freq)
PUB freq_synth_ena()
' Enable frequency synthesizer and calibrate
writereg(core.CS_SFSTXON, 0, 0)
PUB gpio0(mode=-2): curr_mode 'XXX review: consolidation with other like methods? (API change)
' Configure test signal output on GDO0 pin
' Valid values: $00..$0F, $16..$17, $1B..$1D, $24..$39, $41, $43, $46..$3F (default: $3f)
' (see IO_* constants near top of this file)
' Any other value polls the chip and returns the current setting
' NOTE: The default setting is IO_CLK_XODIV192, which outputs the CC1101's XO clock,
' divided by 192 on the pin.
' TI recommends the clock outputs be disabled when the radio is active, for best performance.
' Only one IO pin at a time can be configured as a clock output.
curr_mode := 0
readreg(core.IOCFG0, 1, @curr_mode)
case mode
$00..$0F, $16..$17, $1B..$1D, $24..$27, $29, $2B, $2E..$3F:
mode &= core.GDO0_CFG_BITS
other:
return curr_mode & core.GDO0_CFG_BITS
mode := ((curr_mode & core.GDO0_CFG_MASK) | mode)
writereg(core.IOCFG0, 1, @mode)
PUB gpio1(mode=-2): curr_mode
' Configure test signal output on GDO1 pin
' Valid values: $00..$0F, $16..$17, $1B..$1D, $24..$39, $41, $43, $46..$3F
' Any other value polls the chip and returns the current setting
' NOTE: This pin is shared with the SPI signal SO, and is valid only when CS is high.
' NOTE: The default setting is IO_HI_Z ($2E): Hi-Z/High-impedance/Tri-state
curr_mode := 0
readreg(core.IOCFG1, 1, @curr_mode)
case mode
$00..$0F, $16..$17, $1B..$1D, $24..$27, $29, $2B, $2E..$3F:
mode &= core.GDO1_CFG_BITS
other:
return curr_mode & core.GDO1_CFG_BITS
mode := ((curr_mode & core.GDO1_CFG_MASK) | mode)
writereg(core.IOCFG1, 1, @mode)
PUB gpio2(mode=-2): curr_mode
' Configure test signal output on GDO2 pin
' Valid values: $00..$0F, $16..$17, $1B..$1D, $24..$39, $41, $43, $46..$3F
' Any other value polls the chip and returns the current setting
' NOTE: The default setting is IO_CHIP_RDYn ($29)
curr_mode := 0
readreg(core.IOCFG2, 1, @curr_mode)
case mode
$00..$0F, $16..$17, $1B..$1D, $24..$27, $29, $2B, $2E..$3F:
mode &= core.GDO2_CFG_BITS
other:
return curr_mode & core.GDO2_CFG_BITS
mode := ((curr_mode & core.GDO2_CFG_MASK) | mode)
writereg(core.IOCFG2, 1, @mode)
PUB idle()
' Change chip state to IDLE
writereg(core.CS_SIDLE, 0, 0)
PUB interm_freq(freq=-2): curr_freq
' Intermediate Frequency (IF), in Hz
' Valid values: 25_390..787_109 (default: 380_859; rounded to the nearest value)
' Default value: 380_859
' Any other value polls the chip and returns the current setting
curr_freq := 0
readreg(core.FSCTRL1, 1, @curr_freq)
case freq
25_390..787_109:
freq := 1024 / (F_XOSC/freq)
other:
return curr_freq * (F_XOSC / 1024)
writereg(core.FSCTRL1, 1, @freq)
PUB last_crc_good(): flag
' Flag indicating CRC of last reception matched
' Returns: TRUE (-1) if comparison matched, FALSE (0) otherwise
readreg(core.LQI, 1, @flag)
return ((flag >> core.CRC_OK) & %1) == 1
PUB lna_gain(gain=-255): curr_gain
' Set maximum LNA+LNA2 gain (relative to maximum possible gain)
' Valid values:
' *0 - Maximum possible LNA+LNA2 gain
' -2 - ~2.6dBm below maximum
' -6 - ~6.1dBm below maximum
' -7 - ~7.4dBm below maximum
' -9 - ~9.2dBm below maximum
' -11 - ~11.5dBm below maximum
' -14 - ~14.6dBm below maximum
' -17 - ~17.1dBm below maximum
' Any other value polls the chip and returns the current setting
curr_gain := 0
readreg(core.AGCCTRL2, 1, @curr_gain)
case gain
0, -2, -6, -7, -9, -11, -14, -17:
gain := lookdownz(gain: 0, -2, -6, -7, -9, -11, -14, -17) << core.MAX_LNA_GAIN
other:
curr_gain := (curr_gain >> core.MAX_LNA_GAIN) & core.MAX_LNA_GAIN_BITS
return lookupz(curr_gain: 0, -2, -6, -7, -9, -11, -14, -17)
gain := ((curr_gain & core.MAX_LNA_GAIN_MASK) | gain)
writereg(core.AGCCTRL2, 1, @gain)
PUB magn_target(val=-2): curr_val
' Set target value for averaged amplitude from digital channel filter, in dB
' Valid values:
' 24, 27, 30, *33, 36, 38, 40, 42
' Any other value polls the chip and returns the current setting
curr_val := 0
readreg(core.AGCCTRL2, 1, @curr_val)
case val
24, 27, 30, 33, 36, 38, 40, 42:
val := lookdownz(val: 24, 27, 30, 33, 36, 38, 40, 42) & core.MAGN_TARGET_BITS
other:
curr_val := curr_val & core.MAGN_TARGET_BITS
return lookupz(curr_val: 24, 27, 30, 33, 36, 38, 40, 42)
val := ((curr_val & core.MAGN_TARGET_MASK) | val)
writereg(core.AGCCTRL2, 1, @val)
PUB manchest_enc_ena(mode=-2): curr_mode
' Enable Manchester encoding/decoding
' Valid values: TRUE (-1 or 1), *FALSE (0)
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.MDMCFG2, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.MANCHST_EN
other:
return ((curr_mode >> core.MANCHST_EN) & %1) == 1
mode := ((curr_mode & core.MANCHST_EN_MASK) | mode)
writereg(core.MDMCFG2, 1, @mode)
PUB modulation(mode=-2): curr_mode
' Set modulation of transmitted (TX) or expected (RX) signal
' Valid values:
' *FSK2 (%000): 2-level or binary Frequency Shift-Keyed
' GFSK (%001): Gaussian FSK
' ASKOOK (%011): Amplitude Shift-Keyed or On Off-Keyed
' FSK4 (%100): 4-level FSK
' MSK (%111): Minimum Shift-Keyed
' Any other value polls the chip and returns the current setting
' NOTE: MSK supported only when data_rate() is greater than 26_000
curr_mode := 0
readreg(core.MDMCFG2, 1, @curr_mode)
case mode
FSK2, GFSK, ASKOOK, FSK4, MSK:
mode := mode << core.MOD_FORMAT
other:
return (curr_mode >> core.MOD_FORMAT) & core.MOD_FORMAT_BITS
mode := ((curr_mode & core.MOD_FORMAT_MASK) | mode)
writereg(core.MDMCFG2, 1, @mode)
PUB node_addr(addr=-2): curr_addr
' Set address used for packet filtration
' Valid values: $00..$FF (000-255)
' Default value: $00
' Any other value polls the chip and returns the current setting
' NOTE: $00 and $FF can be used as broadcast addresses.
curr_addr := 0
readreg(core.ADDR, 1, @curr_addr)
case addr
$00..$FF:
other:
return curr_addr
addr &= core.ADDR_MASK
writereg(core.ADDR, 1, @addr)
PUB pa_read(ptr_buff)
' Read PA table into ptr_buff
' NOTE: ptr_buff must be at least 8 bytes in length
readreg(core.PATABLE | core.BURST, 8, ptr_buff)
PUB part_num(): pn
' Part number of device
' Returns: $00
readreg(core.PARTNUM, 1, @pn)
PUB pa_write(ptr_buff)
' Write 8-byte PA table from ptr_buff
' NOTE: Table will be written starting at index 0 from the LSB of ptr_buff
writereg(core.PATABLE | core.BURST, 8, ptr_buff)
PUB payld_len(length=-2): curr_len
' Set payload length, when using fixed payload length mode,
' or maximum payload length when using variable payload length mode.
' Valid values: 1..*255
' Any other value polls the chip and returns the current setting
curr_len := 0
readreg(core.PKTLEN, 1, @curr_len)
case length
1..255:
length &= core.PKTLEN_MASK
other:
return curr_len & core.PKTLEN_MASK
writereg(core.PKTLEN, 1, @length)
PUB payld_len_cfg(mode=-2): curr_mode
' Set payload length mode
' Valid values:
' PKTLEN_FIXED (0): Fixed payload length mode. Payload length is set by payld_len()
' PKTLEN_VAR (1): Variable payload length mode. Payload length is set by first byte of
' payload data (default)
' PKTLEN_INF (2): Infinite payload length mode.
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.PKTCTRL0, 1, @curr_mode)
case mode
0..2:
other:
return curr_mode & core.LEN_CFG_BITS
mode := ((curr_mode & core.LEN_CFG_MASK) | mode) & core.PKTCTRL0_MASK
writereg(core.PKTCTRL0, 1, @mode)
PUB payld_status_ena(mode=-2): curr_mode
' Append status bytes to packet payload (RSSI, LQI, CRC OK)
' Valid values:
' *TRUE (-1 or 1)
' FALSE (0)
' Any other value polls the chip and returns the current setting
curr_mode := 0
readreg(core.PKTCTRL1, 1, @curr_mode)
case abs(mode)
0, 1:
mode := abs(mode) << core.APPEND_STATUS
other:
return ((curr_mode >> core.APPEND_STATUS) & %1) == 1
mode := ((curr_mode & core.APPEND_STATUS_MASK) | mode) & core.PKTCTRL1_MASK
writereg(core.PKTCTRL1, 1, @mode)
PUB pll_locked(): flag
' Flag indicating PLL is locked
' Returns: TRUE (-1) if locked, FALSE otherwise
readreg(core.FSCAL1, 1, @flag)
return (flag <> $3F)
PUB preamble_len(len=-2): curr_len
' Set number of preamble bytes
' Valid values: 2, 3, *4, 6, 8, 12, 16, 24
' Any other value polls the chip and returns the current setting
curr_len := 0
readreg(core.MDMCFG1, 1, @curr_len)
case len
2, 3, 4, 6, 8, 12, 16, 24:
len := (lookdownz(len: 2, 3, 4, 6, 8, 12, 16, 24)) << core.NUM_PREAMBLE
other:
curr_len := (curr_len >> core.NUM_PREAMBLE) & core.NUM_PREAMBLE_BITS
return lookupz(curr_len: 2, 3, 4, 6, 8, 12, 16, 24)
len := ((curr_len & core.NUM_PREAMBLE_MASK) | len)
writereg(core.MDMCFG1, 1, @len)
PUB preamble_quality_thresh(thresh=-2): curr_thr
' Set Preamble quality estimator threshold
' Valid values: *0, 4, 8, 12, 16, 20, 24, 28
' NOTE: If 0, the sync word is always accepted.
' Any other value polls the chip and returns the current setting
curr_thr := 0
readreg(core.PKTCTRL1, 1, @curr_thr)
case thresh
0, 4, 8, 12, 16, 20, 24, 28:
thresh := lookdownz(thresh: 0, 4, 8, 12, 16, 20, 24, 28) << core.PQT
other:
curr_thr := ((curr_thr >> core.PQT) & core.PQT_BITS)
return lookupz(curr_thr: 0, 4, 8, 12, 16, 20, 24, 28)
thresh := ((curr_thr & core.PQT_MASK) | thresh) & core.PKTCTRL1_MASK
writereg(core.PKTCTRL1, 1, @thresh)
PUB reset()
' Reset the chip
writereg(core.CS_SRES, 0, 0)
waitms(5)
PUB rssi(): level
' Received Signal Strength Indicator
' Returns: Signal strength seen by transceiver, in dBm
level := 0
readreg(core.RSSI, 1, @level)
level := ((level signx 7) / 2) - 74
PUB rx_bandwidth = rx_bw
PUB rx_bw(width=-2): curr_wid
' Set receiver channel filter bandwidth, in kHz
' Valid values: 812, 650, 541, 464, 406, 325, 270, 232, 203, 162, 135, 116, 102, 81, 68, 58
' (default: 203)
' Any other value polls the chip and returns the current setting
curr_wid := 0
readreg(core.MDMCFG4, 1, @curr_wid)
case width
812, 650, 541, 464, 406, 325, 270, 232, 203, 162, 135, 116, 102, 81, 68, 58:
width := (lookdown(width: 812, 650, 541, 464, 406, 325, 270, 232,{
} 203, 162, 135, 116, 102, 81, 68, 58)-1) << core.CHANBW
other:
curr_wid := ((curr_wid >> core.CHANBW) & core.CHANBW_BITS)+1
return lookup(curr_wid: 812, 650, 541, 464, 406, 325, 270, 232, 203,{
} 162, 135, 116, 102, 81, 68, 58)
width := ((curr_wid & core.CHANBW_MASK) | width)
writereg(core.MDMCFG4, 1, @width)
PUB rx_fifo_thresh(thresh=-2): curr_thr
' Set receive FIFO thresh, in bytes
' The threshold is exceeded when the number of bytes in the FIFO is greater
' than or equal to this value.
' Valid values: 4, 8, 12, 16, 20, 24, 28, 32, 36, 40, 44, 48, 52, 56, 60, 64 (default: 32)
' Any other value polls the chip and returns the current setting
' NOTE: This affects the TX FIFO, inversely
curr_thr := 0
readreg(core.FIFOTHR, 1, @curr_thr)
case thresh
4..64:
thresh := (thresh / 4) - 1
other:
return ((curr_thr & core.FIFO_THR_BITS) + 1) * 4
thresh := ((curr_thr & core.FIFO_THR_MASK) | thresh) & core.FIFOTHR_MASK
writereg(core.FIFOTHR, 1, @thresh)
PUB rx_mode()
' Change chip state to RX (receive)
writereg(core.CS_SRX, 0, 0)
PUB rx_payld(nr_bytes, ptr_buff)
' Read data queued in the RX FIFO
' nr_bytes Valid values: 1..64
' Any other value is ignored
' NOTE: Ensure buffer at address ptr_buff is at least as big as the number of bytes you're reading
readreg(core.FIFO, nr_bytes, ptr_buff)
PUB sleep()
' Power down chip
writereg(core.CS_SPWD, 0, 0)
PUB state(): curr_state
' Read state-machine register
curr_state := 0
readreg(core.MARCSTATE, 1, @curr_state)
PUB syncwd_mode(mode=-2): curr_mode
' Set sync-word qualifier mode
' Valid values:
' SYNCMODE_NONE (0): Ignore preamble, syncword and carrier level
' SYNCMODE_1516 (1): 15 of 16 syncword bits must match
' *SYNCMODE_1616 (2): 16 of 16 syncword bits must match
' SYNCMODE_3032 (3): 30 of 32 syncword bits must match
' SYNCMODE_CS_ONLY (4): Ignore preamble and syncword,
' but carrier must be above threshold
' SYNCMODE_1516_CS (5): 15 of 16 syncword bits must match,
' and carrier must be above threshold
' SYNCMODE_1616_CS (6): 16 of 16 syncword bits must match,
' and carrier must be above threshold
' SYNCMODE_3032_CS (7): 30 of 32 syncword bits must match,
' and carrier must be above threshold
' Any other value polls the chip and returns the current setting
' NOTE: A 32-bit syncword can be emulated by setting this method to
' SYNCMODE_3032 or SYNCMODE_3032_CS. In these cases, the syncword
' specified by syncwd() will be transmitted twice.
curr_mode := 0
readreg(core.MDMCFG2, 1, @curr_mode)
case mode
0..7:
other:
return curr_mode & core.SYNC_MODE_BITS
mode := ((curr_mode & core.SYNC_MODE_MASK) | mode) & core.MDMCFG2_MASK
writereg(core.MDMCFG2, 1, @mode)
PUB set_syncwd(synptr_cwd=-2)
' Set transmitted (TX) or expected (RX) syncword
' ptr_syncwd: pointer to syncword data
' Valid values: $0000..$FFFF (default: $D391)
writereg(core.SYNC1, 2, ptr_syncwd)
PUB syncwd(ptr_syncwd)
' Get current syncword
' ptr_syncwd: pointer to copy syncword data to
readreg(core.SYNC1, 2, ptr_syncwd)
PUB tx_mode()
' Change chip state to TX (transmit)
writereg(core.CS_STX, 0, 0)
PUB tx_payld(nr_bytes, ptr_buff)
' Queue data to transmit in the TX FIFO
' nr_bytes Valid values: 1..64
' Any other value is ignored