RadioLib Universal wireless communication library for Arduino

AX25.h
1 #if !defined(_RADIOLIB_RADIOLIB_AX25_H)
2 #define _RADIOLIB_RADIOLIB_AX25_H
3
4 #include "../../TypeDef.h"
5
6 #if !defined(RADIOLIB_EXCLUDE_AX25)
7
8 #include "../PhysicalLayer/PhysicalLayer.h"
9 #include "../AFSK/AFSK.h"
10
11 // macros to access bits in byte array, from http://www.mathcs.emory.edu/~cheung/Courses/255/Syllabus/1-C-intro/bit-array.html
12 #define SET_BIT_IN_ARRAY(A, k) ( A[(k/8)] |= (1 << (k%8)) )
13 #define CLEAR_BIT_IN_ARRAY(A, k) ( A[(k/8)] &= ~(1 << (k%8)) )
14 #define TEST_BIT_IN_ARRAY(A, k) ( A[(k/8)] & (1 << (k%8)) )
15 #define GET_BIT_IN_ARRAY(A, k) ( (A[(k/8)] & (1 << (k%8))) ? 1 : 0 )
16
17 // CRC-CCITT calculation macros
18 #define XOR(A, B) ( ((A) || (B)) && !((A) && (B)) )
19 #define CRC_CCITT_POLY 0x1021 // generator polynomial
20 #define CRC_CCITT_POLY_REVERSED 0x8408 // CRC_CCITT_POLY in reversed bit order
21 #define CRC_CCITT_INIT 0xFFFF // initial value
22
23 // maximum callsign length in bytes
24 #define RADIOLIB_AX25_MAX_CALLSIGN_LEN 6
25
26 // flag field MSB LSB DESCRIPTION
27 #define RADIOLIB_AX25_FLAG 0b01111110 // 7 0 AX.25 frame start/end flag
28
29 // address field
30 #define RADIOLIB_AX25_SSID_COMMAND_DEST 0b10000000 // 7 7 frame type: command (set in destination SSID)
31 #define RADIOLIB_AX25_SSID_COMMAND_SOURCE 0b00000000 // 7 7 command (set in source SSID)
32 #define RADIOLIB_AX25_SSID_RESPONSE_DEST 0b00000000 // 7 7 response (set in destination SSID)
33 #define RADIOLIB_AX25_SSID_RESPONSE_SOURCE 0b10000000 // 7 7 response (set in source SSID)
34 #define RADIOLIB_AX25_SSID_HAS_NOT_BEEN_REPEATED 0b00000000 // 7 7 not repeated yet (set in repeater SSID)
35 #define RADIOLIB_AX25_SSID_HAS_BEEN_REPEATED 0b10000000 // 7 7 repeated (set in repeater SSID)
36 #define RADIOLIB_AX25_SSID_RESERVED_BITS 0b01100000 // 6 5 reserved bits in SSID
37 #define RADIOLIB_AX25_SSID_HDLC_EXTENSION_CONTINUE 0b00000000 // 0 0 HDLC extension bit: next octet contains more address information
38 #define RADIOLIB_AX25_SSID_HDLC_EXTENSION_END 0b00000001 // 0 0 address field end
39
40 // control field
41 #define RADIOLIB_AX25_CONTROL_U_SET_ASYNC_BAL_MODE 0b01101100 // 7 2 U frame type: set asynchronous balanced mode (connect request)
42 #define RADIOLIB_AX25_CONTROL_U_SET_ASYNC_BAL_MODE_EXT 0b00101100 // 7 2 set asynchronous balanced mode extended (connect request with module 128)
43 #define RADIOLIB_AX25_CONTROL_U_DISCONNECT 0b01000000 // 7 2 disconnect request
44 #define RADIOLIB_AX25_CONTROL_U_DISCONNECT_MODE 0b00001100 // 7 2 disconnect mode (system busy or disconnected)
45 #define RADIOLIB_AX25_CONTROL_U_UNNUMBERED_ACK 0b01100000 // 7 2 unnumbered acknowledge
46 #define RADIOLIB_AX25_CONTROL_U_FRAME_REJECT 0b10000100 // 7 2 frame reject
47 #define RADIOLIB_AX25_CONTROL_U_UNNUMBERED_INFORMATION 0b00000000 // 7 2 unnumbered information
48 #define RADIOLIB_AX25_CONTROL_U_EXHANGE_IDENTIFICATION 0b10101100 // 7 2 exchange ID
49 #define RADIOLIB_AX25_CONTROL_U_TEST 0b11100000 // 7 2 test
50 #define RADIOLIB_AX25_CONTROL_POLL_FINAL_ENABLED 0b00010000 // 4 4 control field poll/final bit: enabled
51 #define RADIOLIB_AX25_CONTROL_POLL_FINAL_DISABLED 0b00000000 // 4 4 disabled
52 #define RADIOLIB_AX25_CONTROL_S_RECEIVE_READY 0b00000000 // 3 2 S frame type: receive ready (system ready to receive)
53 #define RADIOLIB_AX25_CONTROL_S_RECEIVE_NOT_READY 0b00000100 // 3 2 receive not ready (TNC buffer full)
54 #define RADIOLIB_AX25_CONTROL_S_REJECT 0b00001000 // 3 2 reject (out of sequence or duplicate)
55 #define RADIOLIB_AX25_CONTROL_S_SELECTIVE_REJECT 0b00001100 // 3 2 selective reject (single frame repeat request)
56 #define RADIOLIB_AX25_CONTROL_INFORMATION_FRAME 0b00000000 // 0 0 frame type: information (I frame)
57 #define RADIOLIB_AX25_CONTROL_SUPERVISORY_FRAME 0b00000001 // 1 0 supervisory (S frame)
58 #define RADIOLIB_AX25_CONTROL_UNNUMBERED_FRAME 0b00000011 // 1 0 unnumbered (U frame)
59
60 // protocol identifier field
61 #define RADIOLIB_AX25_PID_ISO_8208 0x01
62 #define RADIOLIB_AX25_PID_TCP_IP_COMPRESSED 0x06
63 #define RADIOLIB_AX25_PID_TCP_IP_UNCOMPRESSED 0x07
64 #define RADIOLIB_AX25_PID_SEGMENTATION_FRAGMENT 0x08
65 #define RADIOLIB_AX25_PID_TEXNET_DATAGRAM_PROTOCOL 0xC3
66 #define RADIOLIB_AX25_PID_LINK_QUALITY_PROTOCOL 0xC4
67 #define RADIOLIB_AX25_PID_APPLETALK 0xCA
68 #define RADIOLIB_AX25_PID_APPLETALK_ARP 0xCB
69 #define RADIOLIB_AX25_PID_ARPA_INTERNET_PROTOCOL 0xCC
70 #define RADIOLIB_AX25_PID_ARPA_ADDRESS_RESOLUTION 0xCD
71 #define RADIOLIB_AX25_PID_FLEXNET 0xCE
72 #define RADIOLIB_AX25_PID_NET_ROM 0xCF
73 #define RADIOLIB_AX25_PID_NO_LAYER_3 0xF0
74 #define RADIOLIB_AX25_PID_ESCAPE_CHARACTER 0xFF
75
76 // AFSK tones in Hz
77 #define RADIOLIB_AX25_AFSK_MARK 1200
78 #define RADIOLIB_AX25_AFSK_SPACE 2200
79
80 // tone duration in us (for 1200 baud AFSK)
81 #define RADIOLIB_AX25_AFSK_TONE_DURATION 833
82
87 class AX25Frame {
88 public:
92 char destCallsign[RADIOLIB_AX25_MAX_CALLSIGN_LEN + 1];
93
97 uint8_t destSSID;
98
102 char srcCallsign[RADIOLIB_AX25_MAX_CALLSIGN_LEN + 1];
103
107 uint8_t srcSSID;
108
112 uint8_t numRepeaters;
113
117 uint8_t control;
118
122 uint8_t protocolID;
123
127 uint16_t infoLen;
128
132 uint8_t rcvSeqNumber;
133
137 uint16_t sendSeqNumber;
138
139 #if !defined(RADIOLIB_STATIC_ONLY)
143 uint8_t* info;
144
148 char** repeaterCallsigns;
149
153 uint8_t* repeaterSSIDs;
154 #else
158 uint8_t info[RADIOLIB_STATIC_ARRAY_SIZE];
159
163 char repeaterCallsigns[8][RADIOLIB_AX25_MAX_CALLSIGN_LEN + 1];
164
168 uint8_t repeaterSSIDs[8];
169 #endif
170
179 AX25Frame(const char* destCallsign, uint8_t destSSID, const char* srcCallsign, uint8_t srcSSID, uint8_t control);
180
191 AX25Frame(const char* destCallsign, uint8_t destSSID, const char* srcCallsign, uint8_t srcSSID, uint8_t control, uint8_t protocolID, const char* info);
192
204 AX25Frame(const char* destCallsign, uint8_t destSSID, const char* srcCallsign, uint8_t srcSSID, uint8_t control, uint8_t protocolID, uint8_t* info, uint16_t infoLen);
205
210 AX25Frame(const AX25Frame& frame);
211
215 ~AX25Frame();
216
221 AX25Frame& operator=(const AX25Frame& frame);
222
230 int16_t setRepeaters(char** repeaterCallsigns, uint8_t* repeaterSSIDs, uint8_t numRepeaters);
231
236 void setRecvSequence(uint8_t seqNumber);
237
242 void setSendSequence(uint8_t seqNumber);
243 };
244
249 class AX25Client {
250 public:
255 explicit AX25Client(PhysicalLayer* phy);
256
257 #if !defined(RADIOLIB_EXCLUDE_AFSK)
262 explicit AX25Client(AFSKClient* audio);
263
272 int16_t setCorrection(int16_t mark, int16_t space, float length = 1.0f);
273 #endif
274
275 // basic methods
276
286 int16_t begin(const char* srcCallsign, uint8_t srcSSID = 0x00, uint8_t preLen = 8);
287
288 #if defined(RADIOLIB_BUILD_ARDUINO)
297 int16_t transmit(String& str, const char* destCallsign, uint8_t destSSID = 0x00);
298 #endif
299
308 int16_t transmit(const char* str, const char* destCallsign, uint8_t destSSID = 0x00);
309
315 int16_t sendFrame(AX25Frame* frame);
316
317 #if !defined(RADIOLIB_GODMODE)
318 private:
319 #endif
320 friend class APRSClient;
321
322 PhysicalLayer* phyLayer;
323 #if !defined(RADIOLIB_EXCLUDE_AFSK)
324 AFSKClient* audioClient;
325 uint32_t afskMark;
326 uint32_t afskSpace;
327 uint32_t afskLen;
328 #endif
329
330 char sourceCallsign[RADIOLIB_AX25_MAX_CALLSIGN_LEN + 1] = {0, 0, 0, 0, 0, 0, 0};
331 uint8_t sourceSSID = 0;
332 uint16_t preambleLen = 0;
333
334 static uint16_t getFrameCheckSequence(uint8_t* buff, size_t len);
335
336 void getCallsign(char* buff);
337 uint8_t getSSID();
338 };
339
340 #endif
341
342 #endif
AFSKClient
Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...
Definition: AFSK.h:16
APRSClient
Client for APRS communication.
Definition: APRS.h:65
AX25Client
Client for AX25 communication.
Definition: AX25.h:249
AX25Client::sendFrame
int16_t sendFrame(AX25Frame *frame)
Transmit arbitrary AX.25 frame.
Definition: AX25.cpp:215
AX25Client::setCorrection
int16_t setCorrection(int16_t mark, int16_t space, float length=1.0f)
Set AFSK tone correction offset. On some platforms, this is required to get the audio produced by the...
Definition: AX25.cpp:170
AX25Client::transmit
int16_t transmit(const char *str, const char *destCallsign, uint8_t destSSID=0x00)
Transmit unnumbered information (UI) frame.
Definition: AX25.cpp:204
AX25Client::begin
int16_t begin(const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preLen=8)
Initialization method.
Definition: AX25.cpp:178
AX25Client::AX25Client
AX25Client(PhysicalLayer *phy)
Constructor for 2-FSK mode.
Definition: AX25.cpp:154
AX25Frame
Abstraction of AX.25 frame format.
Definition: AX25.h:87
AX25Frame::setSendSequence
void setSendSequence(uint8_t seqNumber)
Method to set send sequence number.
Definition: AX25.cpp:150
AX25Frame::AX25Frame
AX25Frame(const char *destCallsign, uint8_t destSSID, const char *srcCallsign, uint8_t srcSSID, uint8_t control)
Overloaded constructor, for frames without info field.
Definition: AX25.cpp:5
AX25Frame::repeaterCallsigns
char ** repeaterCallsigns
Array of repeater callsigns.
Definition: AX25.h:148
AX25Frame::srcCallsign
char srcCallsign[RADIOLIB_AX25_MAX_CALLSIGN_LEN+1]
Callsign of the source station.
Definition: AX25.h:102
AX25Frame::setRecvSequence
void setRecvSequence(uint8_t seqNumber)
Method to set receive sequence number.
Definition: AX25.cpp:146
AX25Frame::sendSeqNumber
uint16_t sendSeqNumber
Send sequence number.
Definition: AX25.h:137
AX25Frame::srcSSID
uint8_t srcSSID
SSID of the source station.
Definition: AX25.h:107
AX25Frame::operator=
AX25Frame & operator=(const AX25Frame &frame)
Overload for assignment operator.
Definition: AX25.cpp:75
AX25Frame::control
uint8_t control
The control field.
Definition: AX25.h:117
AX25Frame::repeaterSSIDs
uint8_t * repeaterSSIDs
Array of repeater SSIDs.
Definition: AX25.h:153
AX25Frame::infoLen
uint16_t infoLen
Number of bytes in the information field.
Definition: AX25.h:127
AX25Frame::setRepeaters
int16_t setRepeaters(char **repeaterCallsigns, uint8_t *repeaterSSIDs, uint8_t numRepeaters)
Method to set the repeater callsigns and SSIDs.
Definition: AX25.cpp:110
AX25Frame::destCallsign
char destCallsign[RADIOLIB_AX25_MAX_CALLSIGN_LEN+1]
Callsign of the destination station.
Definition: AX25.h:92
AX25Frame::info
uint8_t * info
The info field.
Definition: AX25.h:143
AX25Frame::protocolID
uint8_t protocolID
The protocol identifier (PID) field.
Definition: AX25.h:122
AX25Frame::~AX25Frame
~AX25Frame()
Default destructor.
Definition: AX25.cpp:57
AX25Frame::numRepeaters
uint8_t numRepeaters
Number of repeaters to be used.
Definition: AX25.h:112
AX25Frame::rcvSeqNumber
uint8_t rcvSeqNumber
Receive sequence number.
Definition: AX25.h:132
AX25Frame::destSSID
uint8_t destSSID
SSID of the destination station.
Definition: AX25.h:97
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:15