跳到主要内容

CLI 使用说明

设置

如果您还没有设置 ESP RainMaker 命令行界面 (CLI),请按照 [这里] (cli-setup.md) 的步骤进行设置后再使用 CLI。

命令和使用说明

注意:在 Windows 上,使用 python rainmaker.py <子命令>

  1. 运行以下命令进行注册:
    ./rainmaker.py signup <email>
  1. 运行以下命令登录 CLI:

    ./rainmaker.py login [--email <email>]

如果没有提供电子邮件,浏览器窗口将会打开,您可以通过网页进行登录。

  1. 登录成功后,可以使用 Rainmaker CLI。

运行 CLI

使用说明

    ./rainmaker.py [OPTIONS] COMMAND [ARGS]...

选项:

序号参数描述
1-h, --help显示此帮助信息并退出

命令:

运行 ./rainmaker.py {command} -h 获取帮助信息

序号参数描述
1signup注册 ESP Rainmaker
2login登录 ESP Rainmaker
3logout注销当前已登录 ESP Rainmaker 用户
4forgotpassword重置密码
5getnodes获取当前账户下的所有节点
6getnodeconfig获取节点的配置
7getnodestatus获取节点的在线/离线状态
8setparams设置节点参数。注意:在单引号中输入 JSON 数据
9getparams获取节点参数
10removenode删除映射的节点
11provision对节点进行配网
12getmqtthost获取用于固件的 MQTT 主机 URL
13claim对连接到指定串口的节点进行 Claimming(获取云凭据)
14otaupgrade上传 OTA 固件镜像并开始 OTA 升级
15getuserinfo获取当前已登录用户的详细信息
16sharing节点共享操作

注意:对于 ./rainmaker.py setparams 命令,不同主机操作系统需输入不同格式的 JSON 数据参数。

macOS/Linux 系统:'{"Light": {"brightness": 50, "output": false}}'

Windows 系统:"{\"Light\": {\"brightness\": 50, \"output\": false}}"