Compare commits
39 Commits
984a429cc0
...
lcd
| Author | SHA1 | Date | |
|---|---|---|---|
| a3d6a85516 | |||
| a91352ffcd | |||
| fc0fd98426 | |||
| 1a7da67bdb | |||
| 00ea5dae20 | |||
| 63899a606a | |||
| 25b4564a8b | |||
| e2bb406139 | |||
| 96b6a8bec9 | |||
| 509b57fedb | |||
| 75b51f0c7c | |||
| 74404b1a44 | |||
| 9140ba5fb4 | |||
| c9ec16d70c | |||
| 5c61fbd378 | |||
| 8636de8f2f | |||
| 6493988324 | |||
| 64d817e362 | |||
| b3d830cdeb | |||
| 670a523a16 | |||
| cc5bffd1e7 | |||
| 03784ac097 | |||
| 9e912048ab | |||
| 0743fc4a5e | |||
| 046dfbb6e6 | |||
| ef7a027cf0 | |||
| 2dd099f26e | |||
| 8aaed133e8 | |||
| 58a83590ca | |||
| dd5335815c | |||
| e9d5ef46d1 | |||
| 356d8ccd9a | |||
| 4063921340 | |||
| 043fa2fabb | |||
| 6cd7d7db29 | |||
| 17c559a31f | |||
| e6ba60da89 | |||
| 8bf174d256 | |||
| 5f9f508581 |
2
.gitignore
vendored
@@ -10,5 +10,5 @@
|
|||||||
**/Makefile
|
**/Makefile
|
||||||
**/*.cbp
|
**/*.cbp
|
||||||
**/node-modules/
|
**/node-modules/
|
||||||
**/CmakeLists.txt.user
|
**/CMakeLists.txt.user
|
||||||
**/catch2/bin/
|
**/catch2/bin/
|
||||||
|
|||||||
11
README.md
@@ -2,15 +2,16 @@
|
|||||||
|
|
||||||
This repository is a collection of useful code snippets and configurations.
|
This repository is a collection of useful code snippets and configurations.
|
||||||
|
|
||||||
```
|
```bash
|
||||||
github.com/shaunrd0/klips/
|
shaunrd0/klips/
|
||||||
├── ansible # Ansible roles, playbooks, and examples
|
├── ansible # Ansible roles, playbooks, and examples
|
||||||
├── blockchain # Blockchain related project templates and examples
|
├── blockchain # Blockchain related project templates and examples
|
||||||
├── cpp # C++ programs, datastructures, and other examples
|
├── cpp # C++ programs, datastructures, and other examples
|
||||||
├── dotnet # .NET projects and examples
|
├── dotnet # .NET projects and examples
|
||||||
|
├── esp # ESP32 projects and examples
|
||||||
├── figlet # Figlet fonts I like :)
|
├── figlet # Figlet fonts I like :)
|
||||||
├── javascript # Javascript projects and examples
|
├── javascript # Javascript projects and examples
|
||||||
├── python # Python scripts or tools I've made
|
├── python # Python scripts and tools I've made
|
||||||
├── README.md
|
├── scripts # Bash scripts
|
||||||
└── scripts # Bash scripts
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Ansible
|
# ansible
|
||||||
|
|
||||||
A few simple roles / plays I've put together in learning how to use Ansible can be found under their corresponding directories.
|
A few simple roles / plays I've put together in learning how to use Ansible can be found under their corresponding directories.
|
||||||
|
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
# blockchain
|
||||||
|
|
||||||
A template project for getting started working on the Ethereum blockchain.
|
A template project for getting started working on the Ethereum blockchain.
|
||||||
This project comes with basic packages for compiling and deploying Solidity contracts with Truffle.
|
This project comes with basic packages for compiling and deploying Solidity contracts with Truffle.
|
||||||
@@ -72,7 +73,7 @@ I explain how to configure metamask on ropsten on [Knoats - Solidity](https://kn
|
|||||||
|
|
||||||
Give yourself test Ethereum with the [Ropsten ETH Faucet](https://faucet.ropsten.be)
|
Give yourself test Ethereum with the [Ropsten ETH Faucet](https://faucet.ropsten.be)
|
||||||
|
|
||||||
To deploy to ropsten test network, and verify using `truffle-verify-plugin` -
|
To deploy to ropsten test network, and verify using `truffle-verify-plugin` -
|
||||||
|
|
||||||
```asm
|
```asm
|
||||||
npx truffle migrate --network ropsten
|
npx truffle migrate --network ropsten
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Cpp
|
# cpp
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
shaunrd0/klips/cpp/
|
shaunrd0/klips/cpp/
|
||||||
@@ -13,11 +13,11 @@ shaunrd0/klips/cpp/
|
|||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|
||||||
This directory contains a `CMakeLists.txt`, which can be selected to open as a
|
This directory contains a `CMakeLists.txt`, which can be selected to open as a
|
||||||
project within your preferred IDE. From there, all nested examples can be built,
|
project within your preferred IDE. From there, all nested examples can be built,
|
||||||
debugged, and ran.
|
debugged, and ran.
|
||||||
|
|
||||||
Some of the more recent projects in this repository requires the latest CMake LTS.
|
Some of the more recent projects in this repository requires the latest CMake LTS.
|
||||||
To install `cmake` LTS with `apt` we can follow [official instructions from kitware](https://apt.kitware.com/)
|
To install `cmake` LTS with `apt` we can follow [official instructions from kitware](https://apt.kitware.com/)
|
||||||
Alternatively, we can install the LTS with python's `pip`.
|
Alternatively, we can install the LTS with python's `pip`.
|
||||||
```bash
|
```bash
|
||||||
@@ -34,7 +34,7 @@ cmake version 3.22.1
|
|||||||
|
|
||||||
Once cmake is installed, dependencies for all examples can be installed with the command below.
|
Once cmake is installed, dependencies for all examples can be installed with the command below.
|
||||||
```bash
|
```bash
|
||||||
sudo apt install libsdl2-dev freeglut3-dev
|
sudo apt install libsdl2-dev freeglut3-dev
|
||||||
```
|
```
|
||||||
|
|
||||||
If we build from this directory, we build all C++ projects and examples
|
If we build from this directory, we build all C++ projects and examples
|
||||||
@@ -63,7 +63,7 @@ graph-test-object sdl-test visitor-test
|
|||||||
graph-test-simple select-sort
|
graph-test-simple select-sort
|
||||||
```
|
```
|
||||||
|
|
||||||
We can also build from subdirectories.
|
We can also build from subdirectories.
|
||||||
To only build projects related to design patterns we build from the `patterns/` subdirectory, for example
|
To only build projects related to design patterns we build from the `patterns/` subdirectory, for example
|
||||||
```bash
|
```bash
|
||||||
cd /path/to/klips/cpp/patterns
|
cd /path/to/klips/cpp/patterns
|
||||||
@@ -80,5 +80,5 @@ adapter-test factory-test prototype-test state-test
|
|||||||
|
|
||||||
If cmake is not being used in a project, it can be built with `g++` manually using
|
If cmake is not being used in a project, it can be built with `g++` manually using
|
||||||
the commands outlined in `*/.vscode/tasks.json`, or by using VSCode to open the example
|
the commands outlined in `*/.vscode/tasks.json`, or by using VSCode to open the example
|
||||||
and running the build task.
|
and running the build task.
|
||||||
Check the header comments in the main source file for the example for instructions.
|
Check the header comments in the main source file for the example for instructions.
|
||||||
|
|||||||
@@ -1,197 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE QtCreatorProject>
|
|
||||||
<!-- Written by QtCreator 9.0.1, 2022-12-24T09:28:53. -->
|
|
||||||
<qtcreator>
|
|
||||||
<data>
|
|
||||||
<variable>EnvironmentId</variable>
|
|
||||||
<value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.ActiveTarget</variable>
|
|
||||||
<value type="qlonglong">0</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.EditorSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoIndent">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
|
|
||||||
<value type="QString" key="language">Cpp</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
|
|
||||||
<value type="QString" key="language">QmlJS</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
|
|
||||||
<value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.IndentSize">4</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.MarginColumn">80</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseHiding">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.PaddingMode">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ShowMargin">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabSize">8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseGlobal">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseIndenter">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
|
|
||||||
<value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.tintMarginArea">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.PluginSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
|
|
||||||
<value type="bool" key="AutoTest.Framework.Boost">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.CTest">false</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.Catch">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.GTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtTest">true</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
|
|
||||||
<value type="int" key="AutoTest.RunAfterBuild">0</value>
|
|
||||||
<value type="bool" key="AutoTest.UseGlobal">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="ClangTools">
|
|
||||||
<value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
|
|
||||||
<value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
|
|
||||||
<value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
|
|
||||||
<value type="int" key="ClangTools.ParallelJobs">4</value>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
|
|
||||||
<value type="bool" key="ClangTools.UseGlobalSettings">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Target.0</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="QString" key="DeviceType">Desktop</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{70d5e2e6-ad48-44fa-b4dd-c54058c4b48b}</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
|
|
||||||
<value type="QString" key="CMake.Build.Type">Debug</value>
|
|
||||||
<value type="bool" key="CMake.Configure.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMake.Configure.UserEnvironmentChanges"/>
|
|
||||||
<value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
|
|
||||||
-DCMAKE_BUILD_TYPE:STRING=Debug
|
|
||||||
-DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
|
|
||||||
-DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
|
|
||||||
-DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
|
|
||||||
-DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
|
|
||||||
-DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
|
|
||||||
<value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection/cmake-build-debug</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">all</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">clean</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
|
|
||||||
<value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
|
|
||||||
<valuelist type="QVariantList" key="CustomOutputParsers"/>
|
|
||||||
<value type="int" key="PE.EnvironmentAspect.Base">2</value>
|
|
||||||
<valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">widget-app</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.widget-app</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">widget-app</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
|
|
||||||
<value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer-plugin-collection/cmake-build-debug</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.TargetCount</variable>
|
|
||||||
<value type="qlonglong">1</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Updater.FileVersion</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>Version</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
</qtcreator>
|
|
||||||
@@ -1,197 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE QtCreatorProject>
|
|
||||||
<!-- Written by QtCreator 9.0.1, 2022-12-24T09:58:46. -->
|
|
||||||
<qtcreator>
|
|
||||||
<data>
|
|
||||||
<variable>EnvironmentId</variable>
|
|
||||||
<value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.ActiveTarget</variable>
|
|
||||||
<value type="qlonglong">0</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.EditorSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoIndent">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
|
|
||||||
<value type="QString" key="language">Cpp</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
|
|
||||||
<value type="QString" key="language">QmlJS</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
|
|
||||||
<value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.IndentSize">4</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.MarginColumn">80</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseHiding">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.PaddingMode">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ShowMargin">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabSize">8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseGlobal">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseIndenter">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
|
|
||||||
<value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.tintMarginArea">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.PluginSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
|
|
||||||
<value type="bool" key="AutoTest.Framework.Boost">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.CTest">false</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.Catch">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.GTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtTest">true</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
|
|
||||||
<value type="int" key="AutoTest.RunAfterBuild">0</value>
|
|
||||||
<value type="bool" key="AutoTest.UseGlobal">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="ClangTools">
|
|
||||||
<value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
|
|
||||||
<value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
|
|
||||||
<value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
|
|
||||||
<value type="int" key="ClangTools.ParallelJobs">4</value>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
|
|
||||||
<value type="bool" key="ClangTools.UseGlobalSettings">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Target.0</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="QString" key="DeviceType">Desktop</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{70d5e2e6-ad48-44fa-b4dd-c54058c4b48b}</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
|
|
||||||
<value type="QString" key="CMake.Build.Type">Debug</value>
|
|
||||||
<value type="bool" key="CMake.Configure.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMake.Configure.UserEnvironmentChanges"/>
|
|
||||||
<value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
|
|
||||||
-DCMAKE_BUILD_TYPE:STRING=Debug
|
|
||||||
-DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
|
|
||||||
-DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
|
|
||||||
-DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
|
|
||||||
-DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
|
|
||||||
-DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
|
|
||||||
<value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer-plugin</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer-plugin/cmake-build-debug</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">all</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<value type="QString" key="CMakeProjectManager.MakeStep.BuildPreset"></value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">clean</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="CMakeProjectManager.MakeStep.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.UserEnvironmentChanges"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
|
|
||||||
<value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
|
|
||||||
<valuelist type="QVariantList" key="CustomOutputParsers"/>
|
|
||||||
<value type="int" key="PE.EnvironmentAspect.Base">2</value>
|
|
||||||
<valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">widget-app</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.widget-app</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">widget-app</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
|
|
||||||
<value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer-plugin/cmake-build-debug</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.TargetCount</variable>
|
|
||||||
<value type="qlonglong">1</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Updater.FileVersion</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>Version</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
</qtcreator>
|
|
||||||
@@ -1,189 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<!DOCTYPE QtCreatorProject>
|
|
||||||
<!-- Written by QtCreator 8.0.1, 2022-12-18T08:59:41. -->
|
|
||||||
<qtcreator>
|
|
||||||
<data>
|
|
||||||
<variable>EnvironmentId</variable>
|
|
||||||
<value type="QByteArray">{ce8a8d3d-318d-4c62-a573-71d1755252ce}</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.ActiveTarget</variable>
|
|
||||||
<value type="qlonglong">0</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.EditorSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoIndent">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.AutoSpacesForTabs">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.CamelCaseNavigation">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.0">
|
|
||||||
<value type="QString" key="language">Cpp</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">CppGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="EditorConfiguration.CodeStyle.1">
|
|
||||||
<value type="QString" key="language">QmlJS</value>
|
|
||||||
<valuemap type="QVariantMap" key="value">
|
|
||||||
<value type="QByteArray" key="CurrentPreferences">QmlJSGlobal</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="EditorConfiguration.CodeStyle.Count">2</value>
|
|
||||||
<value type="QByteArray" key="EditorConfiguration.Codec">UTF-8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ConstrainTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.IndentSize">4</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.KeyboardTooltips">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.MarginColumn">80</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseHiding">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.MouseNavigation">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.PaddingMode">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.PreferSingleLineComments">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ScrollWheelZooming">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.ShowMargin">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.SmartBackspaceBehavior">0</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SmartSelectionChanging">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.SpacesForTabs">true</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabKeyBehavior">0</value>
|
|
||||||
<value type="int" key="EditorConfiguration.TabSize">8</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseGlobal">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.UseIndenter">false</value>
|
|
||||||
<value type="int" key="EditorConfiguration.Utf8BomBehavior">1</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.addFinalNewLine">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanIndentation">true</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.cleanWhitespace">true</value>
|
|
||||||
<value type="QString" key="EditorConfiguration.ignoreFileTypes">*.md, *.MD, Makefile</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.inEntireDocument">false</value>
|
|
||||||
<value type="bool" key="EditorConfiguration.skipTrailingWhitespace">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.PluginSettings</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.ActiveFrameworks">
|
|
||||||
<value type="bool" key="AutoTest.Framework.Boost">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.CTest">false</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.Catch">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.GTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtQuickTest">true</value>
|
|
||||||
<value type="bool" key="AutoTest.Framework.QtTest">true</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="AutoTest.CheckStates"/>
|
|
||||||
<value type="int" key="AutoTest.RunAfterBuild">0</value>
|
|
||||||
<value type="bool" key="AutoTest.UseGlobal">true</value>
|
|
||||||
<valuemap type="QVariantMap" key="ClangTools">
|
|
||||||
<value type="bool" key="ClangTools.AnalyzeOpenFiles">true</value>
|
|
||||||
<value type="bool" key="ClangTools.BuildBeforeAnalysis">true</value>
|
|
||||||
<value type="QString" key="ClangTools.DiagnosticConfig">Builtin.DefaultTidyAndClazy</value>
|
|
||||||
<value type="int" key="ClangTools.ParallelJobs">4</value>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedDirs"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SelectedFiles"/>
|
|
||||||
<valuelist type="QVariantList" key="ClangTools.SuppressedDiagnostics"/>
|
|
||||||
<value type="bool" key="ClangTools.UseGlobalSettings">true</value>
|
|
||||||
</valuemap>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Target.0</variable>
|
|
||||||
<valuemap type="QVariantMap">
|
|
||||||
<value type="QString" key="DeviceType">Desktop</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Qt 6.3.1 GCC 64bit</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">{6ade7dd7-47b1-42f6-b09c-570bb7fbeb1c}</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveBuildConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveDeployConfiguration">0</value>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.ActiveRunConfiguration">0</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.BuildConfiguration.0">
|
|
||||||
<value type="QString" key="CMake.Build.Type">Debug</value>
|
|
||||||
<value type="QString" key="CMake.Initial.Parameters">-DCMAKE_GENERATOR:STRING=Ninja
|
|
||||||
-DCMAKE_BUILD_TYPE:STRING=Debug
|
|
||||||
-DCMAKE_PROJECT_INCLUDE_BEFORE:FILEPATH=%{IDE:ResourcePath}/package-manager/auto-setup.cmake
|
|
||||||
-DQT_QMAKE_EXECUTABLE:FILEPATH=%{Qt:qmakeExecutable}
|
|
||||||
-DCMAKE_PREFIX_PATH:PATH=%{Qt:QT_INSTALL_PREFIX}
|
|
||||||
-DCMAKE_C_COMPILER:FILEPATH=%{Compiler:Executable:C}
|
|
||||||
-DCMAKE_CXX_COMPILER:FILEPATH=%{Compiler:Executable:Cxx}
|
|
||||||
-DCMAKE_CXX_FLAGS_INIT:STRING=%{Qt:QML_DEBUG_FLAG}</value>
|
|
||||||
<value type="QString" key="CMake.Source.Directory">/home/kapper/Code/klips/cpp/qt/designer</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.BuildConfiguration.BuildDirectory">/home/kapper/Code/klips/cpp/qt/designer/cmake-build-debug</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">all</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Build</value>
|
|
||||||
</valuemap>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.1">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildStepList.Step.0">
|
|
||||||
<valuelist type="QVariantList" key="CMakeProjectManager.MakeStep.BuildTargets">
|
|
||||||
<value type="QString">clean</value>
|
|
||||||
</valuelist>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildStep.Enabled">true</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Build</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.MakeStep</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">1</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Clean</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Clean</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">2</value>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ClearSystemEnvironment">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.CustomParsers"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.BuildConfiguration.ParseStandardOutput">false</value>
|
|
||||||
<valuelist type="QVariantList" key="ProjectExplorer.BuildConfiguration.UserEnvironmentChanges"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Debug</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeBuildConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.BuildConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.DeployConfiguration.0">
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.BuildConfiguration.BuildStepList.0">
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.BuildStepList.StepsCount">0</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DefaultDisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">Deploy</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.BuildSteps.Deploy</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="int" key="ProjectExplorer.BuildConfiguration.BuildStepListCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.DeployConfiguration.CustomData"/>
|
|
||||||
<value type="bool" key="ProjectExplorer.DeployConfiguration.CustomDataEnabled">false</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">ProjectExplorer.DefaultDeployConfiguration</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.DeployConfigurationCount">1</value>
|
|
||||||
<valuemap type="QVariantMap" key="ProjectExplorer.Target.RunConfiguration.0">
|
|
||||||
<value type="bool" key="Analyzer.Perf.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.QmlProfiler.Settings.UseGlobalSettings">true</value>
|
|
||||||
<value type="bool" key="Analyzer.Valgrind.Settings.UseGlobalSettings">true</value>
|
|
||||||
<valuelist type="QVariantList" key="CustomOutputParsers"/>
|
|
||||||
<value type="int" key="PE.EnvironmentAspect.Base">2</value>
|
|
||||||
<valuelist type="QVariantList" key="PE.EnvironmentAspect.Changes"/>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.DisplayName">designer</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.ProjectConfiguration.Id">CMakeProjectManager.CMakeRunConfiguration.designer</value>
|
|
||||||
<value type="QString" key="ProjectExplorer.RunConfiguration.BuildKey">designer</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseCppDebuggerAuto">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseLibrarySearchPath">true</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebugger">false</value>
|
|
||||||
<value type="bool" key="RunConfiguration.UseQmlDebuggerAuto">true</value>
|
|
||||||
<value type="QString" key="RunConfiguration.WorkingDirectory.default">/home/kapper/Code/klips/cpp/qt/designer/cmake-build-debug</value>
|
|
||||||
</valuemap>
|
|
||||||
<value type="qlonglong" key="ProjectExplorer.Target.RunConfigurationCount">1</value>
|
|
||||||
</valuemap>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.TargetCount</variable>
|
|
||||||
<value type="qlonglong">1</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>ProjectExplorer.Project.Updater.FileVersion</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
<data>
|
|
||||||
<variable>Version</variable>
|
|
||||||
<value type="int">22</value>
|
|
||||||
</data>
|
|
||||||
</qtcreator>
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
# Dotnet
|
# dotnet
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
shaunrd0/klips/dotnet/
|
shaunrd0/klips/dotnet/
|
||||||
|
|||||||
38
esp/cpp/01_led-button/01_led-button.ino
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
// set pin numbers
|
||||||
|
const int buttonPin = 4; // the number of the pushbutton pin
|
||||||
|
const int ledPin = 5; // the number of the LED pin
|
||||||
|
|
||||||
|
// variable for storing the pushbutton status
|
||||||
|
int buttonState = 0;
|
||||||
|
|
||||||
|
bool light_on = false;
|
||||||
|
bool handled = false;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
// initialize the pushbutton pin as an input
|
||||||
|
pinMode(buttonPin, INPUT);
|
||||||
|
// initialize the LED pin as an output
|
||||||
|
pinMode(ledPin, OUTPUT);
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
// read the state of the pushbutton value
|
||||||
|
buttonState = digitalRead(buttonPin);
|
||||||
|
// check if the pushbutton is pressed.
|
||||||
|
if (buttonState == HIGH) {
|
||||||
|
if (!handled) {
|
||||||
|
Serial.println("Handling button pressed.");
|
||||||
|
light_on = !light_on;
|
||||||
|
handled = true;
|
||||||
|
digitalWrite(ledPin, light_on ? HIGH : LOW);
|
||||||
|
}
|
||||||
|
// turn LED on
|
||||||
|
} else {
|
||||||
|
if (handled) {
|
||||||
|
Serial.println("Reset button handled state.");
|
||||||
|
handled = false;
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
9
esp/cpp/01_led-button/README.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# 01_led-button
|
||||||
|
|
||||||
|
This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
|
||||||
|
|
||||||
|
The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Simple LED controlled by an on-board button.
|
||||||
BIN
esp/cpp/01_led-button/schematic.png
Normal file
|
After Width: | Height: | Size: 304 KiB |
183
esp/cpp/02_led-button-web/02_led-button-web.ino
Normal file
@@ -0,0 +1,183 @@
|
|||||||
|
#include <WiFi.h>
|
||||||
|
|
||||||
|
//
|
||||||
|
// Web server project globals
|
||||||
|
|
||||||
|
// Replace with your network credentials
|
||||||
|
const char* ssid = "network-name";
|
||||||
|
const char* password = "password";
|
||||||
|
|
||||||
|
WiFiServer server(80);
|
||||||
|
|
||||||
|
// Variable to store the HTTP request
|
||||||
|
String header;
|
||||||
|
|
||||||
|
// Current time
|
||||||
|
unsigned long currentTime = millis();
|
||||||
|
// Previous time
|
||||||
|
unsigned long previousTime = 0;
|
||||||
|
// Define timeout time in milliseconds (example: 2000ms = 2s)
|
||||||
|
const long timeoutTime = 2000;
|
||||||
|
|
||||||
|
//
|
||||||
|
// Button / light project globals
|
||||||
|
|
||||||
|
// set pin numbers
|
||||||
|
const int buttonPin = 4; // the number of the pushbutton pin
|
||||||
|
const int ledPin = 5; // the number of the LED pin
|
||||||
|
|
||||||
|
// variable for storing the pushbutton status
|
||||||
|
int buttonState = 0;
|
||||||
|
|
||||||
|
bool light_on = false;
|
||||||
|
bool handled = false;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
// initialize the pushbutton pin as an input
|
||||||
|
pinMode(buttonPin, INPUT);
|
||||||
|
// initialize the LED pin as an output
|
||||||
|
pinMode(ledPin, OUTPUT);
|
||||||
|
|
||||||
|
// wait for the Serial Monitor to be open
|
||||||
|
while (!Serial) {
|
||||||
|
delay(100);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Connect to Wi-Fi network with SSID and password
|
||||||
|
Serial.print("Connecting to ");
|
||||||
|
Serial.println(ssid);
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
Serial.print(".");
|
||||||
|
}
|
||||||
|
// Print local IP address and start web server
|
||||||
|
Serial.println("");
|
||||||
|
Serial.println("WiFi connected.");
|
||||||
|
Serial.println("Web Server IP address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handles the on-board button press.
|
||||||
|
void handleButtonPress() {
|
||||||
|
// read the state of the pushbutton value
|
||||||
|
buttonState = digitalRead(buttonPin);
|
||||||
|
// check if the pushbutton is pressed.
|
||||||
|
if (buttonState == HIGH) {
|
||||||
|
if (!handled) {
|
||||||
|
Serial.println("Handling button pressed.");
|
||||||
|
light_on = !light_on;
|
||||||
|
handled = true;
|
||||||
|
digitalWrite(ledPin, light_on ? HIGH : LOW);
|
||||||
|
}
|
||||||
|
// turn LED on
|
||||||
|
} else {
|
||||||
|
if (handled) {
|
||||||
|
Serial.println("Reset button handled state.");
|
||||||
|
handled = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void displayPinState(WiFiClient client, int gpio_pin, bool state) {
|
||||||
|
// Display current state, and ON/OFF buttons for GPIO <gpio_pin>
|
||||||
|
client.println(String("<p>GPIO ") + String(gpio_pin) + String(" - Current State ") + String(state ? "ON" : "OFF") + String("</p>"));
|
||||||
|
// If the output state is off, it displays the ON button
|
||||||
|
if (state) {
|
||||||
|
client.println(String("<p><a href=\"/") + String(gpio_pin) + String("/off\"><button class=\"button button2\">OFF</button></a></p>"));
|
||||||
|
} else {
|
||||||
|
client.println(String("<p><a href=\"/") + String(gpio_pin) + String("/on\"><button class=\"button\">ON</button></a></p>"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void handleStateChange(WiFiClient client, int gpio_pin) {
|
||||||
|
if (header.indexOf(String("GET /") + String(gpio_pin) + String("/on")) >= 0) {
|
||||||
|
Serial.println(String("GPIO ") + String(gpio_pin) + String(" on"));
|
||||||
|
light_on = true;
|
||||||
|
digitalWrite(gpio_pin, HIGH);
|
||||||
|
} else if (header.indexOf(String("GET /") + String(gpio_pin) + String("/off")) >= 0) {
|
||||||
|
Serial.println(String("GPIO ") + String(gpio_pin) + String(" off"));
|
||||||
|
light_on = false;
|
||||||
|
digitalWrite(gpio_pin, LOW);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
WiFiClient client = server.available(); // Listen for incoming clients
|
||||||
|
|
||||||
|
handleButtonPress();
|
||||||
|
|
||||||
|
if (client) { // If a new client connects,
|
||||||
|
currentTime = millis();
|
||||||
|
previousTime = currentTime;
|
||||||
|
Serial.println("New Client."); // print a message out in the serial port
|
||||||
|
Serial.println("Web Server IP address: ");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
|
||||||
|
String currentLine = ""; // make a String to hold incoming data from the client
|
||||||
|
while (client.connected() && currentTime - previousTime <= timeoutTime) { // loop while the client's connected
|
||||||
|
// Also handle the button press in this loop to not miss events.
|
||||||
|
handleButtonPress();
|
||||||
|
|
||||||
|
currentTime = millis();
|
||||||
|
if (client.available()) { // if there's bytes to read from the client,
|
||||||
|
char c = client.read(); // read a byte, then
|
||||||
|
Serial.write(c); // print it out the serial monitor
|
||||||
|
header += c;
|
||||||
|
if (c == '\n') { // if the byte is a newline character
|
||||||
|
// if the current line is blank, you got two newline characters in a row.
|
||||||
|
// that's the end of the client HTTP request, so send a response:
|
||||||
|
if (currentLine.length() == 0) {
|
||||||
|
// HTTP headers always start with a response code (e.g. HTTP/1.1 200 OK)
|
||||||
|
// and a content-type so the client knows what's coming, then a blank line:
|
||||||
|
client.println("HTTP/1.1 200 OK");
|
||||||
|
client.println("Content-type:text/html");
|
||||||
|
client.println("Connection: close");
|
||||||
|
client.println();
|
||||||
|
|
||||||
|
// turns the GPIOs on and off
|
||||||
|
// Display the HTML web page
|
||||||
|
client.println("<!DOCTYPE html><html>");
|
||||||
|
client.println("<head><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">");
|
||||||
|
client.println("<link rel=\"icon\" href=\"data:,\">");
|
||||||
|
// CSS to style the on/off buttons
|
||||||
|
// Feel free to change the background-color and font-size attributes to fit your preferences
|
||||||
|
client.println("<style>html { font-family: Helvetica; display: inline-block; margin: 0px auto; text-align: center;}");
|
||||||
|
client.println(".button { background-color: #4CAF50; border: none; color: white; padding: 16px 40px;");
|
||||||
|
client.println("text-decoration: none; font-size: 30px; margin: 2px; cursor: pointer;}");
|
||||||
|
client.println(".button2 {background-color: #555555;}</style></head>");
|
||||||
|
|
||||||
|
//
|
||||||
|
// Web Page Heading
|
||||||
|
client.println("<body><h1>ESP32 Web Server</h1>");
|
||||||
|
//
|
||||||
|
// Web Page Body Contents
|
||||||
|
|
||||||
|
// Button Controls
|
||||||
|
displayPinState(client, ledPin, light_on);
|
||||||
|
|
||||||
|
//
|
||||||
|
// Close Web Page Body / Heading
|
||||||
|
client.println("</body></html>");
|
||||||
|
// The HTTP response ends with another blank line
|
||||||
|
client.println();
|
||||||
|
// Break out of the while loop
|
||||||
|
break;
|
||||||
|
} else { // if you got a newline, then clear currentLine
|
||||||
|
currentLine = "";
|
||||||
|
}
|
||||||
|
} else if (c != '\r') { // if you got anything else but a carriage return character,
|
||||||
|
currentLine += c; // add it to the end of the currentLine
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Clear the header variable
|
||||||
|
header = "";
|
||||||
|
// Close the connection
|
||||||
|
client.stop();
|
||||||
|
Serial.println("Client disconnected.");
|
||||||
|
Serial.println("");
|
||||||
|
}
|
||||||
|
}
|
||||||
15
esp/cpp/02_led-button-web/README.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# 02_led-button-web
|
||||||
|
|
||||||
|
This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
|
||||||
|
|
||||||
|
The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
This example uses the same schematic as [01_led-button](../01_led-button/).
|
||||||
|
|
||||||
|
The only difference is that you can also control the button through a web browser from any device connected to your local network.
|
||||||
|
|
||||||
|
This example was adapted from the example code in the [Arduino ESP32 API reference](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/wifi.html#wi-fi-ap-example).
|
||||||
|
|
||||||
|

|
||||||
BIN
esp/cpp/02_led-button-web/schematic.png
Normal file
|
After Width: | Height: | Size: 304 KiB |
BIN
esp/cpp/02_led-button-web/screenshot.png
Normal file
|
After Width: | Height: | Size: 18 KiB |
161
esp/cpp/03_temp-humidity-web/03_temp-humidity-web.ino
Normal file
@@ -0,0 +1,161 @@
|
|||||||
|
// Import required libraries
|
||||||
|
|
||||||
|
#include "WiFi.h"
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
#include <Adafruit_Sensor.h>
|
||||||
|
#include <DHT.h>
|
||||||
|
|
||||||
|
// Replace with your network credentials
|
||||||
|
const char* ssid = "network-name";
|
||||||
|
const char* password = "password";
|
||||||
|
|
||||||
|
#define DHTPIN 4 // Digital pin connected to the DHT sensor
|
||||||
|
|
||||||
|
// Uncomment the type of sensor in use:
|
||||||
|
#define DHTTYPE DHT11 // DHT 11
|
||||||
|
//#define DHTTYPE DHT22 // DHT 22 (AM2302)
|
||||||
|
//#define DHTTYPE DHT21 // DHT 21 (AM2301)
|
||||||
|
|
||||||
|
DHT dht(DHTPIN, DHTTYPE);
|
||||||
|
|
||||||
|
// Create AsyncWebServer object on port 80
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
String readDHTTemperature() {
|
||||||
|
// Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
|
||||||
|
// Read temperature as Celsius (the default)
|
||||||
|
float t = dht.readTemperature();
|
||||||
|
// Read temperature as Fahrenheit (isFahrenheit = true)
|
||||||
|
//float t = dht.readTemperature(true);
|
||||||
|
// Check if any reads failed and exit early (to try again).
|
||||||
|
if (isnan(t)) {
|
||||||
|
Serial.println("Failed to read from DHT sensor!");
|
||||||
|
return "--";
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Serial.println(t);
|
||||||
|
return String(t);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
String readDHTHumidity() {
|
||||||
|
// Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
|
||||||
|
float h = dht.readHumidity();
|
||||||
|
if (isnan(h)) {
|
||||||
|
Serial.println("Failed to read from DHT sensor!");
|
||||||
|
return "--";
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
Serial.println(h);
|
||||||
|
return String(h);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const char index_html[] PROGMEM = R"rawliteral(
|
||||||
|
<!DOCTYPE HTML><html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
|
||||||
|
<style>
|
||||||
|
html {
|
||||||
|
font-family: Arial;
|
||||||
|
display: inline-block;
|
||||||
|
margin: 0px auto;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
h2 { font-size: 3.0rem; }
|
||||||
|
p { font-size: 3.0rem; }
|
||||||
|
.units { font-size: 1.2rem; }
|
||||||
|
.dht-labels{
|
||||||
|
font-size: 1.5rem;
|
||||||
|
vertical-align:middle;
|
||||||
|
padding-bottom: 15px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h2>ESP32 DHT Server</h2>
|
||||||
|
<p>
|
||||||
|
<i class="fas fa-thermometer-half" style="color:#059e8a;"></i>
|
||||||
|
<span class="dht-labels">Temperature</span>
|
||||||
|
<span id="temperature">%TEMPERATURE%</span>
|
||||||
|
<sup class="units">°C</sup>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<i class="fas fa-tint" style="color:#00add6;"></i>
|
||||||
|
<span class="dht-labels">Humidity</span>
|
||||||
|
<span id="humidity">%HUMIDITY%</span>
|
||||||
|
<sup class="units">%</sup>
|
||||||
|
</p>
|
||||||
|
</body>
|
||||||
|
<script>
|
||||||
|
setInterval(function ( ) {
|
||||||
|
var xhttp = new XMLHttpRequest();
|
||||||
|
xhttp.onreadystatechange = function() {
|
||||||
|
if (this.readyState == 4 && this.status == 200) {
|
||||||
|
document.getElementById("temperature").innerHTML = this.responseText;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
xhttp.open("GET", "/temperature", true);
|
||||||
|
xhttp.send();
|
||||||
|
}, 10000 ) ;
|
||||||
|
|
||||||
|
setInterval(function ( ) {
|
||||||
|
var xhttp = new XMLHttpRequest();
|
||||||
|
xhttp.onreadystatechange = function() {
|
||||||
|
if (this.readyState == 4 && this.status == 200) {
|
||||||
|
document.getElementById("humidity").innerHTML = this.responseText;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
xhttp.open("GET", "/humidity", true);
|
||||||
|
xhttp.send();
|
||||||
|
}, 10000 ) ;
|
||||||
|
</script>
|
||||||
|
</html>)rawliteral";
|
||||||
|
|
||||||
|
// Replaces placeholder with DHT values
|
||||||
|
String processor(const String& var){
|
||||||
|
//Serial.println(var);
|
||||||
|
if(var == "TEMPERATURE"){
|
||||||
|
return readDHTTemperature();
|
||||||
|
}
|
||||||
|
else if(var == "HUMIDITY"){
|
||||||
|
return readDHTHumidity();
|
||||||
|
}
|
||||||
|
return String();
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup(){
|
||||||
|
// Serial port for debugging purposes
|
||||||
|
Serial.begin(115200);
|
||||||
|
|
||||||
|
dht.begin();
|
||||||
|
|
||||||
|
// Connect to Wi-Fi
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(1000);
|
||||||
|
Serial.println("Connecting to WiFi..");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print ESP32 Local IP Address
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
|
||||||
|
// Route for root / web page
|
||||||
|
server.on("/", HTTP_GET, [](AsyncWebServerRequest *request){
|
||||||
|
request->send_P(200, "text/html", index_html, processor);
|
||||||
|
});
|
||||||
|
server.on("/temperature", HTTP_GET, [](AsyncWebServerRequest *request){
|
||||||
|
request->send_P(200, "text/plain", readDHTTemperature().c_str());
|
||||||
|
});
|
||||||
|
server.on("/humidity", HTTP_GET, [](AsyncWebServerRequest *request){
|
||||||
|
request->send_P(200, "text/plain", readDHTHumidity().c_str());
|
||||||
|
});
|
||||||
|
|
||||||
|
// Start server
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop(){
|
||||||
|
|
||||||
|
}
|
||||||
60
esp/cpp/03_temp-humidity-web/README.md
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
# 03_temp-humidity-web
|
||||||
|
|
||||||
|
This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
|
||||||
|
|
||||||
|
The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Temperature and humidity sensor served on a web page within the local network.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
You need to install a couple of libraries for this project:
|
||||||
|
|
||||||
|
* The DHT and the Adafruit Unified Sensor Driver libraries to read from the DHT sensor.
|
||||||
|
* ESPAsyncWebServer and Async TCP libraries to build the asynchronous web server.
|
||||||
|
|
||||||
|
The default Arduino IDE installation will store libraries at `~/Arduino/ibraries` - if this directory doesn't exist, create it.
|
||||||
|
|
||||||
|
### Installing DHT Sensor Library
|
||||||
|
|
||||||
|
To read from the DHT sensor using Arduino IDE, you need to install the [DHT sensor library](https://github.com/adafruit/DHT-sensor-library).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget -O DHT_sensor.zip https://github.com/adafruit/DHT-sensor-library/archive/master.zip
|
||||||
|
unzip DHT_sensor.zip
|
||||||
|
mv DHT-sensor-library-master/ ~/Arduino/libraries/DHT_sensor
|
||||||
|
```
|
||||||
|
|
||||||
|
## Install Adafruit Unified Sensor Driver Library
|
||||||
|
|
||||||
|
You also need to install the [Adafruit Unified Sensor Driver library](https://github.com/adafruit/Adafruit_Sensor) to work with the DHT sensor.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget -O Adafruit_sensor.zip https://github.com/adafruit/Adafruit_Sensor/archive/master.zip
|
||||||
|
unzip Adafruit_sensor.zip
|
||||||
|
mv Adafruit_Sensor-master/ ~/Arduino/libraries/Adafruit_sensor
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing ESPAsyncWebServer Library
|
||||||
|
|
||||||
|
Follow the next steps to install the [ESPAsyncWebServer library](https://github.com/me-no-dev/ESPAsyncWebServer):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget -O ESPAsyncWebServer.zip https://github.com/me-no-dev/ESPAsyncWebServer/archive/master.zip
|
||||||
|
unzip ESPAsyncWebServer.zip
|
||||||
|
mv ESPAsyncWebServer-master/ ~/Arduino/libraries/ESPAsyncWebServer
|
||||||
|
```
|
||||||
|
|
||||||
|
## Installing Async TCP Library
|
||||||
|
|
||||||
|
The ESPAsyncWebServer library requires the [AsyncTCP library](https://github.com/me-no-dev/AsyncTCP) to work. Follow the next steps to install that library:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
wget -O AsyncTCP.zip https://github.com/me-no-dev/AsyncTCP/archive/master.zip
|
||||||
|
unzip AsyncTCP.zip
|
||||||
|
mv AsyncTCP-master/ ~/Arduino/libraries/AsyncTCP
|
||||||
|
```
|
||||||
BIN
esp/cpp/03_temp-humidity-web/schematic.png
Normal file
|
After Width: | Height: | Size: 238 KiB |
BIN
esp/cpp/03_temp-humidity-web/screenshot.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
4
esp/cpp/04_esp-idf-arduino/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
build
|
||||||
|
managed_components
|
||||||
|
dependencies.lock
|
||||||
|
sdkconfig.old
|
||||||
18
esp/cpp/04_esp-idf-arduino/CMakeLists.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# For more information about build system see
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
|
||||||
|
# The following five 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.26)
|
||||||
|
|
||||||
|
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] esp-idf-arduino
|
||||||
|
VERSION 0.1
|
||||||
|
DESCRIPTION "Example ESP-IDF cmake project"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
|
||||||
|
# For writing pure cmake components, see the documentation
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#writing-pure-cmake-components
|
||||||
|
idf_build_set_property(COMPILE_OPTIONS "-Wno-error" APPEND)
|
||||||
81
esp/cpp/04_esp-idf-arduino/README.md
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
# 04_esp-idf-arduino
|
||||||
|
|
||||||
|
There is no schematic for this example, it simply prints some output to the serial monitor at 115200.
|
||||||
|
This is more of a build system example for untethering yourself from the Arduino IDE.
|
||||||
|
|
||||||
|
To build this example you can run the following commands.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# See Dependencies section below for instructions.
|
||||||
|
source ~/path/to/esp-idf/export.sh
|
||||||
|
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake ..
|
||||||
|
make -j $(nproc)
|
||||||
|
|
||||||
|
# Flash the example to the ESP.
|
||||||
|
make flash
|
||||||
|
|
||||||
|
# Check the serial monitor for 'Hello world!' output.
|
||||||
|
idf.py monitor -b 115200
|
||||||
|
```
|
||||||
|
|
||||||
|
To flash to your ESP or access the `idf.py menuconfig` menu from the ESP-IDF you can run the same commands with `make`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make flash
|
||||||
|
make menuconfig
|
||||||
|
```
|
||||||
|
|
||||||
|
If Ninja is preferred:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake .. -G Nina
|
||||||
|
ninja
|
||||||
|
```
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
Install the [ESP-IDF](https://github.com/espressif/esp-idf?tab=readme-ov-file#setup-build-environment)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/v5.3.2/esp32/get-started/linux-macos-setup.html#for-linux-users
|
||||||
|
sudo apt-get install -y git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
|
||||||
|
|
||||||
|
git clone -b v5.3.2 --recursive https://github.com/espressif/esp-idf
|
||||||
|
cd esp-idf
|
||||||
|
./install.sh
|
||||||
|
. ./export.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
In CLion there is an official [Serial Monitor](https://plugins.jetbrains.com/plugin/8031-serial-port-monitor) plugin, or use ESP-IDF -
|
||||||
|
|
||||||
|
```bash
|
||||||
|
idf.py monitor -b 115200
|
||||||
|
```
|
||||||
|
|
||||||
|
## Starting Over
|
||||||
|
|
||||||
|
To set up this project from scratch the following commands were used
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# My example project directory
|
||||||
|
cd ~/Code/klips/esp/cpp/04_esp-idf-arduino
|
||||||
|
idf.py set-target esp32
|
||||||
|
idf.py add-dependency "espressif/arduino-esp32^3.1.1"
|
||||||
|
|
||||||
|
# Autostart Arduino for use of `loop()` and `setup()` functions
|
||||||
|
# You can also use the esp-idf `app_main()` function if preferred
|
||||||
|
# https://docs.espressif.com/projects/arduino-esp32/en/latest/esp-idf_component.html#configuration
|
||||||
|
# You can alternatively do this in the GUI tool `idf.py menuconfig`
|
||||||
|
echo "CONFIG_AUTOSTART_ARDUINO=y" >> sdkconfig
|
||||||
|
sed -i -e 's/CONFIG_FREERTOS_HZ=100/CONFIG_FREERTOS_HZ=1000/' sdkconfig
|
||||||
|
|
||||||
|
# Build the project
|
||||||
|
idf.py build
|
||||||
|
```
|
||||||
|
|
||||||
|
To set this project up in CLion, see [JetBrains documentation](https://www.jetbrains.com/help/clion/esp-idf.html#env-vars).
|
||||||
4
esp/cpp/04_esp-idf-arduino/main/CMakeLists.txt
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
idf_component_register(
|
||||||
|
SRCS "main.cpp"
|
||||||
|
INCLUDE_DIRS "."
|
||||||
|
)
|
||||||
17
esp/cpp/04_esp-idf-arduino/main/idf_component.yml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
## IDF Component Manager Manifest File
|
||||||
|
dependencies:
|
||||||
|
## Required IDF version
|
||||||
|
idf:
|
||||||
|
version: '>=4.1.0'
|
||||||
|
# # Put list of dependencies here
|
||||||
|
# # For components maintained by Espressif:
|
||||||
|
# component: "~1.0.0"
|
||||||
|
# # For 3rd party components:
|
||||||
|
# username/component: ">=1.0.0,<2.0.0"
|
||||||
|
# username2/component2:
|
||||||
|
# version: "~1.0.0"
|
||||||
|
# # For transient dependencies `public` flag can be set.
|
||||||
|
# # `public` flag doesn't have an effect dependencies of the `main` component.
|
||||||
|
# # All dependencies of `main` are public by default.
|
||||||
|
# public: true
|
||||||
|
espressif/arduino-esp32: ^3.1.1
|
||||||
10
esp/cpp/04_esp-idf-arduino/main/main.cpp
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
#include "Arduino.h"
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
Serial.println("Hello world!");
|
||||||
|
delay(1000);
|
||||||
|
}
|
||||||
2405
esp/cpp/04_esp-idf-arduino/sdkconfig
Normal file
4
esp/cpp/05_temp-humidity-web/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
build
|
||||||
|
managed_components
|
||||||
|
dependencies.lock
|
||||||
|
sdkconfig.old
|
||||||
18
esp/cpp/05_temp-humidity-web/CMakeLists.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
# For more information about build system see
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
|
||||||
|
# The following five 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.26)
|
||||||
|
|
||||||
|
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] temp-humidity-web
|
||||||
|
VERSION 0.1
|
||||||
|
DESCRIPTION "Temperature and humidity from DHT sensor served on a web page"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
|
||||||
|
# For writing pure cmake components, see the documentation
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#writing-pure-cmake-components
|
||||||
|
idf_build_set_property(COMPILE_OPTIONS "-Wno-error" APPEND)
|
||||||
27
esp/cpp/05_temp-humidity-web/README.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# 05_temp-humidity-web
|
||||||
|
|
||||||
|
This is the same example in [03_temp-humidity-web](./../03_temp-humidity-web), ported to the cmake ESP-IDF build system.
|
||||||
|
|
||||||
|
For instructions on setting up the ESP-IDF see [04_-esp-idf-arduino](./../04_esp-idf-arduino)
|
||||||
|
|
||||||
|
This example is largely adapted from those in [ESP32-basic-starter-kit.pdf](./ESP32-basic-starter-kit.pdf).
|
||||||
|
|
||||||
|
The APIs in the original examples paired with this PDF have changed, and I decided to do some different things with the code and/or circuits, but the original code can be [found here](https://www.dropbox.com/scl/fo/6znlij3eb23ih4jxcpv2w/AKvB1t9CCUgoVRVtGen8Yrw?rlkey=z84anl0hs940qf9fpl7l8q8q2&e=1&dl=0).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Temperature and humidity sensor served on a web page within the local network.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
To build this example run the following commands.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source ~/path/to/esp-idf/export.sh
|
||||||
|
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake ..
|
||||||
|
make -j $(nproc)
|
||||||
|
make flash
|
||||||
|
```
|
||||||
4
esp/cpp/05_temp-humidity-web/main/CMakeLists.txt
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
idf_component_register(
|
||||||
|
SRCS "main.cpp"
|
||||||
|
INCLUDE_DIRS "."
|
||||||
|
)
|
||||||
19
esp/cpp/05_temp-humidity-web/main/idf_component.yml
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
## IDF Component Manager Manifest File
|
||||||
|
dependencies:
|
||||||
|
## Required IDF version
|
||||||
|
idf:
|
||||||
|
version: '>=4.1.0'
|
||||||
|
# # Put list of dependencies here
|
||||||
|
# # For components maintained by Espressif:
|
||||||
|
# component: "~1.0.0"
|
||||||
|
# # For 3rd party components:
|
||||||
|
# username/component: ">=1.0.0,<2.0.0"
|
||||||
|
# username2/component2:
|
||||||
|
# version: "~1.0.0"
|
||||||
|
# # For transient dependencies `public` flag can be set.
|
||||||
|
# # `public` flag doesn't have an effect dependencies of the `main` component.
|
||||||
|
# # All dependencies of `main` are public by default.
|
||||||
|
# public: true
|
||||||
|
espressif/arduino-esp32: ^3.1.1
|
||||||
|
zorxx/dht: ^1.0.1
|
||||||
|
esp32async/espasyncwebserver: ^3.7.0~1
|
||||||
189
esp/cpp/05_temp-humidity-web/main/main.cpp
Normal file
@@ -0,0 +1,189 @@
|
|||||||
|
#include "WiFi.h"
|
||||||
|
#include "ESPAsyncWebServer.h"
|
||||||
|
#include "main.h"
|
||||||
|
|
||||||
|
// Replace with your network credentials
|
||||||
|
const char *ssid = "wifi";
|
||||||
|
const char *password = "password";
|
||||||
|
|
||||||
|
#define DHTPIN GPIO_NUM_4 // Digital pin connected to the DHT sensor
|
||||||
|
|
||||||
|
// Uncomment the type of sensor in use:
|
||||||
|
#define DHTTYPE DHT_TYPE_DHT11 // DHT 11
|
||||||
|
//#define DHTTYPE DHT_TYPE_DHT22 // DHT 22 (AM2302)
|
||||||
|
//#define DHTTYPE DHT_TYPE_DHT21 // DHT 21 (AM2301)
|
||||||
|
|
||||||
|
float DHT::readTemperature(bool f)
|
||||||
|
{
|
||||||
|
float humidity = 0;
|
||||||
|
float temperature = 0;
|
||||||
|
esp_err_t result = dht_read_float_data(type_, gpio_, &humidity,
|
||||||
|
&temperature);
|
||||||
|
if (result == ESP_OK) {
|
||||||
|
ESP_LOGI("[DHT::readTemperature]", "Humidity: %.1f%% Temperature: %.1f°C",
|
||||||
|
humidity,
|
||||||
|
temperature);
|
||||||
|
} else {
|
||||||
|
ESP_LOGE("[DHT::readTemperature]", "Failed to read sensor data: %s",
|
||||||
|
esp_err_to_name(result));
|
||||||
|
}
|
||||||
|
return f ? (temperature * 1.8f) + 32 : temperature;
|
||||||
|
}
|
||||||
|
|
||||||
|
float DHT::readHumidity()
|
||||||
|
{
|
||||||
|
float humidity = 0;
|
||||||
|
float temperature = 0;
|
||||||
|
esp_err_t result = dht_read_float_data(type_, gpio_, &humidity,
|
||||||
|
&temperature);
|
||||||
|
if (result == ESP_OK) {
|
||||||
|
ESP_LOGI("[DHT::readTemperature]", "Humidity: %.1f%% Temperature: %.1f°C",
|
||||||
|
humidity,
|
||||||
|
temperature);
|
||||||
|
} else {
|
||||||
|
ESP_LOGE("[DHT::readTemperature]", "Failed to read sensor data: %s",
|
||||||
|
esp_err_to_name(result));
|
||||||
|
}
|
||||||
|
return humidity;
|
||||||
|
}
|
||||||
|
|
||||||
|
DHT dht(DHTPIN, DHTTYPE);
|
||||||
|
|
||||||
|
// Create AsyncWebServer object on port 80
|
||||||
|
AsyncWebServer server(80);
|
||||||
|
|
||||||
|
String readDHTTemperature()
|
||||||
|
{
|
||||||
|
// Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
|
||||||
|
float t = dht.readTemperature();
|
||||||
|
// Check if any reads failed and exit early (to try again).
|
||||||
|
if (isnan(t)) {
|
||||||
|
Serial.println("Failed to read from DHT sensor!");
|
||||||
|
return "--";
|
||||||
|
} else {
|
||||||
|
Serial.println(t);
|
||||||
|
return String(t);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
String readDHTHumidity()
|
||||||
|
{
|
||||||
|
// Sensor readings may also be up to 2 seconds 'old' (its a very slow sensor)
|
||||||
|
float h = dht.readHumidity();
|
||||||
|
if (isnan(h)) {
|
||||||
|
Serial.println("Failed to read from DHT sensor!");
|
||||||
|
return "--";
|
||||||
|
} else {
|
||||||
|
Serial.println(h);
|
||||||
|
return String(h);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const char index_html[] PROGMEM = R"rawliteral(
|
||||||
|
<!DOCTYPE HTML><html>
|
||||||
|
<head>
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css" integrity="sha384-fnmOCqbTlWIlj8LyTjo7mOUStjsKC4pOpQbqyi7RrhN7udi9RwhKkMHpvLbHG9Sr" crossorigin="anonymous">
|
||||||
|
<style>
|
||||||
|
html {
|
||||||
|
font-family: Arial;
|
||||||
|
display: inline-block;
|
||||||
|
margin: 0px auto;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
h2 { font-size: 3.0rem; }
|
||||||
|
p { font-size: 3.0rem; }
|
||||||
|
.units { font-size: 1.2rem; }
|
||||||
|
.dht-labels{
|
||||||
|
font-size: 1.5rem;
|
||||||
|
vertical-align:middle;
|
||||||
|
padding-bottom: 15px;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h2>ESP32 DHT Server</h2>
|
||||||
|
<p>
|
||||||
|
<i class="fas fa-thermometer-half" style="color:#059e8a;"></i>
|
||||||
|
<span class="dht-labels">Temperature</span>
|
||||||
|
<span id="temperature">%TEMPERATURE%</span>
|
||||||
|
<sup class="units">°C</sup>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<i class="fas fa-tint" style="color:#00add6;"></i>
|
||||||
|
<span class="dht-labels">Humidity</span>
|
||||||
|
<span id="humidity">%HUMIDITY%</span>
|
||||||
|
<sup class="units">%</sup>
|
||||||
|
</p>
|
||||||
|
</body>
|
||||||
|
<script>
|
||||||
|
setInterval(function ( ) {
|
||||||
|
var xhttp = new XMLHttpRequest();
|
||||||
|
xhttp.onreadystatechange = function() {
|
||||||
|
if (this.readyState == 4 && this.status == 200) {
|
||||||
|
document.getElementById("temperature").innerHTML = this.responseText;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
xhttp.open("GET", "/temperature", true);
|
||||||
|
xhttp.send();
|
||||||
|
}, 10000 ) ;
|
||||||
|
|
||||||
|
setInterval(function ( ) {
|
||||||
|
var xhttp = new XMLHttpRequest();
|
||||||
|
xhttp.onreadystatechange = function() {
|
||||||
|
if (this.readyState == 4 && this.status == 200) {
|
||||||
|
document.getElementById("humidity").innerHTML = this.responseText;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
xhttp.open("GET", "/humidity", true);
|
||||||
|
xhttp.send();
|
||||||
|
}, 10000 ) ;
|
||||||
|
</script>
|
||||||
|
</html>)rawliteral";
|
||||||
|
|
||||||
|
// Replaces placeholder with DHT values
|
||||||
|
String processor(const String &var)
|
||||||
|
{
|
||||||
|
//Serial.println(var);
|
||||||
|
if (var == "TEMPERATURE") {
|
||||||
|
return readDHTTemperature();
|
||||||
|
} else if (var == "HUMIDITY") {
|
||||||
|
return readDHTHumidity();
|
||||||
|
}
|
||||||
|
return String();
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup()
|
||||||
|
{
|
||||||
|
// Serial port for debugging purposes
|
||||||
|
Serial.begin(115200);
|
||||||
|
|
||||||
|
// Connect to Wi-Fi
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
while (WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(1000);
|
||||||
|
Serial.println("Connecting to WiFi..");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Print ESP32 Local IP Address
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
|
||||||
|
// Route for root / web page
|
||||||
|
server.on("/", HTTP_GET, [ ](AsyncWebServerRequest *request) {
|
||||||
|
request->send(200, "text/html", index_html, processor);
|
||||||
|
});
|
||||||
|
server.on("/temperature", HTTP_GET, [ ](AsyncWebServerRequest *request) {
|
||||||
|
request->send(200, "text/plain", readDHTTemperature().c_str());
|
||||||
|
});
|
||||||
|
server.on("/humidity", HTTP_GET, [ ](AsyncWebServerRequest *request) {
|
||||||
|
request->send(200, "text/plain", readDHTHumidity().c_str());
|
||||||
|
});
|
||||||
|
|
||||||
|
// Start server
|
||||||
|
server.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
33
esp/cpp/05_temp-humidity-web/main/main.h
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
#ifndef MAIN_H
|
||||||
|
#define MAIN_H
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
#include "dht.h"
|
||||||
|
|
||||||
|
class DHT {
|
||||||
|
public:
|
||||||
|
DHT(gpio_num_t gpio, dht_sensor_type_t type) :
|
||||||
|
gpio_(gpio), type_(type) { }
|
||||||
|
|
||||||
|
~DHT() = default;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read temperature from DHT sensor
|
||||||
|
*
|
||||||
|
* @param f True to return in Fahrenheit, False for Celsius.
|
||||||
|
*/
|
||||||
|
float readTemperature(bool f = true);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read humidity from DHT sensor.
|
||||||
|
*/
|
||||||
|
float readHumidity();
|
||||||
|
|
||||||
|
private:
|
||||||
|
gpio_num_t gpio_;
|
||||||
|
dht_sensor_type_t type_;
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
#endif // MAIN_H
|
||||||
BIN
esp/cpp/05_temp-humidity-web/schematic.png
Normal file
|
After Width: | Height: | Size: 238 KiB |
BIN
esp/cpp/05_temp-humidity-web/screenshot.png
Normal file
|
After Width: | Height: | Size: 33 KiB |
2415
esp/cpp/05_temp-humidity-web/sdkconfig
Normal file
4
esp/cpp/06_i2c-scanner/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
build
|
||||||
|
managed_components
|
||||||
|
dependencies.lock
|
||||||
|
sdkconfig.old
|
||||||
17
esp/cpp/06_i2c-scanner/CMakeLists.txt
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# For more information about build system see
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
|
||||||
|
# The following five 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.26)
|
||||||
|
|
||||||
|
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] i2c-scanner
|
||||||
|
VERSION 0.1
|
||||||
|
DESCRIPTION "Simple I2C device scanner"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
# For writing pure cmake components, see the documentation
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#writing-pure-cmake-components
|
||||||
|
idf_build_set_property(COMPILE_OPTIONS "-Wno-error" APPEND)
|
||||||
32
esp/cpp/06_i2c-scanner/README.md
Normal file
@@ -0,0 +1,32 @@
|
|||||||
|
# 06_i2c-scanner
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Simple I2C device scanner.
|
||||||
|
|
||||||
|
For this example I used this [SSD1306 OLED display](https://www.digikey.com/en/products/detail/winstar-display/WEA012864DWPP3N00003/20533255).
|
||||||
|
|
||||||
|
To build the example run the following commands.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source ~/path/to/esp-idf/export.sh
|
||||||
|
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake ..
|
||||||
|
make -j $(nproc)
|
||||||
|
|
||||||
|
# Flash to ESP32
|
||||||
|
make flash
|
||||||
|
|
||||||
|
# Open Serial Monitor, press CTRL+] to exit.
|
||||||
|
make monitor
|
||||||
|
```
|
||||||
|
|
||||||
|
Expected output in serial monitor at 115200 baud
|
||||||
|
|
||||||
|
```bash
|
||||||
|
Scanning I2C devices...
|
||||||
|
[0x3c]: Device found with clock rate 100000 and timeout 50
|
||||||
|
Done.
|
||||||
|
```
|
||||||
4
esp/cpp/06_i2c-scanner/main/CMakeLists.txt
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
idf_component_register(
|
||||||
|
SRCS "main.cpp"
|
||||||
|
INCLUDE_DIRS "."
|
||||||
|
)
|
||||||
17
esp/cpp/06_i2c-scanner/main/idf_component.yml
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
## IDF Component Manager Manifest File
|
||||||
|
dependencies:
|
||||||
|
## Required IDF version
|
||||||
|
idf:
|
||||||
|
version: '>=5.3.0'
|
||||||
|
# # Put list of dependencies here
|
||||||
|
# # For components maintained by Espressif:
|
||||||
|
# component: "~1.0.0"
|
||||||
|
# # For 3rd party components:
|
||||||
|
# username/component: ">=1.0.0,<2.0.0"
|
||||||
|
# username2/component2:
|
||||||
|
# version: "~1.0.0"
|
||||||
|
# # For transient dependencies `public` flag can be set.
|
||||||
|
# # `public` flag doesn't have an effect dependencies of the `main` component.
|
||||||
|
# # All dependencies of `main` are public by default.
|
||||||
|
# public: true
|
||||||
|
espressif/arduino-esp32: ^3.1.1
|
||||||
35
esp/cpp/06_i2c-scanner/main/main.cpp
Normal file
@@ -0,0 +1,35 @@
|
|||||||
|
#include "Arduino.h"
|
||||||
|
#include "Wire.h"
|
||||||
|
|
||||||
|
[[maybe_unused]] static const char *TAG = "i2c-scanner";
|
||||||
|
|
||||||
|
void i2c_scan()
|
||||||
|
{
|
||||||
|
uint8_t device_num = 0;
|
||||||
|
Serial.println("Scanning I2C devices...");
|
||||||
|
for (byte address = 1; address < 127; address++) {
|
||||||
|
Wire.beginTransmission(address);
|
||||||
|
byte error = Wire.endTransmission();
|
||||||
|
if (error == 0) {
|
||||||
|
Serial.printf(
|
||||||
|
"[0x%.2x]: Device found with clock rate %lu and timeout %u\n",
|
||||||
|
address,
|
||||||
|
Wire.getClock(), Wire.getTimeOut());
|
||||||
|
device_num++;
|
||||||
|
} else if (error == 4) {
|
||||||
|
Serial.printf("[0x%.2x]: Unknown error.\n", address);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Serial.println(device_num > 0 ? "Done.\n" : "No I2C devices found.\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup()
|
||||||
|
{
|
||||||
|
Serial.begin(115200);
|
||||||
|
Wire.begin();
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop()
|
||||||
|
{
|
||||||
|
i2c_scan();
|
||||||
|
}
|
||||||
BIN
esp/cpp/06_i2c-scanner/schematic.png
Normal file
|
After Width: | Height: | Size: 227 KiB |
2414
esp/cpp/06_i2c-scanner/sdkconfig
Normal file
4
esp/cpp/07_lcd-panel-i2c/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
build
|
||||||
|
managed_components
|
||||||
|
dependencies.lock
|
||||||
|
sdkconfig.old
|
||||||
17
esp/cpp/07_lcd-panel-i2c/CMakeLists.txt
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
# For more information about build system see
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
|
||||||
|
# The following five 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.26)
|
||||||
|
|
||||||
|
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
|
||||||
|
|
||||||
|
project(
|
||||||
|
#[[NAME]] lcd-panel-i2c
|
||||||
|
VERSION 0.1
|
||||||
|
DESCRIPTION "Using the SSD1306 LCD display with ESP-IDF and LVGL over I2C"
|
||||||
|
LANGUAGES CXX
|
||||||
|
)
|
||||||
|
# For writing pure cmake components, see the documentation
|
||||||
|
# https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#writing-pure-cmake-components
|
||||||
|
idf_build_set_property(COMPILE_OPTIONS "-Wno-error" APPEND)
|
||||||
27
esp/cpp/07_lcd-panel-i2c/README.md
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
# 07_lcd-panel-i2c
|
||||||
|
|
||||||
|
Using the ESP IDF for drawing to a LCD screen over I2C.
|
||||||
|
|
||||||
|
[ESP IDF - I2C](https://docs.espressif.com/projects/esp-idf/en/v5.3.2/esp32/api-reference/peripherals/i2c.html)
|
||||||
|
|
||||||
|
[ESP IDF - LCD](https://docs.espressif.com/projects/esp-idf/en/v5.3.2/esp32/api-reference/peripherals/lcd/index.html)
|
||||||
|
|
||||||
|
[ESP IDF - FreeRTOS](https://docs.espressif.com/projects/esp-idf/en/v5.3.2/esp32/api-reference/system/freertos.html)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
For instructions on setting up the ESP-IDF see [04_-esp-idf-arduino](./../04_esp-idf-arduino)
|
||||||
|
|
||||||
|
To build this example run the following commands.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source ~/path/to/esp-idf/export.sh
|
||||||
|
|
||||||
|
mkdir build
|
||||||
|
cd build
|
||||||
|
cmake ..
|
||||||
|
make -j $(nproc)
|
||||||
|
make flash
|
||||||
|
```
|
||||||
BIN
esp/cpp/07_lcd-panel-i2c/example.gif
Normal file
|
After Width: | Height: | Size: 887 KiB |
7
esp/cpp/07_lcd-panel-i2c/main/CMakeLists.txt
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
idf_component_register(
|
||||||
|
SRCS
|
||||||
|
main.cpp display.cpp panel_device.cpp scoped_lock.cpp
|
||||||
|
i2c.h time_keeper.h panel.h ssd1306.h
|
||||||
|
INCLUDE_DIRS .
|
||||||
|
REQUIRES driver
|
||||||
|
)
|
||||||
56
esp/cpp/07_lcd-panel-i2c/main/display.cpp
Normal file
@@ -0,0 +1,56 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#include <lv_init.h>
|
||||||
|
|
||||||
|
#include "display.h"
|
||||||
|
|
||||||
|
// Static TimeKeeper for managing ESP timers across all displays.
|
||||||
|
TimeKeeper Display::timers_;
|
||||||
|
|
||||||
|
Display::Display(IPanelDevice &device) :
|
||||||
|
panel_(device)
|
||||||
|
{
|
||||||
|
if (!lv_is_initialized()) {
|
||||||
|
ESP_LOGI(TAG, "Initialize LVGL");
|
||||||
|
lv_init();
|
||||||
|
}
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Creating LVGL display");
|
||||||
|
lv_display_ = panel_.device_->create_display();
|
||||||
|
// associate the i2c panel handle to the display
|
||||||
|
lv_display_set_user_data(lv_display_, panel_.esp_panel_);
|
||||||
|
|
||||||
|
panel_.register_display_callbacks(lv_display_);
|
||||||
|
}
|
||||||
|
|
||||||
|
void Display::set_text(const char *text,
|
||||||
|
const char *name,
|
||||||
|
lv_label_long_mode_t long_mode,
|
||||||
|
lv_align_t align)
|
||||||
|
{
|
||||||
|
// Lock the mutex due to the LVGL APIs are not thread-safe.
|
||||||
|
ScopedLock lock;
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Display LVGL Scroll Text");
|
||||||
|
lv_obj_t *scr = lv_display_get_screen_active(lv_display_);
|
||||||
|
|
||||||
|
// Create the label if it's `name` doesn't already exist in the map keys.
|
||||||
|
if (!lv_objects_.count(name)) {
|
||||||
|
lv_objects_[name] = lv_label_create(scr);
|
||||||
|
}
|
||||||
|
auto obj = lv_objects_[name];
|
||||||
|
|
||||||
|
// Set text and long mode.
|
||||||
|
lv_label_set_long_mode(obj, long_mode);
|
||||||
|
lv_label_set_text(obj, text);
|
||||||
|
|
||||||
|
// Set the size of the screen.
|
||||||
|
// If you use rotation 90 or 270 use lv_display_get_vertical_resolution.
|
||||||
|
lv_obj_set_width(obj, lv_display_get_horizontal_resolution(lv_display_));
|
||||||
|
lv_obj_align(obj, align, 0, 0);
|
||||||
|
}
|
||||||
114
esp/cpp/07_lcd-panel-i2c/main/display.h
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef DISPLAY_H
|
||||||
|
#define DISPLAY_H
|
||||||
|
|
||||||
|
#include <widgets/label/lv_label.h>
|
||||||
|
|
||||||
|
#include <unordered_map>
|
||||||
|
|
||||||
|
#include "time_keeper.h"
|
||||||
|
#include "panel.h"
|
||||||
|
#include "scoped_lock.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encapsulates lv_display handle and related LVGL operations.
|
||||||
|
* Contains helper methods that wrap basic LVGL operations such as drawing text.
|
||||||
|
* The underlying lv_display can be obtained for manual LVGL operations.
|
||||||
|
* @sa ScopedLock
|
||||||
|
* @sa Display::get()
|
||||||
|
*/
|
||||||
|
class Display {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* Construct a new Display using an object that implements IPanelDevice.
|
||||||
|
*
|
||||||
|
* @param device An object that implements the IPanelDevice interface.
|
||||||
|
*/
|
||||||
|
explicit Display(IPanelDevice &device);
|
||||||
|
|
||||||
|
~Display() = default;
|
||||||
|
|
||||||
|
Display(const Display &) = delete;
|
||||||
|
|
||||||
|
Display(Display &) = delete;
|
||||||
|
|
||||||
|
Display &operator=(Display &) = delete;
|
||||||
|
|
||||||
|
using lv_display_handle_t = lv_display_t *;
|
||||||
|
|
||||||
|
//
|
||||||
|
// GETTERS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Getter for accessing LVGL display handle.
|
||||||
|
*
|
||||||
|
* @sa ScopedLock for calling custom LVGL API's not implemented by Display.
|
||||||
|
*/
|
||||||
|
[[nodiscard]] inline lv_display_handle_t get() const { return lv_display_; }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Getter for accessing LVGL display handle.
|
||||||
|
*
|
||||||
|
* @sa ScopedLock for calling custom LVGL API's not implemented by Display.
|
||||||
|
*/
|
||||||
|
[[nodiscard]] inline lv_display_handle_t get() { return lv_display_; }
|
||||||
|
|
||||||
|
/// Dereference operator for accessing LVGL display handle.
|
||||||
|
[[nodiscard]] inline lv_display_handle_t operator*() const { return get(); }
|
||||||
|
|
||||||
|
/// Dereference operator for accessing LVGL display handle.
|
||||||
|
[[nodiscard]] inline lv_display_handle_t operator*() { return get(); }
|
||||||
|
|
||||||
|
//
|
||||||
|
// LVGL OPERATIONS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a LVGL label with some given text on the current display.
|
||||||
|
* The name of the object can be reused to change text on this label later.
|
||||||
|
*
|
||||||
|
* @param text Text to write to the display.
|
||||||
|
* @param name Name for the LVGL label object associated with this text.
|
||||||
|
* @param long_mode LVGL long mode for text wider than the current display.
|
||||||
|
* @param align LVGL alignment to use for placing the label on the display.
|
||||||
|
*/
|
||||||
|
void set_text(const char *text,
|
||||||
|
const char *name,
|
||||||
|
lv_label_long_mode_t long_mode = LV_LABEL_LONG_SCROLL_CIRCULAR,
|
||||||
|
lv_align_t align = LV_ALIGN_TOP_MID);
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC STATIC MEMBERS
|
||||||
|
|
||||||
|
/// Public static TimeKeeper for managing ESP timers across all displays.
|
||||||
|
static TimeKeeper timers_;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// Panel associated with this Display.
|
||||||
|
Panel panel_;
|
||||||
|
|
||||||
|
/// LVGL display handle.
|
||||||
|
lv_display_handle_t lv_display_;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* LVGL object handles stored in the LVGL screen associated with this Display.
|
||||||
|
*
|
||||||
|
* @sa Display::set_text
|
||||||
|
* @sa lv_display_get_screen_active
|
||||||
|
*/
|
||||||
|
std::unordered_map<const char *, lv_obj_t *> lv_objects_;
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "Display";
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // DISPLAY_H
|
||||||
91
esp/cpp/07_lcd-panel-i2c/main/i2c.h
Normal file
@@ -0,0 +1,91 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef I2C_H
|
||||||
|
#define I2C_H
|
||||||
|
|
||||||
|
#define I2C_BUS_PORT 0
|
||||||
|
|
||||||
|
#include <driver/i2c_master.h>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encapsulates ESP I2C creation and usage.
|
||||||
|
*/
|
||||||
|
struct I2C {
|
||||||
|
/**
|
||||||
|
* Construct and initialize an ESP I2C master bus.
|
||||||
|
* An I2C constructor may only be called one time in any application.
|
||||||
|
*
|
||||||
|
* @param sda GPIO pin number for SDA
|
||||||
|
* @param scl GPIO pin number for SCL
|
||||||
|
* @param rst GPIO pin number for RST
|
||||||
|
*/
|
||||||
|
I2C(gpio_num_t sda, gpio_num_t scl, int rst = -1) :
|
||||||
|
I2C((i2c_master_bus_config_t) {
|
||||||
|
.i2c_port = I2C_BUS_PORT,
|
||||||
|
.sda_io_num = sda,
|
||||||
|
.scl_io_num = scl,
|
||||||
|
.clk_source = I2C_CLK_SRC_DEFAULT,
|
||||||
|
.glitch_ignore_cnt = 7,
|
||||||
|
.flags {
|
||||||
|
.enable_internal_pullup = true,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
rst
|
||||||
|
) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct an ESP I2C master bus given a specific ESP I2C configuration.
|
||||||
|
* An I2C constructor may only be called one time in any application.
|
||||||
|
*
|
||||||
|
* @param config ESP I2C master bus configuration.
|
||||||
|
* @param rst GPIO pin number for RST
|
||||||
|
*/
|
||||||
|
explicit I2C(i2c_master_bus_config_t config, int rst = -1) :
|
||||||
|
esp_bus_config_(config),
|
||||||
|
rst_num_(rst)
|
||||||
|
{
|
||||||
|
i2c_master_bus_handle_t i2c;
|
||||||
|
ESP_LOGI(TAG, "Initializing new master I2C bus");
|
||||||
|
ESP_ERROR_CHECK(i2c_new_master_bus(&esp_bus_config_, &i2c));
|
||||||
|
}
|
||||||
|
|
||||||
|
~I2C() = default;
|
||||||
|
|
||||||
|
//
|
||||||
|
// GETTERS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ESP I2C master bus handle getter.
|
||||||
|
* This will fail if an I2C instance was never constructed.
|
||||||
|
*/
|
||||||
|
static i2c_master_bus_handle_t get()
|
||||||
|
{
|
||||||
|
i2c_master_bus_handle_t i2c = nullptr;
|
||||||
|
ESP_ERROR_CHECK(i2c_master_get_bus_handle(0, &i2c));
|
||||||
|
return i2c;
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC MEMBERS
|
||||||
|
|
||||||
|
/// ESP I2C master bus configuration used during initialization.
|
||||||
|
i2c_master_bus_config_t esp_bus_config_;
|
||||||
|
|
||||||
|
/// RST GPIO pin number.
|
||||||
|
int rst_num_;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "I2C";
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif //I2C_H
|
||||||
6
esp/cpp/07_lcd-panel-i2c/main/idf_component.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
## IDF Component Manager Manifest File
|
||||||
|
dependencies:
|
||||||
|
idf: '>=5.3.0'
|
||||||
|
espressif/arduino-esp32: ^3.1.1
|
||||||
|
lvgl/lvgl: "9.2.0"
|
||||||
|
esp_lcd_sh1107: "^1"
|
||||||
41
esp/cpp/07_lcd-panel-i2c/main/main.cpp
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#include "display.h"
|
||||||
|
#include "ssd1306.h"
|
||||||
|
|
||||||
|
// Pin may vary based on your schematic.
|
||||||
|
#define PIN_SDA GPIO_NUM_21
|
||||||
|
#define PIN_SCL GPIO_NUM_22
|
||||||
|
#define PIN_RST (-1)
|
||||||
|
|
||||||
|
I2C i2c(PIN_SDA, PIN_SCL, PIN_RST);
|
||||||
|
|
||||||
|
void setup()
|
||||||
|
{
|
||||||
|
SSD1306 ssd1306(i2c);
|
||||||
|
Display d(ssd1306);
|
||||||
|
|
||||||
|
d.set_text("Test test 12345678910",
|
||||||
|
"test-text1",
|
||||||
|
LV_LABEL_LONG_SCROLL,
|
||||||
|
LV_ALIGN_CENTER);
|
||||||
|
|
||||||
|
d.set_text("Test test changing text",
|
||||||
|
"test-text1",
|
||||||
|
LV_LABEL_LONG_SCROLL,
|
||||||
|
LV_ALIGN_CENTER);
|
||||||
|
|
||||||
|
d.set_text("Hello hello hello hello hello hello hello hello!", "test-text2");
|
||||||
|
|
||||||
|
d.set_text("A random sentence with no meaning at all.",
|
||||||
|
"test-text3",
|
||||||
|
LV_LABEL_LONG_CLIP,
|
||||||
|
LV_ALIGN_BOTTOM_MID);
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() { }
|
||||||
87
esp/cpp/07_lcd-panel-i2c/main/panel.h
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef PANEL_H
|
||||||
|
#define PANEL_H
|
||||||
|
|
||||||
|
#include "panel_device.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encapsulates esp_lcd_panel handles and operations.
|
||||||
|
* The only exception is esp_lcd_panel_io_i2c_config_t owned by IPanelDevice.
|
||||||
|
* This structure requires details specific to the implementing device.
|
||||||
|
*
|
||||||
|
* Panel is an implementation detail of Display, not meant to be used directly.
|
||||||
|
*/
|
||||||
|
struct Panel {
|
||||||
|
/**
|
||||||
|
* Construct a new Panel using an object that implements IPanelDevice.
|
||||||
|
*
|
||||||
|
* @param device An object that implements the IPanelDevice interface.
|
||||||
|
*/
|
||||||
|
explicit Panel(IPanelDevice &device) :
|
||||||
|
device_(&device),
|
||||||
|
esp_io_(nullptr),
|
||||||
|
esp_panel_(nullptr),
|
||||||
|
esp_panel_config_(
|
||||||
|
(esp_lcd_panel_dev_config_t) {
|
||||||
|
.reset_gpio_num = device_->rst_num_,
|
||||||
|
.bits_per_pixel = 1,
|
||||||
|
.vendor_config = device_->vendor_config(),
|
||||||
|
}
|
||||||
|
)
|
||||||
|
{
|
||||||
|
esp_io_ = device_->create_io_handle();
|
||||||
|
|
||||||
|
device_->create_panel(esp_panel_config_, esp_io_, esp_panel_);
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Resetting panel display");
|
||||||
|
ESP_ERROR_CHECK(esp_lcd_panel_reset(esp_panel_));
|
||||||
|
ESP_LOGI(TAG, "Initializing panel display");
|
||||||
|
ESP_ERROR_CHECK(esp_lcd_panel_init(esp_panel_));
|
||||||
|
ESP_LOGI(TAG, "Turning on panel display");
|
||||||
|
ESP_ERROR_CHECK(esp_lcd_panel_disp_on_off(esp_panel_, true));
|
||||||
|
}
|
||||||
|
|
||||||
|
~Panel() = default;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC MEMBERS
|
||||||
|
|
||||||
|
/// Pointer to object using known interface for IPanelDevice.
|
||||||
|
IPanelDevice *device_;
|
||||||
|
|
||||||
|
/// ESP LCD panel IO handle.
|
||||||
|
esp_lcd_panel_io_handle_t esp_io_;
|
||||||
|
|
||||||
|
/// ESP LCD panel handle.
|
||||||
|
esp_lcd_panel_handle_t esp_panel_;
|
||||||
|
|
||||||
|
/// ESP LCD panel configuration structure.
|
||||||
|
esp_lcd_panel_dev_config_t esp_panel_config_;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers LVGL draw buffers and callbacks for rendering the display.
|
||||||
|
*
|
||||||
|
* @param display_handle Pointer to the LVGL display to use for rendering.
|
||||||
|
*/
|
||||||
|
inline void register_display_callbacks(lv_display_t *display_handle) const
|
||||||
|
{
|
||||||
|
device_->register_rendering_data(display_handle, esp_io_);
|
||||||
|
device_->register_lvgl_tick_timer();
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "Panel";
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif //PANEL_H
|
||||||
145
esp/cpp/07_lcd-panel-i2c/main/panel_device.cpp
Normal file
@@ -0,0 +1,145 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#include "panel_device.h"
|
||||||
|
#include "display.h"
|
||||||
|
|
||||||
|
bool IPanelDevice::lvgl_flush_ready_cb(esp_lcd_panel_io_handle_t,
|
||||||
|
esp_lcd_panel_io_event_data_t *,
|
||||||
|
void *user_ctx)
|
||||||
|
{
|
||||||
|
auto *disp = (lv_display_t *) user_ctx;
|
||||||
|
lv_display_flush_ready(disp);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
void IPanelDevice::lvgl_flush_cb(lv_display_t *display, const lv_area_t *area,
|
||||||
|
uint8_t *px_map) // NOLINT(*-non-const-parameter)
|
||||||
|
{
|
||||||
|
auto panel_handle =
|
||||||
|
(esp_lcd_panel_handle_t) lv_display_get_user_data(display);
|
||||||
|
|
||||||
|
// Necessary because LVGL reserves 2x4 bytes in the buffer for a palette.
|
||||||
|
// Since we are monochrome, we don't need these additional bytes.
|
||||||
|
// For more information about the monochrome, please refer to:
|
||||||
|
// https://docs.lvgl.io/9.2/porting/display.html#monochrome-displays
|
||||||
|
// Skip the palette here.
|
||||||
|
px_map += LVGL_PALETTE_SIZE;
|
||||||
|
|
||||||
|
uint16_t hor_res = lv_display_get_physical_horizontal_resolution(display);
|
||||||
|
int32_t x1 = area->x1;
|
||||||
|
int32_t x2 = area->x2;
|
||||||
|
int32_t y1 = area->y1;
|
||||||
|
int32_t y2 = area->y2;
|
||||||
|
|
||||||
|
|
||||||
|
// As of 03/01/2025 master branch of LVGL contains this helper for the same.
|
||||||
|
// https://docs.lvgl.io/master/API/draw/sw/lv_draw_sw_utils.html
|
||||||
|
// lv_draw_sw_i1_convert_to_vtiled()
|
||||||
|
for (int32_t y = y1; y <= y2; y++) {
|
||||||
|
for (int32_t x = x1; x <= x2; x++) {
|
||||||
|
// Get the byte offset of the pixel coordinates using horizontal-mapping.
|
||||||
|
int h_offset = Pixel::horizontal_byte_offset(x, y, hor_res);
|
||||||
|
// True if the pixel is lit, else false.
|
||||||
|
bool chroma_color = px_map[h_offset] & Pixel::msb_mask(x);
|
||||||
|
|
||||||
|
// We need an additional buffer for transposing the pixel data to the
|
||||||
|
// vertical format required by the display driver.
|
||||||
|
uint8_t *buf = IPanelDevice::get_additional_draw_buffer();
|
||||||
|
// Move to the position in the auxillary buffer where the pixel is stored.
|
||||||
|
buf += Pixel::vertical_byte_offset(x, y, hor_res);
|
||||||
|
|
||||||
|
// Write the single bit to the monochrome display mapped vertically.
|
||||||
|
// Take the Least Significant Bit mask of the Y coordinate to select the
|
||||||
|
// bit representing a pixel at position y in a vertically-mapped display.
|
||||||
|
if (chroma_color) {
|
||||||
|
// Set the vertically-mapped pixel to on.
|
||||||
|
*buf &= ~Pixel::lsb_mask(y);
|
||||||
|
} else {
|
||||||
|
// Set the vertically-mapped pixel to off.
|
||||||
|
*buf |= Pixel::lsb_mask(y);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Pass the draw buffer to the driver.
|
||||||
|
ESP_ERROR_CHECK(
|
||||||
|
esp_lcd_panel_draw_bitmap(panel_handle, x1, y1, x2 + 1, y2 + 1,
|
||||||
|
IPanelDevice::get_additional_draw_buffer()));
|
||||||
|
}
|
||||||
|
|
||||||
|
void IPanelDevice::lvgl_increase_tick_cb(void *)
|
||||||
|
{
|
||||||
|
// Tell LVGL how many milliseconds has elapsed
|
||||||
|
lv_tick_inc(LVGL_TICK_PERIOD_MS);
|
||||||
|
}
|
||||||
|
|
||||||
|
[[noreturn]] void IPanelDevice::lvgl_port_task(void *)
|
||||||
|
{
|
||||||
|
// Optionally initialize some LVGL objects here before entering loop below.
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Starting LVGL task");
|
||||||
|
for (uint32_t time_to_next_ms = 0; true; usleep(1000 * time_to_next_ms)) {
|
||||||
|
// Obtain LVGL API lock before calling any LVGL methods.
|
||||||
|
ScopedLock lock;
|
||||||
|
|
||||||
|
// Optionally handle LVGL input or event logic here.
|
||||||
|
|
||||||
|
// Update LVGL periodic timers.
|
||||||
|
time_to_next_ms = lv_timer_handler();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void IPanelDevice::register_rendering_data(lv_display_t *display_handle,
|
||||||
|
esp_lcd_panel_io_handle_t io_handle)
|
||||||
|
{
|
||||||
|
// Create draw buffer.
|
||||||
|
ESP_LOGI(TAG, "Allocate separate LVGL draw buffers");
|
||||||
|
lv_buf_ = heap_caps_calloc(1, lv_buf_size_,
|
||||||
|
MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
|
||||||
|
assert(lv_buf_);
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Set LVGL draw buffers");
|
||||||
|
// Color format must be set first, LVGL9 suooprt new monochromatic format.
|
||||||
|
lv_display_set_color_format(display_handle, LV_COLOR_FORMAT_I1);
|
||||||
|
lv_display_set_buffers(display_handle, lv_buf_, nullptr,
|
||||||
|
lv_buf_size_,
|
||||||
|
LV_DISPLAY_RENDER_MODE_FULL);
|
||||||
|
lv_display_set_rotation(display_handle, LV_DISPLAY_ROTATION_0);
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Set LVGL callback for flushing to the display");
|
||||||
|
lv_display_set_flush_cb(display_handle, IPanelDevice::lvgl_flush_cb);
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Register io panel callback for LVGL flush ready notification");
|
||||||
|
const esp_lcd_panel_io_callbacks_t cbs = {
|
||||||
|
.on_color_trans_done = IPanelDevice::lvgl_flush_ready_cb,
|
||||||
|
};
|
||||||
|
ESP_ERROR_CHECK(
|
||||||
|
esp_lcd_panel_io_register_event_callbacks(io_handle, &cbs,
|
||||||
|
display_handle));
|
||||||
|
}
|
||||||
|
|
||||||
|
void IPanelDevice::register_lvgl_tick_timer()
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Use esp_timer to increase LVGL tick");
|
||||||
|
const esp_timer_create_args_t esp_timer_args = {
|
||||||
|
.callback = &IPanelDevice::lvgl_increase_tick_cb,
|
||||||
|
// Data to pass to the IPanelDevice::lvgl_port_task callback.
|
||||||
|
.arg = nullptr,
|
||||||
|
.name = "lvgl_tick",
|
||||||
|
};
|
||||||
|
Display::timers_.start_new_timer_periodic(esp_timer_args,
|
||||||
|
LVGL_TICK_PERIOD_MS * 1000);
|
||||||
|
|
||||||
|
// LVGL requires a FreeRTOS task for running it's event loop.
|
||||||
|
// The lvgl_port_task callback can update the UI or handle input logic.
|
||||||
|
// For this basic example we don't do either of these things.
|
||||||
|
ESP_LOGI(TAG, "Create LVGL FreeRTOS task");
|
||||||
|
// Optionally set user data to pass to LVGL's FreeRTOS task callback here.
|
||||||
|
void *user_data = nullptr;
|
||||||
|
xTaskCreate(lvgl_port_task, "LVGL", LVGL_TASK_STACK_SIZE,
|
||||||
|
user_data, LVGL_TASK_PRIORITY, nullptr);
|
||||||
|
}
|
||||||
428
esp/cpp/07_lcd-panel-i2c/main/panel_device.h
Normal file
@@ -0,0 +1,428 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef PANEL_DEVICE_H
|
||||||
|
#define PANEL_DEVICE_H
|
||||||
|
|
||||||
|
#include <esp_lcd_panel_dev.h>
|
||||||
|
#include <esp_lcd_panel_ops.h>
|
||||||
|
#include <esp_lcd_panel_io.h>
|
||||||
|
#include <esp_log.h>
|
||||||
|
|
||||||
|
#include <display/lv_display.h>
|
||||||
|
|
||||||
|
#include "i2c.h"
|
||||||
|
|
||||||
|
// LVGL reserves 2x4 bytes in the buffer to be used as a palette.
|
||||||
|
// This additional space must be added to the IPanelDevice::buf_size_.
|
||||||
|
#define LVGL_PALETTE_SIZE 8
|
||||||
|
#define LVGL_TICK_PERIOD_MS 5
|
||||||
|
#define LVGL_TASK_STACK_SIZE (4 * 1024)
|
||||||
|
#define LVGL_TASK_PRIORITY 2
|
||||||
|
|
||||||
|
#define LCD_H_RES 128
|
||||||
|
#define LCD_V_RES 64
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps some foundational operations performed on pixel coordinates when
|
||||||
|
* dealing with pointer arithmetic. Most of these could be done ad-hoc as needed
|
||||||
|
* but using this helper reduces the risk of errors.
|
||||||
|
*/
|
||||||
|
struct Pixel {
|
||||||
|
/**
|
||||||
|
* Calculate byte offset for the pixel at [x,y] within a horizontally-mapped
|
||||||
|
* monochrome uint8 draw buffer, using the initialized horizontal resolution.
|
||||||
|
*
|
||||||
|
* We use `>> 3` because each pixel requires 1 bit, but each uint8 in the draw
|
||||||
|
* buffer can hold 8 bits. To find the uint8 value in our draw buffer that
|
||||||
|
* stores this pixel's value we must compensate for this when using pixel
|
||||||
|
* coordinates in byte math.
|
||||||
|
*
|
||||||
|
* Therefore, each uint8 in the draw buffer stores the state of 8 pixels.
|
||||||
|
* Below is an example of calculating for [x, y] pixel coordinates [20, 10].
|
||||||
|
*
|
||||||
|
* For the horizontal case, each row (y_) of the image is represented by
|
||||||
|
* `hor_res_ >> 3` bytes (16). The byte-offset of the first pixel in the 10th
|
||||||
|
* row for example is `16 * 10` = 160.
|
||||||
|
*
|
||||||
|
* Since the pixels are stored horizontally we must calculate the 20th pixel
|
||||||
|
* column (x_) as `160 + (20 >> 3)`, or `160 + (20 / 8)` to get a final offset
|
||||||
|
* of 162.
|
||||||
|
*
|
||||||
|
* @param x X pixel coordinate to find byte offset.
|
||||||
|
* @param y Y pixel coordinate to find byte offset.
|
||||||
|
* @return byte offset for a single-byte monochrome pixel at [x,y].
|
||||||
|
*/
|
||||||
|
[[maybe_unused]] [[nodiscard]] static ptrdiff_t
|
||||||
|
horizontal_byte_offset(const int32_t &x, const int32_t &y, const int32_t& hor_res)
|
||||||
|
{
|
||||||
|
// Convert pixel (bit) coordinates to byte coordinates in the draw buffer.
|
||||||
|
return (hor_res >> 3) * y + (x >> 3);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Calculate byte offset for the pixel at [x,y] within a vertically-mapped
|
||||||
|
* monochrome uint8 draw buffer, using the initialized horizontal resolution.
|
||||||
|
*
|
||||||
|
* We use `>> 3` because each pixel requires 1 bit, but each uint8 in the draw
|
||||||
|
* buffer can hold 8 bits. To find the uint8 value in our draw buffer that
|
||||||
|
* stores this pixel's value we must compensate for this when using pixel
|
||||||
|
* coordinates in byte math.
|
||||||
|
*
|
||||||
|
* Therefore, each uint8 in the draw buffer stores the state of 8 pixels.
|
||||||
|
* Below is an example of calculating for [x, y] pixel coordinates [20, 10].
|
||||||
|
*
|
||||||
|
* For the vertical case, each row (y_) of the image is represented by
|
||||||
|
* `hor_res_` bytes (128) - one for each column (x_). Because the pixels are
|
||||||
|
* stored vertically, the byte-offset of the first pixel in the 10th row is
|
||||||
|
* `128 * (10 >> 3)` or * `128 * (10 / 8)` = 128.
|
||||||
|
*
|
||||||
|
* From this location we can simply calculate the 20th pixel column (x_) as
|
||||||
|
* `128 + 20` to get a final offset of 148, because the pixels are stored in a
|
||||||
|
* columnar format.
|
||||||
|
*
|
||||||
|
* @param x X pixel coordinate to find byte offset.
|
||||||
|
* @param y Y pixel coordinate to find byte offset.
|
||||||
|
* @return byte offset for a single-byte monochrome pixel at [x,y].
|
||||||
|
*/
|
||||||
|
[[maybe_unused]] [[nodiscard]] static ptrdiff_t
|
||||||
|
vertical_byte_offset(const int32_t &x, const int32_t &y, const int32_t& hor_res)
|
||||||
|
{
|
||||||
|
// Convert pixel (bit) coordinates to byte coordinates in the draw buffer.
|
||||||
|
return hor_res * (y >> 3) + x;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finds the Most Significant Bit location of bit `i` in a byte.
|
||||||
|
*
|
||||||
|
* MSB LSB
|
||||||
|
* bits 7 6 5 4 3 2 1 0
|
||||||
|
* data 8 7 6 5 4 3 2 1
|
||||||
|
* Left Right
|
||||||
|
*
|
||||||
|
* @return bitmask for MSB location of `i`.
|
||||||
|
*/
|
||||||
|
[[maybe_unused]] [[nodiscard]] static uint8_t
|
||||||
|
msb_mask(const int32_t &i) { return 1 << (7 - i % 8); }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finds the Least Significant Bit location of bit `i` in a byte.
|
||||||
|
*
|
||||||
|
* LSB MSB
|
||||||
|
* bits 0 1 2 3 4 5 6 7
|
||||||
|
* data 1 2 3 4 5 6 7 8
|
||||||
|
* Left Right
|
||||||
|
*
|
||||||
|
* @return bitmask for LSB location of `i`.
|
||||||
|
*/
|
||||||
|
[[maybe_unused]] [[nodiscard]] static uint8_t
|
||||||
|
lsb_mask(const int32_t &i) { return 1 << (i % 8); }
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Encapsulates vendor specific ESP LCD panel initialization logic.
|
||||||
|
* This pure virtual interface can be inherited from for using new LCD devices.
|
||||||
|
* See SSD1306 as an example to implement IPanelDevice for NT35510 or ST7789.
|
||||||
|
*
|
||||||
|
* At this time only I2C is supported.
|
||||||
|
* Classes that inherit from this interface should likely be marked final.
|
||||||
|
*/
|
||||||
|
class IPanelDevice {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* Construct an IPanelDevice.
|
||||||
|
*
|
||||||
|
* @param i2c I2C object. Eventually this will mature to IProtocol or similar.
|
||||||
|
* @param config I2C configuration for this device.
|
||||||
|
* @param height Height of the device screen in pixels.
|
||||||
|
* @param width Width of the device screen in pixels.
|
||||||
|
*/
|
||||||
|
explicit IPanelDevice(I2C &i2c,
|
||||||
|
esp_lcd_panel_io_i2c_config_t config,
|
||||||
|
int width,
|
||||||
|
int height) :
|
||||||
|
IPanelDevice(i2c, config, width, height,
|
||||||
|
width * height / 8 + LVGL_PALETTE_SIZE) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct an IPanelDevice.
|
||||||
|
*
|
||||||
|
* @param i2c I2C object. Eventually this will mature to IProtocol or similar.
|
||||||
|
* @param config I2C configuration for this device.
|
||||||
|
* @param height Height of the device screen in pixels.
|
||||||
|
* @param width Width of the device screen in pixels.
|
||||||
|
* @param draw_buf_size Size of the draw buffer for this device.
|
||||||
|
*/
|
||||||
|
explicit IPanelDevice(I2C &i2c,
|
||||||
|
esp_lcd_panel_io_i2c_config_t io_config,
|
||||||
|
int width,
|
||||||
|
int height,
|
||||||
|
size_t draw_buf_size) :
|
||||||
|
width_(width),
|
||||||
|
height_(height),
|
||||||
|
rst_num_(i2c.rst_num_),
|
||||||
|
lv_buf_size_(draw_buf_size),
|
||||||
|
esp_io_config_(io_config) { }
|
||||||
|
|
||||||
|
virtual ~IPanelDevice() = default;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC METHODS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an LVGL display using the width and height of this device.
|
||||||
|
*
|
||||||
|
* @return Handle to the created LVGL display.
|
||||||
|
*/
|
||||||
|
[[nodiscard]] lv_display_t *create_display() const
|
||||||
|
{
|
||||||
|
auto display = lv_display_create(width_, height_);
|
||||||
|
assert(display);
|
||||||
|
return display;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an ESP LCD panel IO handle.
|
||||||
|
*
|
||||||
|
* @return The created ESP LCD panel IO handle.
|
||||||
|
*/
|
||||||
|
[[nodiscard]] esp_lcd_panel_io_handle_t create_io_handle()
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Creating panel IO handle");
|
||||||
|
esp_lcd_panel_io_handle_t handle = nullptr;
|
||||||
|
ESP_ERROR_CHECK(
|
||||||
|
esp_lcd_new_panel_io_i2c(I2C::get(), &esp_io_config_, &handle));
|
||||||
|
return handle;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create and initialize an ESP panel handle.
|
||||||
|
* IPanelDevice implementors must initialize the panel within init_panel.
|
||||||
|
*
|
||||||
|
* @param config ESP LCD panel configuration.
|
||||||
|
* @param io ESP LCD panel IO handle.
|
||||||
|
* @param [out] panel ESP LCD panel handle output pointer location.
|
||||||
|
*/
|
||||||
|
void create_panel(esp_lcd_panel_dev_config_t &config,
|
||||||
|
esp_lcd_panel_io_handle_t io,
|
||||||
|
esp_lcd_panel_handle_t &panel)
|
||||||
|
{
|
||||||
|
// If the passed handle is already allocated, delete it.
|
||||||
|
if (panel != nullptr) {
|
||||||
|
ESP_LOGI(TAG, "Removing unused panel");
|
||||||
|
esp_lcd_panel_del(panel);
|
||||||
|
}
|
||||||
|
|
||||||
|
ESP_LOGI(TAG, "Installing vendor panel driver");
|
||||||
|
// Call pure virtual method responsible for initializing the panel handle.
|
||||||
|
init_panel(config, io, panel);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Retrieve the device specific vendor configuration structure.
|
||||||
|
*
|
||||||
|
* @return Address of vendor configuration structure.
|
||||||
|
* @sa SSD1306::vendor_config
|
||||||
|
*/
|
||||||
|
virtual void *vendor_config() = 0;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC MEMBERS
|
||||||
|
|
||||||
|
/// Width of the device screen in pixels.
|
||||||
|
int32_t width_;
|
||||||
|
|
||||||
|
/// Height of the device screen in pixels.
|
||||||
|
int32_t height_;
|
||||||
|
|
||||||
|
/// RST GPIO pin number.
|
||||||
|
int rst_num_;
|
||||||
|
|
||||||
|
/// LVGL draw buffer size for the device.
|
||||||
|
size_t lv_buf_size_;
|
||||||
|
|
||||||
|
/// ESP LCD panel IO configuration.
|
||||||
|
esp_lcd_panel_io_i2c_config_t esp_io_config_;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers LVGL draw buffers and callbacks for this display.
|
||||||
|
*
|
||||||
|
* An implementation of the interface can optionally override this method to
|
||||||
|
* provide custom LVGL callbacks and display configurations.
|
||||||
|
*
|
||||||
|
* @param display_handle LVGL display handle to use for rendering.
|
||||||
|
* @param io_handle IO handle for the ESP LCD panel.
|
||||||
|
*/
|
||||||
|
virtual void register_rendering_data(lv_display_t *display_handle,
|
||||||
|
esp_lcd_panel_io_handle_t io_handle);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers LVGL ticker timer callback for rendering this display.
|
||||||
|
*
|
||||||
|
* An implementation of the interface can optionally override this method to
|
||||||
|
* provide custom LVGL callbacks and tick configurations.
|
||||||
|
*/
|
||||||
|
virtual void register_lvgl_tick_timer();
|
||||||
|
|
||||||
|
protected:
|
||||||
|
/**
|
||||||
|
* Static accessor to a static buffer to store draw buffer data for the panel.
|
||||||
|
*
|
||||||
|
* This method is protected to allow an implementation to provide a custom
|
||||||
|
* callback method similar to IPanelDevice::lvgl_flush_cb.
|
||||||
|
*
|
||||||
|
* The buffer is allocated statically within the scope of this function to
|
||||||
|
* allow creating multiple panels that _each_ manage their own statically
|
||||||
|
* allocated draw buffer data. This simplifies implementing the interface by
|
||||||
|
* taking this responsibility off of the implementor. The buffer will only be
|
||||||
|
* allocated if this method is called, so the memory is only used if required.
|
||||||
|
*
|
||||||
|
* @return Pointer to uint8 draw buffer data.
|
||||||
|
* @sa register_rendering_data for overriding LVGL rendering callbacks.
|
||||||
|
*/
|
||||||
|
static uint8_t *get_additional_draw_buffer()
|
||||||
|
{
|
||||||
|
// Static to the scope of this function, not the compilation unit.
|
||||||
|
// For LV_COLOR_FORMAT_I1 we need an extra buffer to hold converted data.
|
||||||
|
static uint8_t oled_buffer[LCD_H_RES * LCD_V_RES / 8];
|
||||||
|
return oled_buffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE METHODS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes the ESP panel using vendor specific APIs and configurations.
|
||||||
|
* This method should implement any setup logic specific to the device.
|
||||||
|
*
|
||||||
|
* @param config ESP LCD panel configuration.
|
||||||
|
* @param io ESP LCD panel IO handle.
|
||||||
|
* @param [out] panel ESP LCD panel handle output pointer location.
|
||||||
|
*/
|
||||||
|
virtual void init_panel(esp_lcd_panel_dev_config_t &config,
|
||||||
|
esp_lcd_panel_io_handle_t io,
|
||||||
|
esp_lcd_panel_handle_t &panel) = 0;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE STATIC METHODS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The callback invoked when panel IO finishes transferring color data.
|
||||||
|
* This signals that the panel is ready to flush image data to the display.
|
||||||
|
*
|
||||||
|
* @param panel LCD panel IO handles.
|
||||||
|
* @param data Panel IO event data, fed by driver.
|
||||||
|
* @param user_ctx User data, passed from `esp_lcd_panel_io_xxx_config_t`.
|
||||||
|
* @return Whether a high priority task has been waken up by this function.
|
||||||
|
* @sa SSD1306::SSD1306 for setting user_ctx data passed to the callback.
|
||||||
|
* @sa register_rendering_data for overriding this callback.
|
||||||
|
*/
|
||||||
|
static bool lvgl_flush_ready_cb(esp_lcd_panel_io_handle_t panel,
|
||||||
|
esp_lcd_panel_io_event_data_t *data,
|
||||||
|
void *user_ctx);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The callback invoked for flushing the rendered image to the display.
|
||||||
|
*
|
||||||
|
* `px_map` contains the rendered image as raw pixel map and it should be
|
||||||
|
* copied to `area` on the display.
|
||||||
|
*
|
||||||
|
* The following details are crucial for understanding the logic surrounding
|
||||||
|
* flushing to the display in this example.
|
||||||
|
*
|
||||||
|
* The order of bits within the px_map from _LVGL_ is MSB first.
|
||||||
|
* MSB LSB
|
||||||
|
* bits 7 6 5 4 3 2 1 0
|
||||||
|
* pixels 0 1 2 3 4 5 6 7
|
||||||
|
* Left Right
|
||||||
|
*
|
||||||
|
* The bytes from _LVGL_ are mapped to pixel rows of the display
|
||||||
|
* 8 bits (pixels) per byte -
|
||||||
|
* [0, 0, 0, 0, 0, 0, 0, 0]
|
||||||
|
* [0, 0, 0, 0, 0, 0, 0, 0]
|
||||||
|
* [0, 0, 0, 0, 0, 0, 0, 0]
|
||||||
|
*
|
||||||
|
* The order of bits expected by the _display driver_ is LSB first.
|
||||||
|
* We must preserve pairing of each bit and pixel when writing to the display.
|
||||||
|
* LSB MSB
|
||||||
|
* bits 0 1 2 3 4 5 6 7
|
||||||
|
* pixels 7 6 5 4 3 2 1 0
|
||||||
|
* Left Right
|
||||||
|
*
|
||||||
|
* Bytes expected by the _display driver_ map to pixel columns of the display.
|
||||||
|
* 8 bits (pixels) per byte -
|
||||||
|
* [0, [0, [0, [0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0, 0, 0, 0,
|
||||||
|
* 0] 0] 0] 0]
|
||||||
|
*
|
||||||
|
* These layouts in memory have no opinion on the shape of the image. The
|
||||||
|
* beginning and end of a row or a column for example is entirely dependent
|
||||||
|
* on how the data is accessed. The vertical and horitzontal resolution may
|
||||||
|
* vary between displays.
|
||||||
|
*
|
||||||
|
* For the LV_COLOR_FORMAT_I1 color format we are using, an additional buffer
|
||||||
|
* is needed for transposing the bits to the vertical arrangement required by
|
||||||
|
* the display driver that is outlined above.
|
||||||
|
*
|
||||||
|
* This callback implementation is an example of handling this transposition
|
||||||
|
* and flushing the data to the display in the expected format.
|
||||||
|
*
|
||||||
|
* @param display LVGL display handle to use for rendering.
|
||||||
|
* @param area Area of the display being flushed.
|
||||||
|
* @param px_map Rendered image data for writing to the display area.
|
||||||
|
* @sa register_rendering_data for overriding this callback.
|
||||||
|
* @sa get_additional_draw_buffer
|
||||||
|
*/
|
||||||
|
static void lvgl_flush_cb(lv_display_t *display,
|
||||||
|
const lv_area_t *area,
|
||||||
|
uint8_t *px_map);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback invoked for every period of the timer.
|
||||||
|
*
|
||||||
|
* This callback _must_ call lv_tick_inc to inform LVGL how much time has
|
||||||
|
* elapsed since the last period of the timer.
|
||||||
|
*
|
||||||
|
* @param data User data passed to the callback.
|
||||||
|
* @sa register_lvgl_tick_timer for setting user data and the tick period of
|
||||||
|
* the timer, or overriding this callback entirely.
|
||||||
|
*/
|
||||||
|
static void lvgl_increase_tick_cb(void *data);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* FreeRTOS task callback invoked for handling LVGL events or updating the UI.
|
||||||
|
*
|
||||||
|
* This function is intentionally an endless loop and should never return.
|
||||||
|
* LVGL initialization logic can optionally be added before entering the loop.
|
||||||
|
* Input logic can optionally be handled within the loop.
|
||||||
|
*
|
||||||
|
* This callback _must_ call lv_timer_handler to handle LVGL periodic timers.
|
||||||
|
*
|
||||||
|
* @param data User data passed to the callback.
|
||||||
|
* @sa register_lvgl_tick_timer for overriding this callback.
|
||||||
|
*/
|
||||||
|
[[noreturn]] static void lvgl_port_task(void *data);
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// LVGL draw buffer associated with this Display's lv_display_t.
|
||||||
|
void *lv_buf_;
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "IPanelDevice";
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // PANEL_DEVICE_H
|
||||||
12
esp/cpp/07_lcd-panel-i2c/main/scoped_lock.cpp
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#include "scoped_lock.h"
|
||||||
|
|
||||||
|
// LVGL library is not thread-safe, this example calls LVGL APIs from tasks.
|
||||||
|
// We must use a mutex to protect it.
|
||||||
|
_lock_t ScopedLock::lv_lock_;
|
||||||
28
esp/cpp/07_lcd-panel-i2c/main/scoped_lock.h
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef SCOPED_LOCK_H
|
||||||
|
#define SCOPED_LOCK_H
|
||||||
|
|
||||||
|
#include <mutex>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Obtains LVGL API mutex lock for the duration of local scope.
|
||||||
|
*
|
||||||
|
* LVGL library is not thread-safe, this lock should be held when making calls
|
||||||
|
* to the LVGL API, and released as soon as possible when finished.
|
||||||
|
*/
|
||||||
|
struct ScopedLock {
|
||||||
|
explicit ScopedLock() { _lock_acquire(&lv_lock_); }
|
||||||
|
|
||||||
|
~ScopedLock() { _lock_release(&lv_lock_); }
|
||||||
|
|
||||||
|
/// Mutex used to protect LVGL API calls.
|
||||||
|
static _lock_t lv_lock_;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SCOPED_LOCK_H
|
||||||
106
esp/cpp/07_lcd-panel-i2c/main/ssd1306.h
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef SSD1306_H
|
||||||
|
#define SSD1306_H
|
||||||
|
|
||||||
|
#include <esp_lcd_panel_ssd1306.h>
|
||||||
|
|
||||||
|
#include "panel_device.h"
|
||||||
|
|
||||||
|
// According to specific display hardware.
|
||||||
|
// https://www.digikey.com/en/products/detail/winstar-display/WEA012864DWPP3N00003/20533255
|
||||||
|
#define SCREEN_WIDTH 128 // OLED display width, in pixels.
|
||||||
|
#define SCREEN_HEIGHT 64 // OLED display height, in pixels.
|
||||||
|
|
||||||
|
// According to SSD1306 datasheet.
|
||||||
|
// https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf
|
||||||
|
#define I2C_HW_ADDR 0x3C
|
||||||
|
#define LCD_PIXEL_CLOCK_HZ (400 * 1000)
|
||||||
|
// Bit number used to represent command and parameter
|
||||||
|
#define LCD_CMD_BITS 8
|
||||||
|
#define LCD_PARAM_BITS 8
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Example of implementing the IPanelDevice interface for SSD1306 LCD device.
|
||||||
|
*/
|
||||||
|
class SSD1306 final : public IPanelDevice {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* Construct a new SSD1306 device.
|
||||||
|
*
|
||||||
|
* @param i2c I2C master bus to manage this device.
|
||||||
|
*/
|
||||||
|
explicit SSD1306(I2C &i2c) :
|
||||||
|
SSD1306(i2c, {.height = SCREEN_HEIGHT}) { }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Construct a new SSD1306 device given a specific SSD1306 configuration.
|
||||||
|
*
|
||||||
|
* @param i2c I2C master bus to manage this device.
|
||||||
|
* @param config SSD1306 vendor configuration.
|
||||||
|
* @param width Width of the device screen in pixels.
|
||||||
|
* @param height Height of the device screen in pixels.
|
||||||
|
*/
|
||||||
|
SSD1306(I2C &i2c,
|
||||||
|
esp_lcd_panel_ssd1306_config_t config,
|
||||||
|
int width = SCREEN_WIDTH,
|
||||||
|
int height = SCREEN_HEIGHT
|
||||||
|
) :
|
||||||
|
IPanelDevice(i2c,
|
||||||
|
(esp_lcd_panel_io_i2c_config_t) {
|
||||||
|
.dev_addr = I2C_HW_ADDR,
|
||||||
|
// User data to pass to the LVGL flush_ready callback.
|
||||||
|
// See IPanelDevice::lvgl_flush_ready_cb
|
||||||
|
.user_ctx = nullptr,
|
||||||
|
.control_phase_bytes = 1,
|
||||||
|
.dc_bit_offset = 6,
|
||||||
|
.lcd_cmd_bits = LCD_CMD_BITS,
|
||||||
|
.lcd_param_bits = LCD_PARAM_BITS,
|
||||||
|
.scl_speed_hz = LCD_PIXEL_CLOCK_HZ,
|
||||||
|
},
|
||||||
|
width,
|
||||||
|
height
|
||||||
|
),
|
||||||
|
ssd1306_config_(config) { }
|
||||||
|
|
||||||
|
~SSD1306() final = default;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC METHODS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Provides the SSD1306 vendor configuration to IPanelDevice consumers.
|
||||||
|
*
|
||||||
|
* @return Address of the SSD1306 vendor configuration structure.
|
||||||
|
*/
|
||||||
|
void *vendor_config() override
|
||||||
|
{
|
||||||
|
return &ssd1306_config_;
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC MEMBERS
|
||||||
|
|
||||||
|
/// SSD1306 configuration structure.
|
||||||
|
esp_lcd_panel_ssd1306_config_t ssd1306_config_;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE METHODS
|
||||||
|
|
||||||
|
/// Initializes the ESP LCD panel handle for the SSD1306 device.
|
||||||
|
void init_panel(esp_lcd_panel_dev_config_t &config,
|
||||||
|
esp_lcd_panel_io_handle_t io,
|
||||||
|
esp_lcd_panel_handle_t &panel) override
|
||||||
|
{
|
||||||
|
ESP_ERROR_CHECK(esp_lcd_new_panel_ssd1306(io, &config, &panel));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // SSD1306_H
|
||||||
161
esp/cpp/07_lcd-panel-i2c/main/time_keeper.h
Normal file
@@ -0,0 +1,161 @@
|
|||||||
|
/*#############################################################################
|
||||||
|
## Author: Shaun Reed ##
|
||||||
|
## Legal: All Content (c) 2025 Shaun Reed, all rights reserved ##
|
||||||
|
## ##
|
||||||
|
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com ##
|
||||||
|
##############################################################################
|
||||||
|
*/
|
||||||
|
#ifndef TIME_KEEPER_H
|
||||||
|
#define TIME_KEEPER_H
|
||||||
|
|
||||||
|
#include <esp_log.h>
|
||||||
|
#include <esp_timer.h>
|
||||||
|
|
||||||
|
#include "i2c.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stores arguments and ESP timer handle for a Timer.
|
||||||
|
* In general Timers should be used via the TimeKeeper interface only.
|
||||||
|
*
|
||||||
|
* Timers cannot be copied, and are only created by a TimeKeeper instance.
|
||||||
|
* The TimeKeeper can delete existing Timers, calling it's destructor.
|
||||||
|
* The ESP timer will be deleted when this class desctructor is called.
|
||||||
|
*/
|
||||||
|
struct Timer {
|
||||||
|
explicit Timer(esp_timer_create_args_t args) :
|
||||||
|
args_(args), esp_timer_(nullptr)
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Creating esp_timer with name: '%s'", args_.name);
|
||||||
|
ESP_ERROR_CHECK(esp_timer_create(&args, &esp_timer_));
|
||||||
|
}
|
||||||
|
|
||||||
|
~Timer()
|
||||||
|
{
|
||||||
|
ESP_LOGI(TAG, "Destroying esp_timer with name: '%s'", args_.name);
|
||||||
|
ESP_ERROR_CHECK(esp_timer_delete(esp_timer_));
|
||||||
|
}
|
||||||
|
|
||||||
|
Timer(const Timer &) = delete;
|
||||||
|
|
||||||
|
Timer(Timer &) = delete;
|
||||||
|
|
||||||
|
Timer &operator=(Timer &) = delete;
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC MEMBERS
|
||||||
|
|
||||||
|
/// Arguments passed to ESP API during timer creation.
|
||||||
|
esp_timer_create_args_t args_;
|
||||||
|
|
||||||
|
/// ESP timer handle.
|
||||||
|
esp_timer_handle_t esp_timer_;
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "Timer";
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* ESP timer mananger class.
|
||||||
|
*
|
||||||
|
* Timers should only be accessed using the get_handle method.
|
||||||
|
* If the Timer destructor is called the underlying ESP timer will be deleted.
|
||||||
|
*/
|
||||||
|
struct TimeKeeper {
|
||||||
|
/// Timer handle type used for referring to Timers.
|
||||||
|
using TimerHandle = Timer *;
|
||||||
|
|
||||||
|
//
|
||||||
|
// GETTERS
|
||||||
|
|
||||||
|
TimerHandle get_handle(const char *name)
|
||||||
|
{
|
||||||
|
return &managed_timers_.at(name);
|
||||||
|
}
|
||||||
|
|
||||||
|
TimerHandle operator[](const char *name) { return get_handle(name); }
|
||||||
|
|
||||||
|
//
|
||||||
|
// PUBLIC METHODS
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new managed Timer with the provided ESP arguments.
|
||||||
|
* The timer can be retrieved later using the args.name field value.
|
||||||
|
*
|
||||||
|
* @param args ESP timer creation arguments.
|
||||||
|
* @return TimerHandle Handle to a Timer managed by this TimeKeeper.
|
||||||
|
* @sa get_handle
|
||||||
|
* @sa operator[](const char*)
|
||||||
|
*/
|
||||||
|
[[maybe_unused]] TimerHandle create_timer(esp_timer_create_args_t args)
|
||||||
|
{
|
||||||
|
auto rt = managed_timers_.emplace(args.name, args);
|
||||||
|
if (!rt.second) {
|
||||||
|
ESP_LOGE(TAG, "Timer already exists with name '%s'", args.name);
|
||||||
|
return nullptr;
|
||||||
|
}
|
||||||
|
return &rt.first->second;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop a Timer with the given name.
|
||||||
|
[[maybe_unused]] void stop_timer(const char *name)
|
||||||
|
{
|
||||||
|
ESP_ERROR_CHECK(esp_timer_stop(get_handle(name)->esp_timer_));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Delete a Timer with the given name.
|
||||||
|
[[maybe_unused]] void delete_timer(const char *name)
|
||||||
|
{
|
||||||
|
if (managed_timers_.erase(name) == 0) {
|
||||||
|
ESP_LOGE(TAG, "Attempt to delete timer that does not exist: '%s'", name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a Timer with the ESP args and call esp_timer_start_periodic.
|
||||||
|
[[maybe_unused]] void
|
||||||
|
start_new_timer_periodic(esp_timer_create_args_t args,
|
||||||
|
uint64_t period)
|
||||||
|
{
|
||||||
|
start_timer_periodic(create_timer(args)->args_.name, period);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Calls esp_timer_start_periodic on the Timer with the given name.
|
||||||
|
[[maybe_unused]] void start_timer_periodic(const char *name,
|
||||||
|
uint64_t period)
|
||||||
|
{
|
||||||
|
ESP_ERROR_CHECK(
|
||||||
|
esp_timer_start_periodic(get_handle(name)->esp_timer_, period));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create a Timer with the ESP args and call esp_timer_start_once.
|
||||||
|
[[maybe_unused]] void start_new_timer_once(esp_timer_create_args_t args,
|
||||||
|
uint64_t timeout_us)
|
||||||
|
{
|
||||||
|
start_timer_once(create_timer(args)->args_.name, timeout_us);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Calls esp_timer_start_once on the Timer with the given name.
|
||||||
|
[[maybe_unused]] void start_timer_once(const char *name,
|
||||||
|
uint64_t timeout_us)
|
||||||
|
{
|
||||||
|
ESP_ERROR_CHECK(
|
||||||
|
esp_timer_start_once(get_handle(name)->esp_timer_, timeout_us));
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
|
||||||
|
//
|
||||||
|
// PRIVATE MEMBERS
|
||||||
|
|
||||||
|
/// Existing ESP timers created for this TimeKeeper instance.
|
||||||
|
std::unordered_map<const char *, Timer> managed_timers_;
|
||||||
|
|
||||||
|
/// Tag used for ESP logging.
|
||||||
|
constexpr static const char *TAG = "TimeKeeper";
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif // TIME_KEEPER_H
|
||||||
BIN
esp/cpp/07_lcd-panel-i2c/schematic.png
Normal file
|
After Width: | Height: | Size: 227 KiB |
2791
esp/cpp/07_lcd-panel-i2c/sdkconfig
Normal file
BIN
esp/cpp/ESP32-basic-starter-kit.pdf
Normal file
BIN
esp/cpp/ESP32-dev-module.png
Normal file
|
After Width: | Height: | Size: 66 KiB |
22
esp/cpp/README.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
# esp
|
||||||
|
|
||||||
|
```bash
|
||||||
|
shaunrd0/klips/esp/
|
||||||
|
├── 01_led-button # Simple LED circuit controlled by an on board button.
|
||||||
|
├── 02_led-button-web # LED controlled by a button or within a web browser.
|
||||||
|
├── 03_temp-humidity-web # Temperature and humidity sensor within a web browser.
|
||||||
|
├── 04_esp-idf-arduino # CMake example instead of Arduino IDE for ESP development.
|
||||||
|
├── 05_temp-humidity-web # Temperature and humidity sensor within a web browser.
|
||||||
|
├── 06_i2c-scanner # Simple I2C device scanner.
|
||||||
|
├── 07_lcd-panel-i2c # Drawing to a LCD display with LVGL over I2C.
|
||||||
|
├── ESP32-basic-starter-kit.pdf # PDF for tutorials in ESP32 starter kit.
|
||||||
|
├── ESP32-dev-module.png
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Examples 1-3 are built using the Arduino IDE.
|
||||||
|
|
||||||
|
All examples after `04_esp-idf-arduino` are built with cmake and the [ESP-IDF](https://github.com/espressif/esp-idf).
|
||||||
|
|
||||||
|
[Arduino ESP32 GitHub](https://github.com/espressif/arduino-esp32) \
|
||||||
|
[Arduino ESP32 API reference](https://docs.espressif.com/projects/arduino-esp32/en/latest/libraries.html)
|
||||||
@@ -1,9 +1,9 @@
|
|||||||
# Javascript
|
# javascript
|
||||||
|
|
||||||
This directory contains Javascript projects and examples that I've made.
|
This directory contains Javascript projects and examples that I've made.
|
||||||
|
|
||||||
```
|
```bash
|
||||||
github.com/shaunrd0/klips/javascript
|
shaunrd0/klips/javascript
|
||||||
├── webgl # Examples of using WebGL within JS
|
├── webgl # Examples of using WebGL within JS
|
||||||
└── README.md
|
└── README.md
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,12 +1,13 @@
|
|||||||
|
# python
|
||||||
|
|
||||||
This directory contains a collection of Python scripts or CLI tools that I've made.
|
This directory contains a collection of Python scripts or CLI tools that I've made.
|
||||||
Each of these projects provide a `requirements.txt` that can be used to
|
Each of these projects provide a `requirements.txt` that can be used to
|
||||||
install the required Python packages and dependencies.
|
install the required Python packages and dependencies.
|
||||||
|
|
||||||
To install Python 3.9 and `pip`
|
To install Python 3.9 and `pip`
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo apt install python3.9 python3-pip
|
sudo apt install python3.9 python3-pip
|
||||||
python3.9 -m pip install -U pip
|
python3.9 -m pip install -U pip
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||