From 6a74634cbcf45576970e55a69b82402d2fb421df Mon Sep 17 00:00:00 2001 From: Gabriel Augendre Date: Tue, 27 Apr 2021 15:29:06 +0200 Subject: [PATCH] Add traffic lights --- traffic_lights/.gitignore | 3 ++ traffic_lights/.idea/.gitignore | 8 +++++ traffic_lights/.idea/misc.xml | 10 ++++++ traffic_lights/.idea/modules.xml | 8 +++++ traffic_lights/.idea/traffic_lights.iml | 2 ++ traffic_lights/.idea/vcs.xml | 6 ++++ traffic_lights/CMakeLists.txt | 33 ++++++++++++++++++ traffic_lights/include/README | 39 +++++++++++++++++++++ traffic_lights/include/lib.h | 33 ++++++++++++++++++ traffic_lights/lib/README | 46 +++++++++++++++++++++++++ traffic_lights/lib/lib.cpp | 20 +++++++++++ traffic_lights/platformio.ini | 14 ++++++++ traffic_lights/src/main.cpp | 30 ++++++++++++++++ traffic_lights/test/README | 11 ++++++ 14 files changed, 263 insertions(+) create mode 100644 traffic_lights/.gitignore create mode 100644 traffic_lights/.idea/.gitignore create mode 100644 traffic_lights/.idea/misc.xml create mode 100644 traffic_lights/.idea/modules.xml create mode 100644 traffic_lights/.idea/traffic_lights.iml create mode 100644 traffic_lights/.idea/vcs.xml create mode 100644 traffic_lights/CMakeLists.txt create mode 100644 traffic_lights/include/README create mode 100644 traffic_lights/include/lib.h create mode 100644 traffic_lights/lib/README create mode 100644 traffic_lights/lib/lib.cpp create mode 100644 traffic_lights/platformio.ini create mode 100644 traffic_lights/src/main.cpp create mode 100644 traffic_lights/test/README diff --git a/traffic_lights/.gitignore b/traffic_lights/.gitignore new file mode 100644 index 0000000..3fe18ad --- /dev/null +++ b/traffic_lights/.gitignore @@ -0,0 +1,3 @@ +.pio +CMakeListsPrivate.txt +cmake-build-*/ diff --git a/traffic_lights/.idea/.gitignore b/traffic_lights/.idea/.gitignore new file mode 100644 index 0000000..73f69e0 --- /dev/null +++ b/traffic_lights/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml +# Editor-based HTTP Client requests +/httpRequests/ diff --git a/traffic_lights/.idea/misc.xml b/traffic_lights/.idea/misc.xml new file mode 100644 index 0000000..e28889e --- /dev/null +++ b/traffic_lights/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/traffic_lights/.idea/modules.xml b/traffic_lights/.idea/modules.xml new file mode 100644 index 0000000..7ccf296 --- /dev/null +++ b/traffic_lights/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/traffic_lights/.idea/traffic_lights.iml b/traffic_lights/.idea/traffic_lights.iml new file mode 100644 index 0000000..f08604b --- /dev/null +++ b/traffic_lights/.idea/traffic_lights.iml @@ -0,0 +1,2 @@ + + \ No newline at end of file diff --git a/traffic_lights/.idea/vcs.xml b/traffic_lights/.idea/vcs.xml new file mode 100644 index 0000000..6c0b863 --- /dev/null +++ b/traffic_lights/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/traffic_lights/CMakeLists.txt b/traffic_lights/CMakeLists.txt new file mode 100644 index 0000000..4ba7933 --- /dev/null +++ b/traffic_lights/CMakeLists.txt @@ -0,0 +1,33 @@ +# !!! WARNING !!! AUTO-GENERATED FILE, PLEASE DO NOT MODIFY IT AND USE +# https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags +# +# If you need to override existing CMake configuration or add extra, +# please create `CMakeListsUser.txt` in the root of project. +# The `CMakeListsUser.txt` will not be overwritten by PlatformIO. + +cmake_minimum_required(VERSION 3.13) +set(CMAKE_SYSTEM_NAME Generic) +set(CMAKE_C_COMPILER_WORKS 1) +set(CMAKE_CXX_COMPILER_WORKS 1) + +project("traffic_lights" C CXX) + +include(CMakeListsPrivate.txt) + +if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/CMakeListsUser.txt) +include(CMakeListsUser.txt) +endif() + +add_custom_target( + Production ALL + COMMAND platformio -c clion run "$<$>:-e${CMAKE_BUILD_TYPE}>" + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} +) + +add_custom_target( + Debug ALL + COMMAND platformio -c clion run --target debug "$<$>:-e${CMAKE_BUILD_TYPE}>" + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} +) + +add_executable(Z_DUMMY_TARGET ${SRC_LIST}) diff --git a/traffic_lights/include/README b/traffic_lights/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/traffic_lights/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/traffic_lights/include/lib.h b/traffic_lights/include/lib.h new file mode 100644 index 0000000..7c0f401 --- /dev/null +++ b/traffic_lights/include/lib.h @@ -0,0 +1,33 @@ +// +// Created by Gabriel Augendre on 27/04/2021. +// + +#ifndef TOY_PROJECTS_LIB_H +#define TOY_PROJECTS_LIB_H + +#define GREEN 2 +#define YELLOW 3 +#define RED 4 +#define BUZZER 5 +#define BUTTON 6 +#define BUZZ_DURATION 100 +#define BUZZ_FREQUENCY 440 + +/** + * Block until the button is pressed. + */ +void waitForButton(); + +/** + * Make the buzzer beep n times. + * @param n number of times the buzzer should beep. + */ +void beep(int n); + +/** + * Make the buzzer beep once. + * See `beep(int)` for more control. + */ +void beep(); + +#endif //TOY_PROJECTS_LIB_H diff --git a/traffic_lights/lib/README b/traffic_lights/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/traffic_lights/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/traffic_lights/lib/lib.cpp b/traffic_lights/lib/lib.cpp new file mode 100644 index 0000000..a9476d6 --- /dev/null +++ b/traffic_lights/lib/lib.cpp @@ -0,0 +1,20 @@ +// +// Created by Gabriel Augendre on 27/04/2021. +// + +#include "lib.h" + +void waitForButton() { + while (digitalRead(BUTTON) == HIGH) {} +} + +void beep(int n) { + for (int i = 0; i < n; i++) { + tone(BUZZER, BUZZ_FREQUENCY, BUZZ_DURATION); + delay(BUZZ_DURATION * 2); + } +} + +void beep() { + beep(1); +} diff --git a/traffic_lights/platformio.ini b/traffic_lights/platformio.ini new file mode 100644 index 0000000..ea23b77 --- /dev/null +++ b/traffic_lights/platformio.ini @@ -0,0 +1,14 @@ +; 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:uno] +platform = atmelavr +board = uno +framework = arduino diff --git a/traffic_lights/src/main.cpp b/traffic_lights/src/main.cpp new file mode 100644 index 0000000..1c1a056 --- /dev/null +++ b/traffic_lights/src/main.cpp @@ -0,0 +1,30 @@ +#include +#include "lib.h" + +void setup() { + pinMode(GREEN, OUTPUT); + pinMode(YELLOW, OUTPUT); + pinMode(RED, OUTPUT); + pinMode(BUZZER, OUTPUT); + // assumes the button connects to GND when pressed + pinMode(BUTTON, INPUT_PULLUP); +} + +void loop() { + digitalWrite(RED, LOW); + digitalWrite(YELLOW, LOW); + digitalWrite(GREEN, HIGH); + waitForButton(); + beep(); + delay(1000); + digitalWrite(GREEN, LOW); + digitalWrite(YELLOW, HIGH); + delay(3000); + digitalWrite(YELLOW, LOW); + digitalWrite(RED, HIGH); + beep(2); + delay(5000); + beep(3); + delay(2000); + digitalWrite(YELLOW, HIGH); +} diff --git a/traffic_lights/test/README b/traffic_lights/test/README new file mode 100644 index 0000000..b94d089 --- /dev/null +++ b/traffic_lights/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO 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 PlatformIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html