Merge pull request #64 from RobertGawron/develop

Develop

.github/workflows/docs-generation.yml

@@ -12,7 +12,7 @@ jobs:
     - name: install latex and generate documents
       run: |
         sudo apt-get install -y texlive-latex-base texlive-latex-extra texlive-extra-utils poppler-utils pdf2svg
-        cd ./ContinousIntegration
+        cd ./ContinuousIntegration
         chmod +x ./run_generate_docs.sh
         ./run_generate_docs.sh
         mkdir result
@@ -23,4 +23,4 @@ jobs:
       if: always()
       with:
         name: Latex Documents
-        path: ./ContinousIntegration/result
+        path: ./ContinuousIntegration/result

ContinousIntegration/README.md → ContinuousIntegration/README.md

@@ -1,3 +1,3 @@
-# Continous Integration
+# ContinuousIntegration
 
 This folder contains scripts run by GitHub continuous integration module. These scripts should be also run locally before pull request.

Simulation/SignalFilter/README.md

@@ -1,3 +1,3 @@
-# Filtration of output signal by using digital filterr
+# Filtration of output signal by using digital filter
 
 This is a dummy attempt to check how digital signal filtering could help removing noise. When writing this simulation, I didn't have the device, so couldn't use exact values. Nevertheless it seems that this will be helpful way to improve signal quality.

Software/HardwareDataLogger/.github/workflows/static-code-analysis.yml

@@ -13,7 +13,7 @@ jobs:
     - name: install cppcheck and run tests
       run: |
         sudo apt-get install -y cppcheck 
-        cd ./ContinousIntegration       
+        cd ./ContinuousIntegration       
         chmod +x ./run_c_static_code_analysis.sh
         ls run_c_static_code_analysis.sh
         ./run_c_static_code_analysis.sh
@@ -23,7 +23,7 @@ jobs:
       if: always()
       run: |
         sudo pip install flake8 flake8-html 
-        cd ./ContinousIntegration
+        cd ./ContinuousIntegration
         chmod +x ./run_python_static_code_analysis.sh
         ls
         ./run_python_static_code_analysis.sh
@@ -33,11 +33,11 @@ jobs:
       if: always()
       with:
         name: Report for Python sources
-        path: ./ContinousIntegration/python_lint_repport/
+        path: ./ContinuousIntegration/python_lint_report/
 
     - name: Archive C results
       uses: actions/upload-artifact@v2
       if: always()
       with:
         name: Report for C sources
-        path: ./ContinousIntegration/C_Lint_*.txt     
+        path: ./ContinuousIntegration/C_Lint_*.txt     

Software/HardwareDataLogger/.github/workflows/unit-test.yml

@@ -12,7 +12,7 @@ jobs:
     - name: Build and run tests      
       run: |
         sudo pip install pytest pytest-html
-        cd ./ContinousIntegration
+        cd ./ContinuousIntegration
         chmod +x ./run_unit_tests.sh
         ./run_unit_tests.sh
 

Software/HardwareDataLogger/ContinuousIntegration/.gitignore

@@ -0,0 +1,2 @@
+C_Lint_ReportApplicationOnly.txt
+C_Lint_ReportFull.txt

Software/HardwareDataLogger/ContinousIntegration/README.md → Software/HardwareDataLogger/ContinuousIntegration/README.md

@@ -1,3 +1,3 @@
-# Continous Integration
+# ContinuousIntegration
 
 This folder contains scripts run by GitHub continuous integration module. These scripts should be also run locally before pull request.

Software/HardwareDataLogger/ContinuousIntegration/run_python_static_code_analysis.sh

@@ -0,0 +1 @@
+flake8 --format=html --htmldir=python_lint_report ../Simulation/FirmwarePCSimulator 

Software/HardwareDataLogger/Simulation/FirmwarePCSimulator/README.md

@@ -10,7 +10,7 @@ This project consists of two parts:
 Note that in order to load .so object into an application, both of them needs to be 32bits, or 64bits. In case of errors during loading .so object, check your version on Python and gcc (both should be either 32bits or 64bits).
 
 ## Requirements
-- Intsall PyQt5
+- Install PyQt5
 
 ```pip install PyQt5```
 - Install gcc an makefile

Software/HardwareDataLogger/Software/NUCLEO-F091RC/Src/gm_measurement_calculator.c

@@ -2,26 +2,26 @@
 #include "gm_circular_buffer.h"
 #include "gm_measurement.h"
 
-static volatile GMMeasurement_Value_t occurenceCounter;
+static volatile GMMeasurement_Value_t occurrenceCounter;
 
 void GMMeasurementCalculator_Init()
 {
     GMCircularBuffer_Init();
-    occurenceCounter = 0U;
+    occurrenceCounter = 0U;
 }
 
 void GMMeasurementCalculator_OnSamplingDone()
 {
-    GMCircularBuffer_Insert(occurenceCounter);
+    GMCircularBuffer_Insert(occurrenceCounter);
 
     // reset counter to start from the beginning for the new sample
-    occurenceCounter = 0;
+    occurrenceCounter = 0;
 }
 
 void GMMeasurementCalculator_OnGMPulseObserved()
 {
-    if (occurenceCounter < SAMPLE_STORAGE_ELEMENT_MAX_VALUE)
+    if (occurrenceCounter < SAMPLE_STORAGE_ELEMENT_MAX_VALUE)
     {
-        occurenceCounter++;
+        occurrenceCounter++;
     }
 }

Software/HardwareDataLogger/Software/NUCLEO-F091RC/Src/gm_view_histogram.c

@@ -45,7 +45,7 @@ void GMViewHistogram_ShowHistogram()
             uint16_t binValue = GMHistogram_GetBinValue(i, histogramBinAmount);
             uint32_t normalizedBinValue = binValue * graphHeight/ maxBinValue;
 
-            uint8_t x1 = binWidthOnDisplay - 1; // one pixel to avoiid overlap
+            uint8_t x1 = binWidthOnDisplay - 1; // one pixel to avoid overlap
             GMDisplayHW_DrawRectangle(x0, GMDisplayHW_GetDisplayHeight()-normalizedBinValue, x1, GMDisplayHW_GetDisplayHeight());
 
             x0 += binWidthOnDisplay;