命令文档

概述

定义

说明

对于（channel）通道号参数，如果是IPC设备可以忽略，如果是NVR或者BPI（如果不填channel表示请求对象是基站或者NVR，如果带了channle，表示请求对象是基站或者NVR通道上的某个设备），根据需要填写。所有透传命令输入输出采用JSON格式数据，输入/输出最左侧一列是key值，中间一列是说明，倒数第二列是值类型说明，最后一列是设备支持情况，如果没有使用FI FN FB特殊表明支持某一类设备，表示设备都支持。

注意

对于FoscamNVR，channel参数都没有实际意义，可以填写任意值，或者不包含该字段，因为暂时无法获取到通道上的设备相关信息。

对于IVYNVR，channel有实际意义，因为设备端SDK部分命令可能已经实现了相关功能。

命令返回Json数据中ret定义

1. 设备基本信息

1.1 获取设备能力集合

IVY_CTRL_MSG_GET_DEVABILITY = 22029

• 支持设备

• 输入

1.1.1 (standardization=0输出)获取设备能力集合

• 输出 （当standardization不为1）

1. IVY设备的val0能力集和此定义完全一样，SDK会将Foscam设备部分能力转换并对应到IVY设备val0能力集
2. val1-val8 主要是Foscam的能力集，可能也适用于IVY
3. val9-val12 主要是foscam设备的能力集合，可能也适用于IVY
4. IVY设备增加新的能力集应该在val0上添加，或者val13开始添加；因此可能会出现IVY能力集val1-val12是空的不能使用，只是因为SDK做了兼容导致的
5. 如果Foscam能力集中已经有了IVY所需的能力集，再意义相同的情况下，尽量使用使用已经存在的能力集位
6. 在Foscam不存在此能力集的前提下，最保险的操作就是IVY从val13开始增加新能力集。

• 将Foscam 0表示支持 1标志不支持进行转换的标志位，转换后0表示不支持，1表示支持：

• val0能力集

• val4能力集

• val6能力集

• val9能力集(OSD显示相关能力集位)

看到红色部分不要奇怪，这是为了兼容以前的设备，以前设备9-12的值都是0，红色部分以前都是支持的，所以用0表示支持

• val10能力集(图像相关能力集位)

• val11能力集（报警功能相关能力集位）

• val12能力集（外设控制相关能力集位）

• 备注

目前使用嵌入式SDK的设备会一次返回9个值，请按实际支持的选择对应值。没有使用嵌入式SDK的IPC，也会一次返回9个值，这个是为了兼容旧设备。无论是设备的能力集还是设备通道上的设备的能力集，都按照此定义

如果是NVR设备，只能获取NVR的能力，不能获取通道上的设备能力集。

• 示例

• input

none

• output

{
    "ret":0,
    "cnt":13,
    "val0":351951,
    "val1":1532,
    "val2":1090,
    "val3":40,
    "val4":852,
    "val5":0,
    "val6":29,
    "val7":0,
    "val8":0,
    "val9":0,
    "val10":0,
    "val11":0,
    "val12":0
}

1.1.2 (standardization=1输出)获取设备能力集合 (推荐使用)

如果带有(Foscam)表示明确只有Foscam设备有此能力集，IVY设备没有。

没有特殊说明的 1 为支持 0 为不支持。

预值点 / 巡航 / 预值点巡航 是三种能力，请注意

• 输出 （当standardization等于1）

• ability[0] 能力集

• ability[1] 能力集

• ability[2] 能力集

• ability[3] 能力集

• ability[4] 能力集

• 示例

• input

{
    "standardization":1
}

• output

{
   "ability" : [ 3072153219, 3668000616, 48400 ],
   "ret" : 0
}

1.1.3 获取NVR上Foscam设备能力集合

IVY_CTRL_MSG_GET_FOSCAM_DEVICE_ABILITY_ON_THE_NVR = 26187

V4 BIT4 支持，并且设备是IVY NVR，且通道上设备为 FoscamIPC 可以使用; 通道上设备类型可通过事件 IVY_CTRL_MSG_IPCLIST_CHG的devType判断

• 支持设备

• 输入

• 输出

如果 standardization = 1，返回json和1.1.2一致，另外多个了model字段，表示Foscam设备的model号（推荐使用）

如果 没有 standardization，返回 json 为

1.2 获取设备信息

IVY_CTRL_MSG_GET_DEVINFO = 22025

• 输入

无

• 输出

• 设备类型定义

• wifi类型

• 语言

• 引用

// C/C++
typedef enum { 
    IVYIO_DEV_IPC = 0, 
    IVYIO_DEV_BATTERY_CAMERA = 1, 
    IVYIO_DEV_NVR            = 2, 
    IVYIO_DEV_BASE_STATION   = 3, 
    IVYIO_DEV_OTHER          = 100,

    // for compatible with old fos dev
    IVYIO_DEV_FOS_IPC = 1000,
    IVYIO_DEV_FOS_NVR,
    IVYIO_DEV_FOS_BPI
}IVYIO_DEV_TYPE;

typedef enum 
{ 
    PLATFORM_HISI      = 0, 
    PLATFORM_AMBA      = 1, 
    PLATFORM_MSTAR      = 2, 
    PLATFORM_INGENIC   = 3,
    PLATFORM_JZ   = 4,
    PLATFORM_OTHER      = 100 
}IVYIO_PLATFORM_TYPE;


// Java
package com.ivyio.sdk;

public class DevType {
    public static final int IVY_IPC = 0;
    public static final int IVY_BATTERY_CAMERA = 1; 
    public static final int IVY_NVR = 2;
    public static final int IVY_BASE_STATION = 3; 
    public static final int IVY_OTHER = 100;

    // for compatible with old fos dev
    public static final int FOS_IPC = 1000;
    public static final int FOS_NVR = 1001;
    public static final int FOS_BPI = 1002;
}


public class PlatformType {
    public static final int HISI = 0;  
    public static final int AMBA = 1; 
    public static final int MSTAR = 2; 
    public static final int INGENIC = 3; 
    public static final int JZ = 4;
    public static final int OTHER = 100; 
}

• 备注

如果是NVR设备，只能获取NVR的设备信息，不能获取通道上的设备信息。

• 示例

• input

none

• output

{
   "devName" : "Rm9zY2FtX2NhbWVyYQ==",
   "devType" : 1000,
   "firmwareVersion" : "2.121.2.39",
   "hardwareVersion" : "1.16.1.3",
   "language" : 2,
   "mac" : "A0E73066C9FD",
   "model" : 7206,
   "oemCode" : 3000,
   "platType" : 2,
   "productName" : "MDS2060",
   "ret" : 0,
   "sensorType" : 24,
   "serialNo" : "0000000000000001",
   "uid" : "J8SOJU8QSY8ST79LZZZZFY8Z",
   "wifiType" : 6
}

1.3 设置设备信息

• 支持设备

IVY_CTRL_MSG_SET_DEVINFO = 22027

• 输入

• 输出

• 示例

• input

{
   "devName" : "Rm9zY2FtX2NhbWVyYQ=="
}

• output

{
   "ret" : 0
}

2. 直播设置

2.1 设置镜像翻转

IVY_CTRL_MSG_SET_VIDEO_MIRROR_FLIP = 24035

• 输入

• 输出

• 备注

对于FoscamNVR，如果要设置mirror，Json里不要有flip,如果要设置flip，Json里不要有mirror.

• 示例

• input

// Foscam NVR
// Set mirror
{
   "channel":0,
   "mirror" : 1
}
// Set flip
{
    "channel":0,
   "flip" : 1
}

// Foscam IPC / IVY IPC
{
    "mirror":0,
    "flip" : 1
}

// IVY NVR
{
    "channel":0,
    "mirror":0,
    "flip" : 1
}

• output

{
   "ret" : 0,
}

2.2 获取镜像翻转

IVY_CTRL_MSG_GET_VIDEO_MIRROR_FLIP = 24037

• 输入

• 输出

• 示例

• input

// Foscam NVR / IVY NVR
{
   "channel":0,
}

// Foscam IPC / IVY IPC

None

• output

// Foscam IPC / IVY IPC

{
   "flip" : 0,
   "mirror" : 0,
   "ret" : 0
}

// Foscam NVR / IVY NVR
{
   "channel":0,
   "flip" : 0,
   "mirror" : 0,
   "ret" : 0
}

2.3 设置白天夜晚模式

IVY_CTRL_MSG_SET_DAY_NIGHT_MODE = 24053

• 支持设备

• 输入

• 输出

• 示例

• input

// Foscam NVR / IVY NVR 
{
    "channel":0,
    "mode":1,
    "onoff":0
}

• output

{
    "ret":0
}

2.4 获取白天夜晚模式

IVY_CTRL_MSG_GET_DAY_NIGHT_MODE = 24055

• 输入

• 输出

• 示例

• input

// Foscam NVR / IVY NVR 
{
    "channel":0,
}

// Foscam IPC / IVY IPC

None

• output

// Foscam IPC / IVY IPC
{
    "ret":0,
    "mode":0,
    "onoff":0
}

// Foscam NVR / IVY NVR
{
    "ret":0,
    "channel":0,
    "mode":0,
    "onoff":0
}

2.5 设置视频模式（高清，标准，流畅）

IVY_CTRL_MSG_SET_VIDEOSTREAM_MODE = 24023

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "streamMode":1
}

• output

{
    "ret":0
}

2.6 获取视频模式（高清，标准，流畅）

IVY_CTRL_MSG_GET_VIDEOSTREAM_MODE = 24025

• 支持设备

• 输入

• 输出

• 备注

resolution / bitRate 两个字段只有在FOSCAM BPI设备时才使用，其他设备不使用，
这个值来事件：

• 示例

• input

None

• output

{
    "ret":0,
    "streamMode":0
}

2.7 设置OSD

IVY_CTRL_MSG_SET_OSD_PARAM = 24043

• 支持设备

• 输入

• 输出

• osdType

• dispPos

• 备注

对于IVY NVR， osdType值可以忽略，但是一定要有这个字段。

• 示例

• input

{
    "channel":0,
    "osdType":1,
    "dispPos":1,
}

• output

{
    "ret":0
}

2.7.1 设置OSD (推荐使用)

IVY_CTRL_MSG_SET_OSD_PARAM = 24043

• 支持设备

• 输入

• 输出

• osdType

• dispPos 定义

从最低位开始，每2个bit位表示一种OSD类型位置

• 位置类型

• 示例

• input

{
    "osdType":1,
    "dispPos":1,
}

• output

{
    "ret":0
}

2.8 获取OSD

IVY_CTRL_MSG_GET_OSD_PARAM = 24045

• 输入

• 输出

• 示例

• input

{
    "channel":0
}

• output

{
    "ret":0,
    "osdType":1,
    "dispPos":1
}

2.8.1 获取OSD (推荐使用)

IVY_CTRL_MSG_GET_OSD_PARAM = 24045

• 输入

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "osdType":1,
    "dispPos":1
}

2.9 图像色彩调节

IVY_CTRL_MSG_SET_IMAGE_COLOR = 26077

• 支持设备

• 输入

• 输出

• colorBit

• 示例

• input

{
    "colorBit":1,
    "value":90
}

• output

{
    "ret":0
}

2.10 设置WDR模式

IVY_CTRL_MSG_SET_WDR = 26079

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "mode":1
}

• output

{
    "ret":0
}

2.11 隐私遮挡

2.11.1 获取隐私遮挡是否开启

IVY_CTRL_MSG_GET_PRIVACY_ZONE_ENABLE = 24087

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "isEnable":0,
    "ret":0
}

2.11.2 获取隐私遮挡区域

IVY_CTRL_MSG_GET_PRIVACY_ZONE = 24089

• 支持设备

• 输出

• area json结构

• 示例

• input

None

• output

{
    "area": {
        "x1": 10,
        "y1": 20,
        "x2": 10,
        "y2": 20
    },
    "ret": 0
}

2.11.3 设置隐私遮挡区域开启或者关闭

IVY_CTRL_MSG_SET_PRIVACY_ZONE_ENABLE = 24091

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "isEnable": 0
}

• output

{
    "ret": 0
}

2.11.4 设置隐私遮挡区域

IVY_CTRL_MSG_SET_PRIVACY_ZONE = 24093

• 支持设备

• 输入

• area json结构

• 输出

• 示例

• input

{
    "isEnable": 0,
    "area": {
        "x1": 10,
        "y1": 20,
        "x2": 60,
        "y2": 40
    }
}

• output

{
    "ret": 0
}

2.12 获取WDR模式

IVY_CTRL_MSG_GET_WDR = 26133

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret": 0,
    "mode": 0
}

2.13 获取图像色彩

IVY_CTRL_MSG_GET_IMAGE_COLOR = 26135

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret": 0,
    "hue": 10,
    "brightness": 30,
    "contrast": 40,
    "saturation": 90,
    "sharpness": 99
}

2.14 获取启用视频遮挡

IVY_CTRL_MSG_GET_EANBLE_VIDEO_MASK = 36065

• 支持设备

• 输入

• 输出

• pos Json结构

• 示例

• input

{
    "channel": 1
}

• output

{
    "ret": 0,
    "enable": 10,
    "pos": 
    [{
        "x1":10,
        "y1":10,
        "x2":20,
        "y2":20
    },
    {
        "x1":30,
        "y1":30,
        "x2":60,
        "y2":60
    }]
}

2.15 设置启用视频遮挡

IVY_CTRL_MSG_SET_EANBLE_VIDEO_MASK = 36063

• 支持设备

• 输入

• 输出

• pos Json结构

• 示例

• input

{
    "channel": 1,
    "enable": 10,
    "pos": 
    [{
        "x1":10,
        "y1":10,
        "x2":20,
        "y2":20
    },
    {
        "x1":30,
        "y1":30,
        "x2":60,
        "y2":60
    }]
}

• output

{
    "ret": 0
}

2.16 设置设备休眠计时器状态（重置/不重置），主要用于IVY低功耗设备

IVY_CTRL_MSG_SET_SLEEP_TIMER = 34073

• 支持设备

• 输入

• 输出

• 备注

可通过UID判断为低功耗设备，并且设备是IVY设备，满足这两个条件可以判断为支持此命令

• 示例

• input

{
    "state": 1
}

• output

{
    "ret": 0
}

2.17 设置视频源索引（V4 BIT9）

IVY_CTRL_MSG_SET_VIDEO_STREAM_SOURCE = 24116

• 支持设备

• 输入

• 输出

• 备注

如果设置成功，会收到事件 IVY_CTRL_MSG_VIDEO_STREAM_SOURCE_CHG 42061

• 示例

• input

{
    "src": 0
}

• output

{
    "ret": 0
}

2.18 获取当前视频源索引 （V4 BIT9）

IVY_CTRL_MSG_GET_VIDEO_STREAM_SOURCE = 24118

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0
}

• output

{
    "ret": 0,
    "src": 1
}

2.19 设置带屏摄像机屏幕显示时长

IVY_CTRL_MSG_SET_SCREEN_DISPLAY_TIME = 26195

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0,
    "time": 0
}

• output

{
    "ret": 0,
}

2.20 获取带屏摄像机屏幕显示时长

IVY_CTRL_MSG_GET_SCREEN_DISPLAY_TIME = 26197

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0
}

• output

{
    "ret": 0,
    "time": 0
}

3. 网络

3.1 获取WIFI列表

IVY_CTRL_MSG_GET_WIFI_AP_LIST = 30029

Foscam设备直接调用这个接口即可，因为当startNo为0的时候，SDK内部会自动调用一次刷新命令。

• 输入

• 输出

• apInfo Json结构

• encryType 类型

• 示例

• input

None

• output

{
    "totalCnt":46,
    "curCnt":5,
    "APInfo":[{
        "ssid":"eGlhb21peXk=",
        "mac":"50:64:2B:E2:E7:95",
        "mode":1,
        "encryption":1,
        "quality":117,
        "encryptType":4
        },{
        "ssid":"UGV0TG9vXzE=",
        "mac":"A0:04:60:DC:04:1A",
        "mode":1,
        "encryption":1,
        "quality":107,
        "encryptType":3
        },{
        "ssid":"TUVSQ1VSWV9ERTNGQltdJiBUZXN0",
        "mac":"20:DC:E6:DE:3F:B8",
        "mode":1,
        "encryption":1,
        "quality":97,
        "encryptType":4
        },{
        "ssid":"TkVUR0VBUjUxLTVH",
        "mac":"A0:04:60:DC:04:19",
        "mode":1,
        "encryption":1
        ,"quality":95,
        "encryptType":3
        },{
        "ssid":"VFAtTElOS184ODg=",
        "mac":"BC:46:99:A2:43:CA",
        "mode":1,
        "encryption":1,
        "quality":93,
        "encryptType":4}],
        "ret":0}

3.2 设置WIFI参数

IVY_CTRL_MSG_SET_WIFI_PARAM = 30023

• 支持设备

• 输入

• 输出

• encType加密类型

• 备注

对于FI设备mode没有任何作用，可以忽略

• 示例

• input

{
    "ssid":"VFAtTElOS184ODg=",
    "password":"YWJjMTIzNDU2YWJj",
    "mode":1,
    "encType":4
}

• output

{
    "ret":0
}

3.3 测试WIFI

IVY_CTRL_MSG_TEST_WIFI = 30031

• 支持设备

• 输入

• 输出

• errno 错误码

• 示例

• input

{
    "channel":0,
    "ssid":"bXlzc2lk",
    "password":"YWJjMTIzNDU2YWJj",
    "mode":1, 
    "encType":0, 
    "authMode":1
}

• output

{
    "ret":0,
}

3.4. 设置网络自适应

IVY_CTRL_MSG_SET_NETWORK_ADAPTATION = 30041

• 输入

• 输出

• 示例

• input

{
    "enable":0
}

• output

{
    "ret":0
}

3.5 获取网络自适应

IVY_CTRL_MSG_GET_NETWORK_ADAPTATION = 30043

• 输入

• 输出

• 示例

• input

none

• output

{
    "ret":0,
    "enable":1
}

3.6 获取网络参数

IVY_CTRL_MSG_GET_NET_PARAM = 30021

• 支持设备

• 输入

忽略此参数，不用传，目前没有获取通道上设备的功能。

• 输出

• 示例

• input

none

• output

{
    "dhcp": 1,
    "dns1": "192.168.1.1",
    "dns2": "8.8.8.8",
    "gate": "192.168.1.1",
    "ip": "192.168.1.41",
    "mask": "255.255.255.0",
    "netType": 0,
    "ret": 0
}

3.7 设置网络参数

IVY_CTRL_MSG_SET_NET_PARAM = 30019

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "dhcp": 1,
    "dns1": "192.168.1.1",
    "dns2": "8.8.8.8",
    "gate": "192.168.1.1",
    "ip": "192.168.1.41",
    "mask": "255.255.255.0",
    "netType": 0,
    "ret": 0
}

• output

{
    "ret": 0
}

3.8 获取DDNS

IVY_CTRL_MSG_GET_DDNS_CONFIG = 30035

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret": 0,
    "isEnable": 1,
    "ddnsServer": "192.168.1.1",
    "port": "8.8.8.8",
    "hostName": "192.168.1.1",
    "password": "192.168.1.41",
    "factoryDDNS": "255.255.255.0"
}

3.9 设置DDNS

IVY_CTRL_MSG_SET_DDNS_CONFIG = 30033

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "isEnable": 1,
    "ddnsServer": "192.168.1.1",
    "port": "8.8.8.8",
    "hostName": "192.168.1.1",
    "password": "192.168.1.41",
    "factoryDDNS": "255.255.255.0"
}

• output

{
    "ret": 0
}

3.10 获取WIFI参数

IVY_CTRL_MSG_GET_WIFI_PARAM = 30025

• 支持设备

• 输出

• encType加密类型

• 备注

对于FI设备，mode没有任何意义，可以忽略

• 示例

• input

None

• output

{
    "ret": 0,
    "ssid": "TVlTU0lE",
    "mode": 0,
    "encType": 2,
    "authMode": 0,
    "password": "U1NJRFBBU1NXT1JE"
}

3.11 获取网络连接模式

IVY_CTRL_MSG_GET_NET_MODE = 30060

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret": 0,
    "netMode": "0"
}

3.12 设置热点

IVY_CTRL_MSG_SET_WIFI_AP_INFO = 30068

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0,
    "ssid": "MY_SSID",
    "psk": "MY_PASSWORD",
    "authMode": 2
}

• output

{
    "ret": 0
}

3.13 获取热点信息

IVY_CTRL_MSG_GET_WIFI_AP_INFO = 30070

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0
}

• output

{
    "ret": 0，
    "ssid": "MY_SSID",
    "psk": "MY_PASSWORD",
    "authMode": 2
}

4 系统

4.1 升级/补丁/导入配置

4.1.1 在线升级

IVY_CTRL_MSG_SET_ONLINE_UPGRADE = 26035

• 支持设备

• 输入

• 输出

• type定义

• 备注

Foscam IPC升级，可以忽略bitCh
IVY IPC升级，可以忽略bitCh
IVY NVR，按位表示要升级的通道，bit0-bit31，如果要升级NVR，channel要填0.

• 示例

• input

// Foscam IPC / Foscam IPC
{
    "url":"aHR0cDovL3Rlc3QuZG93bi5jb20vdXBncmFkZS5iaW4="
}

// device On Foscam NVR
{
    "channel":1,
    "url":"aHR0cDovL3Rlc3QuZG93bi5jb20vdXBncmFkZS5iaW4="
}

// IVY IPC
{
    "url":"aHR0cDovL3Rlc3QuZG93bi5jb20vdXBncmFkZS5iaW4="，
    "type":1
}

// IVY NVR
{
    "channel":0,
    "url":"aHR0cDovL3Rlc3QuZG93bi5jb20vdXBncmFkZS5iaW4="，
    "type":1
}

// device On IVY NVR
{
    "channel":1,
    "url":"aHR0cDovL3Rlc3QuZG93bi5jb20vdXBncmFkZS5iaW4=",
    "type":1
}

• output

{
    "ret":0
}

4.1.2 导入配置文件

IVY_CTRL_MSG_IMPORT_CONFIG_FILE = 26103

• 支持设备

• 输入

• 输出

• 备注

ret结果只是表示设备收到了配置文件，但是是否真正导入了这个文件，要通过事件IVY_CTRL_MSG_IMPORT_CFG_RESULT_CHG来查看

• 示例

• input

{
    "url":"YzpcXGNvbmZpZy5iaW4="
}

• output

{
    "ret":0
}

4.1.3 获取配置文件名称

IVY_CTRL_MSG_GET_CONFIG_FILE_NAME = 26105

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "fileName":"Y29uZmlnLmJpbg==",
    "ret":0
}

4.1.4 通过本地文件升级/打补丁

IVY_CTRL_MSG_UPGRADE_BY_FILE = 26107

• 支持设备

• 输入

• 输出

• 备注

type只针对FosNvr

• 示例

• input

{
    "fileName":"YzpcXHBhdGNoLmJpbg=="
}

• output

{
    "ret":0
}

4.1.5 移除补丁

IVY_CTRL_MSG_REMOVE_PATCH = 26109

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret":0
}

4.1.6 通过文件升级NVR通道上的IPC

IVY_CTRL_MSG_UPGRADE_IPC_BY_FILE = 26129

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "fileName":"YzpcXG15ZmlsZS5iaW4=",
    "channels":1
}

• output

{
    "ret":0
}

4.1.7 通过URL升级NVR通道上的IPC

IVY_CTRL_MSG_UPGRADE_IPC_ONLINE = 26131

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "fileName":"aHR0cDovL3d3dy5teS5jb20vdXBncmFkZS5iaW4=",
    "channels":1
}

• output

{
    "ret":0
}

4.2 获取电源频率

IVY_CTRL_MSG_GET_ENVIRONMENT = 24041

• 支持设备

• 输入

• 输出

• 示例

• input

// Foscam IPC
None


// Foscam NVR
{
    "channel":0
}

• output

{
    "ret":0,
    "mode":2
}

4.3 设置电源频率

IVY_CTRL_MSG_SET_ENVIRONMENT = 24039

• 支持设备

• 输入

• 输出

• 示例

• input

// Foscam IPC
None


// Foscam NVR
{
    "channel":0,
    "mode":2
}

// Foscam IPC
{
    "mode":2
}

• output

{
    "ret":0
}

4.4 恢复出厂设置

IVY_CTRL_MSG_FACTORY_RESET = 26027

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret":0
}

4.5 修改用户信息

IVY_CTRL_MSG_CHANGE_USER_INFO = 22023

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "usr":"admin",
    "pwd":"",
    "newUsr":"1",
    "newPwd":"foscam1"
}

• output

{
    "ret":0
}

4.6 设置语音提示

IVY_CTRL_MSG_SET_VOICE_STATE = 26065

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0,
    "isEnable":1
}

• output

{
    "ret":0
}

4.7 获取语音提示

IVY_CTRL_MSG_GET_VOICE_STATE = 26067

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0
}

• output

{
    "ret":0,
    "isEnable":1
}

4.8 设置LED灯状态

IVY_CTRL_MSG_SET_LED_STATE = 26061

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0，
    "isEnable": 0
}

• output

{
    "ret":0
}

4.9 获取LED灯状态

IVY_CTRL_MSG_GET_LED_STATE = 26063

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel": 0
}

• output

{
    "ret":0,
    "isEnable": 0
}

4.10 设置维护模式

IVY_CTRL_MSG_SET_MAINTAIN_CONFIG = 26049

• 支持设备

• 输入

• 输出

• date

• 示例

• input

{
    "date": 1,
    "hour": 23,
    "minute": 23,
    "second": 10
}

• output

{
    "ret":0
}

4.11 获取维护模式

IVY_CTRL_MSG_GET_MAINTAIN_CONFIG = 26051

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "date": 1,
    "hour": 23,
    "minute": 23,
    "second": 10
}

4.12 设置静默升级

IVY_CTRL_MSG_SET_SILENT_UPGRADE_CONFIG = 26053

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "date": 1,
    "hour": 23,
    "minute": 23,
    "second": 10,
    "enable": 1,
    "userId": "1LKFLDKS",
    "portal": "www.test.com"
}

• output

{
    "ret":0
}

4.13 获取静默升级

IVY_CTRL_MSG_GET_SILENT_UPGRADE_CONFIG = 26055

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "date": 1,
    "hour": 23,
    "minute": 23,
    "second": 10,
    "enable": 1,
    "userId": "1LKFLDKS",
    "portal": "www.test.com"
}

4.14 时间设置

4.14.1 设置系统时间 （废弃）

IVY_CTRL_MSG_SET_SYSTEM_TIME = 26019

• 输入

• IVY NVR 输入参数

• 输出

• 备注

如果是Foscam IPC时间需要根据当前时区转换成UTC时间，比如:+08:00，想要设置IPC时间为2019/1/18 9:00:00，正确的UTC时间是2019/1/18 1:00:00；
如果isDst为1并且是Foscam IPC， aheadOfTime才起作用

• Foscam IPC / NVR 输入参数

• dst_month / dst_week / dst_day / dst_hour Json格式

• 示例

• input

{
    "isDst": 0, 
    "aheadOfTime": 0, 
    "year": 2021, 
    "month": 5, 
    "day": 18, 
    "hour": 1, 
    "min": 27, 
    "sec": 1, 
    "timeZone": 0, 
    "timeSource": 0, 
    "dateFormat": 0, 
    "timeFormat": 1, 
    "ntpServer": ""
}

• output

{
    "ret":0
}

4.14.2 获取系统时间 （废弃）

IVY_CTRL_MSG_GET_SYSTEM_TIME = 26021

• 输入

• 输出

• Foscam IPC / NVR 输出参数

• dst_month / dst_week / dst_day / dst_hour Json格式

• 示例

• input

None

• output

{
    "ret":0,
    "isDst": 0, 
    "aheadOfTime": 0, 
    "year": 2021, 
    "month": 5, 
    "day": 18, 
    "hour": 1, 
    "min": 27, 
    "sec": 1, 
    "timeZone": 0, 
    "timeSource": 0, 
    "dateFormat": 0, 
    "timeFormat": 1, 
    "ntpServer": ""    
}

4.14.3 设置夏令时 （废弃）

IVY_CTRL_MSG_SET_DST = 26125

• 支持设备

• 输入

• 输出

• Json结构

• 备注

  {
    "month":{"s":1, "e":2}, // 从1月到2月
    "week":{"s":1, "e":2},  // 从第一周到第二周
    "day":{"s":1, "e":2},   // 从星期1到星期二
    "hour":{"s":1, "e":23}, // 从1点到23点
  }

• 示例

• input

{
    "day": {
        "e": 7,
        "s": 7
    },
    "hasAheadOfTime": 0,
    "hour": {
        "e": 2,
        "s": 2
    },
    "month": {
        "e": 10,
        "s": 4
    },
    "ret": 0,
    "week": {
        "e": 5,
        "s": 1
    }
}

• output

{
    "ret":0
}

4.14.4 获取夏令时 （废弃）

IVY_CTRL_MSG_GET_DST = 26127

• 支持设备

• 输出

• 备注

每一项值的含义同设置，提前时间指的是 IVY_CTRL_MSG_SET_SYSTEM_TIME 命令中
的aheadOfTime

• 示例

• input

None

• output

{
    "ret":0,
    "day": {
        "e": 7,
        "s": 7
    },
    "hasAheadOfTime": 0,
    "hour": {
        "e": 2,
        "s": 2
    },
    "month": {
        "e": 10,
        "s": 4
    },
    "ret": 0,
    "week": {
        "e": 5,
        "s": 1
    }
}

4.14.5 设置系统时间 （推荐使用）

IVY_CTRL_MSG_SET_SYSTEM_TIME = 26019

• 输入

• dst_month / dst_week / dst_day / dst_hour Json格式

• 输出

• 备注

如果是Foscam IPC时间需要根据当前时区转换成UTC时间，比如:+08:00，想要设置IPC时间为2019/1/18 9:00:00，正确的UTC时间是2019/1/18 1:00:00；
如果isDst为1并且是Foscam IPC， aheadOfTime才起作用

• 示例

• input

{
    "isDst": 0, 
    "aheadOfTime": 0, 
    "year": 2021, 
    "month": 5, 
    "day": 18, 
    "hour": 1, 
    "min": 27, 
    "sec": 1, 
    "timeZone": 0, 
    "timeSource": 0, 
    "dateFormat": 0, 
    "timeFormat": 1, 
    "ntpServer": ""
}

• output

{
    "ret":0
}

4.14.6 获取系统时间 （推荐使用）

IVY_CTRL_MSG_GET_SYSTEM_TIME = 26021

• 输入

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "isDst": 0, 
    "aheadOfTime": 0, 
    "year": 2021, 
    "month": 5, 
    "day": 18, 
    "hour": 1, 
    "min": 27, 
    "sec": 1, 
    "timeZone": 0, 
    "timeSource": 0, 
    "dateFormat": 0, 
    "timeFormat": 1, 
    "ntpServer": ""    
    "dstCanWork":0
}

4.16 重启系统

• 支持设备

IVY_CTRL_MSG_REBOOT_SYSTEM = 26023

• 输入

• 输出

• 示例

• input

{
    "channel":0
}

• output

{
    "ret":0
}

4.17 设置设备音量

IVY_CTRL_MSG_SET_AUDIO_VOLUME = 24047

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel":0,
    "volume":98
}

• output

{
    "ret":0
}

4.18 获取设备音量

IVY_CTRL_MSG_GET_AUDIO_VOLUME = 24049

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel":0
}

• output

{
    "ret":0,
    "volume":99
}

4.19 开关蜂鸣器

IVY_CTRL_MSG_SWITCH_BUZZER = 26057

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "switch":0
}

• output

{
    "ret":0
}

4.20 获取电池电量

IVY_CTRL_MSG_SWITCH_BUZZER = 26059

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel":0
}

• output

{
    "ret":0,
    "level":4,
    "status":2,
    "temperature":2,
    "wifiLevel":4
}

4.21 获取夜灯

• 支持设备

IVY_CTRL_MSG_GET_NIGHT_LIGHT = 24071

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "onoff":1
}

4.22 设置夜灯

IVY_CTRL_MSG_SET_NIGHT_LIGHT = 24069

• 支持设备

• 输出

• 示例

• input

{
    "onoff":1
}

• output

{
    "ret":0
}

4.23 设置音频状态

IVY_CTRL_MSG_SET_AUDIO_ENABLE_STATE = 26073

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel":1,
    "isEnable":1
}

• output

{
    "ret":0
}

4.24 获取音频状态

IVY_CTRL_MSG_GET_AUDIO_ENABLE_STATE = 26075

• 支持设备

• 输入

• 输出

• 示例

• input

{
    "channel":1
}

• output

{
    "ret":0,
    "isEnable":1
}

4.25 获取session列表

IVY_CTRL_MSG_GET_SESSION_LIST = 26081

• 支持设备

• 输出

• 示例

• input

None

• output

{
    "ret":0,
    "ip":["192.168.1.10", "192.168.1.20"]
}

4.26 获取log信息

IVY_CTRL_MSG_GET_LOG = 26083

• 支持设备

• 输出

• 备注

如果是FoscamIPC, 只需要用 start / count
如果是FoscamNVR，需要参数 page / logType / channel / startTime / endTime，并且log的格式为 chn+starttime+endtime+user+ip+type+ida+ido

FoscamNVR type值定义：

• 示例

• input

// 1622131200 , 2021-05-28 00:00:00 beijing
// 1622217599 , 2021-05-28 23:59:59 beijing
{
    "page":0,
    "logType":0,
    "channel":1,
    "startTime":1622131200,
    "endTime":1622217599
}