diff --git a/_a_f_s_k_8h_source.html b/_a_f_s_k_8h_source.html index 08787abe..af700c59 100644 --- a/_a_f_s_k_8h_source.html +++ b/_a_f_s_k_8h_source.html @@ -119,11 +119,12 @@ $(document).ready(function(){initNavTree('_a_f_s_k_8h_source.html',''); initResi
62  friend class HellClient;
63  friend class SSTVClient;
64  friend class AX25Client;
-
65 };
-
66 
-
67 #endif
-
68 
-
69 #endif
+
65  friend class FSK4Client;
+
66 };
+
67 
+
68 #endif
+
69 
+
70 #endif
HellClient
Client for Hellschreiber transmissions.
Definition: Hellschreiber.h:89
@@ -137,6 +138,7 @@ $(document).ready(function(){initNavTree('_a_f_s_k_8h_source.html',''); initResi
RTTYClient
Client for RTTY communication. The public interface is the same as Arduino Serial.
Definition: RTTY.h:88
SSTVClient
Client for SSTV transmissions.
Definition: SSTV.h:120
AFSKClient::begin
int16_t begin()
Initialization method.
Definition: AFSK.cpp:8
+
FSK4Client
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:16
-
FSK4Client::begin
int16_t begin(float base, uint32_t shift, uint16_t rate)
Constructor for AFSK mode.
Definition: FSK4.cpp:20
+
FSK4Client::begin
int16_t begin(float base, uint32_t shift, uint16_t rate)
Initialization method.
Definition: FSK4.cpp:18
AFSKClient
Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direc...
Definition: AFSK.h:17
-
FSK4Client::idle
void idle()
Send out idle condition (RF tone at mark frequency).
Definition: FSK4.cpp:62
+
FSK4Client::idle
void idle()
Send out idle condition (RF tone at mark frequency).
Definition: FSK4.cpp:59
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
-
FSK4Client
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:17
-
FSK4Client::FSK4Client
FSK4Client(PhysicalLayer *phy)
Constructor for FSK-4 mode.
Definition: FSK4.cpp:6
+
FSK4Client
Client for FSK-4 communication. The public interface is the same as Arduino Serial.
Definition: FSK4.h:16
+
FSK4Client::FSK4Client
FSK4Client(PhysicalLayer *phy)
Constructor for FSK-4 mode.
Definition: FSK4.cpp:4
Module
Implements all common low-level SPI/UART methods to control the wireless module. Every module class c...
Definition: Module.h:17
diff --git a/class_a_f_s_k_client-members.html b/class_a_f_s_k_client-members.html index caec7d2b..c63ab328 100644 --- a/class_a_f_s_k_client-members.html +++ b/class_a_f_s_k_client-members.html @@ -92,12 +92,13 @@ $(document).ready(function(){initNavTree('class_a_f_s_k_client.html',''); initRe AFSKClient(PhysicalLayer *phy, RADIOLIB_PIN_TYPE pin)AFSKClient AX25Client (defined in AFSKClient)AFSKClientfriend begin()AFSKClient - HellClient (defined in AFSKClient)AFSKClientfriend - MorseClient (defined in AFSKClient)AFSKClientfriend - noTone()AFSKClient - RTTYClient (defined in AFSKClient)AFSKClientfriend - SSTVClient (defined in AFSKClient)AFSKClientfriend - tone(uint16_t freq, bool autoStart=true)AFSKClient + FSK4Client (defined in AFSKClient)AFSKClientfriend + HellClient (defined in AFSKClient)AFSKClientfriend + MorseClient (defined in AFSKClient)AFSKClientfriend + noTone()AFSKClient + RTTYClient (defined in AFSKClient)AFSKClientfriend + SSTVClient (defined in AFSKClient)AFSKClientfriend + tone(uint16_t freq, bool autoStart=true)AFSKClient diff --git a/class_a_f_s_k_client.html b/class_a_f_s_k_client.html index ee5b8d95..d8c8284b 100644 --- a/class_a_f_s_k_client.html +++ b/class_a_f_s_k_client.html @@ -128,6 +128,9 @@ class SSTVClient< class AX25Client   + +class FSK4Client + 

Detailed Description

Client for audio-based transmissions. Requires Arduino tone() function, and a module capable of direct mode transmission using DIO pins.

diff --git a/class_a_f_s_k_client.js b/class_a_f_s_k_client.js index cabc4316..624e7fcb 100644 --- a/class_a_f_s_k_client.js +++ b/class_a_f_s_k_client.js @@ -5,6 +5,7 @@ var class_a_f_s_k_client = [ "noTone", "class_a_f_s_k_client.html#ade91356bb158bbc820d28855dd5818d1", null ], [ "tone", "class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33", null ], [ "AX25Client", "class_a_f_s_k_client.html#a0012621c1414f4c7573e961b57884a5b", null ], + [ "FSK4Client", "class_a_f_s_k_client.html#ac0313fe86041eb37d290019203e095d3", null ], [ "HellClient", "class_a_f_s_k_client.html#afeb005bab389f137def61f1acc3714d3", null ], [ "MorseClient", "class_a_f_s_k_client.html#ae5c5757c553100373984a416b6c3690a", null ], [ "RTTYClient", "class_a_f_s_k_client.html#a018393f703a257e39cd263cccf4ffad5", null ], diff --git a/class_f_s_k4_client-members.html b/class_f_s_k4_client-members.html index be1b9fbc..98be902a 100644 --- a/class_f_s_k4_client-members.html +++ b/class_f_s_k4_client-members.html @@ -91,9 +91,10 @@ $(document).ready(function(){initNavTree('class_f_s_k4_client.html',''); initRes - - - + + + +
begin(float base, uint32_t shift, uint16_t rate)FSK4Client
FSK4Client(PhysicalLayer *phy)FSK4Clientexplicit
idle()FSK4Client
write(uint8_t *buff, size_t len) (defined in FSK4Client)FSK4Client
write(uint8_t b) (defined in FSK4Client)FSK4Client
FSK4Client(AFSKClient *audio)FSK4Clientexplicit
idle()FSK4Client
write(uint8_t *buff, size_t len) (defined in FSK4Client)FSK4Client
write(uint8_t b) (defined in FSK4Client)FSK4Client
diff --git a/class_f_s_k4_client.html b/class_f_s_k4_client.html index a1d80272..79fcaf85 100644 --- a/class_f_s_k4_client.html +++ b/class_f_s_k4_client.html @@ -100,8 +100,11 @@ Public Member Functions  FSK4Client (PhysicalLayer *phy)  Constructor for FSK-4 mode. More...
  + FSK4Client (AFSKClient *audio) + Constructor for AFSK mode. More...
+  int16_t begin (float base, uint32_t shift, uint16_t rate) - Constructor for AFSK mode. More...
+ Initialization method. More...
  void idle () @@ -118,7 +121,7 @@ size_t write (uint8_t

Client for FSK-4 communication. The public interface is the same as Arduino Serial.

Constructor & Destructor Documentation

-

◆ FSK4Client()

+

◆ FSK4Client() [1/2]

@@ -149,6 +152,40 @@ size_t write (uint8_t +
+
+ +

◆ FSK4Client() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
FSK4Client::FSK4Client (AFSKClient * audio)
+ 		+explicit
+
+ +

Constructor for AFSK mode.

+
Parameters
+ + +
audioPointer to the AFSK instance providing audio.
+
+
+

Member Function Documentation

@@ -184,14 +221,7 @@ size_t write (uint8_t
-

Constructor for AFSK mode.

-
Parameters
- - -
audioPointer to the AFSK instance providing audio.
-
-
-

Initialization method.

+

Initialization method.

Parameters
diff --git a/class_f_s_k4_client.js b/class_f_s_k4_client.js index bcd36565..03dbe82a 100644 --- a/class_f_s_k4_client.js +++ b/class_f_s_k4_client.js @@ -1,6 +1,7 @@ var class_f_s_k4_client = [ [ "FSK4Client", "class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617", null ], + [ "FSK4Client", "class_f_s_k4_client.html#a65105b2744c4721b75ca0894c654bf82", null ], [ "begin", "class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9", null ], [ "idle", "class_f_s_k4_client.html#a79ca465012acc9223d61d5b063ff8257", null ], [ "write", "class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2", null ], diff --git a/functions_f.html b/functions_f.html index c6a7ab39..968c57bc 100644 --- a/functions_f.html +++ b/functions_f.html @@ -106,7 +106,7 @@ $(document).ready(function(){initNavTree('functions_f.html',''); initResizable() : tone_t
  • FSK4Client() -: FSK4Client +: FSK4Client
    • diff --git a/index.html b/index.html index 2e4941bd..825757a9 100644 --- a/index.html +++ b/index.html @@ -104,6 +104,7 @@ $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
  • AX.25 (AX25Client)
  • SSTV (SSTVClient)
  • Hellschreiber (HellClient)
    • +
  • 4-FSK (FSK4Client)
  • TransportLayer protocols
      diff --git a/navtreedata.js b/navtreedata.js index f30b885f..bca28e6e 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -45,10 +45,10 @@ var NAVTREE = var NAVTREEINDEX = [ "_a_f_s_k_8h_source.html", -"class_m_q_t_t_client.html#ace3ee45313dea2f853207accf20b7c87", -"class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534", -"class_si4431.html", -"group__status__codes.html#ga8ec3e01efb503b4e32c59ea0a6566714" +"class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015", +"class_s_x126x.html#a41a1de0ebffe7b65de6fd8cceb9a5123", +"class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9", +"group__status__codes.html#ga8c65c39a6addd77e64c36ae1aff64c95" ]; var SYNCONMSG = 'click to disable panel synchronisation'; diff --git a/navtreeindex0.js b/navtreeindex0.js index e942ecac..4fad56b1 100644 --- a/navtreeindex0.js +++ b/navtreeindex0.js @@ -51,14 +51,15 @@ var NAVTREEINDEX0 = "annotated.html":[3,0], "class_a_f_s_k_client.html":[3,0,0], "class_a_f_s_k_client.html#a0012621c1414f4c7573e961b57884a5b":[3,0,0,4], -"class_a_f_s_k_client.html#a018393f703a257e39cd263cccf4ffad5":[3,0,0,7], +"class_a_f_s_k_client.html#a018393f703a257e39cd263cccf4ffad5":[3,0,0,8], "class_a_f_s_k_client.html#a30b86bb7cd087b3bc3c45a011ba266c3":[3,0,0,1], "class_a_f_s_k_client.html#a6d2341901c83e45f853c077e60f1fa33":[3,0,0,3], +"class_a_f_s_k_client.html#ac0313fe86041eb37d290019203e095d3":[3,0,0,5], "class_a_f_s_k_client.html#acfe53917bcba7f79611e01865c42fefd":[3,0,0,0], "class_a_f_s_k_client.html#ade91356bb158bbc820d28855dd5818d1":[3,0,0,2], -"class_a_f_s_k_client.html#ae5c5757c553100373984a416b6c3690a":[3,0,0,6], -"class_a_f_s_k_client.html#ae8dd4f2f60ef4fd1fa1868a7a630ab20":[3,0,0,8], -"class_a_f_s_k_client.html#afeb005bab389f137def61f1acc3714d3":[3,0,0,5], +"class_a_f_s_k_client.html#ae5c5757c553100373984a416b6c3690a":[3,0,0,7], +"class_a_f_s_k_client.html#ae8dd4f2f60ef4fd1fa1868a7a630ab20":[3,0,0,9], +"class_a_f_s_k_client.html#afeb005bab389f137def61f1acc3714d3":[3,0,0,6], "class_a_x25_client.html":[3,0,1], "class_a_x25_client.html#a341db993853c6817a8f6c7087ead0ba6":[3,0,1,3], "class_a_x25_client.html#a38be2b9385e4804339b3e4b57b90c2ca":[3,0,1,2], @@ -156,11 +157,12 @@ var NAVTREEINDEX0 = "class_e_s_p8266.html#ae25a6901976a548443e2b7d49ca94d9b":[3,0,4,1], "class_e_s_p8266.html#aee0279b476a83a55f54ab22e6d8f3904":[3,0,4,7], "class_f_s_k4_client.html":[3,0,5], -"class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9":[3,0,5,1], +"class_f_s_k4_client.html#a2b366b8f3c08f81431d8cc5f907652e9":[3,0,5,2], "class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617":[3,0,5,0], -"class_f_s_k4_client.html#a31218736d4f9a3412ee9009a4c4f5a22":[3,0,5,4], -"class_f_s_k4_client.html#a79ca465012acc9223d61d5b063ff8257":[3,0,5,2], -"class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2":[3,0,5,3], +"class_f_s_k4_client.html#a31218736d4f9a3412ee9009a4c4f5a22":[3,0,5,5], +"class_f_s_k4_client.html#a65105b2744c4721b75ca0894c654bf82":[3,0,5,1], +"class_f_s_k4_client.html#a79ca465012acc9223d61d5b063ff8257":[3,0,5,3], +"class_f_s_k4_client.html#aa59fb42d3eeafe5ab3f0437ef5567ec2":[3,0,5,4], "class_h_c05.html":[3,0,6], "class_h_c05.html#a5cc3184c58de65cbff18447c6d03de18":[3,0,6,0], "class_h_c05.html#a83cf61ee5a79c06f43861a6e5a8a15b6":[3,0,6,1], @@ -247,7 +249,5 @@ var NAVTREEINDEX0 = "class_m_q_t_t_client.html#a49cb16ef730ad50ba5dc472ac10d933e":[3,0,15,1], "class_m_q_t_t_client.html#a6ecdbc80b76ae32b926e84af620dacb6":[3,0,15,0], "class_m_q_t_t_client.html#a782158f20b289746b7b6884fd922a22c":[3,0,15,8], -"class_m_q_t_t_client.html#a9488df90534953c33d76e9183965a300":[3,0,15,7], -"class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015":[3,0,15,5], -"class_m_q_t_t_client.html#ac15b32e89df903b20b066113bf8c4a88":[3,0,15,2] +"class_m_q_t_t_client.html#a9488df90534953c33d76e9183965a300":[3,0,15,7] }; diff --git a/navtreeindex1.js b/navtreeindex1.js index f378ac8c..0df8867f 100644 --- a/navtreeindex1.js +++ b/navtreeindex1.js @@ -1,5 +1,7 @@ var NAVTREEINDEX1 = { +"class_m_q_t_t_client.html#ab59a1174098dfdf514d8ec6d0bd9d015":[3,0,15,5], +"class_m_q_t_t_client.html#ac15b32e89df903b20b066113bf8c4a88":[3,0,15,2], "class_m_q_t_t_client.html#ace3ee45313dea2f853207accf20b7c87":[3,0,15,6], "class_m_q_t_t_client.html#aea3fb930ed43a0b3122ccc90efebb99d":[3,0,15,4], "class_m_q_t_t_client.html#af10176e2cf67bd652823d44f3203a96e":[3,0,15,3], @@ -247,7 +249,5 @@ var NAVTREEINDEX1 = "class_s_x126x.html#a2f60df59c80241d98ce078c0417a7f08":[3,0,37,28], "class_s_x126x.html#a3350cbfab628956c1a456383ac7bb2b2":[3,0,37,20], "class_s_x126x.html#a3765f534418d4e0540c179621c019138":[3,0,37,6], -"class_s_x126x.html#a38e6d7831f35893a5b8328c10a2901bf":[3,0,37,48], -"class_s_x126x.html#a41a1de0ebffe7b65de6fd8cceb9a5123":[3,0,37,61], -"class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8":[3,0,37,8] +"class_s_x126x.html#a38e6d7831f35893a5b8328c10a2901bf":[3,0,37,48] }; diff --git a/navtreeindex2.js b/navtreeindex2.js index 1af28b26..c475c7b5 100644 --- a/navtreeindex2.js +++ b/navtreeindex2.js @@ -1,5 +1,7 @@ var NAVTREEINDEX2 = { +"class_s_x126x.html#a41a1de0ebffe7b65de6fd8cceb9a5123":[3,0,37,61], +"class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8":[3,0,37,8], "class_s_x126x.html#a492b2d057dd803c3884fa1adc8e22534":[3,0,37,63], "class_s_x126x.html#a5052dc09f4b10ee22e169129f368685f":[3,0,37,55], "class_s_x126x.html#a514cabe74bbe3434d7e4f244c4077752":[3,0,37,40], @@ -247,7 +249,5 @@ var NAVTREEINDEX2 = "class_serial_module.html#a753631600e2070c57ed74e9eb296ce19":[3,0,26,0], "class_si4430.html":[3,0,27], "class_si4430.html#a025a31861d1511090168e416140d0343":[3,0,27,2], -"class_si4430.html#a8e17e67d0d3dd9b478be964be8647ca7":[3,0,27,1], -"class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9":[3,0,27,0], -"class_si4430.html#af8d615431bf66e06b45487f3fff73d16":[3,0,27,3] +"class_si4430.html#a8e17e67d0d3dd9b478be964be8647ca7":[3,0,27,1] }; diff --git a/navtreeindex3.js b/navtreeindex3.js index eae59112..9fb978e3 100644 --- a/navtreeindex3.js +++ b/navtreeindex3.js @@ -1,5 +1,7 @@ var NAVTREEINDEX3 = { +"class_si4430.html#ac5ac1122e863a92b374a71e8880e16d9":[3,0,27,0], +"class_si4430.html#af8d615431bf66e06b45487f3fff73d16":[3,0,27,3], "class_si4431.html":[3,0,28], "class_si4431.html#a332bfd2a32dea9ac0700bf172fe5b2d0":[3,0,28,0], "class_si4431.html#a4da296b35056e076ff69a288bd801d19":[3,0,28,2], @@ -154,8 +156,8 @@ var NAVTREEINDEX3 = "functions_d.html":[3,3,0,3], "functions_e.html":[3,3,0,4], "functions_f.html":[3,3,0,5], -"functions_func.html":[3,3,1,0], "functions_func.html":[3,3,1], +"functions_func.html":[3,3,1,0], "functions_func_b.html":[3,3,1,1], "functions_func_c.html":[3,3,1,2], "functions_func_d.html":[3,3,1,3], @@ -247,7 +249,5 @@ var NAVTREEINDEX3 = "group__status__codes.html#ga819f4587f681d62d96babf3f51a0268e":[2,4,32], "group__status__codes.html#ga81f8c801d5a34b8000dd127002092299":[2,4,5], "group__status__codes.html#ga8a1f83c8c9abed26b497c9eb69f1a521":[2,4,24], -"group__status__codes.html#ga8a4168b6953ca4e289d2bda1d4c422e7":[2,4,25], -"group__status__codes.html#ga8c65c39a6addd77e64c36ae1aff64c95":[2,4,4], -"group__status__codes.html#ga8d2622e3d347809a5b8b13b90e789121":[2,4,40] +"group__status__codes.html#ga8a4168b6953ca4e289d2bda1d4c422e7":[2,4,25] }; diff --git a/navtreeindex4.js b/navtreeindex4.js index fb061ff5..34827195 100644 --- a/navtreeindex4.js +++ b/navtreeindex4.js @@ -1,5 +1,7 @@ var NAVTREEINDEX4 = { +"group__status__codes.html#ga8c65c39a6addd77e64c36ae1aff64c95":[2,4,4], +"group__status__codes.html#ga8d2622e3d347809a5b8b13b90e789121":[2,4,40], "group__status__codes.html#ga8ec3e01efb503b4e32c59ea0a6566714":[2,4,67], "group__status__codes.html#ga922d0c9f0434ca59f8e82fce26d0e4c7":[2,4,14], "group__status__codes.html#ga975011f5b371bfc864c36e65f2b26a24":[2,4,27], diff --git a/search/all_5.js b/search/all_5.js index 9195077d..ff1ac0b2 100644 --- a/search/all_5.js +++ b/search/all_5.js @@ -5,5 +5,5 @@ var searchData= ['flipbits16_116',['flipBits16',['../class_module.html#a160006371be8e121a8a54cc4462b3a72',1,'Module']]], ['forceldro_117',['forceLDRO',['../class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8',1,'SX126x::forceLDRO()'],['../class_s_x1272.html#a4aaf9d61310fa7b4fce413ae53d30ac0',1,'SX1272::forceLDRO()'],['../class_s_x1278.html#a6d6398c4d4fde302d6d4752708bce856',1,'SX1278::forceLDRO()']]], ['freq_118',['freq',['../structtone__t.html#a322e5f269a6a7eaae58f3ca0b73da0cf',1,'tone_t']]], - ['fsk4client_119',['FSK4Client',['../class_f_s_k4_client.html',1,'FSK4Client'],['../class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617',1,'FSK4Client::FSK4Client()']]] + ['fsk4client_119',['FSK4Client',['../class_f_s_k4_client.html',1,'FSK4Client'],['../class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617',1,'FSK4Client::FSK4Client(PhysicalLayer *phy)'],['../class_f_s_k4_client.html#a65105b2744c4721b75ca0894c654bf82',1,'FSK4Client::FSK4Client(AFSKClient *audio)']]] ]; diff --git a/search/functions_5.js b/search/functions_5.js index 08c051bd..66cbfbd6 100644 --- a/search/functions_5.js +++ b/search/functions_5.js @@ -4,5 +4,5 @@ var searchData= ['flipbits_460',['flipBits',['../class_module.html#a7f5fd7409f21d33a16ea1de589962ae6',1,'Module']]], ['flipbits16_461',['flipBits16',['../class_module.html#a160006371be8e121a8a54cc4462b3a72',1,'Module']]], ['forceldro_462',['forceLDRO',['../class_s_x126x.html#a420c23bb1861646e29f44c0f4c646ee8',1,'SX126x::forceLDRO()'],['../class_s_x1272.html#a4aaf9d61310fa7b4fce413ae53d30ac0',1,'SX1272::forceLDRO()'],['../class_s_x1278.html#a6d6398c4d4fde302d6d4752708bce856',1,'SX1278::forceLDRO()']]], - ['fsk4client_463',['FSK4Client',['../class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617',1,'FSK4Client']]] + ['fsk4client_463',['FSK4Client',['../class_f_s_k4_client.html#a2cdcea538e5b58e99a23f98ef4a68617',1,'FSK4Client::FSK4Client(PhysicalLayer *phy)'],['../class_f_s_k4_client.html#a65105b2744c4721b75ca0894c654bf82',1,'FSK4Client::FSK4Client(AFSKClient *audio)']]] ];
    • baseBase (space) frequency to be used in MHz (in FSK-4 mode), or the space tone frequency in Hz (in AFSK mode)