Fix typos (#126)

Signed-off-by: tinyboxvk <[email protected]>

README.md

@@ -83,7 +83,7 @@ The out of tree module gr-lora_sdr can be installed from source or directly as a
 	```sh
 	cd gr-lora_sdr/
 	```
-- You can optionally install the required dependecies using the provided conda environment, or directly install the dependecies independently and bypass the use of conda.
+- You can optionally install the required dependencies using the provided conda environment, or directly install the dependencies independently and bypass the use of conda.
 	You can follow this [tutorial](https://www.how2shout.com/how-to/install-anaconda-wsl-windows-10-ubuntu-linux-app.html) or simply following:
 	- First download the latest release of conda, for example:
 		```sh

apps/simulation/README.md

@@ -6,9 +6,9 @@ A simple script measuring the frame error rate of a flowgraph. The error rate is
     - data: temporary files containing the transmitted payloads, received payloads, and CRC validity for each SNR.
     - flowgraph: A sample flowgraph class 
     - results: A figure of the obtained FER as well as the values of the data. Can be loaded in ```load_results.py``` to compare different simulations.
-    - load_results.py: Open prevously obtained curves and plot them alongside each others.
+    - load_results.py: Open previously obtained curves and plot them alongside each others.
 ## Usage
     - Open ```mc_simulator.py``` and set the parameters you want to evaluate
     - ```cd``` to this directory 
-    - Execute ```python mc_simulator.py``` in a teminal
+    - Execute ```python mc_simulator.py``` in a terminal
     - You can load and plot previous simulation results by adding their name inside ```load_results.py```

apps/simulation/mc_simulator.py

@@ -22,7 +22,7 @@
 clk_offset_ppm = 0      # crystal offset in ppm
 pay_len = 32            # in bytes
 ldro = False            # usage of low datarate optimisation mode
-soft_decoding = True   # usage of soft-decision decoding in hte receiver
+soft_decoding = True   # usage of soft-decision decoding in the receiver
 
 
 # Result variables initialisation

docs/doxygen/update_pydoc.py

@@ -83,7 +83,7 @@ def utoascii(text):
     if text is None:
         return ''
     out = text.encode('ascii', 'replace')
-    # swig will require us to replace blackslash with 4 backslashes
+    # swig will require us to replace backslash with 4 backslashes
     # TODO: evaluate what this should be for pybind11
     out = out.replace(b'\\', b'\\\\\\\\')
     out = out.replace(b'"', b'\\"').decode('ascii')

grc/lora_sdr_dewhitening.block.yml

@@ -21,7 +21,7 @@ documentation: |-
         Input:
             in: stream of payload and CRC nibbles
             pay_len: payload length in bytes
-            new_frame: indicate begining of new frame
+            new_frame: indicate beginning of new frame
             CRC: payload crc presence
         Output:
             out: dewhitened payload bytes (and CRC if present)

grc/lora_sdr_fft_demod.block.yml

@@ -35,7 +35,7 @@ documentation: |-
     Recover the value of a lora symbol using argmax(DFT(lora_symbol * ref_downchirp)
         Parameters: 
            impl_head: usage of an implicit header (explicit will be used otherwise) 
-           soft_decoding: use soft-decision decoding, outputing LLRs instead of the argmax   
+           soft_decoding: use soft-decision decoding, outputting LLRs instead of the argmax   
         Input:        
             in: vector of 2^sf complex samples        
         Output:        

grc/lora_sdr_lora_tx.block.yml

@@ -90,7 +90,7 @@ documentation: |-
         - Frame zero padding: number of null samples padded after each frame
 
     Inputs:
-        - in: Message of the payload to transmitt
+        - in: Message of the payload to transmit
     Outputs
         - out: Stream of baseband complex samples that can be fed to the SDR frontend
 

lib/crc_verif_impl.cc

@@ -92,7 +92,7 @@ namespace gr
                 pmt::pmt_t err = pmt::string_to_symbol("error");
                 m_crc_presence = pmt::to_long(pmt::dict_ref(tags[0].value, pmt::string_to_symbol("crc"), err));
                 m_payload_len = pmt::to_long(pmt::dict_ref(tags[0].value, pmt::string_to_symbol("pay_len"), err));
-                curent_tag = tags[0];
+                current_tag = tags[0];
                 // std::cout<<m_payload_len<<" "<<nitem_to_process<<std::endl;
                 // std::cout<<"\ncrc_crc "<<tags[0].offset<<" - crc: "<<(int)m_crc_presence<<" - pay_len: "<<(int)m_payload_len<<"\n";
 
@@ -149,9 +149,9 @@ namespace gr
                         produce(1,1);
                     }
 					if (output_items.size()){
-		                curent_tag.value = pmt::dict_add(curent_tag.value, pmt::string_to_symbol("crc_valid"), pmt::from_bool(crc_valid == 1));
-		                curent_tag.offset = nitems_written(0);
-		                add_item_tag(0, curent_tag);
+		                current_tag.value = pmt::dict_add(current_tag.value, pmt::string_to_symbol("crc_valid"), pmt::from_bool(crc_valid == 1));
+		                current_tag.offset = nitems_written(0);
+		                add_item_tag(0, current_tag);
                     }
                     if (print_rx_msg != NONE)
                     {
@@ -187,8 +187,8 @@ namespace gr
             else if ((in_buff.size()>= m_payload_len) && !m_crc_presence)
             {
                 if (output_items.size()){
-		            curent_tag.offset = nitems_written(0);
-		            add_item_tag(0, curent_tag);
+		            current_tag.offset = nitems_written(0);
+		            add_item_tag(0, current_tag);
 				}
                 // get payload as string
                 message_str.clear();

lib/crc_verif_impl.h

@@ -20,7 +20,7 @@ namespace gr {
         std::vector<uint8_t> in_buff;///< input buffer containing the data bytes and CRC if any
         int print_rx_msg;  ///< print received message in terminal. 0: no print, 1: ASCII, 2: HEX
         bool output_crc_check; ///< output the result of the payload CRC check
-        tag_t curent_tag; ///< the most recent tag for the packet we are currently processing
+        tag_t current_tag; ///< the most recent tag for the packet we are currently processing
 
 
         uint32_t cnt=0;///< count the number of frame

lib/dewhitening_impl.h

@@ -11,7 +11,7 @@ namespace gr {
     {
      private:
         int m_payload_len;  ///< Payload length in bytes
-        int m_crc_presence; ///< indicate the precence of a CRC
+        int m_crc_presence; ///< indicate the presence of a CRC
         int offset = 0;       ///< The offset in the whitening table
         std::vector<uint8_t> dewhitened; ///< The dewhitened bytes
 

lib/frame_sync_impl.h

@@ -82,7 +82,7 @@ namespace gr
       std::vector<gr_complex> additional_symbol_samp;  ///< save the value of the last 1.25 downchirp as it might contain the first payload symbol
       std::vector<gr_complex> preamble_raw;      ///<vector containing the preamble upchirps without any synchronization
       std::vector<gr_complex> preamble_raw_up;  ///<vector containing the upsampled preamble upchirps without any synchronization
-      std::vector<gr_complex> downchirp_raw;    ///< vetor containing the preamble downchirps without any synchronization
+      std::vector<gr_complex> downchirp_raw;    ///< vector containing the preamble downchirps without any synchronization
       std::vector<gr_complex> preamble_upchirps; ///<vector containing the preamble upchirps
       std::vector<gr_complex> net_id_samp;       ///< vector of the oversampled network identifier samples
       std::vector<int> net_ids;                  ///< values of the network identifiers received

lib/header_decoder_impl.cc

@@ -186,7 +186,7 @@ namespace gr
                 for (int i = 0; i < nitem_to_process; i++)
                 {
                     if (pay_cnt < (uint32_t)m_payload_len * 2 + (m_has_crc ? 4 : 0))
-                    { //only output usefull value (payload and CRC if any)
+                    { //only output useful value (payload and CRC if any)
                         nout++;
                         pay_cnt++;
                         out[i] = in[i];

lib/kiss_fft.c

@@ -9,7 +9,7 @@
 
 #include "_kiss_fft_guts.h"
 /* The guts header contains all the multiplication and addition macros that are defined for
- fixed or floating point complex numbers.  It also delares the kf_ internal functions.
+ fixed or floating point complex numbers.  It also declares the kf_ internal functions.
  */
 static void kf_bfly2(
         kiss_fft_cpx * Fout,

lib/whitening_impl.h

@@ -18,7 +18,7 @@ namespace gr
       std::vector<uint8_t> m_payload;       ///< store the payload bytes
       std::vector<std::string> payload_str; ///< payload as a string
       bool m_file_source;                   ///< indicate that the payload are provided by a file through an input stream
-      bool m_use_length_tag;                ///< wheter to use the length tag to separate frames or the separator character
+      bool m_use_length_tag;                ///< whether to use the length tag to separate frames or the separator character
       std::string m_length_tag_name;        ///< name/key of the length tag
       int m_input_byte_cnt;                 ///< number of bytes from the input already processed
       uint64_t m_tag_offset;                ///< offset of the length tag