wn/esp8266boilerplate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

edit readme

Browse Source
This commit is contained in:
Wolfgang Hottgenroth
2019-04-25 17:08:06 +02:00
parent 7289d581a8
commit 063dbcf809
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
readme.md
View File

@@ -1,28 +1,30 @@
readme.md ==== Usage of the esp8266boilerplate project in your own Arduino ESP8266 projects ====
Created on: Apr 25, 2019
Author: Wolfgang Hottgenroth <woho@hottis.de> Wolfgang Hottgenroth <woho@hottis.de>
* Create an Arduino ESP8266 project in Sloeber * Create an Arduino ESP8266 project in Sloeber
* Add esp8266boilerplate as submodule to your project: * Add esp8266boilerplate as submodule to your project:
git submodule init git submodule init
git submodule add git@gitlab.com:wolutator/esp8266boilerplate.git git submodule add git@gitlab.com:wolutator/esp8266boilerplate.git
* Copy ConfigGenerator/ConfigDataStructure.py-example into your project directory,
rename it to ConfigDataStructure.py * Copy `ConfigGenerator/ConfigDataStructure.py-example` into your project directory,
* Edit ConfigDataStructure.py according to your requirements rename it to `ConfigDataStructure.py`
* Edit `ConfigDataStructure.py` according to your requirements
* Change into directory ConfigGenerator and run configGen.sh, * Change into directory ConfigGenerator and run configGen.sh,
it generates the configuration code for your projects into your it generates the configuration code for your projects into your
project directory (files configuration.cpp and configuration.h, do not edit project directory (files configuration.cpp and configuration.h, do not edit
these files) these files)
* Copy defines.h-example into your project directory and edit it * Copy `defines.h-example` into your project directory and edit it
according to your requirements according to your requirements
* In to main cpp file of your project you have the functions setup() and loop(). * In to main cpp file of your project you have the functions `setup()` and `loop()`.
Edit this file and call mainSetup() from the setup() function and mainLoop() from Edit this file and call `mainSetup()` from the `setup()` function and `mainLoop()` from
the loop() function. Do not change anything else in this file. the `loop()` function. Do not change anything else in this file.
* Add the directory esp8266boilerplate as an include and a source location in the * Add the directory `esp8266boilerplate` as an include and a source location in the
properties of your project. properties of your project.
* Create all the code you need for you application. Call your own main setup function * Create all the code you need for you application. Call your own main setup function
setupApplication() and your own main loop function loopApplication(). These functions `setupApplication()` and your own main loop function `loopApplication()`. These functions
will be called via mainSetup and mainLoop when the system is running in production will be called via mainSetup and mainLoop when the system is running in production
(in contrast to configuration) mode. (in contrast to configuration) mode.