# 一键部署 MicroPython 开发环境

**Repository Path**: chauncyma/one-key-deployment-micropython

## Basic Information

- **Project Name**: 一键部署 MicroPython 开发环境
- **Description**: 本项目用于快速搭建 MicroPython 开发环境，编译自定义固件
- **Primary Language**: Shell
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2022-11-26
- **Last Updated**: 2022-11-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 一键部署 MicroPython 开发环境

本项目用于快速搭建`MicroPython`开发环境，编译自定义固件


> 测试环境：`Windows 10 (1909)` + `Windows Terminal (Preview)` + `Ubuntu`

### 使用方法

#### 0、直接下载脚本文件

如果不想克隆本项目还可以使用如下命令直接下载脚本文件，然后从第 3 步开始操作

```bash
sudo apt install -y wget && wget -O build.sh https://walkline.wang/build.sh && wget -O compile.sh https://walkline.wang/compile.sh && wget -O update.sh https://walkline.wang/update.sh
```

#### 1、打开`Terminal`，新建一个`Ubuntu`窗口

#### 2、进入脚本目录

```bash
cd esp32
```

#### 3、给脚本增加执行权限

```bash
chmod +x *.sh
```

#### 4、部署编译环境并编译固件

```bash
./build.sh
```

> 在此过程中
> * 需要输入登录账号的**密码**，注意观察
> * 会弹出图形界面选择是否自动重启相关服务，选`Yes`即可

> 从`github`克隆项目可能会下载超时，如果超时则需要重新开始，否则会编译失败

#### 5、重新编译固件

在对固件源代码做出修改后可以直接使用下边的命令重新编译固件

```bash
./compile.sh
```

![screenshot](images/screenshot_01.png)

#### 6、同步`MicroPython`和`ESP-IDF`项目

为了保持本地项目和官方同步，还需要不时的更新`MicroPython`和`ESP-IDF`项目文件

```bash
./update.sh
```

### 附录

#### 解决从`github`克隆速度慢的问题（方法一）

* 先访问 [这个网站](http://gfw.news/site) 解决一些问题

* 在`Ubuntu`命令行输入如下命令，启用代理上网

	```bash
	export ALL_PROXY="socks5://127.0.0.1:1085"
	export all_proxy="socks5://127.0.0.1:1085"
	```

* 快速开启和关闭代理上网

	需要在`Ubuntu`配置文件`.bashrc`最后添加如下代码

	```bash
	proxy() {
		export ALL_PROXY="socks5://127.0.0.1:1085"
		export all_proxy="socks5://127.0.0.1:1085"
	}

	noproxy() {
		unset ALL_PROXY
		unset all_proxy
	}
	```

	保存并退出文件后使配置文件立即生效

	```bash
	source .bashrc
	```

	之后就可以使用如下命令开启和关闭代理上网功能了

	```bash
	proxy
	noproxy
	```
#### （推荐）解决从`github`克隆速度慢的问题（方法二）

这个方法的思路是从国内网站下载打包好的`MicroPython`和`ESP-IDF`项目源文件，因为源文件下载时可能（肯定）已经过时，所以下载完第一件事就是先更新这两个项目，更新部分文件的速度要比全部克隆快很多，这也是推荐这个方法的原因，最后，再重新部署一次即可大功告成！

先克隆下边两个项目（感谢[水潭](https://gitee.com/youxinweizhi)大叔提供的打包文件）：

* [esp32-idf](https://gitee.com/youxinweizhi/esp32-idf)
* [micropython_src](https://gitee.com/youxinweizhi/micropython_src)

解压缩后分别将`micropython`和`esp-idf`文件夹移动到脚本目录`~/esp32`下，然后使用`update`命令更新这两个项目

```bash
./update.sh
```

最后使用`build`命令重新部署即可

```bash
./build.sh
```

### 参考资料

https://github.com/xiaoxiaohuixxh/one_click_compile_micropython_for_esp32

### 合作交流

* 联系邮箱：<walkline@163.com>
* QQ 交流群：
    * 走线物联：163271910
    * 扇贝物联：31324057

<p align="center"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/qrcode_walkline.png" width="300px" alt="走线物联"><img src="https://gitee.com/walkline/WeatherStation/raw/docs/images/qrcode_bigiot.png" width="300px" alt="扇贝物联"></p>