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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
|
#ifndef TYT_CODEPLUG_HH
#define TYT_CODEPLUG_HH
#include <QDateTime>
#include "codeplug.hh"
#include "signaling.hh"
#include "channel.hh"
#include "contact.hh"
#include "tyt_extensions.hh"
class DMRContact;
class Zone;
class RXGroupList;
class ScanList;
class GPSSystem;
class SMSExtension;
class SMSTemplate;
/** Base class of all TyT codeplugs. This class implements the majority of all codeplug elements
* present in all TyT codeplugs. This eases the support of several TyT radios, as only the
* differences in the codeplug to this base class must be implemented.
*
* @ingroup tyt */
class TyTCodeplug : public Codeplug
{
Q_OBJECT
public:
/** Represents a single channel (analog or digital) within the TyT codeplug.
*
* Memory layout of encoded channel:
* @verbinclude tyt_channel.txt */
class ChannelElement: public Codeplug::Element
{
public:
/** Possible modes for the channel, i.e. analog and digital. */
enum Mode {
MODE_ANALOG = 1, ///< Analog channel.
MODE_DIGITAL = 2 ///< Digital channel.
};
/** Bandwidth of the channel. */
enum Bandwidth {
BW_12_5_KHZ = 0, ///< 12.5 kHz narrow, (default for binary channels).
BW_20_KHZ = 1, ///< 20 kHz (really?)
BW_25_KHZ = 2 ///< 25kHz wide.
};
/** Possible privacy types. */
enum PrivacyType {
PRIV_NONE = 0, ///< No privacy.
PRIV_BASIC = 1, ///< Basic privacy.
PRIV_ENHANCED = 2 ///< Enhanced privacy.
};
/** TX Admit criterion. */
enum Admit {
ADMIT_ALWAYS = 0, ///< Always allow TX.
ADMIT_CH_FREE = 1, ///< Allow TX if channel is free.
ADMIT_TONE = 2, ///< Allow TX if CTCSS tone matches.
ADMIT_COLOR = 3, ///< Allow TX if color-code matches.
};
protected:
/** Constructs a channel from the given memory. */
ChannelElement(uint8_t *ptr, size_t size);
public:
/** Constructs a channel from the given memory. */
ChannelElement(uint8_t *ptr);
/** Destructor. */
virtual ~ChannelElement();
/** Returns @c true if channel is valid/enabled. */
bool isValid() const;
/** Clears/resets the channel and therefore disables it. */
void clear();
/** Returns the size of the element. */
static constexpr unsigned int size() { return 0x0040; }
/** Returns the mode of the channel. */
virtual Mode mode() const;
/** Sets the mode of the channel. */
virtual void setMode(Mode setMode);
/** Returns the bandwidth of the (analog) channel. */
virtual FMChannel::Bandwidth bandwidth() const;
/** Sets the bandwidth of the (analog) channel. */
virtual void setBandwidth(FMChannel::Bandwidth bw);
/** Returns @c true if the channel has auto scan enabled. */
virtual bool autoScan() const;
/** Enables/disables auto scan for this channel. */
virtual void enableAutoScan(bool enable);
/** Returns @c true if the channel has lone worker enabled. */
virtual bool loneWorker() const;
/** Enables/disables lone worker for this channel. */
virtual void enableLoneWorker(bool enable);
/** Returns @c true if the channel has talkaround enabled. */
virtual bool talkaround() const;
/** Enables/disables talkaround for this channel. */
virtual void enableTalkaround(bool enable);
/** Returns @c true if the channel has rx only enabled. */
virtual bool rxOnly() const;
/** Enables/disables rx only for this channel. */
virtual void enableRXOnly(bool enable);
/** Returns the time slot of this channel. */
virtual DMRChannel::TimeSlot timeSlot() const;
/** Sets the time slot of this channel. */
virtual void setTimeSlot(DMRChannel::TimeSlot ts);
/** Returns the color code of this channel. */
virtual uint8_t colorCode() const;
/** Sets the color code of this channel. */
virtual void setColorCode(uint8_t ts);
/** Returns the index of the privacy system (key). */
virtual uint8_t privacyIndex() const;
/** Sets the index of the privacy system (key). */
virtual void setPrivacyIndex(uint8_t ts);
/** Returns the type of the privacy system. */
virtual PrivacyType privacyType() const;
/** Sets the type of the privacy system. */
virtual void setPrivacyType(PrivacyType type);
/** Returns @c true if the channel has private call confirmation enabled. */
virtual bool privateCallConfirm() const;
/** Enables/disables private call confirmation for this channel. */
virtual void enablePrivateCallConfirm(bool enable);
/** Returns @c true if the channel has data call confirmation enabled. */
virtual bool dataCallConfirm() const;
/** Enables/disables data call confirmation for this channel. */
virtual void enableDataCallConfirm(bool enable);
/** Returns some weird reference frequency setting for reception. */
virtual TyTChannelExtension::RefFrequency rxRefFrequency() const;
/** Sets some weird reference frequency setting for reception. */
virtual void setRXRefFrequency(TyTChannelExtension::RefFrequency ref);
/** Returns some weird reference frequency setting for transmission. */
virtual TyTChannelExtension::RefFrequency txRefFrequency() const;
/** Sets some weird reference frequency setting for transmission. */
virtual void setTXRefFrequency(TyTChannelExtension::RefFrequency ref);
/** Returns @c true if the channel has alarm confirmation enabled. */
virtual bool emergencyAlarmACK() const;
/** Enables/disables alarm confirmation for this channel. */
virtual void enableEmergencyAlarmACK(bool enable);
/** Returns @c true if the channel has display PTT ID enabled. */
virtual bool displayPTTId() const;
/** Enables/disables PTT ID display for this channel. */
virtual void enableDisplayPTTId(bool enable);
/** Returns @c true if the channel has VOX enabled. */
virtual bool vox() const;
/** Enables/disables VOX for this channel. */
virtual void enableVOX(bool enable);
/** Returns the admit criterion for this channel. */
virtual Admit admitCriterion() const;
/** Sets the admit criterion for this channel. */
virtual void setAdmitCriterion(Admit admit);
/** Returns the transmit contact index (+1) for this channel. */
virtual uint16_t contactIndex() const;
/** Sets the transmit contact index (+1) for this channel. */
virtual void setContactIndex(uint16_t idx);
/** Returns @c true, if the transmit time out is disabled. */
virtual bool txTimeOutDisabled() const;
/** Returns the transmit time-out in seconds. */
virtual Interval txTimeOut() const;
/** Sets the transmit time-out in seconds. */
virtual void setTXTimeOut(const Interval &tot);
/** Disables the transmit timeout. */
virtual void resetTXTimeOut();
/** Returns the transmit time-out re-key delay in seconds. */
virtual uint8_t txTimeOutRekeyDelay() const;
/** Sets the transmit time-out re-key delay in seconds. */
virtual void setTXTimeOutRekeyDelay(uint8_t delay);
/** Returns the emergency system index (+1) for this channel. */
virtual uint8_t emergencySystemIndex() const;
/** Sets the emergency system index (+1) for this channel. */
virtual void setEmergencySystemIndex(uint8_t idx);
/** Returns the scan-list index (+1) for this channel. */
virtual uint8_t scanListIndex() const;
/** Sets the scan-list index (+1) for this channel. */
virtual void setScanListIndex(uint8_t idx);
/** Returns the RX group list index (+1) for this channel. */
virtual uint8_t groupListIndex() const;
/** Sets the RX group list index (+1) for this channel. */
virtual void setGroupListIndex(uint8_t idx);
/** Returns the positioning system index (+1) for this channel. */
virtual uint8_t positioningSystemIndex() const;
/** Sets the positioning system index (+1) for this channel. */
virtual void setPositioningSystemIndex(uint8_t idx);
/** Returns @c true if the channel has DTMF decoding enabled. */
virtual bool dtmfDecode(uint8_t idx) const;
/** Enables/disables DTMF decoding this channel. */
virtual void setDTMFDecode(uint8_t idx, bool enable);
/** Returns the RX frequency in Hz. */
virtual Frequency rxFrequency() const;
/** Sets the RX frequency in Hz. */
virtual void setRXFrequency(const Frequency &Hz);
/** Returns the TX frequency in Hz. */
virtual Frequency txFrequency() const;
/** Sets the TX frequency in Hz. */
virtual void setTXFrequency(const Frequency &Hz);
/** Returns the CTCSS/DSC signaling for RX. */
virtual SelectiveCall rxSignaling() const;
/** Sets the CTCSS/DSC signaling for RX. */
virtual void setRXSignaling(const SelectiveCall &code);
/** Returns the CTCSS/DSC signaling for TX. */
virtual SelectiveCall txSignaling() const;
/** Sets the CTCSS/DSC signaling for TX. */
virtual void setTXSignaling(const SelectiveCall &code);
/** Returns the signaling system index (+1) for RX. */
virtual uint8_t rxSignalingSystemIndex() const;
/** Sets the signaling system index (+1) for RX. */
virtual void setRXSignalingSystemIndex(uint8_t idx);
/** Returns the signaling system index (+1) for TX. */
virtual uint8_t txSignalingSystemIndex() const;
/** Sets the signaling system index (+1) for TX. */
virtual void setTXSignalingSystemIndex(uint8_t idx);
/** Returns @c true if the channel transmits GPS information enabled. */
virtual bool txGPSInfo() const;
/** Enables/disables transmission of GPS information for this channel. */
virtual void enableTXGPSInfo(bool enable);
/** Returns @c true if the channel receives GPS information enabled. */
virtual bool rxGPSInfo() const;
/** Enables/disables reception of GPS information for this channel. */
virtual void enableRXGPSInfo(bool enable);
/** Returns the name of this channel. */
virtual QString name() const;
/** Sets the name of this channel. */
virtual void setName(const QString &setName);
/** Constructs a generic @c Channel object from the codeplug channel. */
virtual Channel *toChannelObj(const ErrorStack &err=ErrorStack()) const;
/** Links a previously constructed channel to the rest of the configuration. */
virtual bool linkChannelObj(Channel *c, Context &ctx, const ErrorStack &err=ErrorStack()) const;
/** Initializes this codeplug channel from the given generic configuration. */
virtual void fromChannelObj(const Channel *c, Context &ctx);
public:
/** Some limits of the element. */
struct Limit: public Element::Limit {
/** Maximum length of the name. */
static constexpr unsigned int nameLength() { return 16; }
};
protected:
/** Some internal offsets within the element. */
struct Offset: public Element::Offset {
/// @cond DO_NOT_DOCUMENT
static constexpr Offset::Bit mode() { return {0x0000, 0}; }
static constexpr Offset::Bit bandwidth() { return {0x0000, 2}; }
static constexpr Offset::Bit autoscan() { return {0x0000, 4}; }
static constexpr Offset::Bit loneworker() { return {0x0000, 8}; }
static constexpr Offset::Bit talkaround() { return {0x0001, 0}; }
static constexpr Offset::Bit rxonly() { return {0x0001, 1}; }
static constexpr Offset::Bit timeslot() { return {0x0001, 2}; }
static constexpr Offset::Bit colorcode() { return {0x0001, 4}; }
static constexpr Offset::Bit privacyIndex() { return {0x0002, 0}; }
static constexpr Offset::Bit privacyType() { return {0x0002, 4}; }
static constexpr Offset::Bit privateCallConfirm() { return {0x0002, 6}; }
static constexpr Offset::Bit dataCallConfirm() { return {0x0002, 7}; }
static constexpr Offset::Bit rxRefFrequency() { return {0x0003, 0}; }
static constexpr Offset::Bit emergencyAlarmACK() { return {0x0003, 3}; }
static constexpr Offset::Bit displayPTTId() { return {0x0003, 7}; }
static constexpr Offset::Bit txRefFrequency() { return {0x0004, 0}; }
static constexpr Offset::Bit vox() { return {0x0004, 4}; }
static constexpr Offset::Bit admitCriterion() { return {0x0004, 6}; }
static constexpr unsigned int contactIndex() { return 0x0006; }
static constexpr Offset::Bit txTimeOut() { return {0x0008, 0}; }
static constexpr unsigned int txTimeOutRekeyDelay() { return 0x0009; }
static constexpr unsigned int emergencySystemIndex() { return 0x000a; }
static constexpr unsigned int scanListIndex() { return 0x000b; }
static constexpr unsigned int groupListIndex() { return 0x000c; }
static constexpr unsigned int positioningSystemIndex() { return 0x000d; }
static constexpr unsigned int dtmfDecode() { return 0x000e; }
static constexpr unsigned int rxFrequency() { return 0x0010; }
static constexpr unsigned int txFrequency() { return 0x0014; }
static constexpr unsigned int rxSignaling() { return 0x018; }
static constexpr unsigned int txSignaling() { return 0x01a; }
static constexpr unsigned int rxSignalingSystemIndex() { return 0x01c; }
static constexpr unsigned int txSignalingSystemIndex() { return 0x01d; }
static constexpr Offset::Bit txGPSInfo() { return {0x001f, 0}; }
static constexpr Offset::Bit rxGPSInfo() { return {0x001f, 1}; }
static constexpr unsigned int name() { return 0x0020; }
/// @endcond
};
};
/** Represents a digital (DMR) contact within the codeplug.
*
* Memory layout of encoded contact:
* @verbinclude tyt_contact.txt */
class ContactElement: public Codeplug::Element
{
protected:
/** Constructor. */
ContactElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
ContactElement(uint8_t *ptr);
/** Destructor. */
virtual ~ContactElement();
void clear();
bool isValid() const;
/** Returns the DMR ID of the contact. */
virtual uint32_t dmrId() const;
/** Sets the DMR ID of the contact. */
virtual void setDMRId(uint32_t id);
/** Returns the call-type of the contact. */
virtual DMRContact::Type callType() const;
/** Sets the call-type of the contact. */
virtual void setCallType(DMRContact::Type type);
/** Returns @c true if the ring-tone is enabled for this contact. */
virtual bool ringTone() const;
/** Enables/disables the ring-tone for this contact. */
virtual void enableRingTone(bool enable);
/** Returns the name of the contact. */
virtual QString name() const;
/** Sets the name of the contact. */
virtual void setName(const QString &nm);
/** Encodes the give contact. */
virtual bool fromContactObj(const DMRContact *contact);
/** Creates a contact. */
virtual DMRContact *toContactObj() const;
};
/** Represents a zone within the codeplug.
* Please note that a zone consists of two elements the @c ZoneElement and the @c ZoneExtElement.
* The latter adds additional channels for VFO A and the channels for VFO B.
*
* Memory layout of encoded zone:
* @verbinclude tyt_zone.txt */
class ZoneElement: public Codeplug::Element
{
protected:
/** Constructor. */
ZoneElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
ZoneElement(uint8_t *ptr);
/** Desturctor. */
virtual ~ZoneElement();
void clear();
bool isValid() const;
/** Returns the name of the zone. */
virtual QString name() const;
/** Sets the name of the zone. */
virtual void setName(const QString &setName);
/** Returns the index (+1) of the @c n-th member. */
virtual uint16_t memberIndex(unsigned n) const;
/** Sets the index (+1) of the @c n-th member. */
virtual void setMemberIndex(unsigned n, uint16_t idx);
/** Encodes a given zone object. */
virtual bool fromZoneObj(const Zone *zone, Context &ctx);
/** Creates a zone. */
virtual Zone *toZoneObj() const;
/** Links the created zone to channels. */
virtual bool linkZone(Zone *zone, Context &ctx) const;
};
/** Representation of an RX group list within the codeplug.
*
* Memory layout of encoded RX group list:
* @verbinclude tyt_grouplist.txt */
class GroupListElement: public Codeplug::Element
{
protected:
/** Constructor. */
GroupListElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
GroupListElement(uint8_t *ptr);
/** Destructor. */
virtual ~GroupListElement();
void clear();
bool isValid() const;
/** Returns the name of the group list. */
virtual QString name() const;
/** Sets the name of the group list. */
virtual void setName(const QString &nm);
/** Returns the n-th member index. */
virtual uint16_t memberIndex(unsigned n) const;
/** Sets the n-th member index. */
virtual void setMemberIndex(unsigned n, uint16_t idx);
/** Encodes the given group list. */
virtual bool fromGroupListObj(const RXGroupList *lst, Context &ctx);
/** Creates a group list object. */
virtual RXGroupList *toGroupListObj(Context &ctx);
/** Links the given group list. */
virtual bool linkGroupListObj(RXGroupList *lst, Context &ctx);
};
/** Represents a scan list within the codeplug.
*
* Memory layout of encoded scan list (0x0068 bytes):
* @verbinclude tyt_scanlist.txt */
class ScanListElement: public Codeplug::Element
{
protected:
/** Constructor. */
ScanListElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
ScanListElement(uint8_t *ptr);
/** Destructor. */
virtual ~ScanListElement();
bool isValid() const;
void clear();
/** Returns the name of the scan list. */
virtual QString name() const;
/** Sets the name of the scan list. */
virtual void setName(const QString &nm);
/** Returns the index (+1) of the first priority channel. */
virtual uint16_t priorityChannel1Index() const;
/** Set the index (+1) of the first priority channel. */
virtual void setPriorityChannel1Index(uint16_t idx);
/** Returns the index (+1) of the second priority channel. */
virtual uint16_t priorityChannel2Index() const;
/** Set the index (+1) of the second priority channel. */
virtual void setPriorityChannel2Index(uint16_t idx);
/** Returns the index (+1) of the TX channel. 0=current, 0xffff=none. */
virtual uint16_t txChannelIndex() const;
/** Sets the index (+1) of the TX channel. 0=current, 0xffff=none. */
virtual void setTXChannelIndex(uint16_t idx);
/** Returns the hold time in ms. */
virtual unsigned holdTime() const;
/** Sets the hold time in ms. */
virtual void setHoldTime(unsigned time);
/** Returns the priority sample time in ms. */
virtual unsigned prioritySampleTime() const;
/** Sets the priority sample time in ms. */
virtual void setPrioritySampleTime(unsigned time);
/** Returns the n-th member index. */
virtual uint16_t memberIndex(unsigned n) const;
/** Sets the n-th member index. */
virtual void setMemberIndex(unsigned n, uint16_t idx);
/** Encodes the given scan list. */
virtual bool fromScanListObj(const ScanList *lst, Context &ctx);
/** Creates a scan list. */
virtual ScanList *toScanListObj(Context &ctx);
/** Links the scan list object. */
virtual bool linkScanListObj(ScanList *lst, Context &ctx, const ErrorStack &err=ErrorStack());
};
/** Codeplug representation of the general settings.
*
* Memory layout of encoded settings:
* @verbinclude tyt_settings.txt */
class GeneralSettingsElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
GeneralSettingsElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit GeneralSettingsElement(uint8_t *ptr);
/** Destructor. */
virtual ~GeneralSettingsElement();
void clear();
/** Returns the first intro line. */
virtual QString introLine1() const;
/** Sets the first intro line. */
virtual void setIntroLine1(const QString line);
/** Returns the second intro line. */
virtual QString introLine2() const;
/** Sets the second intro line. */
virtual void setIntroLine2(const QString line);
/** Returns the monitor type. */
virtual TyTSettingsExtension::MonitorType monitorType() const;
/** Sets the monitor type. */
virtual void setMonitorType(TyTSettingsExtension::MonitorType type);
/** Returns @c true if all LEDs are disabled. */
virtual bool allLEDsDisabled() const;
/** Enables/disables all LEDs. */
virtual void disableAllLEDs(bool disable);
/** Returns @c true, if save preamble is enabled. */
virtual bool savePreamble() const;
/** Enables/disables save preamble. */
virtual void setSavePreamble(bool enable);
/** Returns @c true, if save RX mode is enabled. */
virtual bool saveModeRX() const;
/** Enables/disables save mode RX. */
virtual void setSaveModeRX(bool enable);
/** Returns @c true, if all tones are disabled. */
virtual bool allTonesDisabled() const;
/** Enables/disables all tones. */
virtual void disableAllTones(bool disable);
/** Returns @c true, if the channel free indication tone is enabled. */
virtual bool chFreeIndicationTone() const;
/** Enables/disables the channel free indication tone. */
virtual void setChFreeIndicationTone(bool enable);
/** Returns @c true, if password and lock is enabled. */
virtual bool passwdAndLock() const;
/** Enables/disables password and lock. */
virtual void enablePasswdAndLock(bool enable);
/** Returns @c true, if the talk permit tone is enabled for DMR channels. */
virtual bool talkPermitToneDigital() const;
/** Enables/disables talk permit tone for DMR channels. */
virtual void enableTalkPermitToneDigital(bool enable);
/** Returns @c true, if the talk permit tone is enabled for analog channels. */
virtual bool talkPermitToneAnalog() const;
/** Enables/disables talk permit tone for analog channels. */
virtual void enableTalkPermitToneAnalog(bool enable);
/** Returns @c true, if intro picture is enabled. */
virtual bool introPicture() const;
/** Enables/disables the intro picture. */
virtual void enableIntroPicture(bool enable);
/** Returns the default DMR ID of the radio. */
virtual uint32_t dmrId() const;
/** Sets the default DMR ID of the radio. */
virtual void setDMRId(uint32_t id);
/** Returns the TX preamble duration. */
virtual unsigned txPreambleDuration() const;
/** Sets the TX preamble duration. */
virtual void setTXPreambleDuration(unsigned ms);
/** Returns the group call hang time. */
virtual unsigned groupCallHangTime() const;
/** Sets the group call hang time. */
virtual void setGroupCallHangTime(unsigned ms);
/** Returns the private call hang time. */
virtual unsigned privateCallHangTime() const;
/** Sets the private call hang time. */
virtual void setPrivateCallHangTime(unsigned ms);
/** Returns the VOX sensitivity. */
virtual unsigned voxSesitivity() const;
/** Sets the group call hang time. */
virtual void setVOXSesitivity(unsigned ms);
/** Returns the low-battery warning interval. */
virtual unsigned lowBatteryInterval() const;
/** Sets the low-battery warning interval. */
virtual void setLowBatteryInterval(unsigned sec);
/** Returns @c true if the call-alert is continuous. */
virtual bool callAlertToneIsContinuous() const;
/** Returns the call-alert tone duration. */
virtual unsigned callAlertToneDuration() const;
/** Sets the call-alert tone duration. */
virtual void setCallAlertToneDuration(unsigned sec);
/** Sets the call-alert tone continuous. */
virtual void setCallAlertToneContinuous();
/** Returns the lone-worker response time. */
virtual unsigned loneWorkerResponseTime() const;
/** Sets the lone-worker response time. */
virtual void setLoneWorkerResponseTime(unsigned min);
/** Returns the lone-worker reminder time. */
virtual unsigned loneWorkerReminderTime() const;
/** Sets the lone-worker reminder time. */
virtual void setLoneWorkerReminderTime(unsigned min);
/** Returns the scan digital hang time. */
virtual unsigned scanDigitalHangTime() const;
/** Sets the scan digital hang time. */
virtual void setScanDigitalHangTime(unsigned ms);
/** Returns the scan analog hang time. */
virtual unsigned scanAnalogHangTime() const;
/** Sets the scan analog hang time. */
virtual void setScanAnalogHangTime(unsigned ms);
/** Returns @c true if the backlight is always on. */
virtual bool backlightIsAlways() const;
/** Returns the backlight time. */
virtual unsigned backlightTime() const;
/** Sets the backlight time. */
virtual void setBacklightTime(unsigned sec);
/** Turns the backlight always on. */
virtual void backlightTimeSetAlways();
/** Returns @c true if the keypad lock is manual. */
virtual bool keypadLockIsManual() const;
/** Returns the keypad lock time. */
virtual unsigned keypadLockTime() const;
/** Sets the keypad lock time. */
virtual void setKeypadLockTime(unsigned sec);
/** Set keypad lock to manual. */
virtual void keypadLockTimeSetManual();
/** Returns the 8-digit power-on password. */
virtual uint32_t powerOnPassword() const;
/** Sets the 8-digit power-on password. */
virtual void setPowerOnPassword(uint32_t passwd);
/** Returns @c true, if the radio programming password is enabled. */
virtual bool radioProgPasswordEnabled() const;
/** Returns the 8-digit radio programming password. */
virtual uint32_t radioProgPassword() const;
/** Sets the 8-digit radio programming password. */
virtual void setRadioProgPassword(uint32_t passwd);
/** Disables the radio programming password. */
virtual void radioProgPasswordDisable();
/** Returns @c true, if the PC programming password is enabled. */
virtual bool pcProgPasswordEnabled() const;
/** Returns the PC programming password. */
virtual QString pcProgPassword() const;
/** Sets the PC programming password. */
virtual void setPCProgPassword(const QString &pass);
/** Disables the PC programming password. */
virtual void pcProgPasswordDisable();
/** Returns the radio name. */
virtual QString radioName() const;
/** Sets the radio name. */
virtual void setRadioName(const QString &name);
/** Encodes the general settings. */
virtual bool fromConfig(const Config *config);
/** Updates config from general settings. */
virtual bool updateConfig(Config *config);
};
/** Codeplug representation of programming time-stamp and CPS version.
*
* Memory layout of encoded timestamp:
* @verbinclude tyt_timestamp.txt */
class TimestampElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
TimestampElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit TimestampElement(uint8_t *ptr);
/** Destructor. */
virtual ~TimestampElement();
void clear();
/** Returns the time stamp. */
virtual QDateTime timestamp() const;
/** Sets the time stamp. */
virtual void setTimestamp(const QDateTime &ts);
/** Returns the CPS version. */
virtual QString cpsVersion() const;
};
/** Represents a single GPS system within the codeplug.
*
* Memory layout of encoded GPS system (size 0x0010 bytes):
* @verbinclude tyt_gpssystem.txt */
class GPSSystemElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
GPSSystemElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit GPSSystemElement(uint8_t *ptr);
/** Destructor. */
virtual ~GPSSystemElement();
bool isValid() const;
void clear();
/** Returns @c true if the revert channel is the current one. */
virtual bool revertChannelIsSelected() const;
/** Returns the revert channel index (+1). */
virtual uint16_t revertChannelIndex() const;
/** Sets the revert channel index (+1). */
virtual void setRevertChannelIndex(uint16_t idx);
/** Sets the revert channel to the current one. */
virtual void setRevertChannelSelected();
/** Returns @c true if the repeat interval is disabled. */
virtual bool repeatIntervalDisabled() const;
/** Returns the repeat interval. */
virtual unsigned repeatInterval() const;
/** Sets the repeat interval in seconds. */
virtual void setRepeatInterval(unsigned sec);
/** Disables the GPS repeat interval. */
virtual void disableRepeatInterval();
/** Returns @c true if the destination contact is disabled. */
virtual bool destinationContactDisabled() const;
/** Returns the destination contact index (+1). */
virtual uint16_t destinationContactIndex() const;
/** Sets the destination contact index (+1). */
virtual void setDestinationContactIndex(uint16_t idx);
/** Disables the destination contact. */
virtual void disableDestinationContact();
/** Encodes the given GPS system. */
virtual bool fromGPSSystemObj(GPSSystem *sys, Context &ctx);
/** Constructs a GPS system. */
virtual GPSSystem *toGPSSystemObj();
/** Links the given GPS system. */
virtual bool linkGPSSystemObj(GPSSystem *sys, Context &ctx);
};
/** Represents all menu settings within the codeplug on the radio.
*
* Memory representation of the menu settings:
* @verbinclude tyt_menusettings.txt */
class MenuSettingsElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
MenuSettingsElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit MenuSettingsElement(uint8_t *ptr);
/** Destructor. */
virtual ~MenuSettingsElement();
void clear();
/** Returns @c true if the menu hang time is infinite. */
virtual bool menuHangtimeIsInfinite() const;
/** Returns the menu hang time in seconds. */
virtual unsigned menuHangtime() const;
/** Sets the menu hang time in seconds. */
virtual void setMenuHangtime(unsigned sec);
/** Sets the menu hang time to be infinite. */
virtual void infiniteMenuHangtime();
/** Returns @c true if text message menu is enabled. */
virtual bool textMessage() const;
/** Enables/disables text message menu. */
virtual void enableTextMessage(bool enable);
/** Returns @c true if call alert menu is enabled. */
virtual bool callAlert() const;
/** Enables/disables call alert menu. */
virtual void enableCallAlert(bool enable);
/** Returns @c true if contact editing is enabled. */
virtual bool contactEditing() const;
/** Enables/disables contact editing. */
virtual void enableContactEditing(bool enable);
/** Returns @c true if manual dial is enabled. */
virtual bool manualDial() const;
/** Enables/disables manual dial. */
virtual void enableManualDial(bool enable);
/** Returns @c true if contact radio-check menu is enabled. */
virtual bool remoteRadioCheck() const;
/** Enables/disables contact radio-check menu. */
virtual void enableRemoteRadioCheck(bool enable);
/** Returns @c true if remote monitor menu is enabled. */
virtual bool remoteMonitor() const;
/** Enables/disables remote monitor menu. */
virtual void enableRemoteMonitor(bool enable);
/** Returns @c true if radio enable menu is enabled. */
virtual bool remoteRadioEnable() const;
/** Enables/disables radio enable menu. */
virtual void enableRemoteRadioEnable(bool enable);
/** Returns @c true if radio disable menu is enabled. */
virtual bool remoteRadioDisable() const;
/** Enables/disables radio disable menu. */
virtual void enableRemoteRadioDisable(bool enable);
/** Returns @c true if scan menu is enabled. */
virtual bool scan() const;
/** Enables/disables scan menu. */
virtual void enableScan(bool enable);
/** Returns @c true if edit scan-list menu is enabled. */
virtual bool scanListEditing() const;
/** Enables/disables edit scan-list menu. */
virtual void enableScanListEditing(bool enable);
/** Returns @c true if call-log missed menu is enabled. */
virtual bool callLogMissed() const;
/** Enables/disables call-log missed menu. */
virtual void enableCallLogMissed(bool enable);
/** Returns @c true if call-log answered menu is enabled. */
virtual bool callLogAnswered() const;
/** Enables/disables call-log answered menu. */
virtual void enableCallLogAnswered(bool enable);
/** Returns @c true if call-log outgoing menu is enabled. */
virtual bool callLogOutgoing() const;
/** Enables/disables call-log outgoing menu. */
virtual void enableCallLogOutgoing(bool enable);
/** Returns @c true if talkaround menu is enabled. */
virtual bool talkaround() const;
/** Enables/disables talkaround menu. */
virtual void enableTalkaround(bool enable);
/** Returns @c true if tone/alert menu is enabled. */
virtual bool alertTone() const;
/** Enables/disables tone/alert menu. */
virtual void enableAlertTone(bool enable);
/** Returns @c true if power menu is enabled. */
virtual bool power() const;
/** Enables/disables power menu. */
virtual void enablePower(bool enable);
/** Returns @c true if backlight menu is enabled. */
virtual bool backlight() const;
/** Enables/disables backlight menu. */
virtual void enableBacklight(bool enable);
/** Returns @c true if intro screen menu is enabled. */
virtual bool bootScreen() const;
/** Enables/disables intro screen menu. */
virtual void enableBootScreen(bool enable);
/** Returns @c true if keypad lock menu is enabled. */
virtual bool keypadLock() const;
/** Enables/disables keypad lock menu. */
virtual void enableKeypadLock(bool enable);
/** Returns @c true if LED indicator menu is enabled. */
virtual bool ledIndicator() const;
/** Enables/disables LED indicator menu. */
virtual void enableLEDIndicator(bool enable);
/** Returns @c true if squelch menu is enabled. */
virtual bool squelch() const;
/** Enables/disables squelch menu. */
virtual void enableSquelch(bool enable);
/** Returns @c true if VOX menu is enabled. */
virtual bool vox() const;
/** Enables/disables VOX menu. */
virtual void enableVOX(bool enable);
/** Returns @c true if password menu is enabled. */
virtual bool password() const;
/** Enables/disables password menu. */
virtual void enablePassword(bool enable);
/** Returns @c true if display mode menu is enabled. */
virtual bool displayMode() const;
/** Enables/disables display mode menu. */
virtual void enableDisplayMode(bool enable);
/** Returns @c true if program radio menu is enabled. */
virtual bool radioProgramming() const;
/** Enables/disables program radio menu. */
virtual void enableRadioProgramming(bool enable);
/** Encodes the menu settings. */
virtual bool fromConfig(const Config *config);
/** Updates config from menu settings. */
virtual bool updateConfig(Config *config);
};
/** Represents all button settings within the codeplug on the radio.
*
* Memory representation of the button settings:
* @verbinclude tyt_buttonsettings.txt */
class ButtonSettingsElement: public Codeplug::Element
{
public:
/** The possible button actions. */
typedef enum TyTButtonSettings::ButtonAction ButtonAction;
protected:
/** Hidden constructor. */
ButtonSettingsElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit ButtonSettingsElement(uint8_t *ptr);
/** Destructor. */
virtual ~ButtonSettingsElement();
void clear();
/** Returns the action for a short press on side button 1. */
virtual ButtonAction sideButton1Short() const;
/** Sets the action for a short press on side button 1. */
virtual void setSideButton1Short(ButtonAction action);
/** Returns the action for a long press on side button 1. */
virtual ButtonAction sideButton1Long() const;
/** Sets the action for a short press on side button 1. */
virtual void setSideButton1Long(ButtonAction action);
/** Returns the action for a short press on side button 2. */
virtual ButtonAction sideButton2Short() const;
/** Sets the action for a short press on side button 2. */
virtual void setSideButton2Short(ButtonAction action);
/** Returns the action for a long press on side button 2. */
virtual ButtonAction sideButton2Long() const;
/** Sets the action for a short press on side button 2. */
virtual void setSideButton2Long(ButtonAction action);
/** Returns the long-press duration in ms. */
virtual unsigned longPressDuration() const;
/** Sets the long-press duration in ms. */
virtual void setLongPressDuration(unsigned ms);
/** Encodes the button settings. */
virtual bool fromConfig(const Config *config);
/** Updates config from button settings. */
virtual bool updateConfig(Config *config);
};
/** Represents a single one-touch setting within the codeplug on the radio.
*
* Memory representation of a one-touch setting:
* @verbinclude tyt_onetouchsettings.txt */
class OneTouchSettingElement: public Codeplug::Element
{
public:
/** Possible one-touch actions. */
enum Action {
CALL = 0b0000, ///< Call someone, see @c contact.
MESSAGE = 0b0001, ///< Send a message, see @c message.
DTMF1 = 0b1000, ///< Analog call DTMF system 1.
DTMF2 = 0b1001, ///< Analog call DTMF system 2.
DTMF3 = 0b1010, ///< Analog call DTMF system 3.
DTMF4 = 0b1011 ///< Analog call DTMF system 4.
};
/** Possible one-touch action types. */
enum Type {
Disabled = 0b00, ///< Disabled one-touch.
Digital = 0b01, ///< Digital call/message.
Analog = 0b10 ///< Analog call.
};
protected:
/** Hidden constructor. */
OneTouchSettingElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit OneTouchSettingElement(uint8_t *ptr);
/** Destructor. */
virtual ~OneTouchSettingElement();
bool isValid() const;
void clear();
/** Returns the action to perform. */
virtual Action action() const;
/** Sets the action to perform. */
virtual void setAction(Action action);
/** Returns the type of the action. */
virtual Type actionType() const;
/** Sets the type of the action. */
virtual void setActionType(Type action);
/** Returns the message index +1. */
virtual uint8_t messageIndex() const;
/** Sets the message index +1. */
virtual void setMessageIndex(uint8_t idx);
/** Returns the contact index +1. */
virtual uint16_t contactIndex() const;
/** Sets the contact index +1. */
virtual void setContactIndex(uint16_t idx);
};
/** Represents the emergency settings within the codeplug on the radio.
*
* Memory representation of the emergency settings (size 0x0010 bytes):
* @verbinclude tyt_emergencysettings.txt */
class EmergencySettingsElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
EmergencySettingsElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit EmergencySettingsElement(uint8_t *ptr);
/** Destructor. */
virtual ~EmergencySettingsElement();
virtual void clear();
/** Returns @c true if emergency remote monitor is enabled. */
virtual bool emergencyRemoteMonitor() const;
/** Enables/disables emergency remote monitor. */
virtual void enableEmergencyRemoteMonitor(bool enable);
/** Returns @c true if remote monitor is enabled. */
virtual bool remoteMonitor() const;
/** Enables/disables remote monitor. */
virtual void enableRemoteMonitor(bool enable);
/** Returns @c true if radio disable is enabled. */
virtual bool radioDisable() const;
/** Enables/disables radio disable. */
virtual void enableRadioDisable(bool enable);
/** Returns the remote monitor duration in seconds. */
virtual unsigned remoteMonitorDuration() const;
/** Sets the remote monitor duration in seconds. */
virtual void setRemoteMonitorDuration(unsigned sec);
/** Returns the TX time-out in ms. */
virtual unsigned txTimeOut() const;
/** Sets the TX time-out in ms. */
virtual void setTXTimeOut(unsigned ms);
/** Returns the message limit. */
virtual unsigned messageLimit() const;
/** Sets the message limit. */
virtual void setMessageLimit(unsigned limit);
};
/** Represents a single emergency system within the radio.
*
* Memory representation of emergency system (size 0x0028 bytes):
* @verbinclude tyt_emergencysystem.txt */
class EmergencySystemElement: public Codeplug::Element
{
public:
/** Possible alarm type for the system. */
enum AlarmType {
DISABLED = 0, ///< No alarm at all
REGULAR = 1, ///< Regular alarm sound.
SILENT = 2, ///< Silent alarm.
SILENT_W_VOICE = 3 ///< silent alarm with voice.
};
/** Possible alarm modes for the system. */
enum AlarmMode {
ALARM = 0, ///< Just alarm.
ALARM_W_CALL = 1, ///< Alarm + call.
ALARM_W_VOICE = 2 ///< Alarm + call + voice?
};
protected:
/** Hidden constructor. */
EmergencySystemElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit EmergencySystemElement(uint8_t *ptr);
/** Destructor. */
virtual ~EmergencySystemElement();
bool isValid() const;
void clear();
/** Returns the name of the system. */
virtual QString name() const;
/** Sets the name of the system. */
virtual void setName(const QString &name);
/** Returns the alarm type of the system. */
virtual AlarmType alarmType() const;
/** Sets the alarm type of the system. */
virtual void setAlarmType(AlarmType type);
/** Returns the alarm mode of the system. */
virtual AlarmMode alarmMode() const;
/** Sets the alarm mode of the system. */
virtual void setAlarmMode(AlarmMode mode);
/** Returns the number of impolite retries. */
virtual unsigned impoliteRetries() const;
/** Sets the number of impolite retries. */
virtual void setImpoliteRetries(unsigned num);
/** Returns the number of polite retries. */
virtual unsigned politeRetries() const;
/** Sets the number of polite retries. */
virtual void setPoliteRetries(unsigned num);
/** Returns the hot MIC duration in seconds. */
virtual unsigned hotMICDuration() const;
/** Sets the hot MIC duration in seconds. */
virtual void setHotMICDuration(unsigned sec);
/** Returns @c true if the revert channel is the selected one. */
virtual bool revertChannelIsSelected() const;
/** Returns the index of the revert channel. */
virtual uint16_t revertChannelIndex() const;
/** Sets the revert channel index. */
virtual void setRevertChannelIndex(uint16_t idx);
/** Sets revert channel to selected channel. */
virtual void revertChannelSelected();
};
/** Represents all encryption keys and settings within the codeplug on the device.
*
* Memory representation of encryption settings:
* @verbinclude tyt_privacy.txt */
class EncryptionElement: public Codeplug::Element
{
protected:
/** Hidden constructor. */
EncryptionElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
explicit EncryptionElement(uint8_t *ptr);
/** Destructor. */
virtual ~EncryptionElement();
void clear();
/** Returns the size of the element. */
static constexpr unsigned int size() { return 0x00b0; }
/** Returns @c true if the n-th "enhanced" key (128bit) is set.
* That is, if it is not filled with 0xff. */
virtual bool isEnhancedKeySet(unsigned n) const;
/** Returns the n-th "enhanced" key (128bit). */
virtual QByteArray enhancedKey(unsigned n) const;
/** Sets the n-th "enhanced" key (128bit). */
virtual void setEnhancedKey(unsigned n, const QByteArray &key);
/** Returns @c true if the n-th "basic" key (16bit) is set.
* That is, if it is not filled with 0xff. */
virtual bool isBasicKeySet(unsigned n) const;
/** Returns the n-th "basic" key (16bit). */
virtual QByteArray basicKey(unsigned n) const;
/** Sets the n-th "basic" key (16bit). */
virtual void setBasicKey(unsigned n, const QByteArray &key);
/** Encodes given commercial extension. */
virtual bool fromCommercialExt(CommercialExtension *encr, Context &ctx);
/** Updates the commercial extension. */
virtual bool updateCommercialExt(Context &ctx);
/** Links the given encryption extension. */
virtual bool linkCommercialExt(CommercialExtension *ext, Context &ctx);
public:
/** Some limits for the element. */
struct Limit {
/** Specifies the maximum number of basic (DMR) encryption keys (16bit). */
static constexpr unsigned int basicKeys() { return 16; }
/** Specifies the maximum number of advanced (AES) encryption keys (128bit). */
static constexpr unsigned int advancedKeys() { return 8; }
};
protected:
/** Some internal offsets. */
struct Offset {
/// @cond DO_NOT_DOCUMENT
static constexpr unsigned int advancedKeys() { return 0x0000; }
static constexpr unsigned int betweenAdvancedKeys() { return 0x0010; }
static constexpr unsigned int basicKeys() { return 0x0090; }
static constexpr unsigned int betweenBasicKeys() { return 0x0002; }
/// @endcond
};
};
/** Basic pre-defined SMS text message. */
class MessageElement: public Element
{
protected:
/** Hidden constructor. */
MessageElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
MessageElement(uint8_t *ptr);
/** The size of the element. */
static constexpr unsigned int size() { return 0x00120; }
void clear();
bool isValid() const;
/** Returns the text of the message. */
virtual QString text() const;
/** Sets the text of the message. */
virtual void setText(const QString &text);
/** Encodes the given SMS template. */
virtual bool encode(SMSTemplate *sms, const ErrorStack &err=ErrorStack());
/** Decodes the given SMS template. */
virtual SMSTemplate *decode(const ErrorStack &err=ErrorStack());
public:
/** Some limits. */
struct Limit {
static constexpr unsigned int length() { return 144; } ///< Maximum message length.
};
};
/** Bank of pre-defined SMS text messages. */
class MessageBankElement: public Element
{
protected:
/** Hidden constructor. */
MessageBankElement(uint8_t *ptr, size_t size);
public:
/** Constructor. */
MessageBankElement(uint8_t *ptr);
/** The size of the element. */
static constexpr unsigned int size() { return MessageElement::size()*Limit::messages(); }
void clear();
/** Returns the i-th message. */
virtual MessageElement message(unsigned int i) const;
/** Encodes all messages. */
virtual bool encode(Context &ctx, const Flags &flags, const ErrorStack &err=ErrorStack());
/** Decodes all messages. */
virtual bool decode(Context &ctx, const ErrorStack &err=ErrorStack());
public:
/** Some Limits. */
struct Limit {
/** The maximum number of messages in a bank. */
static constexpr unsigned int messages() { return 50; }
};
};
protected:
/** Empty constructor. */
explicit TyTCodeplug(QObject *parent = nullptr);
public:
/** Destructor. */
virtual ~TyTCodeplug();
/** Clears and resets the complete codeplug to some default values. */
virtual void clear();
bool index(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) const;
/** Decodes the binary codeplug and stores its content in the given generic configuration. */
bool decode(Config *config, const ErrorStack &err=ErrorStack());
/** Encodes the given generic configuration as a binary codeplug. */
bool encode(Config *config, const Flags &flags = Flags(), const ErrorStack &err=ErrorStack());
public:
/** Decodes the binary codeplug and stores its content in the given generic configuration using
* the given context. */
virtual bool decodeElements(Context &ctx, const ErrorStack &err=ErrorStack());
/** Encodes the given generic configuration as a binary codeplug using the given context. */
virtual bool encodeElements(const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack());
/** Clears the time-stamp in the codeplug. */
virtual void clearTimestamp() = 0;
/** Sets the time-stamp. */
virtual bool encodeTimestamp() = 0;
/** Clears the general settings in the codeplug. */
virtual void clearGeneralSettings() = 0;
/** Updates the general settings from the given configuration. */
virtual bool encodeGeneralSettings(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Updates the given configuration from the general settings. */
virtual bool decodeGeneralSettings(Config *config, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all contacts in the codeplug. */
virtual void clearContacts() = 0;
/** Encodes all digital contacts in the configuration into the codeplug. */
virtual bool encodeContacts(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a digital contact to the configuration for each one in the codeplug. */
virtual bool createContacts(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all RX group lists in the codeplug. */
virtual void clearGroupLists() = 0;
/** Encodes all group lists in the configuration into the codeplug. */
virtual bool encodeGroupLists(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a RX group list to the configuration for each one in the codeplug. */
virtual bool createGroupLists(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Links all added RX group lists within the configuration. */
virtual bool linkGroupLists(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all channels in the codeplug. */
virtual void clearChannels() = 0;
/** Encodes all channels in the configuration into the codeplug. */
virtual bool encodeChannels(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a channel to the configuration for each one in the codeplug. */
virtual bool createChannels(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Links all added channels within the configuration. */
virtual bool linkChannels(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all zones in the codeplug. */
virtual void clearZones() = 0;
/** Encodes all zones in the configuration into the codeplug. */
virtual bool encodeZones(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a zone to the configuration for each one in the codeplug. */
virtual bool createZones(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Links all added zones within the configuration. */
virtual bool linkZones(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all scan lists in the codeplug. */
virtual void clearScanLists() = 0;
/** Encodes all scan lists in the configuration into the codeplug. */
virtual bool encodeScanLists(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a scan list to the configuration for each one in the codeplug. */
virtual bool createScanLists(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Links all added scan lists within the configuration. */
virtual bool linkScanLists(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all positioning systems in the codeplug. */
virtual void clearPositioningSystems() = 0;
/** Encodes all DMR positioning systems in the configuration into the codeplug. */
virtual bool encodePositioningSystems(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Adds a GPS positioning system to the configuration for each one in the codeplug. */
virtual bool createPositioningSystems(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Links all added positioning systems within the configuration. */
virtual bool linkPositioningSystems(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears the button settings in the codeplug. */
virtual void clearButtonSettings() = 0;
/** Encodes the button settings. */
virtual bool encodeButtonSettings(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Decodes the button settings. */
virtual bool decodeButtonSetttings(Config *config, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all encryption keys in the codeplug. */
virtual void clearPrivacyKeys() = 0;
/** Encodes the encryption keys. */
virtual bool encodePrivacyKeys(Config *config, const Flags &flags, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Decodes the encryption keys. */
virtual bool decodePrivacyKeys(Config *config, Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears the menu settings in the codeplug. */
virtual void clearMenuSettings() = 0;
/** Clears all text messages in the codeplug. */
virtual void clearTextMessages() = 0;
/** Encodes text messages. */
virtual bool encodeTextMessages(Context &ctx, const Flags &flags, const ErrorStack &err=ErrorStack()) = 0;
/** Decodes text messages. */
virtual bool decodeTextMessages(Context &ctx, const ErrorStack &err=ErrorStack()) = 0;
/** Clears all emergency systems in the codeplug. */
virtual void clearEmergencySystems() = 0;
};
#endif // TYT_CODEPLUG_HH
|