Merge branch 'develop/v2.0' into 'master'

update to version 2.0 with new structure

See merge request rd/esp-iot-solution!478

Author: zhanzhaocheng

.gitignore

@@ -7,6 +7,11 @@ build/
 *.old
 *.cproject
 
+# gtags
+GTAGS
+GRTAGS
+GPATH
+
 # vscode setting
 .vscode/
 
@@ -17,13 +22,13 @@ build/
 .DS_Store
 
 # Doc build artifacts
-docs/*/_build/
-docs/*/doxygen-warning-log.txt
-docs/*/sphinx-warning-log.txt
-docs/*/sphinx-warning-log-sanitized.txt
-docs/*/xml/
-docs/*/xml_in/
-docs/*/man/
+docs/**/_build/
+docs/**/doxygen-warning-log.txt
+docs/**/sphinx-warning-log.txt
+docs/**/sphinx-warning-log-sanitized.txt
+docs/**/xml/
+docs/**/xml_in/
+docs/**/man/
 docs/doxygen_sqlite3.db
 
 # Example project files

.gitlab-ci.yml

@@ -2,72 +2,89 @@ stages:
   - build
   - deploy
 
+variables:
+  IOT_SOLUTION_PATH: "$CI_PROJECT_DIR"
+
 before_script:
-  - export PATH="/opt/xtensa-esp32-elf/bin:$PATH"
-  - export PATH="/opt/esp32ulp-elf-binutils/bin:$PATH"
-  - export PATH="$CI_PROJECT_DIR/submodule/esp-idf/tools:$PATH"
+  # add gitlab ssh key
   - mkdir -p ~/.ssh
   - chmod 700 ~/.ssh
   - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
   - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
   - chmod 600 ~/.ssh/id_rsa
   - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
-  - git submodule update -f --init --recursive
+  - git --version
+  - git submodule update --init --recursive
 
-variables:
-  IDF_PATH: "$CI_PROJECT_DIR/submodule/esp-idf"
-  IOT_SOLUTION_PATH: "$CI_PROJECT_DIR"
+.build_template: &build_template
+  stage: build
+  image: espressif/idf:release-v4.3
+  tags:
+    - build
+  variables:
+    BATCH_BUILD: "1"
+    V: "0"
+
+.build_examples_template: &build_examples_template
+  <<: *build_template
+  artifacts:
+    when: always
+    paths:
+      - $BUILD_PATH/*/*/build/*.bin
+      - $BUILD_PATH/*/*/build/*.elf
+      - $BUILD_PATH/*/*/build/*.map
+      - $BUILD_PATH/*/*/build/download.config
+      - $BUILD_PATH/*/*/build/bootloader/*.bin
+      - $LOG_PATH
+    expire_in: 1 week
+  variables:
+    IDF_CI_BUILD: "1"
+    LOG_PATH: "$CI_PROJECT_DIR/log_examples"
+    BUILD_PATH: "$CI_PROJECT_DIR/build_examples"
+  script:
+    # it's not possible to build 100% out-of-tree and have the "artifacts"
+    # mechanism work, but this is the next best thing
+    - rm -rf ${BUILD_PATH}
+    - mkdir ${BUILD_PATH}
+    - mkdir -p ${LOG_PATH}
+    # build some of examples
+    - ${IOT_SOLUTION_PATH}/tools/ci/build_examples.sh "${CI_JOB_NAME}"
+
+build_examples_00:
+  <<: *build_examples_template
 
-build:
+build_docs:
   stage: build
+  image: $CI_DOCKER_REGISTRY/esp-idf-doc-env:v7
   tags:
-    - iot
-  image: $CI_DOCKER_REGISTRY/esp32-ci-env
+    - build_docs
+  artifacts:
+    when: always
+    paths:
+      # English version of documentation
+      - docs/en/doxygen-warning-log.txt
+      - docs/en/sphinx-warning-log.txt
+      - docs/en/sphinx-warning-log-sanitized.txt
+      - docs/en/_build/html
+      # Chinese version of documentation
+      - docs/zh_CN/doxygen-warning-log.txt
+      - docs/zh_CN/sphinx-warning-log.txt
+      - docs/zh_CN/sphinx-warning-log-sanitized.txt
+      - docs/zh_CN/_build/html
+    expire_in: 1 mos
   script:
-    - cd examples/check_pedestrian_flow
-    - make defconfig
-    - idf.py build
-    - cd ../eth2wifi
-    - make defconfig
-    - idf.py build
-    - cd ../oled_screen_module
-    - make defconfig
-    - idf.py build
-    - cd ../smart_device/alink_smart_device_demo
-    - make defconfig
-    - idf.py build
-    - cd ..
-    - cd ../empty_project
-    - make defconfig
-    - idf.py build
-    - cd ../hmi/ugfx_example
-    - make defconfig
-    - idf.py build
-    - cd ../lvgl_example
-    - make defconfig
-    - idf.py build
-    - cd ../
-    - cd ../touch_pad_evb
-    - make defconfig
-    - idf.py build
-    - cd ../ulp_examples/ulp_watering_device
-    - make defconfig
-    - make -j8
-    - cd ../ulp_rtc_gpio
-    - make defconfig
-    - make -j8
-    - cd ../ulp_tsens
-    - make defconfig
-    - make -j8
-    - cd ../ulp_spi
-    - make defconfig
-    - make -j8
-    - cd ../ulp_hall_sensor
-    - make defconfig
-    - make -j8
-    - cd ../../../tools/unit-test-app
-    - make defconfig
-    - make IOT_TEST_ALL=1 -j8
+    - source /opt/pyenv/activate && pyenv global 3.6.10
+    - /opt/pyenv/pyenv-1.2.16/versions/3.6.10/bin/python -m pip install --user -r docs/requirements.txt
+    - cd docs
+    - ./check_lang_folder_sync.sh
+    - cd en
+    - make gh-linkcheck
+    - make html
+    - ../check_doc_warnings.sh
+    - cd ../zh_CN
+    - make gh-linkcheck
+    - make html
+    - ../check_doc_warnings.sh
 
 push_to_github:
   stage: deploy

.gitmodules

@@ -1,18 +1,6 @@
-[submodule "submodule/esp-idf"]
-	path = submodule/esp-idf
-	url = https://github.com/espressif/esp-idf.git
-[submodule "components/network/mqtt/espmqtt"]
-	path = components/network/mqtt/espmqtt
-	url = https://github.com/tuanpmt/espmqtt.git
-[submodule "components/platforms/alink/esp32-alink"]
-	path = components/platforms/alink/esp32-alink
-	url = https://github.com/espressif/esp32-alink.git
-[submodule "Adafruit-GFX-Library"]
-	path = components/spi_devices/lcd/Adafruit-GFX-Library
-	url = https://github.com/adafruit/Adafruit-GFX-Library.git
-[submodule "components/hmi/ugfx_gui/ugfx"]
-	path = components/hmi/ugfx_gui/ugfx
-	url = http://git.ugfx.io/ugfx/ugfx.git
-[submodule "components/hmi/lvgl_gui/lvgl"]
-	path = components/hmi/lvgl_gui/lvgl
-	url = https://github.com/littlevgl/lvgl.git
+[submodule "components/gui/lvgl_gui/lvgl"]
+	path = components/gui/lvgl_gui/lvgl
+	url = https://github.com/lvgl/lvgl.git
+[submodule "examples/hmi/lvgl_example/components/lv_examples/lv_examples"]
+	path = examples/hmi/lvgl_example/components/lv_examples/lv_examples
+	url = https://github.com/littlevgl/lv_examples.git

.readthedocs.yml

@@ -0,0 +1,17 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - htmlzip
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements.txt

CMakeLists.txt

@@ -0,0 +1,51 @@
+Contributions Guide
+========================
+
+We welcome contributions to the esp-iot-solution project!
+
+How to Contribute
+--------------------
+
+Contributions to esp-iot-solution - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/articles/about-pull-requests>`_.
+
+Before Contributing
+----------------------
+
+Before sending us a Pull Request, please consider this list of points:
+
+* Is the contribution entirely your own work, or already licensed under an Apache License 2.0 compatible Open Source License? If not then we unfortunately cannot accept it.
+
+* Does any new code conform to the esp-idf : :doc:`Style Guide <style-guide>` ?
+
+* Does the code documentation follow requirements in `Documenting-code <http://docs.espressif.com/projects/esp-idf/en/stable/contribute/documenting-code.html>`_ ?
+
+* Is the code adequately commented for people to understand how it is structured?
+
+* Are comments and documentation written in clear English, with no spelling or grammar errors?
+
+* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" `squashed into previous commits <http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit>`_?
+
+* If you're unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
+
+Pull Request Process
+-----------------------
+
+After you open the Pull Request, there will probably be some discussion in the comments field of the request itself.
+
+Once the Pull Request is ready to merge, it will first be merged into our internal git system for in-house automated testing.
+
+If this process passes, it will be merged onto the public github repository.
+
+Legal Part
+------------
+
+Before a contribution can be accepted, you will need to sign our `contributor-agreement <http://docs.espressif.com/projects/esp-idf/en/stable/contribute/contributor-agreement.html>`_. You will be prompted for this automatically as part of the Pull Request process.
+
+Related Documents
+-----------------
+
+.. toctree::
+    :maxdepth: 1
+
+    style-guide
+