diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws01.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws01.png new file mode 100644 index 00000000..27fd30b4 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws01.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws02.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws02.png new file mode 100644 index 00000000..6c72729f Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws02.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws03.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws03.png new file mode 100644 index 00000000..dc54d9ac Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws03.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws04.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws04.png new file mode 100644 index 00000000..e8dcab4a Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws04.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws05.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws05.png new file mode 100644 index 00000000..d3cecd95 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws05.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws06.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws06.png new file mode 100644 index 00000000..070004d9 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws06.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws07.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws07.png new file mode 100644 index 00000000..4c034a86 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws07.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws08.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws08.png new file mode 100644 index 00000000..36b0ca16 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws08.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws09.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws09.png new file mode 100644 index 00000000..83f583d8 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws09.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws10.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws10.png new file mode 100644 index 00000000..64702cc1 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws10.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws11.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws11.png new file mode 100644 index 00000000..21bcadc2 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws11.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws12.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws12.png new file mode 100644 index 00000000..80e7ce50 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws12.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws13.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws13.png new file mode 100644 index 00000000..0328cbff Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws13.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws14.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws14.png new file mode 100644 index 00000000..98816247 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws14.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws15.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws15.png new file mode 100644 index 00000000..2fdb2df4 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws15.png differ diff --git a/docs/assets/img/getting_started_pics/m5stickc/stickc_aws16.png b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws16.png new file mode 100644 index 00000000..345d7cfc Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5stickc/stickc_aws16.png differ diff --git a/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md new file mode 100644 index 00000000..235d6157 --- /dev/null +++ b/docs/en/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md @@ -0,0 +1,146 @@ +# M5StickC Quick Start - Amazon FreeRTOS Win {docsify-ignore-all} + + + +## 1. Set Up Development Environment + +### 1.1 Setting Up the Toolchain on Windows + +#### 1.1.1 Download Toolchain + +- [click here to download esp32_win32_msys2_environment_and_toolchain-20180110.zip](https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20180110.zip) + +#### 1.1.2 Install MSYS2 + +- Unzip the file ‘esp32_win32_msys2_environment_and_toolchain-20180110.zip’ to the root directory of ‘Drive C:’, you will find ‘msys32’ folder + + + +#### 1.1.3 Creat folder + +- Run ‘C:\msys32\mingw32.exe’, enter command menu, and create esp directory by inputting ‘mkdir -p ~/esp’ + + + +### 1.2 Install ESP-IDF + +#### 1.2.1 Clone ESP-IDF + +- Input ‘cd ~/esp’, then ‘git clone -b v3.3 --recursive https://github.com/espressif/esp-idf.git’ You will see the directory of esp-idf + + + +#### 1.2.2 Set ESP-IDF environment variables on Windows + +- Create a script file ‘export_idf_path.sh’ in ‘C:\msys32\etc\profile.d’, and add the code: export IDF_PATH="C:/msys32/home/terryyao/esp/esp-idf" +Please refer to the actual path of ESP-IDF in your PC + + + + +#### 1.2.3 Verify environment + +- Enter ‘printenv IDF_PATH’ to verify + + + +### 1.3 Install Python Packages + +- Input ‘python -m pip install --user -r $IDF_PATH/requirements.txt’ + + + +### 1.4 Test Demo + +- Program a demo to test, for example ‘hello_world’ + +#### 1.4.1 Enter the esp directory + +- Enter the esp directory and input ‘cd ~/esp’ + +#### 1.4.2 Copy the example of 'hello_world' to esp directory + +- Input ‘cp -r $IDF_PATH/examples/get-started/hello_world ./’ + +#### 1.4.3 Enter ‘hello_world’ example + +- input ‘cd ~/esp/hello_world’ + +#### 1.4.4 Connect M5StickC with PC, start to configure + +- Input ’make menuconfig’, enter Configuration menu: + + + +- Once you see above screen, means ESP-IDF set up well. Exit + +## 2. Download and Configure FreeRTOS + +### 2.1 Install AWS FreeRTOS + +- Input ‘git clone --recursive https://github.com/aws/amazon-freertos’ + + + +### 2.2 Get M5StickC code + +#### 2.2.1 Enter Development Board Menu + +- Input ‘cd amazon-freertos/vendors/espressif/boards/’ + +#### 2.2.2 Download M5StickC code + +- Input ‘git clone http://gitlab.m5stack.com/sakabin/aws-stickc-idf m5stickc’ + + + +#### 2.2.3 Use 'AWS CLI' to run AWS IoT commands + +- Input 'easy_install awscli' to install the AWS CLI + +#### 2.2.4 Configure AWS + +- Visit IAM console to get AWS Access Key ID, and AWS Secret Access Key for an IAM user + + + +- Run ‘aws configure’ to set parameters + + + +- Create two files, ‘config’ and ‘credentials’, in C:\msys32\home\user\.aws + + + +#### 2.2.5 Install boto3 Python module + +- Input ‘easy_install boto3’ + + + +#### 2.2.6 Configure network + +- Open ‘demos\common\tools\aws_config_quick_start\configure.json’ to configure ‘thing_name’, ‘wifi_ssid’, ‘wifi_password’, ‘wifi_security’, as below + + + +- Enter ‘demos/common/tools/aws_config_quick_start’ folder, input ‘python SetupAWS.py setup’ + + + +- Enter ‘demos\espressif\esp32_devkitc_esp_wrover_kit\make’, input ‘make menuconfig’ + +- To start compiling, you need to block IDF_PATH by inputting ‘unset IDF_PATH’ + +#### 2.2.7 Enter M5StickC Menu + +- Input ‘cd m5stickc/aws_demos’ + +#### 2.2.8 Burn-in + +- Input ‘make flash monitor’, then select default + + + +#### 2.2.9 Succeed! + diff --git a/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md new file mode 100644 index 00000000..2d199976 --- /dev/null +++ b/docs/zh_CN/quick_start/m5stickc/m5stickc_quick_start_with_AWS-FreeRTOS_Windows.md @@ -0,0 +1,146 @@ +# M5StickC Amazon FreeRTOS 上手指南 {docsify-ignore-all} + + + +## 1. 开发环境配置 + +### 1.1 Windows安装Toolchain 编译链工具 + +#### 1.1.1 下载Toolchain + +- [点击此处下载 esp32_win32_msys2_environment_and_toolchain-20180110.zip](https://dl.espressif.com/dl/esp32_win32_msys2_environment_and_toolchain-20180110.zip) + +#### 1.1.2 安装MSYS2 + +- 解压 ‘esp32_win32_msys2_environment_and_toolchain-20180110.zip’ 到C盘根目录, 你将看到MSYS32文件夹 + + + +#### 1.1.3 创建目录 + +- 打开C:\msys32\mingw32.exe, 进入shell command界面,并创建esp目录 mkdir -p ~/esp + + + +### 1.2 安装 ESP-IDF + +#### 1.2.1 下载 ESP-IDF + +- 输入cd ~/esp, 然后git clone -b v3.3 --recursive https://github.com/espressif/esp-idf.git,你将看到esp-idf的目录 + + + +#### 1.2.2 设置Windows系统ESP-IDF环境变量 + +- 在C:\msys32\etc\profile.d创建脚本文件export_idf_path.sh, 并加入代码: export IDF_PATH="C:\msys32\home\Administrator\esp\esp-idf " + + + + + +#### 1.2.3 确认路径 + +- 输入printenv IDF_PATH验证 + + + +### 1.3 安装 Python Packages + +- 输入python -m pip install --user -r $IDF_PATH/requirements.txt + + + +### 1.4 选择Demo测试环境 + +- 编译一个demo测试, 如hello_word + +#### 1.4.1 Enter the esp directory + +- 输入 ‘cd ~/esp’ + +#### 1.4.2 Copy the example of 'hello_world' to esp directory + +- Input ‘cp -r $IDF_PATH/examples/get-started/hello_world ./’ + +#### 1.4.3 进入 ‘hello_world’ 示例 + +- 进入esp目录, 输入cd ~/esp + +#### 1.4.4 将M5StickC连接电脑 开始配置 + +- 输入 ’make menuconfig’ 进入配置菜单 + + + +- 如果你能看到该界面说明ESP-IDF环境配置完成 + +## 2. 下载和编译 FreeRTOS + +### 2.1 安装 AWS FreeRTOS + +- 输入 ‘git clone --recursive https://github.com/aws/amazon-freertos’ + + + +### 2.2 获取M5StickC的代码 + +#### 2.2.1 进入开发板文件目录 + +- 输入 ‘cd amazon-freertos/vendors/espressif/boards/’ + +#### 2.2.2 下载 M5StickC 代码 + +- 输入 ‘git clone http://gitlab.m5stack.com/sakabin/aws-stickc-idf m5stickc’ + + + +#### 2.2.3 使用 'AWS CLI' 运行AWS IoT命令 + +- 输入 'easy_install awscli' 安装AWS CLI + +#### 2.2.4 配置 AWS + +- 访问 IAM 控制台 获取 IAM用户的AWS Access Key ID 和 AWS Secret Access Key + + + +- 运行 ‘aws configure’ 配置参数 + + + +- 在C:\msys32\home\user\.aws路径生成config和credentials两个文件 + + + +#### 2.2.5 安装 boto3 Python 模块 + +- 输入 ‘easy_install boto3’ + + + +#### 2.2.6 配置网络 + +- 打开 ‘demos\common\tools\aws_config_quick_start\configure.json’ 配置 ‘thing_name’, ‘wifi_ssid’, ‘wifi_password’, ‘wifi_security’等信息,如图 + + + +- 进入 ‘demos/common/tools/aws_config_quick_start’ 目录,输入 ‘python SetupAWS.py setup’ + + + +- 进入 ‘demos\espressif\esp32_devkitc_esp_wrover_kit\make’ 输入 ‘make menuconfig’ + +- 开始编译前, 你需要使用‘unset IDF_PATH’命令屏蔽掉之前配置的IDF_PATH路径 + +#### 2.2.7 进入 M5StickC 目录 + +- 输入 ‘cd m5stickc/aws_demos’ + +#### 2.2.8 Burn-in + +- 输入 ‘make flash monitor’ 保持默认选项 + + + +#### 2.2.9 烧录成功 +