diff --git a/readme.md.orig b/readme.md.orig new file mode 100644 index 0000000..93febaa --- /dev/null +++ b/readme.md.orig @@ -0,0 +1,63 @@ +<<<<<<< HEAD +![Build Status](https://git.itsblue.de/Fenoglio/coderacer/badges/master/build.svg) +![Flyer](/Doku/Bilder/coderace_get_in_contact_pic.png) +## Repo Overview +This is fun in progress and for sure not covering all questions and topics. +Hopefully you will get an idea of what that project means and is able to do. +Have fun and let us know what you think. + +Repo dir | Description +---------|-------------- +Arduino/libraries | arduino stuff and libraries +Doku | HowTo as well as doxygen documentation. To view doxygen documentation repository has to be downloaded (no rendering through gitlab) +Install | Everything to get your dev IDE running on your PC +AppInventor | Module to load into AppInventor or directly to your phone. +Fritzing | Schematics and stuff +Bilder | Pictures of racers and events;-) + +## Full API Docs +A full API Documentation is available [here](https://fenoglio.pages.itsblue.de/coderacer/) + +## How to start +* Start reading the [{code}racer HowTo](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf) +* Learn about the [{code}racer API](https://fenoglio.pages.itsblue.de/coderacer/) +* Download the {code}racer Repo and install the IDE on your PC (see [CodeRacer HowTo Page.8](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Installation of used libraries (see [{code}racer HowTo Page.10](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Compile example (esp32_coderacer_beispiel) (see [{code}racer HowTo Page.11](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Work on your OWN CodeRacer Algo + +## Feedback/Questions +* Please write your questions/feedback to development@itsblue.de + +======= +![Build Status](https://git.itsblue.de/Fenoglio/coderacer/badges/master/build.svg) +![Flyer](/Doku/Bilder/coderace_get_in_contact_pic.png) +## Repo Overview +This is fun in progress and for sure not covering all questions and topics. +Hopefully you will get an idea of what that project means and is able to do. +Have fun and let us know what you think. + +Repo dir | Description +---------|-------------- +Arduino/libraries | arduino stuff and libraries +Doku | HowTo as well as doxygen documentation. View it [here](https://pages.itsblue.de/fenoglio/coderacer/) +Install | Everything to get your dev IDE running on your PC +AppInventor | Module to load into AppInventor or directly to your phone. +Fritzing | Schematics and stuff +Bilder | Pictures of racers and events;-) + +## Full API Docs +A full API Documentation is available [here](https://pages.itsblue.de/fenoglio/coderacer/) + +## How to start +* Start reading the [{code}racer HowTo](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf) +* Learn about the [{code}racer API](https://pages.itsblue.de/fenoglio/coderacer/) +* Download the {code}racer Repo and install the IDE on your PC (see [CodeRacer HowTo Page.8](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Installation of used libraries (see [{code}racer HowTo Page.10](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Compile example (esp32_coderacer_beispiel) (see [{code}racer HowTo Page.11](https://git.itsblue.de/Fenoglio/coderacer/tree/master/Doku/coderacer_handbuch.pdf)) +* Work on your OWN CodeRacer Algo + +## Feedback/Questions +* Please write your questions/feedback to development@itsblue.de + +>>>>>>> f6a79fe7b7828a529dc55c811b94e43f733e5aa2 diff --git a/vsode/coderacer_mkII/.gitignore b/vsode/coderacer_mkII/.gitignore new file mode 100644 index 0000000..5762142 --- /dev/null +++ b/vsode/coderacer_mkII/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/vsode/coderacer_mkII/.travis.yml b/vsode/coderacer_mkII/.travis.yml new file mode 100644 index 0000000..a8bbc57 --- /dev/null +++ b/vsode/coderacer_mkII/.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 diff --git a/vsode/coderacer_mkII/.vscode/extensions.json b/vsode/coderacer_mkII/.vscode/extensions.json new file mode 100644 index 0000000..0f0d740 --- /dev/null +++ b/vsode/coderacer_mkII/.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" + ] +} diff --git a/vsode/coderacer_mkII/include/README b/vsode/coderacer_mkII/include/README new file mode 100644 index 0000000..45496b1 --- /dev/null +++ b/vsode/coderacer_mkII/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 diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.cpp b/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.cpp new file mode 100644 index 0000000..4a6e33f --- /dev/null +++ b/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.cpp @@ -0,0 +1,1230 @@ +// the compiler switch for an ESP8266 is looking like this: #elif defined(ARDUINO_ARCH_ESP8266) +#include "CodeRacer_MKII.h" + +using namespace std; + +/** @brief CodeRace constructor without pins. All pins settings taken from the coderacer header file +* @return nothing +*/ +CodeRacerMKII::CodeRacerMKII() +{ + _button_pin = H_BUTTON_PIN; + _servo_pin = H_SERVO_PIN; + _us_trigger_pin = H_US_TRIG_PIN; + _us_echo_pin = H_US_ECHO_PIN; + _drive_left_frwd_pin = H_DRIVE_LEFT_FWRD_PIN; + _drive_left_back_pin = H_DRIVE_LEFT_BACK_PIN; + _drive_left_enable_pin = H_DRIVE_LEFT_ENABLE_PIN; + _drive_right_frwd_pin = H_DRIVE_RIGHT_FWRD_PIN; + _drive_right_back_pin = H_DRIVE_RIGHT_BACK_PIN; + _drive_right_enable_pin = H_DRIVE_RIGHT_ENABLE_PIN; + _led_frwd_pin = H_LED_FRWD_PIN; + _led_stop_pin = H_LED_STOP_PIN; + _led_left_pin = H_LED_LEFT_PIN; + _led_right_pin = H_LED_RIGHT_PIN; +} + +/** @brief CodeRace constructor with pins.This will overwrite the default settings taken from the header file. +* @param button_pin Pin the external button is connected at +* @param servo_pin Pin the servo drive is connected at +* @param us_trigger_pin Pin the trigger signal of the ultrasonic sensor is connected at +* @param us_echo_pin Pin the echo signal of the ultrasonic sensor is connected at +* @param drive_left_frwd_pin Pin the forward pin of the left side drive device driver is connected at +* @param drive_left_back_pin Pin the backward pin of the left side drive device driver is connected at +* @param drive_left_enable_pin Pin the enable pin of the left side drive device driver is connected at +* @param drive_right_frwd_pin Pin the forward pin of the right side drive device driver is connected at +* @param drive_right_back_pin Pin the backward pin of the right side drive device driver is connected at +* @param drive_right_enable_pin Pin the enable pin of the right side drive device driver is connected at +* @param led_frwd_pin Pin the led that signals forward direction is connected at +* @param led_stop_pin Pin the led that signals that the drives are stopped is connected at +* @param led_left_pin Pin the led that signals left side direction is connected at +* @param led_right_pin Pin the led that signals right side direction is connected at +* @return nothing +*/ +CodeRacerMKII::CodeRacerMKII(uint8_t button_pin , uint8_t servo_pin, + uint8_t us_trigger_pin, uint8_t us_echo_pin, + uint8_t drive_left_frwd_pin, uint8_t drive_left_back_pin, uint8_t drive_left_enable_pin, + uint8_t drive_right_frwd_pin, uint8_t drive_right_back_pin, uint8_t drive_right_enable_pin, + uint8_t led_frwd_pin, uint8_t led_stop_pin, uint8_t led_left_pin, uint8_t led_right_pin +) +{ + _button_pin = button_pin; + _servo_pin = servo_pin; + _us_trigger_pin = us_trigger_pin; + _us_echo_pin = us_echo_pin; + _drive_left_frwd_pin = drive_left_frwd_pin; + _drive_left_back_pin = drive_left_back_pin; + _drive_left_enable_pin = drive_left_enable_pin; + _drive_right_frwd_pin = drive_right_frwd_pin; + _drive_right_back_pin = drive_right_back_pin; + _drive_right_enable_pin = drive_right_enable_pin; + _led_frwd_pin = led_frwd_pin; + _led_stop_pin = led_stop_pin; + _led_left_pin = led_left_pin; + _led_right_pin = led_right_pin; +} + +/** @brief Initialisation of all attributes and settings of the coderacer. Defaults are taken from the header file. +* @return nothing +*/ +void CodeRacerMKII::begin() { + + // init of variables and objects + _bluetoothcreated = false; + _bt_stopOnLostConnection_timeout_ms = 0; + _bt_lastmessagereceived = millis(); + _bt_ignoremsgs.clear(); + _bt_onlymsgs.clear(); + + _servo_dummy = new Servo(); // the dummy is needed so far to avoid conflicts with analog write + _servo = new Servo(); + servo_center_pos = H_SERVO_CENTER_POS; + servo_left_pos = H_SERVO_LEFT_POS; + servo_right_pos = H_SERVO_RIGHT_POS; + servo_sweep_left_pos = H_SERVO_SWEEP_LEFT_POS; + servo_sweep_right_pos = H_SERVO_SWEEP_RIGHT_POS; + _servo_position = servo_center_pos; + _servo_sweep_step = SERVO_SWEEP_TO_LEFT_STEP; + _servo_position_set_at_ms = millis(); + _servo_position_eta_in_ms = 0; + + _drive_left_speed = H_DRIVE_LEFT_SPEED; + _drive_right_speed = H_DRIVE_RIGHT_SPEED; + + _turn_left_for_ms = H_RACER_TURN_LEFT_FOR_MS; + _turn_right_for_ms = H_RACER_TURN_RIGHT_FOR_MS; + + coderracer_activ = false; + _coderracer_activ = true; + _drive = false; + _drive_set_at_ms = millis(); + _servo_sweep = false; + + _last_led_switched_at_ms = millis(); + _last_led_on = 0; + _led_count = 3; + + _servo_look_around_at_ms = millis() + random(FUN_MIN_PAUSE_MS, FUN_MAX_PAUSE_MS); + + _usonic_stop_distance_cm = H_US_STOP_DISTANCE_CM; + usonic_set_stop_distance_cm(_usonic_stop_distance_cm); + _coderacer_stopped_at_min_distance = false; + + // Ultrasonic sensor + pinMode(_us_trigger_pin, OUTPUT); + pinMode(_us_echo_pin, INPUT); + + // Servo drive + _servo->attach(_servo_pin); + + // Left drive + pinMode(_drive_left_frwd_pin, OUTPUT); + pinMode(_drive_left_back_pin, OUTPUT); + set_drive_left_state(DRIVESTOP); + ledcSetup(DRIVE_PWM_LEFT_CHANNEL, 5000, 8); // channel , 50 Hz, 8-bit width + ledcAttachPin(_drive_left_enable_pin, DRIVE_PWM_LEFT_CHANNEL); // connect left drive enable with PWM channel + + // Right drive + pinMode(_drive_right_frwd_pin, OUTPUT); + pinMode(_drive_right_back_pin, OUTPUT); + set_drive_right_state(DRIVESTOP); + ledcSetup(DRIVE_PWM_RIGHT_CHANNEL, 5000, 8); // channel , 50 Hz, 8-bit width + ledcAttachPin(_drive_right_enable_pin, DRIVE_PWM_RIGHT_CHANNEL); // connect right drive enable pin with PWM channel + + // LEDs + pinMode(_led_frwd_pin, OUTPUT); + pinMode(_led_stop_pin, OUTPUT); + pinMode(_led_left_pin, OUTPUT); + pinMode(_led_right_pin, OUTPUT); + // all LEDS off + set_leds_all_off(); + + // Button & -interrupt + button_last_pressed_at_ms = 0; + pinMode(_button_pin, INPUT_PULLUP); + attachInterrupt(digitalPinToInterrupt(_button_pin), _set_button_state, FALLING); + + // Random + randomSeed(analogRead(0)); + + //fun stuff + coderacer_fun_enabled = false; + +} + +//************************************** +//*** Coderacer hihger level methods *** +//************************************** +/** @defgroup higherlevel Higher level methods, setters and getters +* @{ +*/ +/** @defgroup higherlevelmeths Methods +* @{ +*/ + +/** @brief Stops the racer and sets status LEDs. +* @return nothing +*/ +void CodeRacerMKII::stop_driving() { + _servo_sweep = false; + _drive = false; + set_drives_stop_left_right(); + set_leds_left_stop_frwd_right(LEDOFF, LEDON, LEDOFF, LEDOFF); +} + +/** @brief Sets the speed and the directions of both drives so that it will move forward. +* +* The speed is taken from the header file or set by one of the methods defined in the lower level drive methods section +* @return nothing +*/ +void CodeRacerMKII::drive_forward() +{ + drive_forward(_drive_left_speed, _drive_right_speed); +} + +/** @brief Sets the speed as specified for both drives and the directions of both drives so that it will move forward. +* +* The specified speed values for both drives will be stored internaly so next time if you use e.g. drive_forward() exactly the here specified values will be taken. +* @param left_speed speed for the left side drive. 0<=speed<=255 +* @param right_speed speed for the right side drive. 0<=speed<=255 +* @return nothing +*/ +void CodeRacerMKII::drive_forward(uint8_t left_speed, uint8_t right_speed) +{ + set_drives_states_left_right(DRIVEFRWD, DRIVEFRWD); + set_drives_speed_left_right(left_speed, right_speed); + set_leds_left_stop_frwd_right(LEDOFF, LEDOFF, LEDON, LEDOFF); + _drive = true; + _drive_set_at_ms = millis(); +} + +/** @brief Sets the speed and the directions of both drives so that it will move backward. +* +* The speed is taken from the header file or set by one of the methods defined in the lower level drive methods section +* @return nothing +*/ +void CodeRacerMKII::drive_backward() +{ + drive_backward(_drive_left_speed, _drive_right_speed); +} + +/** @brief Sets the speed as specified for both drives and the directions of both drives so that it will move backward. +* +* The specified speed values for both drives will be stored internaly so next time if you use e.g. drive_backward() exactly the here specified values will be taken. +* @param left_speed speed for the left side drive. 0<=speed<=255 +* @param right_speed speed for the right side drive. 0<=speed<=255 +* @return nothing +*/ +void CodeRacerMKII::drive_backward(uint8_t left_speed, uint8_t right_speed) +{ + set_drives_states_left_right(DRIVEBACK, DRIVEBACK); + set_drives_speed_left_right(left_speed, right_speed); + set_leds_left_stop_frwd_right(LEDOFF, LEDON, LEDON, LEDOFF); + _drive = true; + _drive_set_at_ms = millis(); +} + +/** @brief Will turn the racer to the left for the internally stroe time in ms and with the internally stored speed. +* +* The speed for both the left side and right side drive can be set by the methods described in the lower level drive section. The turn to left time can be set by thoose methods as well. +* The method is delayed until the racer has turned. +* @return nothing +*/ +void CodeRacerMKII::turn_left() +{ + turn_left(_turn_left_for_ms, _drive_left_speed, _drive_right_speed); +} + +/** @brief Will turn the racer to the left for the specified time in ms and with the internally stored speed. +* +* The specified duration of time is stored internally and will be used next time by e.g. turn_left() +* @param turn_for_ms duration of time in ms to turn the racer +* @return nothing +*/ +void CodeRacerMKII::turn_left(unsigned long turn_for_ms) +{ + turn_left(turn_for_ms, _drive_left_speed, _drive_right_speed); +} + +/** @brief Will turn the racer to the left for the specified time in ms and with the specified speed. +* +* The specified duration of time and the specified speeds are stored internally and will be used next time by e.g. turn_left() +* @param turn_for_ms duration of time in ms to turn the racer +* @param left_speed speed for the left side drive +* @param right_speed speed for the right side drive +* @return nothing +*/ +void CodeRacerMKII::turn_left(unsigned long turn_for_ms, uint8_t left_speed, uint8_t right_speed) +{ + _drive = false; + set_leds_left_stop_frwd_right(LEDON, LEDOFF, LEDOFF, LEDOFF); // LEDs setzen + set_drives_states_left_right(DRIVEBACK, DRIVEFRWD); + set_drives_speed_left_right(left_speed, right_speed); + // wait set delay for the timed turn + _turn_left_for_ms = turn_for_ms; + delay(_turn_left_for_ms); + // stop drives again + set_drives_stop_left_right(); +} + +/** @brief Will turn the racer to the right for the internally stroe time in ms and with the internally stored speed. +* +* The speed for both the left side and right side drive can be set by the methods described in the lower level drive section. The turn to right time can be set by thoose methods as well. +* The method is delayed until the racer has turned. +* @return nothing +*/ +void CodeRacerMKII::turn_right() +{ + turn_right(_turn_right_for_ms, _drive_left_speed, _drive_right_speed); +} + +/** @brief Will turn the racer to the right for the specified time in ms and with the internally stored speed. +* +* The specified duration of time is stored internally and will be used next time by e.g. turn_right() +* @param turn_for_ms duration of time in ms to turn the racer +* @return nothing +*/ +void CodeRacerMKII::turn_right(unsigned long turn_for_ms) +{ + turn_right(turn_for_ms, _drive_left_speed, _drive_right_speed); +} + +/** @brief Will turn the racer to the right for the specified time in ms and with the specified speed. +* +* The specified duration of time and the specified speeds are stored internally and will be used next time by e.g. turn_right() +* @param turn_for_ms duration of time in ms to turn the racer +* @param left_speed speed for the left side drive +* @param right_speed speed for the right side drive +* @return nothing +*/ +void CodeRacerMKII::turn_right(unsigned long turn_for_ms, uint8_t left_speed, uint8_t right_speed) +{ + _drive = false; + set_leds_left_stop_frwd_right(LEDOFF, LEDOFF, LEDOFF, LEDON); // LEDs setzen + set_drives_states_left_right(DRIVEFRWD, DRIVEBACK); + set_drives_speed_left_right(left_speed, right_speed); + // wait set delay for the timed turn + _turn_right_for_ms = turn_for_ms; + delay(_turn_right_for_ms); + // stop drives again + set_drives_stop_left_right(); +} + +/** @brief Enables to stopp the racer if during a distance measurement the measured distance is smaller then the internally stored minimal distance. +* +* This allow all of the none-single shot ultra sonic measurement methods to stopp the racer in the case the measured distance is smaller than minimal distance. This is just the enablement - you have to call one of the none-single-shot ultra sonic measurement methods continously while driving and maybe sweeping the servo. +* If the racer was stopped can be checked with stopped_at_min_distance() - it will return true in that case. +* The minimal distance can be set by the ultrasonic sensor setter methods. +* There is an example coming with the coderacer libary that you can load and get an idea how that works. +* @return nothing +*/ +void CodeRacerMKII::start_stop_at_min_distance() { + start_stop_at_min_distance(_usonic_stop_distance_cm); +} + +/** @brief Enables to stopp the racer if during a distance measurement the measured distance is smaller then the specified minimal distance. +* +* This is almos the same as described for start_stop_at_min_distance(). You can specify the distance in cm here - this value will be stored internally and used by start_stop_at_min_distance() next time. +* @param min_distance_cm the minimal disctance in cm +* @return nothing +*/ +void CodeRacerMKII::start_stop_at_min_distance(unsigned long min_distance_cm) { + if (false == _coderacer_stop_at_distance_enabled) { + _coderacer_stopped_at_min_distance = false; + usonic_set_stop_distance_cm(min_distance_cm); + _coderacer_stop_at_distance_enabled = true; + } +} + +/** @brief Disables to stopp the racer if during a distance measurement the measured distance is smaller then the specified minimal distance. +* @return nothing +*/ +void CodeRacerMKII::stop_stop_at_min_distance() { + _coderacer_stop_at_distance_enabled = false; +} + +/** @brief This will return if the codracer is in active mode or not. +* +* There is a button used to toogle between active and inactive each time it is pressed This may help you to start driving and scanning the distance by pressing the button - and as well to stop the racer by pressing the button. +* This method will set the LEDs depending on the mode and sets the servo back to center and stopps the racer when leaving the active mode. You can leave or enter the active mode as well by setting using set_active() and set_inactive(). +* The button itself triggers and internall interrupt event and sets the active state - but you have to continously call that method to switch between inactive and active mode depending on the active state. +* If in inactive mode and fun is enabeld by just setting the coderacer_fun_enabled = true ... some fun will happen :-) +* +* @return True if the coderacer is in active mode. False if in inactive mode. +*/ +bool CodeRacerMKII::start_stop() { + if (_coderracer_activ != coderracer_activ) { + _coderracer_activ = coderracer_activ; + if (true == _coderracer_activ) { + set_leds_all_off(); + delay(500); + } + else { + stop_driving(); + set_leds_all_on(); + delay(200); + servo_set_to_center(); + _servo_look_around_at_ms = millis() + random(20000, 120000); + } + } + + if ((false == _coderracer_activ) && (true == coderacer_fun_enabled)) { + kitt(); + look_around(); + } + + return(_coderracer_activ); +} + +/** @} */ // end of group higherlevelmeths + /** @defgroup higherlevelgetters Getters and setters + * @{ + */ + +/** @brief Returns true if the racer was stopped at minimum distance. This set to false each time start_stop_at_min_distance() is called. +* @return True if stopped. +*/ +bool CodeRacerMKII::stopped_at_min_distance() { + return(_coderacer_stopped_at_min_distance); +} + +/** @brief Return true if the racer is driving - forward or backward +* @return True if driving forward or backward +*/ +bool CodeRacerMKII::is_driving() { + return(_drive); +} + +/** @brief Returns the duration of time that is internally stored and used for turning the racer left +* @return Time to turn left in ms +*/ +unsigned long CodeRacerMKII::turn_left_for_ms() { + return(_turn_left_for_ms); +} + +/** @brief Returns the duration of time that is internally stored and used for turning the racer left +* @return Time to turn left in ms +*/ +unsigned long CodeRacerMKII::turn_right_for_ms() { + return(_turn_right_for_ms); +} + +/** @brief Sets the coderracer_active state to inactive. If start_stop() is used - the inactive mode will be entered. +* @return nothing +*/ +void CodeRacerMKII::set_inactive() { + coderracer_activ = false; +} + +/** @brief Sets the coderracer_active state to active. If start_stop() is used - the active mode will be entered. +* @return nothing +*/ +void CodeRacerMKII::set_active() { + coderracer_activ = true; +} + +/** @brief Checks if coderracer_activ is set. +* +* coderracer_activ is toggled each time the button is pressed. After power on coderracer_activ is set to False. +* @return True id coderracer_activ is set - False if not. +*/ +bool CodeRacerMKII::is_active() { + return(coderracer_activ); +} + +/** @} */ // end of group higherlevelgetters +/** @} */ // end of group higherlevel + +//************************************** +//*** Just for fun *** +//************************************** +/** @defgroup lowerlevelfun Lower level fun stuff methods +* @{ +*/ +/** @brief Fun stuff - will move the servo around after a random amount of time +* @return nothing +*/ +void CodeRacerMKII::look_around() +{ + if (_servo_look_around_at_ms < millis()) { + _servo_look_around_at_ms = millis() + random(FUN_MIN_PAUSE_MS, FUN_MAX_PAUSE_MS); + servo_set_to_left(); + delay(500); + servo_set_to_right(); + delay(800); + servo_set_to_center(); + delay(300); + servo_set_to_left(); + delay(100); + servo_set_to_center(); + } +} + +/** @brief Fun stuff - you know Knightrider... +* @return nothing +*/ +void CodeRacerMKII::kitt() +{ + if (millis() - _last_led_switched_at_ms > LED_SWITCH_MS) { + _last_led_switched_at_ms = millis(); + if (_last_led_on >= 5) { + _led_count = -1; + } + else if (_last_led_on <= 0) { + _led_count = 1; + } + _last_led_on = _last_led_on + _led_count; + switch (_last_led_on) { + case 0: + set_leds_left_stop_frwd_right(LEDON, LEDOFF, LEDOFF, LEDOFF); + break; + case 1: + set_leds_left_stop_frwd_right(LEDON, LEDOFF, LEDOFF, LEDOFF); + break; + case 2: + set_leds_left_stop_frwd_right(LEDOFF, LEDON, LEDOFF, LEDOFF); + break; + case 3: + set_leds_left_stop_frwd_right(LEDOFF, LEDOFF, LEDON, LEDOFF); + break; + case 4: + case 5: + set_leds_left_stop_frwd_right(LEDOFF, LEDOFF, LEDOFF, LEDON); + break; + } + } +} + +/** @} */ // end of group lowerlevelfun + + +//************************************** +//*** Bluetooth *** +//************************************** +/** @defgroup lowerlevelbluetooth Lower level bluetooth methods +* @{ +*/ +/** @brief starting the bluetooth service for the coderacer if not already started +* @param name the device will be listed by that name in your bluetooth device lists +* @return nothing +*/ +void CodeRacerMKII::bt_start(String name) +{ + if (false == _bluetoothcreated) { + _BTSerial = new BluetoothSerial(); + _BTSerial->begin(name); + _bluetoothcreated = true; + } +} + +/** @brief enables the code to stop if there was no incoming message for the specified time. This will be checked everytime bt_getXXX or bt_msgavailable is called. +* @param timeout after that duration of milliseconds without an incoming bluetooth message the coderacer will be stopped. 0 means this stoppinf is disabled. +* @return nothing +*/ +void CodeRacerMKII::bt_enable_stopOnLostConnection(unsigned long timeout) +{ + _bt_stopOnLostConnection_timeout_ms = timeout; +} + +/** @brief enables the code to stop if there was no incoming message for 1 second. This will be checked everytime bt_getXXX or bt_msgavailable is called. +* @return nothing +*/ +void CodeRacerMKII::bt_enable_stopOnLostConnection() +{ + _bt_stopOnLostConnection_timeout_ms = 1000; +} + +/** @brief Disables the code to stop if there was no incoming message for a certain duration of time. +* @return nothing +*/ +void CodeRacerMKII::bt_disable_stopOnLostConnection() +{ + _bt_stopOnLostConnection_timeout_ms = 0; +} + +/** @brief gets the bluetooth message string until a delimiter of 0 +* @return will return the string. If nothing is availbale or the service is not started it will return an empty string. +*/ +String CodeRacerMKII::bt_getString() +{ + return bt_getString(0); +} + +/** @brief gets the bluetooth message string until a specified delimiter +* @return will return the string. If nothing is availbale or the service is not started it will return an empty string. +*/ +String CodeRacerMKII::bt_getString(uint8_t delimiterbyte) +{ + String readstring = ""; + if (bt_msgavailable()) + { + readstring = _BTSerial->readStringUntil(delimiterbyte); + if (find(_bt_ignoremsgs.begin(), _bt_ignoremsgs.end(), readstring) != _bt_ignoremsgs.end()) + { + readstring = ""; + } + } + return(readstring); +} + +/** @brief add a String to a list of Strings that will be ignored if this is received via blue tooth. Ignores means - it will be read from the pipe but not returned to user code. But it will reset the message timeout counter. +* @param stringtoignore the String that has to be ignored. Will be added to the internal list if not already there. +*/ +void CodeRacerMKII::bt_addStringToIgnoreList(String stringtoignore) +{ + std::vector::iterator it; + if (stringtoignore.length() > 0) + { + it = find(_bt_ignoremsgs.begin(), _bt_ignoremsgs.end() ,stringtoignore); + if (it == _bt_ignoremsgs.end()) + { + _bt_ignoremsgs.push_back(stringtoignore); + } + } +} + +/** @brief removes a String from the list of Strings that will be ignored if this is received via blue tooth. Ignores means - it will be read from the pipe but not returned to user code. But it will reset the message timeout counter. +* @param stringtoignore the String that has to be removed from the ignore list. +*/ +void CodeRacerMKII::bt_removeStringFromIgnoreList(String stringtoignore) +{ + std::vector::iterator it; + if (stringtoignore.length() > 0) + { + it = find(_bt_ignoremsgs.begin(), _bt_ignoremsgs.end(), stringtoignore); + if (it != _bt_ignoremsgs.end()) + { + _bt_ignoremsgs.erase(it); + } + } +} + +/** @brief Clears the list of Strings that will be ignored if this is received via blue tooth. All elements of the list will be deleted from the list. +*/ +void CodeRacerMKII::bt_clearIgnoreList() +{ + _bt_ignoremsgs.clear(); +} + + +/** @brief checks if a bluetooth is available. Will also stop the coderacer if there was nor message received for a certain time - and if stopping was enabled . +* @return true if a message is available , false if not message is available or the service was not started +*/ +bool CodeRacerMKII::bt_msgavailable() +{ + bool rc = false; + if (true == _bluetoothcreated) { + if(_BTSerial->available()) + { + rc = true; + _bt_lastmessagereceived = millis(); + } + if (_bt_stopOnLostConnection_timeout_ms > 0) + { + if ((millis() - _bt_lastmessagereceived) > _bt_stopOnLostConnection_timeout_ms) + { + stop_driving(); + } + } + + } + return rc; +} + +/** @} */ // end of group lowerlevelbluetooth + +//************************************** +//*** Servo drive lower level control *** +//************************************** +/** @defgroup lowerlevelservo Lower level servo drive methods and getters +* @{ +*/ +/** @defgroup lowerlevelservomeths Methods +* @{ +*/ +/** @brief Overwrites the default settings taken from header file by the parameters given to this method +* @param pos_center The postion at which the servo moves to straight forward. Default is 90. Allowed 10 <= pos_center <= 170. +* @param pos_left The postion at which the servo moves to the left. Default is 170. Allowed 10 <= pos_center <= 170. +* @param pos_right The postion at which the servo moves to the right. Default is 10. Allowed 10 <= pos_center <= 170. +* @param sweep_left_pos If the servo is sweeping from left to the right - this defines the most left postion. Default is 140. Allowed 10 <= pos_center <= 170. +* @param sweep_right_pos If the servo is sweeping from left to the right - this defines the most right postion. Default is 40. Allowed 10 <= pos_center <= 170. +* @return nothing +*/ +void CodeRacerMKII::servo_settings(uint8_t pos_center, uint8_t pos_left, uint8_t pos_right, uint8_t sweep_left_pos, uint8_t sweep_right_pos) +{ + servo_center_pos = pos_center; + servo_left_pos = pos_left; + servo_right_pos = pos_right; + servo_sweep_left_pos = sweep_left_pos; + servo_sweep_right_pos = sweep_right_pos; +} + +/** @brief Turns sweeping of the servo from left to right and back on. +* +* The sweeping range is defind by #servo_sweep_left_pos and #servo_sweep_right_pos attributes. Both can be set by either servo_settings() or as public members. +* Every time servo_sweep() is called the servo is driven by 5 steps until either #servo_sweep_left_pos or #servo_sweep_right_pos is reached. Then it will turn the +* direction and step to the other side every time this method is called. +* @return nothing +*/ +void CodeRacerMKII::servo_sweep() +{ + uint8_t position; + _servo_sweep = true; + if (millis() - _servo_position_set_at_ms > SERVO_SWEEP_MS) { + position = _servo_position + _servo_sweep_step; + //sprintf(_debugmsg,"[%s] current position=%ld newpostion=%ld", __func__, _servo_position, position); + if ((position >= servo_sweep_left_pos) || (position >= SERVO_MAX_POSITION)) { + position = servo_sweep_left_pos; + _servo_sweep_step = SERVO_SWEEP_TO_RIGHT_STEP; + } + if ((position <= servo_sweep_right_pos) || (position <= SERVO_MIN_POSITION)) { + position = servo_sweep_right_pos; + _servo_sweep_step = SERVO_SWEEP_TO_LEFT_STEP; + } + _servo_set_position(position); + } +} + +/** @brief Drives the servo to the postion that is defined by #servo_right_pos +* @return nothing +*/ +void CodeRacerMKII::servo_set_to_right() +{ + servo_set_position_wait(servo_right_pos); +} + +/** @brief Drives the servo to the postion that is defined by #servo_left_pos +* @return nothing +*/ +void CodeRacerMKII::servo_set_to_left() +{ + servo_set_position_wait(servo_left_pos); +} + +/** @brief Drives the servo to the postion that is defined by #servo_center_pos +* @return nothing +*/ +void CodeRacerMKII::servo_set_to_center() +{ + servo_set_position_wait(servo_center_pos); +} + +/** @brief Drive the servo to the postion given to this method +* +* The method will wait until the servo has reached its new position. +* @param position Position the servo will be drived to. Allowed are values 10<=postion<=170. 10 is at the right hand side, 170 at the left hand side. +* @return The new servo position +*/ +uint8_t CodeRacerMKII::servo_set_position_wait(uint8_t position) +{ + _servo_sweep = false; + unsigned long wait_time_ms = _servo_set_position(position); + delay(wait_time_ms); + return(_servo_position); +} + +/** @brief Drive the servo to the postion given to this method +* +* The method will not wait until the servo has reached its new position. +* @param position Position the servo will be drived to. Allowed are values 10<=postion<=170. 10 is at the right hand side, 170 at the left hand side. +* @return The time in ms the servo will need to reach the new position +*/ +unsigned long CodeRacerMKII::servo_set_position(uint8_t position) +{ + _servo_sweep = false; + unsigned long wait_time_ms = _servo_set_position(position); + return(wait_time_ms); +} + +unsigned long CodeRacerMKII::_servo_set_position(uint8_t position) +{ + uint8_t _position = position; + uint8_t absdiff; + + if (position < SERVO_MIN_POSITION) { + _position = SERVO_MIN_POSITION; + } + else if (position > SERVO_MAX_POSITION) { + _position = SERVO_MAX_POSITION; + } + _servo->write(_position); + // wait minimal delay to avoid code collaps + delay(SERVO_SET_1TICK_POSITION_DELAY_MS); + absdiff = abs(_servo_position - _position); + if (absdiff > 1) { + _servo_position_eta_in_ms = absdiff * SERVO_SET_1TICK_POSITION_DELAY_MS; + } + else { + _servo_position_eta_in_ms = 0; + } + + _servo_position_set_at_ms = millis(); + _servo_position = _position; + + return(_servo_position_eta_in_ms); +} + +/** @} */ // end of group lowerlevelservomeths +/** @defgroup lowerlevelservogetters Getters +* @{ +*/ + +/** @brief Get the actual position of the servo +* @return Actual position of the servo +*/ +uint8_t CodeRacerMKII::servo_position() { + return(_servo_position); +} + +/** @brief Get the system time in ms the servo was set to the actual position +* @return System time in ms the servo was set +*/ +unsigned long CodeRacerMKII::servo_position_set_at_ms() { + return(_servo_position_set_at_ms); +} + +/** @brief Get the system time in ms the servo will reach its position +* This is an estimated time. +* If this is a time in the future, the servo may still moving. +* If this is a time in the past , the servo should have reached its postion already. +* @return System time in ms the servo will reach its position +*/ +unsigned long CodeRacerMKII::servo_position_eta_in_ms() { + return(_servo_position_eta_in_ms); +} + +/** @} */ // end of group lowerlevelservogetters +/** @} */ // end of group lowerlevelservo + + +//************************************** +//*** Ultrasonic lower level control *** +//************************************** +/** @defgroup lowerlevelus Lower level ultra sonic methods and getters +* @{ +*/ +/** @defgroup lowerlevelusmeths Methods +* @{ +*/ + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in cm. +* +* This is the medium one out of 3 measurements. The maximum measured distance is about 100cm and defined by the US_MAX_ECHO_TIME_US setting in the header file. +* @return The measured distance in cm. +*/ +unsigned long CodeRacerMKII::usonic_measure_cm() +{ + return(usonic_measure_cm(US_MAX_ECHO_TIME_US)); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in microseconds. +* +* This is the medium one out of 3 measurements. The maximum measured distance is about 6000 microseconds and defined by the US_MAX_ECHO_TIME_US setting in the header file. +* @return The measured distance in microseconds. +*/ +unsigned long CodeRacerMKII::usonic_measure_us() + { + return(usonic_measure_us(US_MAX_ECHO_TIME_US)); + } + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in cm. +* +* This is the medium one out of 3 measurements. Be careful with high values for max_echo_run_time_us - this may increase run time due to the fact that if there is nothing in range of the sensor it will wait until this specified run time of the echo is over. +* The maximum range the sensor is specified for is about 300cm. +* @param max_echo_run_time_us Defines the maximum echo run time and by that the maximum of distance that can be measured. +* @return The measured distance in cm. +*/ +unsigned long CodeRacerMKII::usonic_measure_cm(unsigned long max_echo_run_time_us) +{ + unsigned long echo_runtime_us = usonic_measure_us(max_echo_run_time_us); + unsigned long distance_cm = echo_runtime_us * 0.0172; + //Serial.print("MEASURE_DISTANCE. Distance in cm is: "); + //Serial.println(distance_cm); + _usonic_distance_cm = distance_cm; + return(distance_cm); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in microseconds. +* +* This is the medium one out of 3 measurements. Be careful with high values for max_echo_run_time_us - this may increase run time due to the fact that if there is nothing in range of the sensor it will wait until this specified run time of the echo is over. +* The maximum range the sensor is specified for is about 300cm. +* @param max_echo_run_time_us Defines the maximum echo run time in microseconds and by that the maximum of distance that can be measured. +* @return The measured distance in microseconds. +*/ +unsigned long CodeRacerMKII::usonic_measure_us(unsigned long max_echo_run_time_us) +{ + unsigned long echo_runtime_us[3] = { 0,0,0 }; + uint8_t measnr = 0; + + do { + echo_runtime_us[measnr] = usonic_measure_single_shot_us(max_echo_run_time_us); + if (echo_runtime_us[measnr] > 200) { + measnr++; + } + } while (measnr < 3); + + // we will take the medium out of 3 values ... + if (echo_runtime_us[0] > echo_runtime_us[1]) { std::swap(echo_runtime_us[0], echo_runtime_us[1]); } + if (echo_runtime_us[1] > echo_runtime_us[2]) { std::swap(echo_runtime_us[1], echo_runtime_us[2]); } + if (echo_runtime_us[0] > echo_runtime_us[1]) { std::swap(echo_runtime_us[0], echo_runtime_us[1]); } + + //Serial.print("MEASURE_DISTANCE_US. Echo runtime in us is: "); + //Serial.println(echo_runtime_us[1]); + + // if the stop at minimal distance is enabeled - check for minimal distance is reached + if (true == _coderacer_stop_at_distance_enabled) { + if (echo_runtime_us[1] <= _usonic_stop_distance_us) { + _coderacer_stopped_at_min_distance = true; + stop_driving(); + _coderacer_stop_at_distance_enabled = false; + } + } + _usonic_distance_us = echo_runtime_us[1]; + return(echo_runtime_us[1]); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in cm. +* +* This is a one shot measurement. The maximum measured distance is about 6000 microseconds and defined by the US_MAX_ECHO_TIME_US setting in the header file. +* @return The measured distance in cm. +*/ +unsigned long CodeRacerMKII::usonic_measure_single_shot_cm() +{ + return(usonic_measure_single_shot_cm(US_MAX_ECHO_TIME_US)); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in microseconds. +* +* This is a one shot measurement. The maximum measured distance is about 6000 microseconds and defined by the US_MAX_ECHO_TIME_US setting in the header file. +* @return The measured distance in microseconds. +*/ +unsigned long CodeRacerMKII::usonic_measure_single_shot_us() +{ + return(usonic_measure_single_shot_us(US_MAX_ECHO_TIME_US)); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in cm. +* +* This is a one shot measurement. Be careful with high values for max_echo_run_time_us - this may increase run time due to the fact that if there is nothing in range of the sensor it will wait until this specified run time of the echo is over. +* The maximum range the sensor is specified for is about 300cm. +* @param max_echo_run_time_us Defines the maximum echo run time in microseconds and by that the maximum of distance that can be measured. +* @return The measured distance in cm. +*/ +unsigned long CodeRacerMKII::usonic_measure_single_shot_cm(unsigned long max_echo_run_time_us) +{ + // convert into cm ... 344m/sec is the speed of noise - thus 34400cm/sec ... or 34,400cm/milisec ... or 0,0344cm/microsec + // the echo has to go the distance twice - forth and back - so the duration has to be the half of the measured one + // distance_cm = echo_duration/2 * 0,0344 or distance_cm = echo_duration/2 / 29,1 or distance_cm = echo_duration * 0,0172 + // distance_cm = (echo_duration/2) / 29.1; + unsigned long echo_runtime_us = usonic_measure_single_shot_us(max_echo_run_time_us); + unsigned long distance_cm = echo_runtime_us * 0.0172; + //Serial.print("MEASURE_DISTANCE. Distance in cm is: "); + //Serial.println(distance_cm); + _usonic_distance_cm = distance_cm; + return(distance_cm); +} + +/** @brief Measures the distance to the next object in front of the ultra sonic sensor in microseconds. +* +* This is a one shot measurement. Be careful with high values for max_echo_run_time_us - this may increase run time due to the fact that if there is nothing in range of the sensor it will wait until this specified run time of the echo is over. +* The maximum range the sensor is specified for is about 300cm. +* @param max_echo_run_time_us Defines the maximum echo run time in microseconds and by that the maximum of distance that can be measured. +* @return The measured distance in microseconds. +*/ +unsigned long CodeRacerMKII::usonic_measure_single_shot_us(unsigned long max_echo_run_time_us) + { + unsigned long echo_runtime_us; + // start measurement - send a short pulse "HIGH" to the TRIG pin of the ultrasonic sensor + pinMode(_us_echo_pin, OUTPUT); + pinMode(_us_echo_pin, INPUT); + digitalWrite(_us_trigger_pin, LOW); + delayMicroseconds(2); + digitalWrite(_us_trigger_pin, HIGH); + delayMicroseconds(10); + digitalWrite(_us_trigger_pin, LOW); + // measure runtime in microseconds until the ECHO pin aof the sensor goes HIGH + echo_runtime_us = pulseInLong(_us_echo_pin, HIGH, max_echo_run_time_us); + if (echo_runtime_us == 0) { + echo_runtime_us = max_echo_run_time_us; // US_MAX_ECHO_TIME_US; + } + //Serial.print("MEASURE_DISTANCE_US. Echo runtime in us is: "); + //Serial.println(echo_runtime_us); + _usonic_distance_us = echo_runtime_us; + return(echo_runtime_us); + } + +/** @} */ // end of group lowerlevelusmethods +/** @defgroup lowerlevelusgetters Setters and getters +* @{ +*/ + +/** @brief Sets the stop distance in cm. +* +* If start_stop_at_min_distance() is used and distance measured with one of the measurement methods - the racer will be stopped immediately. All except the singe shot methods of the ultra sonic measurements methods supports that. +* Internally the stop distance will be set as both - in cm and in microseconds. +* @param stop_distance_cm Distance in cm the racer will be stopped if that features was enabled by start_stop_at_min_distance() before. +* @return nothing +*/ +void CodeRacerMKII::usonic_set_stop_distance_cm(unsigned long stop_distance_cm) +{ + _usonic_stop_distance_us = stop_distance_cm * 58.14; +} + +/** @brief Sets the stop distance in cm. +* +* If start_stop_at_min_distance() is used and distance measured with one of the measurement methods - the racer will be stopped immediately. All except the singe shot methods of the ultra sonic measurements methods supports that. +* Internally the stop distance will be set as both - in cm and in microseconds. +* @param stop_distance_us Distance in cm the racer will be stopped if that features was enabled by start_stop_at_min_distance() before. +* @return nothing +*/ +void CodeRacerMKII::usonic_set_stop_distance_us(unsigned long stop_distance_us) +{ + _usonic_stop_distance_us = stop_distance_us; +} + +/** @brief Returns the last measured distance in microseconds +* @return Distance in microseconds +*/ +unsigned long CodeRacerMKII::usonic_distance_us() { + return(_usonic_distance_us); +} + +/** @brief Returns the last measured distance in cm +* @return Distance in cm +*/ +unsigned long CodeRacerMKII::usonic_distance_cm() { + return(_usonic_distance_cm); +} + +/** @} */ // end of group lowerlevelusgetters +/** @} */ // end of group lowerlevelus + + +//************************************** +//*** Drives lower level control *** +//************************************** + +/** @defgroup lowerleveldrives Lower level drives methods and getters +* @{ +*/ +/** @defgroup lowerleveldrivesmeths Methods +* @{ +*/ + +/** @brief Overwrites some drive settings. This will replace the defaults set by the values in the header file. +* @param drive_left_speed Speed of the left side drive +* @param drive_right_speed Speed of the right side drive +* @param turn_left_for_ms Time in ms the racer will turn to the left around its center if turn_left() is called +* @param turn_right_for_ms Time in ms the racer will turn to the right around its center if turn_right() is called +* @return nothing +*/ +void CodeRacerMKII::drives_settings(uint8_t drive_left_speed, uint8_t drive_right_speed, unsigned long turn_left_for_ms, unsigned long turn_right_for_ms) +{ + _drive_left_speed = drive_left_speed; + _drive_right_speed = drive_right_speed; + _turn_left_for_ms = turn_left_for_ms; + _turn_right_for_ms = turn_right_for_ms; +} + +/** @brief Stopps both drives +* @return nothing +*/ +void CodeRacerMKII::set_drives_stop_left_right() { + set_drive_left_state(DRIVESTOP); + set_drive_right_state(DRIVESTOP); +} + +/** @brief Sets both of the drives to a specified drivestate (DRIVESTOP, DRIVEFRWD, DRIVEBACK) +* @param stateleft drivestate to set for the left side drive +* @param stateright drivestate to set for the right side drive +* @return nothing +*/ +void CodeRacerMKII::set_drives_states_left_right(drivestate stateleft, drivestate stateright) { + set_drive_left_state(stateleft); + set_drive_right_state(stateright); +} + +/** @brief Sets the left side drive to the specified drivestate (DRIVESTOP, DRIVEFRWD, DRIVEBACK) +* @param state drivestate to set for the left side drive +* @return nothing +*/ +void CodeRacerMKII::set_drive_left_state(drivestate state) { + set_drive_state(state, _drive_left_frwd_pin, _drive_left_back_pin); +} + +/** @brief Sets the right side drive to the specified drivestate (DRIVESTOP, DRIVEFRWD, DRIVEBACK) +* @param state drivestate to set for the right side drive +* @return nothing +*/ +void CodeRacerMKII::set_drive_right_state(drivestate state) { + set_drive_state(state, _drive_right_frwd_pin, _drive_right_back_pin); +} + +/** @brief Sets the specified drivestate for the drive connected to the sepecified pins (DRIVESTOP, DRIVEFRWD, DRIVEBACK) +* @param state drivestate to set for the connected drive +* @param frwdpin Pin the forward signal of the drive device driver is connected at +* @param backpin Pin the backward signal of the drive device driver is connected at +* @return nothing +*/ +void CodeRacerMKII::set_drive_state(drivestate state, uint8_t frwdpin, uint8_t backpin) { + switch (state) { + case DRIVESTOP: + digitalWrite(frwdpin, LOW); + digitalWrite(backpin, LOW); + break; + case DRIVEFRWD: + digitalWrite(frwdpin, HIGH); + digitalWrite(backpin, LOW); + break; + case DRIVEBACK: + digitalWrite(frwdpin, LOW); + digitalWrite(backpin, HIGH); + break; + } +} + +/** @brief Sets the speed for both of the drives. +* +* The drive will run with that speed afterwards. The direction of the drive has to be specfied with one of the set_drive_state methods before +* @param speedleft speed of the left side drive. 0<=speed<=255 +* @param speedright speed of the right side drive. 0<=speed<=255 +* @return nothing +*/ +void CodeRacerMKII::set_drives_speed_left_right(uint8_t speedleft, uint8_t speedright) { + set_drive_left_speed(speedleft); + set_drive_right_speed(speedright); +} + +/** @brief Sets the speed for the left side drive. +* +* The drive will run with that speed afterwards. The direction of the drive has to be specfied with one of the set_drive_state methods before +* @param speed speed of the left side drive. 0<=speed<=255 +* @return nothing +*/ +void CodeRacerMKII::set_drive_left_speed(uint8_t speed) { + set_drive_speed(speed, _drive_left_enable_pin); +} + +/** @brief Sets the speed for the right side drive. +* +* The drive will run with that speed afterwards. The direction of the drive has to be specfied with one of the set_drive_state methods before +* @param speed speed of the right side drive. 0<=speed<=255 +* @return nothing +*/ +void CodeRacerMKII::set_drive_right_speed(uint8_t speed) { + set_drive_speed(speed, _drive_right_enable_pin); +} + +/** @brief Sets the speed for the drive of the enable pin connected to the specified pin. +* +* The drive will run with that speed afterwards. The direction of the drive has to be specfied with one of the set_drive_state methods before +* @param speed speed of the drive. 0<=speed<=255 +* @param enablepin Pin the drives device driver enable pin is connected at +* @return nothing +*/ +void CodeRacerMKII::set_drive_speed(uint8_t speed, uint8_t enablepin) { + _analog_write(enablepin, (int)speed); +} + +/** @} */ // end of group lowerleveldrivesmethods +/** @defgroup lowerleveldrivesgetters Getters +* @{ +*/ + +/** @brief Get the setting for the speed of the right side drive +* @return Speed of the right side drive +*/ +uint8_t CodeRacerMKII::drive_right_speed() { + return _drive_right_speed; +} + +/** @brief Get the setting for the speed of the left side drive +* @return Speed of the left side drive +*/ +uint8_t CodeRacerMKII::drive_left_speed() { + return(_drive_left_speed); +} + +void CodeRacerMKII::_analog_write(uint8_t pin, uint8_t speed) { + if (pin == _drive_left_enable_pin) { + _drive_left_speed = speed; + ledcWrite(DRIVE_PWM_LEFT_CHANNEL, speed); + } + if (pin == _drive_right_enable_pin) { + _drive_right_speed = speed; + ledcWrite(DRIVE_PWM_RIGHT_CHANNEL, speed); + } +} + +/** @} */ // end of group lowerleveldrivesgetters +/** @} */ // end of group lowerleveldrives + + +//************************************** +//*** LED lower level control *** +//************************************** +/** @defgroup lowerlevelled Lower level LED methods +* @{ +*/ +/** @defgroup lowerlevelledmeths Methods +* @{ +*/ + +/** @brief Sets all of the 4 LEDs to a ledstate (LEDON, LEDOFF) +* @param leftled set state of status left LED (most left yellow led) +* @param stopled set state of status stop LED (red led) +* @param frwdled set state of status forward LED (green or blue led) +* @param rightled set state of status right LED (most right yellow led) +* @return nothing +*/ +void CodeRacerMKII::set_leds_left_stop_frwd_right(ledstate leftled, ledstate stopled, ledstate frwdled, ledstate rightled) { + digitalWrite(_led_left_pin, leftled); + digitalWrite(_led_frwd_pin, frwdled); + digitalWrite(_led_right_pin, rightled); + digitalWrite(_led_stop_pin, stopled); +} + +/** @brief Sets all of the 4 LEDs to the same ledstate (LEDON, LEDOFF) +* @param alleds set state to all status LEDs +* @return nothing +*/ +void CodeRacerMKII::set_leds_all(ledstate alleds) { + digitalWrite(_led_left_pin, alleds); + digitalWrite(_led_frwd_pin, alleds); + digitalWrite(_led_right_pin, alleds); + digitalWrite(_led_stop_pin, alleds); +} + +/** @brief Sets all of the 4 LEDs to the ledstate LEDOFF +* @return nothing +*/ +void CodeRacerMKII::set_leds_all_off() { + set_leds_all(LEDOFF); +} + +/** @brief Sets all of the 4 LEDs to the ledstate LEDON +* @return nothing +*/ +void CodeRacerMKII::set_leds_all_on() { + set_leds_all(LEDON); +} + +/** @} */ // end of group lowerlevelledmets +/** @} */ // end of group lowerlevelled + + +//************************************** +//*** ISRs *** +//************************************** +//IRAM_ATTR is used to load the code into DRAM and not to Flash to make it faster - required for ISRs +void IRAM_ATTR CodeRacerMKII::_set_button_state() { + if ((millis() - button_last_pressed_at_ms) > BUTTON_BOUNCING_TIME_MS) { + button_last_pressed_at_ms = millis(); // simplest debouncing - just wait ;-) + coderracer_activ = !coderracer_activ; + } +} + +//********************************************************************************************************************** +//** Helper methods +//********************************************************************************************************************** + diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.h b/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.h new file mode 100644 index 0000000..2e89253 --- /dev/null +++ b/vsode/coderacer_mkII/lib/CodeRacer_MKII/CodeRacer_MKII.h @@ -0,0 +1,270 @@ +#include "Arduino.h" +#include // std::swap +#include // Servo drive support for ESP32 +#include "esp32-hal-ledc.h" // Part of ESP32 board files - Analog output +#include "BluetoothSerial.h" // Bluetooth enablement - part of ESP or standart Arduino lib +#include // support for vectors +#include + +#if !defined(CONFIG_BT_ENABLED) || !defined(CONFIG_BLUEDROID_ENABLED) +#error Bluetooth is not enabled! Please run `make menuconfig` to and enable it +#endif + +#ifndef __CodeRacer_MKII_H__ +#define __CodeRacer_MKII_H__ + +//----- Fun stuff --------- +#define FUN_MIN_PAUSE_MS 120000 // minimum and maximum pause between to rounds fun +#define FUN_MAX_PAUSE_MS 300000 +#define LED_SWITCH_MS 50 // speed of knight rider lights +//----- Button ------------ +#define H_BUTTON_PIN 17 +#define BUTTON_BOUNCING_TIME_MS 200 // bouncing delay +//----- Servo ----- +#define H_SERVO_PIN 16 +#define H_SERVO_LEFT_POS 145 // left position of the servo +#define H_SERVO_CENTER_LEFT 100 // left-center position of the servo +#define H_SERVO_RIGHT_POS 35 // right position of the servo +#define H_SERVO_CENTER_RIGHT 80 // right-center position of the servo +#define H_SERVO_CENTER_POS 90 // center position of the servo +#define H_SERVO_SWEEP_LEFT_POS 140 // most left sweep position of the servo +#define H_SERVO_SWEEP_RIGHT_POS 40 // most right sweep position of the servo +#define SERVO_SWEEP_TO_LEFT_STEP 5 // sweep step to the left +#define SERVO_SWEEP_TO_RIGHT_STEP -5 // sweep step to the right +#define SERVO_SWEEP_MS 10 // duration of time betwee to sweep steps +#define SERVO_MAX_POSITION 170 // maximum servo position +#define SERVO_MIN_POSITION 10 // minimum servo position +#define SERVO_SET_1TICK_POSITION_DELAY_MS 3 // minimum duration of time between two servo steps + +//----- Ultrasonic sensor ----- +#define H_US_TRIG_PIN 12 +#define H_US_ECHO_PIN 14 +#define H_US_STOP_DISTANCE_CM 25 // if the measured distance is smaller the racer maybe stopped +#define US_MAX_ECHO_TIME_US 6000 // timeout for ultrasonic sensor measurements - this is about 100cm + +//----- Drives ----- +#define H_DRIVE_RIGHT_SPEED 255 // default speed of right side drive. 0 ...255 +#define H_DRIVE_LEFT_SPEED 255 // default speed of left side drive. 0 ...255 +#define H_DRIVE_RIGHT_ENABLE_PIN 2 +#define H_DRIVE_RIGHT_FWRD_PIN 4 +#define H_DRIVE_RIGHT_BACK_PIN 15 +#define H_DRIVE_LEFT_ENABLE_PIN 21 +#define H_DRIVE_LEFT_FWRD_PIN 22 +#define H_DRIVE_LEFT_BACK_PIN 23 +#define H_RACER_TURN_LEFT_FOR_MS 400 // duration of time the racer will turn to left +#define H_RACER_TURN_RIGHT_FOR_MS 400 // duration of time the racer will turn to right + +#define DRIVE_PWM_LEFT_CHANNEL 5 // PWM-channel for left side drive +#define DRIVE_PWM_RIGHT_CHANNEL 6 // PWM-channel for right side drive + +//----- LEDs ----- +#define H_LED_FRWD_PIN 26 +#define H_LED_STOP_PIN 25 +#define H_LED_LEFT_PIN 33 +#define H_LED_RIGHT_PIN 27 + + +using namespace std; + +static volatile bool coderracer_activ = false;; +static volatile unsigned long button_last_pressed_at_ms = millis(); + +enum ledstate { + LEDOFF, + LEDON +}; + +enum drivestate { + DRIVESTOP, + DRIVEFRWD, + DRIVEBACK +}; + +//--- this is as preparation of the class creation +class CodeRacerMKII { + + private: + + //bluetooth + std::vector _bt_ignoremsgs; + std::vector _bt_onlymsgs; + bool _bluetoothcreated; + unsigned long _bt_stopOnLostConnection_timeout_ms; + unsigned long _bt_lastmessagereceived; + BluetoothSerial* _BTSerial; + + //pins + uint8_t _button_pin; + uint8_t _servo_pin; + uint8_t _us_trigger_pin; + uint8_t _us_echo_pin; + uint8_t _drive_left_frwd_pin; + uint8_t _drive_left_back_pin; + uint8_t _drive_left_enable_pin; + uint8_t _drive_right_frwd_pin; + uint8_t _drive_right_back_pin; + uint8_t _drive_right_enable_pin; + uint8_t _led_frwd_pin; + uint8_t _led_stop_pin; + uint8_t _led_left_pin; + uint8_t _led_right_pin; + + //servo variables + int8_t _servo_sweep_step; + uint8_t _servo_position; + unsigned long _servo_position_set_at_ms; + unsigned long _servo_position_eta_in_ms; + + //drives variables + uint8_t _drive_left_speed; + uint8_t _drive_right_speed; + unsigned long _turn_left_for_ms; + unsigned long _turn_right_for_ms; + + // ultrasonic variables + bool _coderacer_stopped_at_min_distance; + bool _coderacer_stop_at_distance_enabled; + unsigned long _usonic_stop_distance_cm; + unsigned long _usonic_stop_distance_us; + unsigned long _usonic_distance_us; + unsigned long _usonic_distance_cm; + + //fun stuff variables + unsigned long _last_led_switched_at_ms; + uint8_t _led_count; + uint8_t _last_led_on; + unsigned long _servo_look_around_at_ms; + + + unsigned long _min_distance_cm; + bool _drive; + unsigned long _drive_set_at_ms; + bool _servo_sweep; + bool _coderracer_activ; + + //objects + Servo* _servo; + Servo* _servo_dummy; + + static void _set_button_state(); + void _analog_write(uint8_t pin, uint8_t speed); + unsigned long _servo_set_position(uint8_t position); + + public: + //properties + bool coderacer_fun_enabled; + + uint8_t servo_center_pos; /**< The position the servo is looking straight forward. Default is 90 . Allowed are values 10<=pos<=170 */ + uint8_t servo_left_pos; /**< The position the servo is looking to the left. Default is 170 . Allowed are values 10<=pos<=170 */ + uint8_t servo_right_pos; /**< The position the servo is looking to the right. Default is 0 . Allowed are values 10<=pos<=170 */ + uint8_t servo_sweep_left_pos; /**< When the servo is sweeping this is the left most position */ + uint8_t servo_sweep_right_pos; /**< When the servo is sweeping this is the right most position */ + + //methods + CodeRacerMKII(); + + CodeRacerMKII(uint8_t button_pin, uint8_t servo_pin, + uint8_t us_trigger_pin, uint8_t us_echo_pin, + uint8_t drive_left_frwd_pin, uint8_t drive_left_back_pin, uint8_t drive_left_enable_pin, + uint8_t drive_right_frwd_pin, uint8_t drive_right_back_pin, uint8_t drive_right_enable_pin, + uint8_t led_frwd_pin, uint8_t led_stop_pin, uint8_t led_left_pin, uint8_t led_right_pin); + + void set_inactive(); + void set_active(); + + void begin(); + + // getters + bool is_active(); + bool is_driving(); + bool stopped_at_min_distance(); + unsigned long usonic_distance_cm(); + unsigned long usonic_distance_us(); + uint8_t servo_position(); + unsigned long servo_position_set_at_ms(); + unsigned long servo_position_eta_in_ms(); + uint8_t drive_left_speed(); + uint8_t drive_right_speed(); + unsigned long turn_left_for_ms(); + unsigned long turn_right_for_ms(); + + // higher level {code}racer services + void stop_driving(); + void drive_forward(); + void drive_forward(uint8_t left_speed, uint8_t right_speed); + void drive_backward(); + void drive_backward(uint8_t left_speed, uint8_t right_speed); + void turn_left(); + void turn_left(unsigned long turn_for_ms); + void turn_left(unsigned long turn_for_ms, uint8_t left_speed, uint8_t right_speed); + void turn_right(); + void turn_right(unsigned long turn_for_ms); + void turn_right(unsigned long turn_for_ms, uint8_t left_speed, uint8_t right_speed); + + void start_stop_at_min_distance(); + void start_stop_at_min_distance(unsigned long min_distance_cm); + void stop_stop_at_min_distance(); + bool start_stop(); + + // Bluetooth + void bt_enable_stopOnLostConnection(); + void bt_enable_stopOnLostConnection(unsigned long timeout); + void bt_disable_stopOnLostConnection(); + void bt_start(String name); + String bt_getString(); + String bt_getString(uint8_t delimiterbyte); + bool bt_msgavailable(); + void bt_addStringToIgnoreList(String stringtoignore); + void bt_clearIgnoreList(); + void bt_removeStringFromIgnoreList(String stringtoignore); + + // LEDs + void set_leds_left_stop_frwd_right(ledstate leftled, ledstate stopled, ledstate frwdled, ledstate rightled); + void set_leds_all(ledstate alleds); + void set_leds_all_off(); + void set_leds_all_on(); + + // Drives + void drives_settings(uint8_t drive_left_speed, uint8_t drive_right_speed, unsigned long turn_left_ms, unsigned long turn_right_ms); + void set_drives_states_left_right(drivestate stateleft, drivestate stateright); + void set_drive_left_state(drivestate state); + void set_drive_right_state(drivestate state); + void set_drive_state(drivestate state, uint8_t frwdpin, uint8_t backpin); + void set_drives_speed_left_right(uint8_t speedleft, uint8_t speedright); + void set_drive_left_speed(uint8_t speed); + void set_drive_right_speed(uint8_t speed); + void set_drive_speed(uint8_t speed, uint8_t enablepin); + void set_drives_stop_left_right(); + + // Ultrasonic sensor + unsigned long usonic_measure_cm(); + unsigned long usonic_measure_us(); + unsigned long usonic_measure_cm(unsigned long max_echo_run_time_us); + unsigned long usonic_measure_us(unsigned long max_echo_run_time_us); + unsigned long usonic_measure_single_shot_cm(); + unsigned long usonic_measure_single_shot_us(); + unsigned long usonic_measure_single_shot_cm(unsigned long max_echo_run_time_us); + unsigned long usonic_measure_single_shot_us(unsigned long max_echo_run_time_us); + void usonic_set_stop_distance_cm(unsigned long stop_distance_cm); + void usonic_set_stop_distance_us(unsigned long stop_distance_us); + + // Servo drive + void servo_settings(uint8_t pos_center, uint8_t pos_left, uint8_t pos_right, uint8_t sweep_left_pos, uint8_t sweep_right_pos); + uint8_t servo_set_position_wait(uint8_t position); + unsigned long servo_set_position(uint8_t position); + void servo_set_to_right(); + void servo_set_to_left(); + void servo_set_to_center(); + void servo_sweep(); + + // just for fun + void kitt(); + void look_around(); + + + +}; + + + +#endif diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino b/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino new file mode 100644 index 0000000..bfb432e --- /dev/null +++ b/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/SimpleBTCoderacer/SimpleBTCoderacer.ino @@ -0,0 +1,56 @@ + +// Full API description of the coderacer.h can be found here: https://fenoglio.pages.itsblue.de/coderacer/ +// Repository with all needed data and users guide is here: https://git.itsblue.de/Fenoglio/coderacer/tree/master +// An example for a application to control the coderacer via bluetooth can be found here: https://git.itsblue.de/Fenoglio/coderacer/tree/master/AppInventor/SimpleBTCoderacer +// - this app was developed with MIT App Inventor and can be uploaded to your account to rework it. + +#include + +CodeRacer coderacer; +String recvddata = ""; //Variable in der der Bluetooth Befehl gespeichert wird + +void setup() { + Serial.begin(115200); + coderacer.begin(); + coderacer.bt_start("CodeRacer"); //Bluetooth für den Coderacer anschalten + coderacer.bt_enable_stopOnLostConnection(); //Coderacer anhalten, wenn 1 Sekunde nichts per Bluetooth empfangen wurde + coderacer.bt_addStringToIgnoreList("."); //das "." Zeichen wird beim empfangen ignoriert +} + +void loop() { + // Prüfen ob Bluetooth Nachrichten angekommen sind und die gleich abholen ... + recvddata = coderacer.bt_getString(); //die Nachtricht merken (sie steht jetzt in recvdata und kann später benutzt werden) + if (recvddata != "") //wenn eine Nachricht empfangen wurde, in der was drin steht ... + { + Serial.println(recvddata); + + if(recvddata == "stop") + { + coderacer.stop_driving(); + } + + if(recvddata == "vor") + { + coderacer.drive_forward(255,255); + } + + if(recvddata.startsWith("rueck")) + { + coderacer.drive_backward(255,255); + } + + if(recvddata.startsWith("links")) + { + coderacer.turn_left(); + } + + if(recvddata.startsWith("rechts")) + { + coderacer.turn_right(); + } + } + + delay(20); +} + + diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino b/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino new file mode 100644 index 0000000..0ac2270 --- /dev/null +++ b/vsode/coderacer_mkII/lib/CodeRacer_MKII/examples/coderacer_mkII_beispiel/coderacer_mkII_beispiel.ino @@ -0,0 +1,82 @@ +#include + +//----- settings for the ultrasonic sensor ----- +#define US_STOP_ABSTAND_CM 20 // if distance goes below that - stop the racer + +//----- variables we need +unsigned long distance_cm = 0; + +//---- construct the coderacer object +CodeRacer coderacer; + +//---- set up code - executed ones +void setup() { + // start serial monitor + Serial.begin(115200); + // initialize the coderacer + coderacer.begin(); + // enable fun stuff + coderacer.coderacer_fun_enabled = true; + // look to the left, to the right and to center... :-) + coderacer.servo_set_to_left(); + delay(100); + coderacer.servo_set_to_right(); + delay(100); + coderacer.servo_set_to_center(); + delay(100); +} + +//---- 'endless' loop +void loop() { + + // check if the racer was started (button was toggled to coderacer active state + if(true == coderacer.start_stop()){ + + Serial.print("Speed of right side drive: "); + Serial.println(coderacer.drive_right_speed()); + Serial.print("Speed of left side drive: "); + Serial.println(coderacer.drive_left_speed()); + + // measure the distance - at the position of the servo + distance_cm = coderacer.usonic_measure_cm(); + + coderacer.start_stop_at_min_distance(US_STOP_ABSTAND_CM); + while(!coderacer.stopped_at_min_distance()){ + + Serial.print("Distanc in cm: "); + Serial.println(distance_cm); + + if(distance_cm > 50){ + coderacer.drive_forward(); + coderacer.servo_sweep(); + } + else if(distance_cm > 40){ + coderacer.turn_right(); + } + else if(distance_cm > 30){ + coderacer.turn_left(); + } + else { + + coderacer.drive_backward(); + } + + // measure the distance - at the position of the servo + distance_cm = coderacer.usonic_measure_cm(); + + } + + Serial.println("***** STOPPED ***** "); + Serial.print("Measured stop distanc of cm: "); + Serial.println(distance_cm); + Serial.print("Measured at servo position of: "); + Serial.println(coderacer.servo_position()); + + coderacer.set_inactive(); + + } + +} + + + diff --git a/vsode/coderacer_mkII/lib/CodeRacer_MKII/keywords.txt b/vsode/coderacer_mkII/lib/CodeRacer_MKII/keywords.txt new file mode 100644 index 0000000..1f6ab67 --- /dev/null +++ b/vsode/coderacer_mkII/lib/CodeRacer_MKII/keywords.txt @@ -0,0 +1,15 @@ +CodeRacer KEYWORD1 +begin KEYWORD2 +servo_einstellungen KEYWORD2 +motor_einstellungen KEYWORD2 +anhalten KEYWORD2 +normal_tempo KEYWORD2 +vorwaerts KEYWORD2 +links KEYWORD2 +rechts KEYWORD2 +servo_rechts KEYWORD2 +servo_links KEYWORD2 +servo_mitte KEYWORD2 +abstand_messen KEYWORD2 +servo_schwenk KEYWORD2 +start_stop KEYWORD2 \ No newline at end of file diff --git a/vsode/coderacer_mkII/lib/README b/vsode/coderacer_mkII/lib/README new file mode 100644 index 0000000..8c9c29c --- /dev/null +++ b/vsode/coderacer_mkII/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in a an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/vsode/coderacer_mkII/platformio.ini b/vsode/coderacer_mkII/platformio.ini new file mode 100644 index 0000000..fa532b9 --- /dev/null +++ b/vsode/coderacer_mkII/platformio.ini @@ -0,0 +1,15 @@ +;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 + diff --git a/vsode/coderacer_mkII/src/coderacer_main.cpp b/vsode/coderacer_mkII/src/coderacer_main.cpp new file mode 100644 index 0000000..2759405 --- /dev/null +++ b/vsode/coderacer_mkII/src/coderacer_main.cpp @@ -0,0 +1,128 @@ +#include "CodeRacer_MKII.h" + +#include +#include "esp32-hal-ledc.h" + +//----- Werte für den Ultraschallsensor ----- +#define US_STOP_ABSTAND_CM 20 // Wenn der gemessene Abstand kleiner ist, hält der CodeRacer an +#define US_MIN_ABSTAND_LI_RE 8 // Wenn der Unterschied zwischen linkem und und rechtem Abstand kleiner ist, dann drehe in dieselbe Richtugn wie vorher weiter +#define MAX_ANZAHL_DREHUNGEN 10 // Wenn der Coderacer sich schon so oft gedreht hat ohne eine Stelle zu finden, wo es Platz gibt - fahren wir mal ein Stück rückwärts ... + +//----- Variablen, die wir brauchen um uns Werte zu merken ---- +long abstand_vorn_cm, abstand_links_cm, abstand_rechts_cm; +enum drehrichtung {links=0, rechts}; +drehrichtung drehung = links; +unsigned int anzahl_drehung = 0; +CodeRacerMKII coderacer; + +//---- Hier startet der Code zum Einstellen aller wichtigen Dinge. Setup() wird einmal ausgeführt. ---- +void setup() { + // Monitor + Serial.begin(115200); // Serial Monitor aktivieren. Mit dem Monitor kann man sich Werte und Meldungen anzeigen lassen. + + // CodeRacer initialisieren + coderacer.begin(); + + coderacer.servo_set_to_left(); + delay(10); + coderacer.servo_set_to_right(); + delay(10); + coderacer.servo_set_to_center(); + + anzahl_drehung = 0; + drehung = links; + +} + +//---- Hier startet unsere endlose Schleife - die immer wieder von vorn angefangen wird, wenn wir am Ende angekommen sind. Da ist unser "Fahr"Code drin, der den CodeRacer steuert +void loop() { + + + // Abstand messen -> nach vorn ... um zu sehen, ob was passiert messen wir immer ... auch wenn der Racer nicht fahren soll + abstand_vorn_cm = coderacer.usonic_measure_cm(); + + // Abfragen ob der Racer fahren soll oder nicht ... + if(true == coderacer.start_stop()){ + + // Abstandssensor schon verstellen ... dann hat er das bis zur nächsten Messung auch geschafft + coderacer.servo_sweep(); + + // Ist die Bahn frei? + if(abstand_vorn_cm < US_STOP_ABSTAND_CM){ + // Nein! Der Abstand nach vorn ist kleiner als erlaubt! + // Racer anhalten + coderacer.stop_driving(); + // Nach links schauen! + coderacer.servo_set_to_left(); + // Abstand messen und merken. + abstand_links_cm = coderacer.usonic_measure_cm(); + // Nach rechts schauen! + coderacer.servo_set_to_right(); + // Abstand messen und merken. + abstand_rechts_cm = coderacer.usonic_measure_cm(); + + + // Ist der Abstand links oder rechts groß genug genug? + // Wenn nicht - wenn der Racer sich bisher noch nicht gedreht hat - fahre ein Stück rückwarts. Wenn der Racer sich gerade schon gedreht hat, drehe in dieselbe Richtung wie vorher. + if((abstand_links_cm < US_MIN_ABSTAND_LI_RE) && (abstand_rechts_cm < US_MIN_ABSTAND_LI_RE)){ + if(anzahl_drehung == 0){ + coderacer.drive_backward(); + delay(300); + coderacer.stop_driving(); + //noch mal Abstand messen ... + coderacer.servo_set_to_left(); + // Abstand messen und merken. + abstand_links_cm = coderacer.usonic_measure_cm(); + // Nach rechts schauen! + coderacer.servo_set_to_right(); + // Abstand messen und merken. + abstand_rechts_cm = coderacer.usonic_measure_cm(); + } + if( anzahl_drehung > MAX_ANZAHL_DREHUNGEN ){ + anzahl_drehung = 0; + } else { + anzahl_drehung ++; + } + } + + // wenn der Racer sich noch nicht gedreht hat (anzahl_drehung == 0) - oder gerade rückwärts gefahren ist (anzahl_drehung == 1) drehe jetzt dahin wo mehr Platz ist; + if(anzahl_drehung <= 1){ + // Welcher Abstand ist größer? + if(abstand_links_cm > abstand_rechts_cm){ + // Links ist mehr Platz! + drehung = links; + } + else{ + // Rechts ist mehr Platz! + drehung = rechts; + } + } + + switch(drehung){ + case links: + coderacer.turn_left(); + coderacer.servo_set_to_center(); + break; + case rechts: + coderacer.turn_right(); + coderacer.servo_set_to_center(); + break; + } + } + else{ + // Ja! Die Bahn ist frei + // Wenn die Bahn richtig frei ist, dann können wir den Zähler fürs drehen auf 0 setzen ... + if( abstand_vorn_cm > (US_STOP_ABSTAND_CM + US_MIN_ABSTAND_LI_RE)){ + anzahl_drehung = 0; + } + coderacer.drive_forward(); + } + + } else { + anzahl_drehung = 0; + } + +} + + + diff --git a/vsode/coderacer_mkII/test/README b/vsode/coderacer_mkII/test/README new file mode 100644 index 0000000..c3b0ed6 --- /dev/null +++ b/vsode/coderacer_mkII/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