4.2 KiB
title
| title |
|---|
| MaixCDK 快速开始 |
仅支持 Linux 系统，推荐使用 Ubuntu >= 20.04。
也可以使用
Docker环境进行构建，参考 Docker 环境使用方法。Docker环境准备好了ubuntu20.04系统和依赖，可以直接获取开始编译，对Docker熟悉或者搭建本地开发环境遇到问题可以参考。
- 本地编译环境准备
sudo apt update
sudo apt install git cmake build-essential python3 python3-pip
cmake --version # cmake 版本应该 >= 3.13, 或者也可以使用 `pip install cmake -U` 来安装最新版本的 cmake
如果你希望编译出来到 Linux PC 上跑，而不是交叉编译到开发板，如果是
Ubuntu，请使用系统版本>=20.04，否则有些依赖包可能会版本太旧无法编译通过，并且按照Dockerfile里面的安装依赖的命令来安装依赖。 如果编译仍然报错，请使用Docker环境进行编译。
- 下载代码
git clone https://github.com/Sipeed/MaixCDK
稳定的 Release 版本请到 release 页面 下载。
中国国内用户可能克隆速度比较慢，可以使用
git clone https://gitee.com/Sipeed/MaixCDK
- 安装依赖
cd MaixCDK
pip install -U pip # 更新 pip 到最新版本
pip install -U -r requirements.txt # 安装依赖
中国国内可以加
-i https://pypi.tuna.tsinghua.edu.cn/simple参数来使用清华源。Docker环境里面已经装好了，不过也可以在Docker容器里面执行命令更新到最新版本。
此时在终端执行maixtool和maixcdk命令可以看到帮助信息。
如果报错找不到命令，可以尝试重启终端，或者通过
find / -name "maixtool"来找到maixtool命令的位置，然后通过export PATH=maixtool所在目录;$PATH来设置系统环境变量，重启终端就可以执行maixtool命令了。
- 编译
cd examples/hello_world
maixcdk menuconfig
根据提示选择设备平台，会出来一个界面可以配置一些参数，初次使用用默认的参数即可（用默认的参数也可以不执行 menuconfig, 直接执行 build 命令），然后按ESC按键，再按Y保存退出。
maixcdk build
第一次执行这一步会根据设备下载编译工具链，下载如果太慢，可以根据提示手动下载到提示的目录，然后再执行编译。
编译完后在build目录下可以看到二进制程序文件，以及build/dl_lib下有依赖的so文件。
修改了代码后，再次执行maixcdk build即可编译。
maixcdk build 命令默认会扫描所有文件更改再构建，如果你没有增删源码文件可以执行maixcdk build --no-gen编译会更快。
因为用了
cmake，build命令会每次都执行cmake命令，加了--no-gen参数后只会执行make命令所以更快，但是由于增删文件后需要执行cmake来扫描文件更改，为了防止开发者忘记执行所以默认行为就是每次都扫描再构建。
也可以执行maixcdk distclean 清除所有编译产生的临时文件以从一个干净的环境开始编译（但是这样构建时间会很长，一般编译出现奇怪的问题可以先尝试这样解决）。
- 上传程序到设备
拷贝 可执行文件 和 dl_lib文件夹 到设备运行。
- 运行
通过串口终端或者 ssh 终端 或者 ADB 等方式在终端运行程序。
- 打包发布
在工程目录下，使用 maixcdk -p maixcam release 可以为 maixcam 打包一个程序包并且存放在dist目录，可以上传发布到MaixHub 应用商店。
安装包使用方法：
- 方法一： 直接解压拷贝到设置执行
chmod +x main.sh && ./main.sh即可运行。 - 方法二： 在设备运行应用商店应用，在 MaixHub 应用商店 扫码安装。
- 方法三： 对于开发者，保证设备已经连到了和电脑所在局域网，在工程目录执行
maixcdk deploy会出现一个二维码， 在设备运行应用商店应用扫码安装。
这里只是简单提及一下，发布的应用需要遵循APP 开发准则。
- 新建工程
使用命令创建工程：
maixcdk new