Skip to content

Commit bba1bae

Browse files
lbuquelbuque
committed
2 parents df18b6c + fd09d3a commit bba1bae

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1408
-60
lines changed

‎README.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66

77
```shell
88
mkdir uiflow_workspace && cd uiflow_workspace
9-
git clone https://github.com/m5stack/esp-idf.git
10-
git -C esp-idf checkout 8fbf4ba6058bcf736317d8a7aa75d0578563c38b
9+
git clone -b uiflow/v2.0-idf5.0.4 https://github.com/m5stack/esp-idf.git
1110
git -C esp-idf submodule update --init --recursive
1211
./esp-idf/install.sh
1312
. ./esp-idf/export.sh
@@ -18,38 +17,17 @@ git -C esp-idf submodule update --init --recursive
1817
```shell
1918
git clone https://github.com/m5stack/uiflow_micropython
2019
cd uiflow_micropython/m5stack
21-
make submodules # Only need once
20+
make submodules
21+
make patch
2222
make littlefs
2323
make mpy-cross
24-
# Build and flash
25-
# atoms3
26-
make BOARD=M5STACK_AtomS3 pack_all flash
27-
# atoms3-lite
28-
make BOARD=M5STACK_AtomS3_Lite pack_all flash
29-
# atoms3u
30-
make BOARD=M5STACK_AtomS3U pack_all flash
31-
# core(BASIC/M5GO/GRAY) (Falsh 16MB)
32-
make BOARD=M5STACK_Basic pack_all flash
33-
# core(BASIC/M5GO/GRAY) (Falsh 4MB)
34-
make BOARD=M5STACK_Basic_4MB pack_all flash
35-
# capsule
36-
make BOARD=M5STACK_Capsule pack_all flash
37-
# core2,tough
38-
make BOARD=M5STACK_Core2 pack_all flash
39-
# cores3
40-
make BOARD=M5STACK_CoreS3 pack_all flash
41-
# dial
42-
make BOARD=M5STACK_Dial pack_all flash
43-
# fire
44-
make BOARD=M5STACK_Fire pack_all flash
45-
# stamps3
46-
make BOARD=M5STACK_StampS3 pack_all flash
47-
# stickcplus
48-
make BOARD=M5STACK_StickC_PLUS pack_all flash
49-
# stickcplus2
50-
make BOARD=M5STACK_StickC_PLUS2 pack_all flash
24+
make flash_all
5125
```
5226

27+
The default board build the M5STACK_AtomS3 one, You can specify a different board by passing `BOARD=<board>` to the make commands. More BOARD type define is under [m5satck/boards](./m5stack/boards/) path.
28+
29+
More command support, you can check the [Makefile](./m5stack/Makefile).
30+
5331
## Documentation
5432

5533
API documentation for this library can be found on [Read the Docs](https://uiflow-micropython.readthedocs.io/en/latest/).

‎docs/_static/controllers/coreink/AppList.png

16.7 KB
Loading

‎docs/_static/controllers/coreink/Config.png

19.3 KB
Loading

‎docs/_static/controllers/coreink/Flow.png

29.4 KB
Loading

‎docs/en/controllers/airq.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#########
2+
AirQ
3+
#########
4+
5+
.. include:: ../refs/controllers.coreink.ref
6+
7+
**********
8+
UI
9+
**********
10+
11+
|flow.png|
12+
13+
**A** key cycles through the available applications.
14+
15+
|config.png|
16+
17+
**B** key toggles between available servers.
18+
19+
**A** key cycles through the available applications.
20+
21+
|applist.png|
22+
23+
**B** key cycles through scripts.
24+
25+
**A** and **B** keys **pressed simultaneously** run the specified script.
26+
27+
**A** key cycles through the available applications.

‎docs/en/controllers/coreink.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#########
2+
CoreInk
3+
#########
4+
5+
.. include:: ../refs/controllers.coreink.ref
6+
7+
**********
8+
UI
9+
**********
10+
11+
|flow.png|
12+
13+
**Btn.EXT** key cycles through the available applications.
14+
15+
|config.png|
16+
17+
**Down** key toggles between available servers.
18+
19+
**Btn.EXT** key cycles through the available applications.
20+
21+
|applist.png|
22+
23+
**Up** and **Down** keys cycle through scripts.
24+
25+
**Center** key runs the specified script.
26+
27+
**Btn.EXT** key cycles through the available applications.

‎docs/en/controllers/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ Controllers
99
atoms3u.rst
1010
stamps3.rst
1111
cardputer.rst
12+
coreink.rst
13+
airq.rst
14+

‎docs/en/refs/controllers.coreink.ref

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. |applist.png| image:: ../../_static/controllers/coreink/AppList.png
2+
3+
.. |config.png| image:: ../../_static/controllers/coreink/Config.png
4+
5+
.. |flow.png| image:: ../../_static/controllers/coreink/Flow.png

‎docs/zh_CN/controllers/airq.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#########
2+
AirQ
3+
#########
4+
5+
.. include:: ../refs/controllers.coreink.ref
6+
7+
**********
8+
UI
9+
**********
10+
11+
|flow.png|
12+
13+
**A** 键循环浏览可用的应用程序。
14+
15+
|config.png|
16+
17+
**B** 键循切换可用服务器。
18+
19+
**A** 键循环浏览可用的应用程序。
20+
21+
|applist.png|
22+
23+
**B** 键循切换脚本。
24+
25+
**A** 和 **B** 键 **同时按下** 运行指定脚本。
26+
27+
**A** 键循环浏览可用的应用程序。

‎docs/zh_CN/controllers/coreink.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#########
2+
CoreInk
3+
#########
4+
5+
.. include:: ../refs/controllers.coreink.ref
6+
7+
**********
8+
UI
9+
**********
10+
11+
|flow.png|
12+
13+
**Btn.EXT** 键循环浏览可用的应用程序。
14+
15+
|config.png|
16+
17+
**下** 键循切换可用服务器。
18+
19+
**Btn.EXT** 键循环浏览可用的应用程序。
20+
21+
|applist.png|
22+
23+
**上** 和 **下** 键循切换脚本。
24+
25+
**中** 键运行指定脚本。
26+
27+
**Btn.EXT** 键循环浏览可用的应用程序。

0 commit comments

Comments
 (0)