Merge pull request #1 from m5stack/dev

Add source code

Author: Forairaaaaa

.clang-format

@@ -1,4 +1,3 @@
-Language:        C
 BasedOnStyle:  Google
 AccessModifierOffset: -4
 AlignAfterOpenBracket: Align
@@ -163,172 +162,3 @@ StatementMacros:
 TabWidth:        4
 UseCRLF:         false
 UseTab:          Never
-...
-
----
-Language:        Cpp
-BasedOnStyle:  Google
-AccessModifierOffset: -4
-AlignAfterOpenBracket: Align
-AlignConsecutiveMacros: true
-AlignConsecutiveAssignments: true
-AlignConsecutiveDeclarations: false
-AlignEscapedNewlines: Left
-AlignOperands:   true
-AlignTrailingComments: true
-AllowAllArgumentsOnNextLine: true
-AllowAllConstructorInitializersOnNextLine: true
-AllowAllParametersOfDeclarationOnNextLine: true
-AllowShortBlocksOnASingleLine: Never
-AllowShortCaseLabelsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: false
-AllowShortLambdasOnASingleLine: All
-AllowShortIfStatementsOnASingleLine: WithoutElse
-AllowShortLoopsOnASingleLine: true
-AlwaysBreakAfterDefinitionReturnType: None
-AlwaysBreakAfterReturnType: None
-AlwaysBreakBeforeMultilineStrings: true
-AlwaysBreakTemplateDeclarations: Yes
-BinPackArguments: true
-BinPackParameters: true
-BraceWrapping:
-  AfterCaseLabel:  false
-  AfterClass:      false
-  AfterControlStatement: false
-  AfterEnum:       false
-  AfterFunction:   true
-  AfterNamespace:  false
-  AfterObjCDeclaration: false
-  AfterStruct:     false
-  AfterUnion:      false
-  AfterExternBlock: false
-  BeforeCatch:     false
-  BeforeElse:      false
-  IndentBraces:    false
-  SplitEmptyFunction: true
-  SplitEmptyRecord: true
-  SplitEmptyNamespace: true
-BreakBeforeBinaryOperators: None
-BreakBeforeBraces: Custom
-BreakBeforeInheritanceComma: false
-BreakInheritanceList: BeforeColon
-BreakBeforeTernaryOperators: true
-BreakConstructorInitializersBeforeComma: false
-BreakConstructorInitializers: BeforeColon
-BreakAfterJavaFieldAnnotations: false
-BreakStringLiterals: true
-ColumnLimit:     120
-CommentPragmas:  '^ IWYU pragma:'
-CompactNamespaces: false
-ConstructorInitializerAllOnOneLineOrOnePerLine: true
-ConstructorInitializerIndentWidth: 4
-ContinuationIndentWidth: 4
-Cpp11BracedListStyle: true
-DeriveLineEnding: true
-DerivePointerAlignment: true
-DisableFormat:   false
-ExperimentalAutoDetectBinPacking: false
-FixNamespaceComments: true
-ForEachMacros:
-  - foreach
-  - Q_FOREACH
-  - BOOST_FOREACH
-IncludeBlocks:   Regroup
-IncludeCategories:
-  - Regex:           '^<ext/.*\.h>'
-    Priority:        2
-    SortPriority:    0
-  - Regex:           '^<.*\.h>'
-    Priority:        1
-    SortPriority:    0
-  - Regex:           '^<.*'
-    Priority:        2
-    SortPriority:    0
-  - Regex:           '.*'
-    Priority:        3
-    SortPriority:    0
-IncludeIsMainRegex: '([-_](test|unittest))?$'
-IncludeIsMainSourceRegex: ''
-IndentCaseLabels: true
-IndentGotoLabels: true
-IndentPPDirectives: None
-IndentWidth:     4
-IndentWrappedFunctionNames: false
-JavaScriptQuotes: Leave
-JavaScriptWrapImports: true
-KeepEmptyLinesAtTheStartOfBlocks: false
-MacroBlockBegin: ''
-MacroBlockEnd:   ''
-MaxEmptyLinesToKeep: 1
-NamespaceIndentation: None
-ObjCBinPackProtocolList: Never
-ObjCBlockIndentWidth: 2
-ObjCSpaceAfterProperty: false
-ObjCSpaceBeforeProtocolList: true
-PenaltyBreakAssignment: 2
-PenaltyBreakBeforeFirstCallParameter: 1
-PenaltyBreakComment: 300
-PenaltyBreakFirstLessLess: 120
-PenaltyBreakString: 1000
-PenaltyBreakTemplateDeclaration: 10
-PenaltyExcessCharacter: 1000000
-PenaltyReturnTypeOnItsOwnLine: 200
-PointerAlignment: Left
-RawStringFormats:
-  - Language:        Cpp
-    Delimiters:
-      - cc
-      - CC
-      - cpp
-      - Cpp
-      - CPP
-      - 'c++'
-      - 'C++'
-    CanonicalDelimiter: ''
-    BasedOnStyle:    google
-  - Language:        TextProto
-    Delimiters:
-      - pb
-      - PB
-      - proto
-      - PROTO
-    EnclosingFunctions:
-      - EqualsProto
-      - EquivToProto
-      - PARSE_PARTIAL_TEXT_PROTO
-      - PARSE_TEST_PROTO
-      - PARSE_TEXT_PROTO
-      - ParseTextOrDie
-      - ParseTextProtoOrDie
-    CanonicalDelimiter: ''
-    BasedOnStyle:    google
-ReflowComments:  true
-SortIncludes:    false
-SortUsingDeclarations: true
-SpaceAfterCStyleCast: false
-SpaceAfterLogicalNot: false
-SpaceAfterTemplateKeyword: true
-SpaceBeforeAssignmentOperators: true
-SpaceBeforeCpp11BracedList: false
-SpaceBeforeCtorInitializerColon: true
-SpaceBeforeInheritanceColon: true
-SpaceBeforeParens: ControlStatements
-SpaceBeforeRangeBasedForLoopColon: true
-SpaceInEmptyBlock: false
-SpaceInEmptyParentheses: false
-SpacesBeforeTrailingComments: 2
-SpacesInAngles:  false
-SpacesInConditionalStatement: false
-SpacesInContainerLiterals: true
-SpacesInCStyleCastParentheses: false
-SpacesInParentheses: false
-SpacesInSquareBrackets: false
-SpaceBeforeSquareBrackets: false
-Standard:        Auto
-StatementMacros:
-  - Q_UNUSED
-  - QT_REQUIRE_VERSION
-TabWidth:        4
-UseCRLF:         false
-UseTab:          Never
-...

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -76,7 +76,7 @@ body:
       label: Issue checklist
       description: Please double-check that you have done each of the following things before submitting the issue.
       options:
-        - label: I searched for previous reports in [the issue tracker](https://github.com/m5stack/M5Stack/issues?q=)
+        - label: I searched for previous reports in [the issue tracker](https://github.com/m5stack/M5PaperS3-UserDemo/issues?q=)
           required: true
         - label: My report contains all necessary details
           required: true

.github/workflows/Arduino-Lint-Check.yml

@@ -37,6 +37,7 @@
 # Build files
 build/
 cmake-build-*/
+components/
 managed_components/
 
 # PlatformIO
@@ -59,3 +60,6 @@ bin/
 obj/
 
 *.code-workspace
+
+sdkconfig
+sdkconfig.old

.gitignore

@@ -0,0 +1,6 @@
+# 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.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(papers3)

CMakeLists.txt

@@ -1,48 +1,37 @@
-# Product Name
+# PaperS3 User Demo
 
-## Overview
+User demo source code of [PaperS3](https://docs.m5stack.com/en/core/PaperS3).
 
-### SKU:xxx
+## Build
 
-Description of the product
+### Fetch Dependencies
 
-## Related Link
+```bash
+python ./fetch_repos.py
+```
 
-- [Document & Datasheet](https://docs.m5stack.com/en/unit/product_Link)
+### Tool Chains
 
-## Required Libraries:
+[ESP-IDF v5.3.3](https://docs.espressif.com/projects/esp-idf/en/v5.3.3/esp32s3/index.html)
 
-- [Adafruit_BMP280_Library](https://github.com/adafruit/Required_Libraries_Link)
+### Build
 
-## License
+```bash
+idf.py build
+```
 
-- [Product Name- MIT](LICENSE)
+### Flash
 
-## Remaining steps(Editorial Staff Look,After following the steps, remember to delete all the content below)
+```bash
+idf.py flash
+```
 
-1. Change [clang format check path](./.github/workflows/clang-format-check.yml#L42-L47).
-2. Add License content to [LICENSE](/LICENSE).
-3. Change link on line 78 of [bug-report.yml](./.github/ISSUE_TEMPLATE/bug-report.yml#L79).
+## Acknowledgments
 
-```cpp
-Example
-# M5Unit-ENV
+This project references the following open-source libraries and resources:
 
-## Overview
+- https://github.com/m5stack/M5GFX.git
+- https://github.com/m5stack/M5Unified.git
+- https://github.com/Forairaaaaa/mooncake
+- https://github.com/Forairaaaaa/mooncake_log
 
-### SKU:U001 & U001-B & U001-C
-
-Contains M5Stack-**UNIT ENV** series related case programs.ENV is an environmental sensor with integrated SHT30 and QMP6988 internally to detect temperature, humidity, and atmospheric pressure data.
-
-## Related Link
-
-- [Document & Datasheet](https://docs.m5stack.com/en/unit/envIII)
-
-## Required Libraries:
-
-- [Adafruit_BMP280_Library](https://github.com/adafruit/Adafruit_BMP280_Library)
-
-## License
-
-- [M5Unit-ENV - MIT](LICENSE)
-```

README.md

@@ -0,0 +1,8 @@
+dependencies:
+  idf:
+    source:
+      type: idf
+    version: 5.3.3
+manifest_hash: 8622a8460fc97b1733c52dd6baf81ad1ba4ebea46542733fc63ae1bebcb2ba3c
+target: esp32s3
+version: 2.0.0

dependencies.lock

@@ -0,0 +1,61 @@
+import os
+import subprocess
+import json
+
+
+def clone_or_update_repo(
+    repo_url, path, ref=None, with_submodules=False, patch_path=None
+):
+    import os
+
+    if not os.path.exists(path):
+        subprocess.run(["git", "clone", repo_url, path], check=True)
+    else:
+        subprocess.run(["git", "-C", path, "fetch"], check=True)
+
+    if ref:
+        subprocess.run(["git", "-C", path, "checkout", ref], check=True)
+
+    if with_submodules:
+        subprocess.run(
+            ["git", "-C", path, "submodule", "update", "--init", "--recursive"],
+            check=True,
+        )
+
+    # 应用 patch
+    if patch_path:
+        patch_full_path = (
+            patch_path
+            if os.path.isabs(patch_path)
+            else os.path.join(os.getcwd(), patch_path)
+        )
+        # 使用 git apply --check 先检测补丁是否能应用，避免报错
+        check_result = subprocess.run(
+            ["git", "-C", path, "apply", "--check", patch_full_path]
+        )
+        if check_result.returncode == 0:
+            subprocess.run(["git", "-C", path, "apply", patch_full_path], check=True)
+            print(f"Applied patch {patch_path} to {path}")
+        else:
+            print(f"Patch {patch_path} cannot be applied cleanly to {path}, skipped.")
+
+
+def fetch_dependencies():
+    script_dir = os.path.dirname(os.path.abspath(__file__))
+    config_path = os.path.join(script_dir, "repos.json")
+
+    with open(config_path) as f:
+        repos = json.load(f)
+
+    for repo in repos:
+        repo_path = os.path.join(script_dir, repo["path"])
+        branch = repo.get("branch")
+        with_submodules = repo.get("with_submodules", False)
+        patch = repo.get("patch")
+        if patch and not os.path.isabs(patch):
+            patch = os.path.join(script_dir, patch)
+        clone_or_update_repo(repo["url"], repo_path, branch, with_submodules, patch)
+
+
+if __name__ == "__main__":
+    fetch_dependencies()