Modified Projekt structure - added 2 projects

coderacer_mkII/simple_template/.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

coderacer_mkII/simple_template/.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

coderacer_mkII/simple_template/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ]
+}

coderacer_mkII/simple_template/include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

coderacer_mkII/simple_template/platformio.ini

@@ -0,0 +1,16 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino
+monitor_speed = 115200
+lib_deps = itsblue/CoderacerMKII@^1.0.0

coderacer_mkII/simple_template/test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html

coderacer_mkII/webdebug_demo/.gitignore

@@ -0,0 +1,5 @@
+.pio
+.vscode/.browse.c_cpp.db*
+.vscode/c_cpp_properties.json
+.vscode/launch.json
+.vscode/ipch

coderacer_mkII/webdebug_demo/.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

coderacer_mkII/webdebug_demo/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ]
+}

coderacer_mkII/webdebug_demo/include/README

@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html

coderacer_mkII/webdebug_demo/platformio.ini

@@ -0,0 +1,16 @@
+; PlatformIO Project Configuration File
+;
+;   Build options: build flags, source filter
+;   Upload options: custom upload port, speed and extra flags
+;   Library options: dependencies, extra library storages
+;   Advanced options: extra scripting
+;
+; Please visit documentation for the other options and examples
+; https://docs.platformio.org/page/projectconf.html
+
+[env:esp32dev]
+platform = espressif32
+board = esp32dev
+framework = arduino
+monitor_speed = 115200
+lib_deps = itsblue/CoderacerMKII@^1.0.0

coderacer_mkII/webdebug_demo/src/CodeRacer_Example_Main.cpp

@@ -0,0 +1,223 @@
+// Example Code of a CodeRacer sketch with implementation of a webserver
+#include "CodeRacer_MKII.h"
+#include "Webserver.h"
+
+CodeRacerMKII Coderacer;    // Inizialization of your CodeRacer
+AsyncWebServer server(80);    // IMPORTANT definition of the asynchronous Web server, including port number
+int Distance;
+int DemoMode=0;
+int maximum= 0;   
+int Array[160];
+int Degrees[160];
+int location= 0;    // Some numbers we need for later...
+Codeserver Test((char*)"coderacer_ap", (char*)"007coderacer");    // Creation of the webserver. enter your network's SSID and password here
+
+
+void setup() 
+{
+  Coderacer.begin();
+  Coderacer.servo_sweep_left_pos=120;   // Just a few adjustments to the servo_sweep parameters- that way, the servo sweeps more narrowly
+  Coderacer.servo_sweep_right_pos= 60;
+
+  /* One problem we came across during the testing of the Coderacer was, that the two engines don't run equally fast- meaning that even with 
+  identical speed (let's say 130, 130), the Racer will slowly pull to one side on longer distances. To adjust this issue, all you can do for now is test 
+  which engine is more powerful- and adjust your speed for the left and right side drives accordingly. */
+  Coderacer.speed_settings(140, 130);   
+
+  Serial.begin(115200);
+
+  Test.Run();   // Calls the Run() routine, which manages everything the webserver needs to work 
+  Coderacer.wifi_printf("Activate a switch to choose a Demonstration program.");
+  wait_ms(1000);
+  /*the IP adress of the server is given out on the Serial monitor. It is currently connected to the CodeRacer we used for testing and programming this sample code.
+  If the IP adress of YOUR CodeRacer differs from the one specified in Webserver.cpp, you have to change the following part of the HTML char array:
+  var Url ="http://192.168.1.146/"; -->  var Url ="your_IP_adress"; */
+}
+
+void loop()
+/* the loop contains four demonstration example codes, seperated by switch/ case which are supposed to give you the idea of the
+CodeRacer routines, what they do, how you can use them and what you need to consider before doing so. By turning on one of the switches, you select one of the demos.
+Activate the CodeRacer by pressing the left button, and watch the CodeRacer doing (hopefully) what it is advised to. Don't hesitate to watch the Webserver as well,
+instructions on how to get it running are shown and executed above. */
+{
+  DemoMode= Coderacer.switch_check();
+  switch (DemoMode)
+  {
+    case 0:
+    {
+      Coderacer.kitt();   // This is just some fun stuff happening while no program has been selected... feel free to edit it out :)
+      break;
+    }
+    case 1:
+    /* a Demo featuring: measuring the distance, driving forward until it falls below a certain value, then driving back 
+    for a small amount of time and turning 90 degrees to the right. NOTE: if you want to print out  debug message on the Webserver,
+    build in a certain delay time so the AJAX protocoll can process the message (otherwise it won't get displayed). */
+    {
+      Coderacer.wifi_printf("Selected: Demo 1, activate your CodeRacer to start");
+      Coderacer.set_leds_all_off();
+      wait_ms(5000);
+      while(Coderacer.is_active())    // If the left button is pressed, the CodeRacer becomes active and the loop starts
+      {
+        wait_ms(300);
+        Distance= Coderacer.usonic_measure_single_shot_cm();
+        while(Distance>25)
+        {
+          Distance=Coderacer.usonic_measure_single_shot_cm();
+          Coderacer.servo_sweep();
+          Coderacer.drive_forward();
+          // tells the CodeRacer to drive forward while sweeping the servo from left to right (the sweeping range is defined eariler in this code) and measure the distance
+        }
+        Coderacer.stop_driving();
+        Coderacer.servo_set_to_center();
+        wait_ms(500);
+        Coderacer.drive_backward_for_ms(500);
+        wait_ms(500);
+        Coderacer.wifi_printf("Drehung!");    //prints out a message on the webserver
+        wait_ms(500);
+        Coderacer.turn_degree(80);    // Due to the inertia of the wheels, lower the degrees of the turn a bit- in this case, although 80 are stated, the Racer does an almost perfect 90 degree turn...
+        wait_ms(500);
+      }
+      break;
+    }
+    case 2:
+    /* a more "intelligent" way to tell the CodeRacer where to drive. Basically the idea is to let the CodeRacer drive forward until a certain distance is reached (as done before).
+    Then, the servo sweeps from left to right filling an array of distances, getting the index of the highest value and then turning a precise amount of degrees,
+    depending on that value. The scheme of the code is explained below*/
+    {
+      Coderacer.wifi_printf("Selected: Demo 2, activate your CodeRacer to start");
+      Coderacer.set_leds_all_off();
+      wait_ms(5000);
+      while(Coderacer.is_active())    
+      {
+        Distance= Coderacer.usonic_measure_cm();
+        while (Distance>25)   // Again a simple way to tell the Racer "drive until a distance of __ cm is reached"
+        {
+          Distance= Coderacer.usonic_measure_single_shot_cm();
+          Coderacer.servo_sweep();
+          Coderacer.drive_forward(210, 190);
+        }
+        Coderacer.stop_driving();
+        wait_ms(1000);
+
+        for(int i=0, k=10; i<160; i++, k++)   // sweeps the servo from right to leftmost position and fills an array with the measured distances
+        {
+          Coderacer.servo_set_position_wait(k);
+          Array[i]=Coderacer.usonic_measure_single_shot_cm();
+        }
+
+        Coderacer.servo_set_to_center();    // Reset servo
+        wait_ms(200);
+
+        maximum= Array[0];    // Defines the maximum value of the array at the index 0
+
+        for (int c = 0; c < 160; c++)   // Emitts the highest value of the distance- array. One flaw: only the first time this value shows up is saved.
+        {
+          if (Array[c] > maximum)
+          {
+            maximum  = Array[c];
+            location = c;
+          }
+        }
+
+        for(int i=0, k=80; i<160; i++, k--)   // Finally, create an array of degrees from 80 to -80 (representing the distance array from 0 to 160)
+        {
+          Degrees[i]= k;
+        }
+        Coderacer.turn_degree(Degrees[location]);   // ...And turn the servo by the number of degrees roughly representing the biggest distance!
+        wait_ms(500);
+      }
+      break;
+    }
+    
+    case 3:
+    /* a demo program featuring: an alternative way telling the CodeRacer to stop when a ceratin distance is reached. the Racer will drive around
+    happily, turning left and right until the specified value is measured. NOTE: it might occur that the Racer won't get to measure the stop distance
+    - if that is the case, just hold your hand in front of it so it breaks out of the while- loop ;) */ 
+    {
+      Coderacer.wifi_printf("Selected: Demo 3, activate your CodeRacer to start");
+      Coderacer.set_leds_all_off();
+      wait_ms(5000);
+      while(Coderacer.is_active())    
+      {    
+        Distance = Coderacer.usonic_measure_cm();   // measure the distance - at the position of the servo 
+        Coderacer.start_stop_at_min_distance(20);   // Select a distance- the CodeRacer will stop if the Usonic Sensor measures it
+        while(!Coderacer.stopped_at_min_distance())   // WHILE the CodeRacer hasn't stopped at the previous declared distance...
+        {    
+          if(Distance > 50)
+          {
+            Coderacer.drive_forward();
+            Coderacer.servo_sweep();
+          }
+          else if(Distance > 40)
+          {
+            Coderacer.turn_right();        
+          }
+          else if(Distance > 30)
+          {
+            Coderacer.turn_left();
+          }
+          else 
+          { 
+            Coderacer.drive_backward();
+          }
+          
+          Distance = Coderacer.usonic_measure_cm();   
+          // Measure the distance again- be careful with usonic_measure_cm(), as this method takes a while to complete. Calling it too fast will crash your Code.
+        }
+        Coderacer.wifi_printf("Stopped at minimal stopped distance selected by user!!");  
+        wait_ms(2000);
+        Coderacer.set_inactive();
+      }
+      break;
+    }
+    case 4:
+    /* a demo program showing the scheme of displaying messages in the Webserver. After doing so, take a look at the dashboard on the website!
+    the racer will drive a specific amounts of ticks for the left and right wheel afterwards, you can check if that works correctly looking into
+    the table. NOTE: you might want to disable the CodeRacer from driving away- no stopping condition built in this time, so it might
+    bump into something while driving... just let the wheels turn freely and watch the dashboard... */
+    {
+      Coderacer.wifi_printf("Selected: Demo 4, activate CodeRacer to start");
+      Coderacer.set_leds_all_off();
+      wait_ms(5000);
+     
+      while(Coderacer.is_active())    
+      {
+        Coderacer.set_obstacle_stop(true);
+        Coderacer.wifi_printf("Welcome...");
+        wait_ms(1000);    
+        // As previously mentioned, the website resfrehes internally, but only in an interval of 750ms
+        // So if you want your message to be properly displayed, you got to build in a delay using wait_ms...
+        Coderacer.wifi_printf("Using wifi_printf");
+        wait_ms(1000);
+        Coderacer.wifi_printf("You can display custom messages on the Webserver!");
+        wait_ms(1000);
+        Coderacer.wifi_printf("But you knew that already!");
+        wait_ms(1000);
+        Coderacer.wifi_printf("Dont forget to build in small waiting windows...");
+        wait_ms(1000);
+        Coderacer.wifi_printf("So your message is transmitted properly!");
+        wait_ms(1000);
+        Coderacer.wifi_printf("Also, check out the clear button!");
+        wait_ms(1000);
+        Coderacer.wifi_printf("Now, watch the stepcounters in the table!");
+        wait_ms(2000);
+
+        Coderacer.drive_ticks_left(200, true);
+        while (true== Coderacer.is_driving()){} // IMPORTANT! halts the Code while the Racer is driving its __ steps on each side.
+        wait_ms(3000);
+        Coderacer.Reset_Stats();    // Resets the stats of the Racer, including stepcounters and speed settings to default.
+        Coderacer.speed_settings(255, 245);   // New Speed settings for both drives...
+        wait_ms(3000);    // The delay is once again needed so the debug message of reset_stats() is properly displayed...
+        Coderacer.drive_ticks_right(200, true);
+        while (true== Coderacer.is_driving()){}
+        Coderacer.wifi_printf("End of demo 3!");
+        wait_ms(3000);
+        Coderacer.set_inactive();
+      }
+      break;
+    }
+    
+  }
+  
+ 
+}

coderacer_mkII/webdebug_demo/test/README

@@ -0,0 +1,11 @@
+
+This directory is intended for PIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html