m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

release coreink

Browse Source
This commit is contained in:
Gitshaoxiang
2020-11-06 15:42:00 +08:00
parent 3b5be209b2
commit bf9ced91ab
15 changed files with 154 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/assets/img/quick_start/coreink/arduino_03.jpg
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 111 KiB

docs/assets/img/quick_start/coreink/arduino_03.webp
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 62 KiB

docs/en/core/coreink.md
+31 -9
View File
@@ -39,7 +39,7 @@ view the corresponding tutorial&quick-Start.
- IoT Terminal
- E-Book
- Industrial Control Panel
- Smart Home Panel
- Electronic Tag
## Specification
@@ -108,7 +108,7 @@ view the corresponding tutorial&quick-Start.
</tr>
<tr>
<td>Gross Weight</td>
<td>xxg</td>
<td>55g</td>
</tr>
<tr>
<td>Dimensions</td>
@@ -116,7 +116,7 @@ view the corresponding tutorial&quick-Start.
</tr>
<tr>
<td>Package Size</td>
<td>x*x*xmm</td>
<td>82*46*20mm</td>
</tr>
<tr>
<td>Case Material</td>
@@ -124,6 +124,32 @@ view the corresponding tutorial&quick-Start.
</tr>
</table>
## EasyLoader
>EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver)
<div class="easyloader-box">
<div style="background-color:white;">
<div><img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/easyloader_intro.webp"></div>
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/CORE/EasyLoader_CoreInk_FactoryTest.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/CORE/EasyLoader_CoreInk_Factory.dmg">MacOS</a>
</div>
</div>
<div>
<video id="example_video" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/Core/CoreInk.mp4" type="video/mp4">
</video>
<div class="easyloader-mask">
<a>
<svg id="play-btn" t="1583228776634" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4152" width="75" height="75"><path d="M512 0C229.216 0 0 229.216 0 512s229.216 512 512 512 512-229.216 512-512S794.784 0 512 0z m0 928C282.24 928 96 741.76 96 512S282.24 96 512 96s416 186.24 416 416-186.24 416-416 416zM384 288l384 224-384 224z" p-id="4153" fill="#007aff"></path></svg></a>
<p>Description:</p>
<p>This video case will demonstrate some of CoreInk's basic features, including magnetics, ink screens, IoT applications, and more (not exactly the same as the program in Easyloader).</p>
</div>
</div>
</div>
## Pin Mapping
**E-Ink Display**
@@ -160,10 +186,6 @@ Screen Resolution：200x200
<tr><td>BM8563</td><td>SDA</td><td>SCL</td></tr>
</table>
## Coreink M-BUS Schematic
<!-- <img class="pic" src="assets/img/product_pics/core/core2/core2_mbus.webp" width = "50%"> -->
## Coreink-HY2.0 4P Port
<table>
@@ -206,7 +228,7 @@ Screen Resolution：200x200
</tbody>
</table>
For more info on specific pin functions refer to the official ESP32 Docs[ESP32 datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/esp32_datasheet_cn.pdf)
For more info on specific pin functions refer to the official ESP32 Docs[ESP32 datasheet](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/esp32_datasheet_en.pdf)
## Related Link
@@ -228,7 +250,7 @@ For more info on specific pin functions refer to the official ESP32 Docs[ESP32 d
<script>
var purchase_link = '';
var purchase_link = 'https://m5stack.com/products/m5stack-esp32-core-ink-development-kit1-54-elnk-display';
var quickstart_link = '#/en/quick_start/coreink/quick_start_arduino';
docs/en/quick_start/coreink/quick_start_arduino.md
+83
View File
@@ -0,0 +1,83 @@
# Arduino IDE Development
## USB Driver
>Before the program is burned, users please download the corresponding CP210X driver package according to the operating system you are using, click the button below. After decompressing the compressed package, select the installation package corresponding to the operating system value for installation.
?> For Mac OS, make sure System preferences -> Security & Privacy -> General before installing, and allow the apps to be installed from the App Store and identified developers
><img src="/image/base/System_preferences.webp" width="50%">
* __Download CP2104 driver__
<div class="files_download">
<p class="item">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Windows.zip">
<img src="/image/base/Windows_logo.webp" width="50">
<span class="item-title">Windows10</span>
</a>
</p>
<p class="item">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_MacOS.zip">
<img src="/image/base/MacOS_logo.webp" width="50">
<span class="item-title">MacOS</span>
</a>
</p>
<p class="item">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/drivers/CP210x_VCP_Linux.zip">
<img src="/image/base/Linux_logo.webp" width="50">
<span class="item-title">Linux</span>
</a>
</p>
</div>
><img src="/image/base/CP210X_install.gif " width="70%">
## Arduino-IDE
>[Click here to visit Arduino's official website](https://www.arduino.cc/en/Main/Software),Select the installation package for your own operating system to download.
<img src="assets/img/related_documents/Arduino_IDE/Arduino_install.webp">
## M5Stack Boards Manager
>1.Open up Arduino IDE, navigate to `File`->`Peferences`->`Settings`
<img src="assets/img/related_documents/Arduino_IDE/Arduino_1.webp">
>2.Copy the following M5Stack Boards Manager url to `Additional Boards Manager URLs:`
**https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/arduino/package_m5stack_index.json**
<img src="assets/img/related_documents/Arduino_IDE/arduino_board_config.webp">
>3.Navigate to `Tools`->`Board:`->`Boards Manager...`
<img src="assets/img/related_documents/Arduino_IDE/board_manage.webp">
>4.Search `M5Stack` in the pop-up window, find it and click `Install`
<img src="assets/img/related_documents/Arduino_IDE/search_M5STACK.webp">
>5.select `Tools`->`Board:`->`M5Stack-CoreInk`
<img src="assets\img\quick_start\coreink\arduino_01.webp">
>6.select `Sketch`->`Include Library:`->`Manage Libraries`
<img src="assets/img/related_documents/Arduino_IDE/manage_libraries.webp">
>7.Search `M5Stack-CoreInk` in the pop-up window, find it and click `Install`
>8.`File`->`Example`->`M5-CoreInk`->`FactoryTest` Open the example and compile and upload it to the device.
<img src="assets\img\quick_start\timer_cam\timercam_arduino_03.webp">
<script>
anchor_search();
scrollFunc();
</script>
docs/en/quick_start/m5stickv/m5stickv_quick_start_maixpy.md
+1 -1
View File
@@ -228,7 +228,7 @@ pmu.enablePMICSleepMode(True)
<a href="https://docs.m5stack.com/#/en/related_documents/M5StickV-Maixpy"><el-button type="primary">get Maixpy examples</el-button></a>
<a href="https://maixpy.sipeed.com/zh/libs/standard/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://cn.maixpy.sipeed.com/en/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://github.com/sipeed/MaixPy/tree/master/projects/maixpy_m5stickv"><el-button type="primary">Github</el-button></a>
docs/en/quick_start/unitv/unitv_quick_start_maixpy.md
+1 -1
View File
@@ -178,7 +178,7 @@ while True:
In the library documentation, you can find more APIs to help you build a variety of applications。
<a href="https://maixpy.sipeed.com/en/libs/standard/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://cn.maixpy.sipeed.com/en/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://github.com/sipeed/MaixPy/tree/master/projects/maixpy_m5stickv"><el-button type="primary">Github</el-button></a>
docs/en/uiflow/advanced.md
-1
View File
@@ -153,7 +153,6 @@ __Note: The created variable name is not allowed to be consistent with the param
><img src="/image/MQTT/UIFlow_MQTT.webp" width="50%">
## Initialization procedure
* __MQTT configuration block__
docs/index.md
+2 -2
View File
@@ -8,8 +8,8 @@
{a:"/#/en/core/gray", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/core_gray_01.webp", p:"GRAY", sku:"K002", qs:"#en/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150"},
{a:"/#/en/core/fire", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/core_fire_01.webp", p:"FIRE", sku:"K007", qs:"#en/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"},
{a:"/#/en/core/m5go_lite", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_lite_01.webp", p:"M5GO Lite", sku:"K022", qs:"#en/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO"},
{a:"/#/en/core/m5go", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_01.webp", p:"M5GO Kit", sku:"K006", qs:"#en/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"}
// {a:"/#/en/core/coreink", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/coreink_01.webp", p:"CoreInk", sku:"K006", qs:"#en/quick_start/coreink/quick_start_arduino" ,kw:"ESP32 E-Ink"}
{a:"/#/en/core/m5go", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_01.webp", p:"M5GO Kit", sku:"K006", qs:"#en/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"},
{a:"/#/en/core/coreink", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/coreink_01.webp", p:"CoreInk", sku:"K006", qs:"#en/quick_start/coreink/quick_start_arduino" ,kw:"ESP32 E-Ink"}
];
const face_list = [
//FACES Series
docs/zh_CN/README.md
+2 -2
View File
@@ -8,8 +8,8 @@
{a:"/#/zh_CN/core/gray", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/core_gray_01.webp", p:"GRAY", sku:"K002", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150"},
{a:"/#/zh_CN/core/fire", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/core_fire_01.webp", p:"FIRE", sku:"K007", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"},
{a:"/#/zh_CN/core/m5go_lite", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_lite_01.webp", p:"M5GO Lite", sku:"K022", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO"},
{a:"/#/zh_CN/core/m5go", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_01.webp", p:"M5GO Kit", sku:"K006", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"}
// {a:"/#/zh_CN/core/coreink", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/coreink_01.webp", p:"CoreInk", sku:"K006", qs:"#zh_CN/quick_start/coreink/quick_start_arduino" ,kw:"ESP32 E-Ink"}
{a:"/#/zh_CN/core/m5go", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/kit_m5go_01.webp", p:"M5GO Kit", sku:"K006", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"},
{a:"/#/zh_CN/core/coreink", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/coreink_01.webp", p:"CoreInk", sku:"K006", qs:"#zh_CN/quick_start/coreink/quick_start_arduino" ,kw:"ESP32 E-Ink"}
// {a:"/#/zh_CN/core/m5paper", img:"https://static-cdn.m5stack.com/image/m5-docs_homepage/core/m5paper_01.webp", p:"M5GO Kit", sku:"K006", qs:"#zh_CN/quick_start/m5core/m5stack_core_quick_start" ,kw:"ESP32 IP5306 MPU6886 BMM150 LEGO MICPHONE"},
];
const face_list = [
docs/zh_CN/core/core2.md
-2
View File
@@ -175,8 +175,6 @@ M5Stack Core2支持的开发平台和程序语言：Arduino，[UIFlow](http://fl
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/CORE/EasyLoader_M5Core2_FactoryTest.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/CORE/EasyLoader_M5Core2_FactoryTest.dmg">MacOS</a>
<!-- <a>Linux</a>
<a>MacOS</a> -->
</div>
</div>
<div>
docs/zh_CN/core/coreink.md
+29 -4
View File
@@ -39,7 +39,7 @@
- 物联网控制器
- 电子书阅读器
- 工业仪器显示面板
- 智能家居设备
- 电子标签
## 规格参数
@@ -108,7 +108,7 @@
</tr>
<tr>
<td>毛重</td>
<td>xxg</td>
<td>55g</td>
</tr>
<tr>
<td>产品尺寸</td>
@@ -116,7 +116,7 @@
</tr>
<tr>
<td>包装尺寸</td>
<td>x*x*xmm</td>
<td>82*46*20mm</td>
</tr>
<tr>
<td>外壳材质</td>
@@ -124,6 +124,31 @@
</tr>
</table>
## EasyLoader
>EasyLoader是一个简洁快速的程序烧录器，其内置了一个产品相关的案例程序，通过简单步骤将其烧录至主控，即可进行一系列的功能验证.**(程序烧录前，请根据设备类型安装相应驱动程序. M5Core型主机[请点击此处查看CP210X驱动安装教程](zh_CN/arduino/arduino_development?id=安装串口驱动)，M5StickC/V/T/ATOM系列可免驱动使用)**
<div class="easyloader-box">
<div style="background-color:white;">
<div><img src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/image/easyloader_intro.webp"></div>
<div class="easyloader-btn">
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/Windows/CORE/EasyLoader_CoreInk_FactoryTest.exe">Windows</a>
<a href="https://m5stack.oss-cn-shenzhen.aliyuncs.com/EasyLoader/MacOS/CORE/EasyLoader_CoreInk_Factory.dmg">MacOS</a>
</div>
</div>
<div>
<video id="example_video" controls>
<source src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/video/Product_example_video/Core/CoreInk.mp4" type="video/mp4">
</video>
<div class="easyloader-mask">
<a>
<svg id="play-btn" t="1583228776634" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="4152" width="75" height="75"><path d="M512 0C229.216 0 0 229.216 0 512s229.216 512 512 512 512-229.216 512-512S794.784 0 512 0z m0 928C282.24 928 96 741.76 96 512S282.24 96 512 96s416 186.24 416 416-186.24 416-416 416zM384 288l384 224-384 224z" p-id="4153" fill="#007aff"></path></svg></a>
<p>案例描述:</p>
<p>该视频案例将演示CoreInk的一些基本特性，包括磁吸，墨水屏，IoT应用等(与Easyloader中的程序并不完全一致)</p>
</div>
</div>
</div>
## 管脚映射
**墨水屏幕**
@@ -225,7 +250,7 @@
<script>
var purchase_link = '';
var purchase_link = 'https://m5stack.com/products/m5stack-esp32-core-ink-development-kit1-54-elnk-display';
var quickstart_link = '#/zh_CN/quick_start/coreink/quick_start_arduino';
docs/zh_CN/quick_start/coreink/quick_start_arduino.md
+2 -4
View File
@@ -36,11 +36,9 @@
>7.在弹出的对话框中搜索`M5Stack-CoreInk`-> 点击`安装`
<img src="assets\img\quick_start\timer_cam\timercam_arduino_02.webp">
>8.`File`->`Example`->`M5-CoreInk`->`FactoryTest` 打开案例程序，编译上传至设备。
>8.`File`->`Example`->`M5-CoreInk` 打开案例程序，编译上传至设备。
<img src="assets\img\quick_start\timer_cam\timercam_arduino_03.webp">
<img src="assets\img\quick_start\coreink\arduino_03.webp">
<script>
docs/zh_CN/quick_start/m5stickv/m5stickv_quick_start_maixpy.md
+1 -1
View File
@@ -219,7 +219,7 @@ pmu.enablePMICSleepMode(True)
<a href="https://docs.m5stack.com/#/zh_CN/related_documents/M5StickV-Maixpy"><el-button type="primary">查看Maixpy案例</el-button></a>
<a href="https://maixpy.sipeed.com/zh/libs/standard/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://cn.maixpy.sipeed.com/zh/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://github.com/sipeed/MaixPy/tree/master/projects/maixpy_m5stickv"><el-button type="primary">Github</el-button></a>
docs/zh_CN/quick_start/unitv/unitv_quick_start_maixpy.md
+1 -1
View File
@@ -174,7 +174,7 @@ while True:
在程序库文档中，你可以找到更多的API，方便你搭建各式各样的应用。
<a href="https://maixpy.sipeed.com/zh/libs/standard/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://cn.maixpy.sipeed.com/zh/"><el-button type="primary">Maixpy docs</el-button></a>
<a href="https://github.com/sipeed/MaixPy/tree/master/projects/maixpy_m5stickv"><el-button type="primary">Github</el-button></a>
docs/zh_CN/uiflow/advanced.md
+1 -3
View File
@@ -150,9 +150,7 @@ __注意：创建的变量名称不允许与形参名称一致，即不允许使
<img src="/image/MQTT/UIFlow_MQTT.webp" width="50%">
# 初始化程序
## 初始化程序
* __MQTT配置块__