Initial commit

Author: finger563

.gitignore

@@ -0,0 +1,35 @@
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+build/
+sdkconfig
+sdkconfig.old

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "components/espp"]
+	path = components/espp
+	url = git@github.com:esp-cpp/espp

CMakeLists.txt

@@ -0,0 +1,24 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+
+# add the component directories that we want to use
+set(EXTRA_COMPONENT_DIRS
+  "components/"
+  "components/espp/components/"
+)
+
+set(
+  COMPONENTS
+  # TODO: add additional esp-idf and espp components you want to use to the line below:
+  "main esptool_py logger task"
+  CACHE STRING
+  "List of components to include"
+  )
+
+# TODO: update this with your project's name
+project(template)
+
+set(CMAKE_CXX_STANDARD 20)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 esp-cpp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+# ESP++ Template
+
+Template repository for building an ESP app with ESP++ (espp) components and
+ESP-IDF components.
+
+## Development
+
+This repository is designed to be used as a template repository - so you can
+sepcify this as the template repository type when creating a new repository on
+GitHub.
+
+After setting this as the template, make sure to update the following:
+- [This README](./README.md) to contain the relevant description and images of your project
+- The [./CMakeLists.txt](./CMakeLists.txt) file to have the components that you
+  want to use (and any you may have added to the [components
+  folder](./components)) as well as to update the project name
+- The [./main/main.cpp](./main/main.cpp) To run the main code for your app. The
+  [main folder](./main) is also where you can put additional header and source
+  files that you don't think belong in their own components but help keep the
+  main code clean.
+
+## Cloning
+
+Since this repo contains a submodule, you need to make sure you clone it
+recursively, e.g. with:
+
+``` sh
+git clone --recurse-submodules <your repo name>
+```
+
+Alternatively, you can always ensure the submodules are up to date after cloning
+(or if you forgot to clone recursively) by running:
+
+``` sh
+git submodule update --init --recursive
+```
+
+## Build and Flash
+
+Build the project and flash it to the board, then run monitor tool to view serial output:
+
+```
+idf.py -p PORT flash monitor
+```
+
+(Replace PORT with the name of the serial port to use.)
+
+(To exit the serial monitor, type ``Ctrl-]``.)
+
+See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
+
+## Output
+
+Example screenshot of the console output from this app:
+
+![CleanShot 2023-07-12 at 14 01 21](https://github.com/esp-cpp/template/assets/213467/7f8abeae-121b-4679-86d8-7214a76f1b75)

components/espp

@@ -0,0 +1,2 @@
+idf_component_register(SRC_DIRS "."
+                       INCLUDE_DIRS ".")

main/CMakeLists.txt

@@ -0,0 +1,39 @@
+#include <chrono>
+#include <thread>
+
+#include "logger.hpp"
+#include "task.hpp"
+
+using namespace std::chrono_literals;
+
+extern "C" void app_main(void) {
+  static auto start = std::chrono::high_resolution_clock::now();
+  static auto elapsed = [&]() {
+    auto now = std::chrono::high_resolution_clock::now();
+    return std::chrono::duration<float>(now - start).count();
+  };
+
+  espp::Logger logger({.tag = "Template", .level = espp::Logger::Verbosity::DEBUG});
+
+  logger.info("Bootup");
+
+  // make a simple task that prints "Hello World!" every second
+  espp::Task task({
+      .name = "Hello World",
+      .callback = [&](auto &m, auto &cv) -> bool {
+        logger.debug("[{:.3f}] Hello from the task!", elapsed());
+        std::unique_lock<std::mutex> lock(m);
+        cv.wait_for(lock, 1s);
+        // we don't want to stop the task, so return false
+        return false;
+      },
+      .stack_size_bytes = 4096,
+    });
+  task.start();
+
+  // also print in the main thread
+  while (true) {
+    logger.debug("[{:.3f}] Hello World!", elapsed());
+    std::this_thread::sleep_for(1s);
+  }
+}

main/main.cpp

@@ -0,0 +1,23 @@
+# TODO: uncomment one of these if you want to support a specifc target by default
+# CONFIG_IDF_TARGET="esp32"
+# CONFIG_IDF_TARGET="esp32s2"
+# CONFIG_IDF_TARGET="esp32s3"
+# CONFIG_IDF_TARGET="esp32c3"
+
+# TODO: uncomment if you want freertos to run at 1 khz instead of the default 100 hz
+# CONFIG_FREERTOS_HZ=1000
+
+# TODO: uncomment if you want to run the esp at max clock speed (240 mhz)
+# ESP32-specific
+#
+# CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ_240=y
+# CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ=240
+
+# TODO: uncomment if you want to update the event and main task stask sizes
+# Common ESP-related
+#
+# CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE=4096
+# CONFIG_ESP_MAIN_TASK_STACK_SIZE=8192
+
+# TODO: uncomment if you want to enable exceptions (which may be needed by certain components such as cli)
+# CONFIG_COMPILER_CXX_EXCEPTIONS=y