diff --git a/_a_p_r_s_8h_source.html b/_a_p_r_s_8h_source.html new file mode 100644 index 00000000..7358dc0f --- /dev/null +++ b/_a_p_r_s_8h_source.html @@ -0,0 +1,161 @@ + + +
+ + + + +
+ RadioLib
+
+ Universal wireless communication library for Arduino
+ |
+
CAFSKClient | Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direct mode transmission using DIO pins |
CAX25Client | Client for AX25 communication |
CAX25Frame | Abstraction of AX.25 frame format |
CCC1101 | Control class for CC1101 module |
CFSK4Client | Client for FSK-4 communication. The public interface is the same as Arduino Serial |
CHellClient | Client for Hellschreiber transmissions |
CITA2String | ITA2-encoded string |
CLLCC68 | Derived class for LLCC68 modules |
CModule | Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class |
CMorseClient | Client for Morse Code communication. The public interface is the same as Arduino Serial |
CnRF24 | Control class for nRF24 module |
CPhysicalLayer | Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class |
CRF69 | Control class for RF69 module. Also serves as base class for SX1231 |
CRFM22 | Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modules |
CRFM23 | Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modules |
CRFM95 | Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM96 | Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM97 | Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges |
CRFM98 | Only exists as alias for RFM96, since there seems to be no difference between RFM96 and RFM98 modules |
CRTTYClient | Client for RTTY communication. The public interface is the same as Arduino Serial |
CSi4430 | Derived class for Si4430 modules |
CSi4431 | Derived class for Si4431 modules |
CSi4432 | Derived class for Si4432 modules |
CSi443x | Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSSTVClient | Client for SSTV transmissions |
CSSTVMode_t | Structure to save data about supported SSTV modes |
CSX1231 | Control class for SX1231 module. Overrides some methods from RF69 due to different register values |
CSX1261 | Derived class for SX1261 modules |
CSX1262 | Derived class for SX1262 modules |
CSX1268 | Derived class for SX1268 modules |
CSX126x | Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSX1272 | Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic hardware and only differ in parameter ranges |
CSX1273 | Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges |
CSX1276 | Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1277 | Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1278 | Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names) |
CSX1279 | Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX127x | Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSX1280 | Derived class for SX1280 modules |
CSX1281 | Derived class for SX1281 modules |
CSX1282 | Derived class for SX1282 modules |
CSX128x | Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
Ctone_t | Structure to save data about tone |
CAPRSClient | Client for APRS communication |
CAX25Client | Client for AX25 communication |
CAX25Frame | Abstraction of AX.25 frame format |
CCC1101 | Control class for CC1101 module |
CFSK4Client | Client for FSK-4 communication. The public interface is the same as Arduino Serial |
CHellClient | Client for Hellschreiber transmissions |
CITA2String | ITA2-encoded string |
CLLCC68 | Derived class for LLCC68 modules |
CModule | Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class |
CMorseClient | Client for Morse Code communication. The public interface is the same as Arduino Serial |
CnRF24 | Control class for nRF24 module |
CPhysicalLayer | Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class |
CRF69 | Control class for RF69 module. Also serves as base class for SX1231 |
CRFM22 | Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modules |
CRFM23 | Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modules |
CRFM95 | Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM96 | Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM97 | Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges |
CRFM98 | Only exists as alias for RFM96, since there seems to be no difference between RFM96 and RFM98 modules |
CRTTYClient | Client for RTTY communication. The public interface is the same as Arduino Serial |
CSi4430 | Derived class for Si4430 modules |
CSi4431 | Derived class for Si4431 modules |
CSi4432 | Derived class for Si4432 modules |
CSi443x | Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSSTVClient | Client for SSTV transmissions |
CSSTVMode_t | Structure to save data about supported SSTV modes |
CSX1231 | Control class for SX1231 module. Overrides some methods from RF69 due to different register values |
CSX1261 | Derived class for SX1261 modules |
CSX1262 | Derived class for SX1262 modules |
CSX1268 | Derived class for SX1268 modules |
CSX126x | Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSX1272 | Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic hardware and only differ in parameter ranges |
CSX1273 | Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges |
CSX1276 | Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1277 | Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1278 | Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names) |
CSX1279 | Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX127x | Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
CSX1280 | Derived class for SX1280 modules |
CSX1281 | Derived class for SX1281 modules |
CSX1282 | Derived class for SX1282 modules |
CSX128x | Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
Ctone_t | Structure to save data about tone |
+ RadioLib
+
+ Universal wireless communication library for Arduino
+ |
+
This is the complete list of members for APRSClient, including all inherited members.
+APRSClient(AX25Client *ax) | APRSClient | explicit |
begin(char symbol, bool alt=false) | APRSClient | |
sendFrame(char *destCallsign, uint8_t destSSID, char *info) | APRSClient | |
sendPosition(char *destCallsign, uint8_t destSSID, char *lat, char *lon, char *msg=NULL, char *time=NULL) | APRSClient |
+ RadioLib
+
+ Universal wireless communication library for Arduino
+ |
+
Client for APRS communication. + More...
+ +#include <APRS.h>
+Public Member Functions | |
APRSClient (AX25Client *ax) | |
Default constructor. More... | |
int16_t | begin (char symbol, bool alt=false) |
Initialization method. More... | |
int16_t | sendPosition (char *destCallsign, uint8_t destSSID, char *lat, char *lon, char *msg=NULL, char *time=NULL) |
Transmit position. More... | |
int16_t | sendFrame (char *destCallsign, uint8_t destSSID, char *info) |
Transmit generic APRS frame. More... | |
Client for APRS communication.
+
+
|
+ +explicit | +
Default constructor.
+ax | Pointer to the instance of AX25Client to be used for APRS. |
int16_t APRSClient::begin | +( | +char | +symbol, | +
+ | + | bool | +alt = false |
+
+ | ) | ++ |
Initialization method.
+symbol | APRS symbol to be displayed. |
alt | Whether to use the primary (false) or alternate (true) symbol table. Defaults to primary table. |
int16_t APRSClient::sendFrame | +( | +char * | +destCallsign, | +
+ | + | uint8_t | +destSSID, | +
+ | + | char * | +info | +
+ | ) | ++ |
Transmit generic APRS frame.
+destCallsign | Destination station callsign. |
destSSID | Destination station SSID. |
info | AX.25 info field contents. |
int16_t APRSClient::sendPosition | +( | +char * | +destCallsign, | +
+ | + | uint8_t | +destSSID, | +
+ | + | char * | +lat, | +
+ | + | char * | +lon, | +
+ | + | char * | +msg = NULL , |
+
+ | + | char * | +time = NULL |
+
+ | ) | ++ |
Transmit position.
+destCallsign | Destination station callsign. |
destSSID | Destination station SSID. |
lat | Latitude as a null-terminated string. |
long | Longitude as a null-terminated string. |
msg | Message to be transmitted. Defaults to NULL (no message). |
msg | Position timestamp. Defaults to NULL (no timestamp). |
This is the complete list of members for AX25Client, including all inherited members.
AX25Client(PhysicalLayer *phy) | AX25Client | explicit |
AX25Client(AFSKClient *audio) | AX25Client | explicit |
begin(const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preambleLen=8) | AX25Client | |
sendFrame(AX25Frame *frame) | AX25Client | |
setCorrection(int16_t mark, int16_t space) | AX25Client | |
transmit(const char *str, const char *destCallsign, uint8_t destSSID=0x00) | AX25Client | |
APRSClient (defined in AX25Client) | AX25Client | friend |
AX25Client(PhysicalLayer *phy) | AX25Client | explicit |
AX25Client(AFSKClient *audio) | AX25Client | explicit |
begin(const char *srcCallsign, uint8_t srcSSID=0x00, uint8_t preambleLen=8) | AX25Client | |
sendFrame(AX25Frame *frame) | AX25Client | |
setCorrection(int16_t mark, int16_t space) | AX25Client | |
transmit(const char *str, const char *destCallsign, uint8_t destSSID=0x00) | AX25Client |
+Friends | |
+class | APRSClient |
Client for AX25 communication.
diff --git a/class_a_x25_client.js b/class_a_x25_client.js index a8f0d172..4f4899bb 100644 --- a/class_a_x25_client.js +++ b/class_a_x25_client.js @@ -5,5 +5,6 @@ var class_a_x25_client = [ "begin", "class_a_x25_client.html#a38be2b9385e4804339b3e4b57b90c2ca", null ], [ "sendFrame", "class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6", null ], [ "setCorrection", "class_a_x25_client.html#aa6a10784d59428a4d5c13067ba6af69c", null ], - [ "transmit", "class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98", null ] + [ "transmit", "class_a_x25_client.html#a985790943f3f3e06a2dfdd36977d0b98", null ], + [ "APRSClient", "class_a_x25_client.html#ac7d2ea7e69067b7b4c6492e198505289", null ] ]; \ No newline at end of file diff --git a/classes.html b/classes.html index 311e9dc7..8669fd1a 100644 --- a/classes.html +++ b/classes.html @@ -106,69 +106,70 @@ $(document).ready(function(){initNavTree('classes.html',''); initResizable(); }) l |
c |
m |
c |
m |
t |
f |
f |
n |
n |
s |
h |
h |
p |
p |
+ RadioLib
+
+ Universal wireless communication library for Arduino
+ |
+
CAFSKClient | Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direct mode transmission using DIO pins |
CAX25Client | Client for AX25 communication |
CAX25Frame | Abstraction of AX.25 frame format |
CFSK4Client | Client for FSK-4 communication. The public interface is the same as Arduino Serial |
CHellClient | Client for Hellschreiber transmissions |
CITA2String | ITA2-encoded string |
CModule | Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class |
CMorseClient | Client for Morse Code communication. The public interface is the same as Arduino Serial |
▼CPhysicalLayer | Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class |
CCC1101 | Control class for CC1101 module |
CnRF24 | Control class for nRF24 module |
▼CRF69 | Control class for RF69 module. Also serves as base class for SX1231 |
CSX1231 | Control class for SX1231 module. Overrides some methods from RF69 due to different register values |
▼CSi443x | Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSi4432 | Derived class for Si4432 modules |
CSi4430 | Derived class for Si4430 modules |
CSi4431 | Derived class for Si4431 modules |
▼CSX126x | Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1262 | Derived class for SX1262 modules |
CLLCC68 | Derived class for LLCC68 modules |
CSX1261 | Derived class for SX1261 modules |
CSX1268 | Derived class for SX1268 modules |
▼CSX127x | Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1272 | Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic hardware and only differ in parameter ranges |
CSX1273 | Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges |
▼CSX1278 | Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names) |
▼CRFM95 | Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM97 | Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges |
CRFM96 | Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1276 | Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1277 | Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1279 | Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges |
▼CSX128x | Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1281 | Derived class for SX1281 modules |
▼CSX1280 | Derived class for SX1280 modules |
CSX1282 | Derived class for SX1282 modules |
CRFM22 | Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modules |
CRFM23 | Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modules |
CRFM98 | Only exists as alias for RFM96, since there seems to be no difference between RFM96 and RFM98 modules |
CRTTYClient | Client for RTTY communication. The public interface is the same as Arduino Serial |
CSSTVClient | Client for SSTV transmissions |
CSSTVMode_t | Structure to save data about supported SSTV modes |
Ctone_t | Structure to save data about tone |
CAPRSClient | Client for APRS communication |
CAX25Client | Client for AX25 communication |
CAX25Frame | Abstraction of AX.25 frame format |
CFSK4Client | Client for FSK-4 communication. The public interface is the same as Arduino Serial |
CHellClient | Client for Hellschreiber transmissions |
CITA2String | ITA2-encoded string |
CModule | Implements all common low-level methods to control the wireless module. Every module class contains one private instance of this class |
CMorseClient | Client for Morse Code communication. The public interface is the same as Arduino Serial |
▼CPhysicalLayer | Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN. Also extracts some common module-independent methods. Using this interface class allows to use the protocols on various modules without much code duplicity. Because this class is used mainly as interface, all of its virtual members must be implemented in the module class |
CCC1101 | Control class for CC1101 module |
CnRF24 | Control class for nRF24 module |
▼CRF69 | Control class for RF69 module. Also serves as base class for SX1231 |
CSX1231 | Control class for SX1231 module. Overrides some methods from RF69 due to different register values |
▼CSi443x | Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSi4432 | Derived class for Si4432 modules |
CSi4430 | Derived class for Si4430 modules |
CSi4431 | Derived class for Si4431 modules |
▼CSX126x | Base class for SX126x series. All derived classes for SX126x (e.g. SX1262 or SX1268) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1262 | Derived class for SX1262 modules |
CLLCC68 | Derived class for LLCC68 modules |
CSX1261 | Derived class for SX1261 modules |
CSX1268 | Derived class for SX1268 modules |
▼CSX127x | Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1272 | Derived class for SX1272 modules. Also used as base class for SX1273. Both modules use the same basic hardware and only differ in parameter ranges |
CSX1273 | Derived class for SX1273 modules. Overrides some methods from SX1272 due to different parameter ranges |
▼CSX1278 | Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279, RFM95 and RFM96. All of these modules use the same basic hardware and only differ in parameter ranges (and names) |
▼CRFM95 | Derived class for RFM95 modules. Overrides some methods from SX1278 due to different parameter ranges |
CRFM97 | Derived class for RFM97 modules. Overrides some methods from RFM95 due to different parameter ranges |
CRFM96 | Derived class for RFM96 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1276 | Derived class for SX1276 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1277 | Derived class for SX1277 modules. Overrides some methods from SX1278 due to different parameter ranges |
CSX1279 | Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter ranges |
▼CSX128x | Base class for SX128x series. All derived classes for SX128x (e.g. SX1280 or SX1281) inherit from this base class. This class should not be instantiated directly from Arduino sketch, only from its derived classes |
▼CSX1281 | Derived class for SX1281 modules |
▼CSX1280 | Derived class for SX1280 modules |
CSX1282 | Derived class for SX1282 modules |
CRFM22 | Only exists as alias for Si4432, since there seems to be no difference between RFM22 and Si4432 modules |
CRFM23 | Only exists as alias for Si4431, since there seems to be no difference between RFM23 and Si4431 modules |
CRFM98 | Only exists as alias for RFM96, since there seems to be no difference between RFM96 and RFM98 modules |
CRTTYClient | Client for RTTY communication. The public interface is the same as Arduino Serial |
CSSTVClient | Client for SSTV transmissions |
CSSTVMode_t | Structure to save data about supported SSTV modes |
Ctone_t | Structure to save data about tone |