红外学习能力

更新时间:2024-06-05 03:15:12下载pdf

红外学习能力

API 列表

action 说明
infrared.learningState 更新学习状态
infrared.learningCode 查询学习到的红外码
infrared.learningCodeSave 保存学习到的红外码
infrared.learningCodeUpdate 修改学习到的红外码
infrared.learningCodeInfos 获取保存的学习到的红外码
infrared.learningCodeDelete 删除学习到的红外码
infrared.learningCodeSend 下发学习到的红外码

更新学习状态

接口说明

使红外网关进入学习状态。

接⼝地址

action: infrared.learningState

请求参数

参数名 类型 说明 是否必填
infrared_id String 红外设备 ID
state String 是否进入学习模式:
  • true:是
  • false:否
  • 请求示例

    {
      "action": "infrared.learningState",
      "params": {
        "infrared_id": "vdevo157924607038167",
          "state": "true"
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Boolean 切换成功,返回 true
    t Long 进⼊入学习模式的时间

    响应示例

    {
        "success": true,
        "t": 1545135036437,
        "result": true
    }
    

    查询学习到的红外码

    接口说明

    获取红外网关在学习状态下学习到的红外码。

    接⼝地址

    action: infrared.learningCode
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    learning_time String 进⼊入学习模式的时间

    请求示例

    {
      "action": "infrared.learningCode",
      "params": {
        "infrared_id": "vdevo157924607038167",
        "learning_time": "1545135036437"
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Object 返回结果

    result 参数说明

    参数名 类型 说明
    success Boolean 是否学习到红外码
    code String 学习到的红外码(当 successfalse 时,值为空)

    响应示例

    {
        "result": {
            "code": "xxxxxxx",
            "success": true
        },
        "success": true,
        "t": 1584019201214
    }
    

    保存学习到的红外码

    接口说明

    同时保存学习到的一个或多个红外码,生成并返回遥控器 ID。

    接⼝地址

    action: infrared.learningCodeSave
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    codes List 保存的红外信息

    codes 参数

    参数名 类型 说明
    name String 学习到的红外码的名称
    key_name String 学习到的红外码按键名称
    code String 学习到的红外码

    请求示例

    {
      "action": "infrared.learningCodeSave",
      "params": {
        "infrared_id": "vdevo157924607038167",
          "codes": [
          {
            "name": "1584019201214",
            "key_name": "电源",
            "code": "xxxxxx"
          },
          {
            "name": "15840193485764",
            "key_name": "音量+",
            "code": "xxxxxxx"
          }
        ]
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Object 返回结果

    result 参数说明

    参数名 类型 说明
    remote_id String 遥控器 ID

    响应示例

    {
        "success": true,
        "t": 1545135036437,
        "result": {
            "remote_id":"xxxx"
        }
    }
    

    修改学习到的红外码

    接口说明

    更新修改学习到的遥控器。

    接⼝地址

    action: infrared.learningCodeUpdate
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    codes List 保存的红外信息

    codes 参数

    参数名 类型 说明
    name String 学习到的红外码的名称
    key_name String 学习到的红外码按键名称
    code String 学习到的红外码

    请求示例

    {
      "action": "infrared.learningCodeUpdate",
      "params": {
        "infrared_id": "vdevo157924607038167",
          "codes": [
          {
            "name": "1584019201214",
            "key_name": "电源",
            "code": "yyyyy"
          }
        ]
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Object 返回结果

    result 参数说明

    参数名 类型 说明
    remote_id String 遥控器 ID

    响应示例

    {
        "success": true,
        "t": 1545135036437,
        "result": {
            "remote_id":"xxxx"
        }
    }
    

    获取保存的学习到的红外码

    接口说明

    获取保存的学习到的红外码的遥控器。

    接⼝地址

    action: infrared.learningCodeInfos
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    remote_id String 遥控器 ID

    请求示例

    {
      "action": "infrared.learningCodeInfos",
      "params": {
        "infrared_id": "vdevo157924607038167",
          "remote_id": "xxxxxx"
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Object 返回结果

    result 参数说明

    参数名 类型 说明
    code String 学习到的红外码
    name String 红外码的名称
    key_name String 学习到的红外码按键
    id Long 学习到的红外码的 ID
    remote_id String 遥控器 ID

    响应示例

    {
        "result": [
            {
                "code": "xxxxx",
                "id": 1294005,
                "key_name": "电源",
                "name": "1584011048645",
                "remote_id": "xxxxx"
            },
            {
                "code": "yyyyy",
                "id": 1294008,
                "key_name": "音量+",
                "name": "1584011186158",
                "remote_id": "xxxxx"
            }
        ],
        "success": true,
        "t": 1584019606407
    }
    

    删除学习到的红外码

    接口说明

    删除学习到的红外码。

    接⼝地址

    action: infrared.learningCodeDelete
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    id String 学习到的红外码的 ID

    请求示例

    {
      "action": "infrared.learningCodeDelete",
      "params": {
        "infrared_id": "vdevo157924607038167",
        "id": "1294009"
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Object 删除是否成功

    响应示例

    {
        "success": true,
        "t": 1545135036437,
        "result": true
    }
    

    下发学习到的红外码

    接口说明

    删除学习到的红外码。

    接⼝地址

    action: infrared.learningCodeSend
    

    请求参数

    参数名 类型 说明 是否必填
    infrared_id String 红外设备 ID
    remote_id String 遥控器 ID(如果没有,则填 TUYA
    code String 学习到的红外码

    请求示例

    {
      "action": "infrared.learningCodeSend",
      "params": {
        "infrared_id": "vdevo157924607038167",
        "remote_id": "xxxxxx",
        "code": "xxxxxx"
      }
    }
    

    响应参数

    参数名 类型 说明
    code Integer 响应码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功时为空
    result Boolean 删除是否成功

    响应示例

    {
        "success": true,
        "t": 1545135036437,
        "result": true
    }