Merge pull request #329 from Luos-io/rc_2.6.0

[RELEASE] Luos Engine : version 2.6.0
Luos-io · Aug 31, 2022 · b0cb11a · b0cb11a
2 parents 70ba394 + 3daacfc
commit b0cb11a
Show file tree

Hide file tree

Showing 835 changed files with 5,447 additions and 6,255 deletions.
diff --git a/.clang-format b/.clang-format
@@ -14,3 +14,4 @@ AlignOperands: true
 BreakBeforeBinaryOperators: All
 AlignConsecutiveMacros: true
 AlignConsecutiveAssignments: true
+IndentPPDirectives: BeforeHash
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -1,25 +1,40 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Report a bug in Luos
 title: "[BUG] "
 labels: bug
-assignees: nicolas-rabault
+assignees: simonbdy
 
 ---
 
-** Which version the bug has been detected **
-Luos engine X.Y.Z
+## Before to begin
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+Thank you for contributing to the Luos project!
 
-**Network configuration**
-- Add the routing table or list the nodes and their services
-- Power input configuration
+Before to begin, please ensure that this bug is an actual bug, and that it has not been reported yet (you can use the GitHub searchbar with keywords to look for other issues).
 
-**How to reproduce the bug**
-Describe thoroughly the steps to reproduce the bug.
+If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
 
-**Additional context**
-Add any other context about the problem here.
-Don't hesitate to add screenshots or to link an entry from the forum.
+At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
+
+## Details
+Please replace the italic test by your inputs and details in each of the following sections:
+
+### Which version the bug has been detected on
+*Luos engine X.Y.Z*
+
+### Description of the bug
+*A clear and concise description of what is the expected behavior and what is the current behavior.*
+
+### Context and environment
+- *Add the routing table or the list of the nodes and their services*
+- *Detail the power input configuration*
+- *Add any other details about the context and environment*
+
+### How to reproduce the bug
+*Describe thoroughly the steps to reproduce the bug.*
+
+### Possible solution
+*Give the details of a possible solution to resolve the bug.*
+
+Thank you! Your issue will be reviewed by our admins.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -3,8 +3,30 @@ name: Feature request
 about: Suggest a new feature to be working in Luos
 title: "[NEW FEATURE] "
 labels: feature
-assignees: nicolas-rabault
+assignees: simonbdy
 
 ---
 
-**What feature would you like to be included in Luos?**
+## Before to begin
+
+Thank you for contributing to the Luos project!
+
+Before to begin, please ensure that the feature you are requesting doesn't exist yet (you can use the GitHub searchbar with keywords to look for other issues).
+
+If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
+
+At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
+
+## Details
+Please replace the italic test by your inputs and details in each of the following sections:
+
+### What feature would you like to be included in Luos?
+*Describe the feature you want to be added to Luos.*
+
+### Describe the expected behavior of the feature
+*Describe how the feature would work, in which environment and context.*
+
+### What is the motivation / use case for changing the behavior?
+*Explain why you request this feature, and in which use case it applies.*
+
+Thank you! Your issue will be reviewed by our admins.
diff --git a/.github/ISSUE_TEMPLATE/porting-request.md b/.github/ISSUE_TEMPLATE/porting-request.md
@@ -3,25 +3,40 @@ name: Porting request
 about: Suggest a new MCU to be compatible with Luos
 title: "[MCU PORTING] "
 labels: porting
-assignees: nicolas-rabault
+assignees: simonbdy
 
 ---
 
-**What MCU would you like Luos to be compatible with?**
+## Before to begin
 
-**Link the datasheet of this MCU:**
+Thank you for contributing to the Luos project!
 
-**Describe your project:**
+Before to begin, please ensure that the issue you want to open doesn't exist yet with the same porting request (you can use the GitHub searchbar with keywords to look for other issues).
 
-**Describe the electronic board hosting the MCU:**
-Add details about the network interface, the pins used, the device, etc.
-Don't hesitate to post a schematic.
+If you only have a usage question, ask it to the [Luos Community](https://discord.gg/luos).
 
-**Ensure that every box bellow is checked:**
- - [ ] The MCU is not in the [compatible list](https://www.luos.io/docs/next/compatibility/mcu_demoboard) in the documentation.
+At last, feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos!
+
+## Details
+Please replace the italic test by your inputs and details in each of the following sections:
+
+### What MCU would you like Luos to be compatible with?
+*List the MCU(s) you want Luos to be compatible with.*
+
+### Link the datasheet of this MCU
+*Please provide the links of the MCU's datasheet.*
+
+### Describe your project
+*Describe your project and explain why you need the MCU(s) to be Luos compatible.*
+
+### Describe the electronic board hosting the MCU
+*Add details about the network interface, the pins used, the device, etc. Don't hesitate to post a schematic.*
+
+### Ensure that every box bellow is checked
+ - [ ] The MCU is not in the [compatible list](https://www.luos.io/docs/compatibility/mcu_demoboard) in the documentation.
  - [ ] The MCU is not already in an existing [porting issue](https://github.com/Luos-io/luos_engine/issues).
- - [x] The issue has the label `porting`.
- - [ ] The issue is added to the [Porting](https://github.com/orgs/Luos-io/projects/3) project.
 
-**Additional context**
-Add any other context about the porting request here.
+### Additional context
+*Add any other context about the porting request here.*
+
+Thank you! Your issue will be reviewed by our admins.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,24 +1,50 @@
-# PR Checklist 
+By submiting this PR, you agree with the associated license ([Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) or [MIT](http://choosealicense.com/licenses/mit/)) and with our [Contributor License Agreement](https://github.com/Luos-io/luos_engine/) (CLA).
 
-### _1- PR Comments_
-    *If needed, to be filled by developer*  
+## Before to begin
 
-<br><hr/>
-*WARNING : Do not edit the checklist below.*  
-<hr/><br>
+Thank you for contributing to the Luos project!
 
-### _2- Developer section_
+Before to begin, please follow these steps:
+
+- [ ] Ensure that this PR is not a duplicate.
+- [ ] Assign @Simonbdy to this PR
+- [ ] Add the PR to the `Luos contribution project`
+
+Feel free to read the [Luos contribution's guidelines](https://github.com/Luos-io/luos_engine/blob/main/CONTRIBUTING.md) and the [documentation page](https://www.luos.io/docs/contribute-to-luos) to have more insight about how to contribute to Luos.
+
+## PR Description section
+
+### Description and dependencies
+*Please include here a summary of the changes and the related issue. List any dependencies that are required for this change.* 
+
+### Changes
+Please choose the relevant options:
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+### Related issue(s)
+*Provide a list of the related issues that will be fixed by this PR.*
+
+---
+
+**WARNING**: Do not edit the checklist below.
+
+---
+
+## Developer section
 
 - [ ] [Documentation] is up to date with new feature
-- [ ] [Tests] are *passed OK* (Non regression, new features & bug fixes)
-- [ ] [Code Quality] Remind to check if :
+- [ ] [Tests] are *passed OK* (non regression, new features & bug fixes)
+- [ ] [Code Quality] please check if:
     * Each function has a header (description, inputs, outputs) 
     * Code is commented (particularly in hard to understand areas)
     * There are no new warnings that can be corrected
     * Commits policy is respected (constitancy commits, clear commits comments)
-<hr/><br>
 
-### _3- QA section_
+## QA section
 
 - [ ] [Review] tests for new features have been *reviewed*
 - [ ] [Changelog] is up-to-date with expected tags  

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,6 +10,10 @@ concurrency:
   group: dev-build-${{ github.head_ref || github.ref_name }}
   cancel-in-progress: true
 
+defaults:
+  run:
+    shell: bash
+
 jobs:
   unit-tests:
     name: Unit tests
@@ -65,6 +69,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
+        project_folders: [examples/projects/l0,
+                          examples/projects/Arduino,
+                          examples/projects/NUCLEO-L432KC,
+                          examples/projects/STM32F4-discovery,
+                          examples/projects/NUCLEO-F401RE,
+                          examples/projects/NUCLEO-F410RB,
+                          examples/projects/NUCLEO-G431KB,
+                          examples/projects/NUCLEO-G474RE,
+                          examples/projects/NUCLEO-F072RB,
+                          examples/projects/NUCLEO-L073RZ,
+                          examples/projects/STM32L4S5_discovery,
+                          examples/projects/ESP32
+                          ]
         os: [macos-latest, windows-latest, ubuntu-latest]
 
     steps:
@@ -84,103 +101,33 @@ jobs:
 
       - name: Run PlatformIO
         run: |
-          # L0
-          platformio run -d examples/projects/l0/button
-          platformio run -d examples/projects/l0/button_freertos
-          platformio run -d examples/projects/l0/controller_motor
-          platformio run -d examples/projects/l0/dc_motor
-          platformio run -d examples/projects/l0/distance
-          platformio run -d examples/projects/l0/dxl
-          platformio run -d examples/projects/l0/gate_serialcom
-          platformio run -d examples/projects/l0/gpio
-          platformio run -d examples/projects/l0/imu
-          platformio run -d examples/projects/l0/led
-          platformio run -d examples/projects/l0/led_strip
-          platformio run -d examples/projects/l0/light_sensor
-          platformio run -d examples/projects/l0/load
-          platformio run -d examples/projects/l0/potentiometer
-          platformio run -d examples/projects/l0/power_switch
-          platformio run -d examples/projects/l0/servo
-          platformio run -d examples/projects/l0/stepper
-          platformio run -d examples/projects/l0/bike_alarm/alarm_controller
-          platformio run -d examples/projects/l0/bike_alarm/start_controller
-          platformio run -d examples/projects/l0/demo/detection_button
-          platformio run -d examples/projects/l0/demo/ledstrip_position
-          platformio run -d examples/projects/l0/demo/motor_copy_app
-          platformio run -d examples/projects/l0/demo/motor_demo_app
-          platformio run -d examples/projects/l0/bootloader
-          # arduino
-          platformio run -d examples/projects/Arduino/button
-          platformio run -d examples/projects/Arduino/fingerprint
-          platformio run -d examples/projects/Arduino/gate_serialcom
-          platformio run -d examples/projects/Arduino/inspector_serialcom
-          platformio run -d examples/projects/Arduino/lcd
-          platformio run -d examples/projects/Arduino/led
-          platformio run -d examples/projects/Arduino/servo_motor
-          platformio run -d examples/projects/Arduino/bldc_simple_foc
-          platformio run -d examples/projects/Arduino/stepper_simple_foc
-          # NUCLEO-L432KC
-          platformio run -d examples/projects/NUCLEO-L432KC/button
-          platformio run -d examples/projects/NUCLEO-L432KC/fingerprint
-          platformio run -d examples/projects/NUCLEO-L432KC/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-L432KC/gpio
-          platformio run -d examples/projects/NUCLEO-L432KC/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-L432KC/lcd
-          platformio run -d examples/projects/NUCLEO-L432KC/led
-          platformio run -d examples/projects/NUCLEO-L432KC/servo
-          platformio run -d examples/projects/NUCLEO-L432KC/bootloader
-          platformio run -d examples/projects/NUCLEO-L432KC/dc_motor
-          platformio run -d examples/projects/NUCLEO-L432KC/potentiometre
-          # STM32F4-discovery
-          platformio run -d examples/projects/STM32F4-discovery/button
-          platformio run -d examples/projects/STM32F4-discovery/gate_serialcom
-          platformio run -d examples/projects/STM32F4-discovery/inspector_serialcom
-          # ******** missing bootloader ********
-          # NUCLEO-F401RE
-          platformio run -d examples/projects/NUCLEO-F401RE/button
-          platformio run -d examples/projects/NUCLEO-F401RE/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-F401RE/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-F401RE/led
-          platformio run -d examples/projects/NUCLEO-F401RE/bootloader
-          platformio run -d examples/projects/NUCLEO-F401RE/dc_motor
-          platformio run -d examples/projects/NUCLEO-F401RE/potentiometer
-          # NUCLEO-F410RB
-          platformio run -d examples/projects/NUCLEO-F410RB/button
-          platformio run -d examples/projects/NUCLEO-F410RB/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-F410RB/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-F410RB/bootloader
-          platformio run -d examples/projects/NUCLEO-F410RB/dc_motor
-          platformio run -d examples/projects/NUCLEO-F410RB/potentiometer
-          # NUCLEO-G431KB
-          platformio run -d examples/projects/NUCLEO-G431KB/button
-          platformio run -d examples/projects/NUCLEO-G431KB/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-G431KB/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-G431KB/bootloader
-          platformio run -d examples/projects/NUCLEO-G431KB/dc_motor
-          platformio run -d examples/projects/NUCLEO-G431KB/potentiometer
-          # NUCLEO-G474RE
-          platformio run -d examples/projects/NUCLEO-G474RE/button
-          platformio run -d examples/projects/NUCLEO-G474RE/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-G474RE/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-G474RE/bootloader
-          # NUCLEO-F072RB
-          platformio run -d examples/projects/NUCLEO-F072RB/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-F072RB/inspector_serialcom
-          platformio run -d examples/projects/NUCLEO-F072RB/bootloader
-          platformio run -d examples/projects/NUCLEO-F072RB/button
-          platformio run -d examples/projects/NUCLEO-F072RB/dc_motor
-          platformio run -d examples/projects/NUCLEO-F072RB/potentiometer
-          # NUCLEO-L073RZ
-          platformio run -d examples/projects/NUCLEO-L073RZ/gate_serialcom
-          platformio run -d examples/projects/NUCLEO-L073RZ/button
-          platformio run -d examples/projects/NUCLEO-L073RZ/bootloader
-          # STM32L4S5_discovery
-          platformio run -d examples/projects/STM32L4S5_discovery/button
-          platformio run -d examples/projects/STM32L4S5_discovery/gate_serialcom
-          platformio run -d examples/projects/STM32L4S5_discovery/bootloader
-          # ESP32
-          platformio run -d examples/projects/ESP32/button
-          platformio run -d examples/projects/ESP32/button_arduino
-          platformio run -d examples/projects/ESP32/led
-          # SAMD21XPLAINED
+          for d in ${{ matrix.project_folders }}/*/
+          do
+            # Parse all folder
+            if [ -f "$d/platformio.ini" ]
+            then
+              # This is a PIO project compile it
+              echo "Compiling : $d"
+              platformio run -d $d
+            else
+              # This folder could contain other projects, continue digging
+              for dd in $d*/
+              do
+                # Parse all folder
+                if [ -f "$dd/platformio.ini" ]
+                then
+                  # This is a PIO project compile it
+                  echo "Compiling : $d"
+                  platformio run -d $dd
+                fi
+              done
+            fi
+          done
           # ******** missing bootloader CI ********
+
+  build-success:
+    name: Build success
+    needs: examples-build
+    runs-on: ubuntu-latest
+    steps:
+    - run: echo "Build succeed!"