Command documentation

Overview

Definition

illustrate

For the (channel) channel number parameter, it can be ignored if it is an IPC device. If it is an NVR or BPI (if channel is not filled in, it means that the request object is a base station or NVR. If channel is brought, it means that the request object is a base station or someone on the NVR channel. Equipment), fill in as needed. *All transparent transmission command input and output use JSON format data. The leftmost column of the input/output is the key value, the middle column is the description, the penultimate column is the value type description, and the last column is the device support status. *If not used FI FN FB specifically indicates support for a certain type of device, indicating that all devices support it.

Notice

*For FoscamNVR, the channel parameters have no practical meaning. You can fill in any value, or this field is not included because the device-related information on the channel cannot be obtained temporarily. *

*For IVYNVR, channel has practical significance, because some commands of the device-side SDK may have implemented related functions. *

The command returns the ret definition in Json data

1. Basic information of the device

1.1 Obtain device capability collection

IVY_CTRL_MSG_GET_DEVABILITY = 22029

• supporting device

• input

1.1.1 (standardization=0 output) Get device capability set

• output (when standardization is not 1)

1. The val0 capability set of the IVY device is exactly the same as this definition. The SDK will convert some capabilities of the Foscam device and map them to the val0 capability set of the IVY device
2. val1-val8 are mainly the capability set of Foscam and may also be applicable to IVY
3. val9-val12 is mainly the capability set of foscam device, and may also be applicable to IVY
4. New capability sets added to IVY devices should be added at val0, or starting from val13; therefore, the IVY capability sets val1-val12 may be empty and cannot be used, just because the SDK has made compatibility caused
5. If the Foscam capability set already has the capability set required by IVY, and the meaning is the same, try to use the existing capability set position
6. Under the premise that Foscam does not have this capability set, the safest operation is for IVY to add a new capability set starting from val13.

• Set Foscam 0 to indicate support and 1 to indicate that the conversion flag is not supported. After conversion, 0 indicates no support and 1 indicates support:

• val0 ability set

• val4 ability set

• val6 ability set

• val9 ability set (OSD displays related ability set bits)

*Don’t be surprised to see the red part. This is for compatibility with previous devices. The values of devices 9-12 in the past were all 0. The red part was supported before, so 0 is used to indicate support *

• val10 capability set (image related capability set)

• val11 capability set (alarm function related capability set bits)

• val12 capability set (peripheral control related capability set bits)

• Remark

Currently, devices using the embedded SDK will return 9 values at a time. Please select the corresponding value according to the actual support. IPC that does not use the embedded SDK will also return 9 values at a time. This is for compatibility with old devices. Whether it is the capability set of the device or the capability set of the device on the device channel, it is defined according to this

If it is an NVR device, you can only obtain the capabilities of the NVR, but not the device capability set on the channel.

• Example

• 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 output) Get device capability set (recommended)

If it contains (Foscam), it means that only the Foscam device has this capability set, and the IVY device does not.

Without special instructions, 1 means supported and 0 means not supported.

Pre-value point/cruise/pre-value point cruise are three abilities, please note

• Output (when standardization equals 1)

• ability[0] ability set

• ability[1] ability set

• ability[2] ability set

• ability[3] ability set

• ability[4] ability set

• Example

• input

{
    "standardization":1
}

• output

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

1.1.3 Obtain Foscam device capability set on NVR

IVY_CTRL_MSG_GET_FOSCAM_DEVICE_ABILITY_ON_THE_NVR = 26187

V4 BIT4 supports it, and the device is IVY NVR, and the device on the channel is FoscamIPC. It can be used; the device type on the channel can be judged by the devType of the event IVY_CTRL_MSG_IPCLIST_CHG

• supporting device

• input

• output

If standardization = 1, the returned json is consistent with 1.1.2, and there are multiple model fields, indicating the model number of the Foscam device (recommended)

If there is no standardization, return json as

1.2 Get device information

IVY_CTRL_MSG_GET_DEVINFO = 22025

• input

none

• output

-Device type definition

• wifi type

• language

• Quote

// 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;
}

• Remark

If it is an NVR device, you can only obtain the device information of the NVR, but not the device information on the channel.

• Example

• 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 Set device information

• supporting device

IVY_CTRL_MSG_SET_DEVINFO = 22027

• input

• output

• Example

• input

{
"devName" : "Rm9zY2FtX2NhbWVyYQ=="
}

• output

{
"ret" : 0
}

2. Live broadcast settings

2.1 Set mirror flip

IVY_CTRL_MSG_SET_VIDEO_MIRROR_FLIP = 24035

• input

• output

• Remark

For FoscamNVR, if you want to set mirror, there is no flip in Json. If you want to set flip, there is no mirror in Json.

• Example

• 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 Get mirror flip

IVY_CTRL_MSG_GET_VIDEO_MIRROR_FLIP = 24037

• input

• output

• Example

• 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 Set day and night mode

IVY_CTRL_MSG_SET_DAY_NIGHT_MODE = 24053

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

2.4 Get day and night mode

IVY_CTRL_MSG_GET_DAY_NIGHT_MODE = 24055

• input

• output

• Example

• 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 Set video mode (HD, standard, smooth)

IVY_CTRL_MSG_SET_VIDEOSTREAM_MODE = 24023

• supporting device

• input

• output

• Example

• input

{
    "streamMode":1
}

• output

{
    "ret":0
}

2.6 Get video mode (HD, standard, smooth)

IVY_CTRL_MSG_GET_VIDEOSTREAM_MODE = 24025

• supporting device

• input

• output

• Remark

The two fields resolution / bitRate are only used when using FOSCAM BPI devices and are not used by other devices.
This value comes to the event:

• Example

• input

None

• output

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

2.7 Set OSD

IVY_CTRL_MSG_SET_OSD_PARAM = 24043

• supporting device

• input

• output

-osdType

-dispPos

• Remark

For IVY NVR, the osdType value can be ignored, but this field must be present.

• Example

• input

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

• output

{
    "ret":0
}

2.7.1 Set OSD (recommended)

IVY_CTRL_MSG_SET_OSD_PARAM = 24043

• supporting device

• input

• output

-osdType

• dispPos definition

Starting from the lowest bit, every 2 bits represent an OSD type position.

• location type

• Example

• input

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

• output

{
    "ret":0
}

2.8 Get OSD

IVY_CTRL_MSG_GET_OSD_PARAM = 24045

• input

• output

• Example

• input

{
    "channel":0
}

• output

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

2.8.1 Get OSD (recommended)

IVY_CTRL_MSG_GET_OSD_PARAM = 24045

• input

• output

• Example

• input

None

• output

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

2.9 Image color adjustment

IVY_CTRL_MSG_SET_IMAGE_COLOR = 26077

• supporting device

• input

• output

-colorBit

• Example

• input

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

• output

{
    "ret":0
}

2.10 Set WDR mode

IVY_CTRL_MSG_SET_WDR = 26079

• supporting device

• input

• output

• Example

• input

{
    "mode":1
}

• output

{
    "ret":0
}

2.11 Privacy Masking

2.11.1 Get whether privacy masking is turned on

IVY_CTRL_MSG_GET_PRIVACY_ZONE_ENABLE = 24087

• supporting device

• output

• Example

• input

None

• output

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

2.11.2 Obtain privacy mask area

IVY_CTRL_MSG_GET_PRIVACY_ZONE = 24089

• supporting device

• output

• area json structure

• Example

• input

None

• output

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

2.11.3 Set privacy masking area on or off

IVY_CTRL_MSG_SET_PRIVACY_ZONE_ENABLE = 24091

• supporting device

• input

• output

• Example

• input

{
    "isEnable": 0
}

• output

{
    "ret": 0
}

2.11.4 Set privacy mask area

IVY_CTRL_MSG_SET_PRIVACY_ZONE = 24093

• supporting device

• input

• area json structure

• output

• Example

• input

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

• output

{
    "ret": 0
}

2.12 Get WDR mode

IVY_CTRL_MSG_GET_WDR = 26133

• supporting device

• output

• Example

• input

None

• output

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

2.13 Get image color

IVY_CTRL_MSG_GET_IMAGE_COLOR = 26135

• supporting device

• output

• Example

• input

None

• output

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

2.14 Get enabled video blocking

IVY_CTRL_MSG_GET_EANBLE_VIDEO_MASK = 36065

• supporting device

• input

• output

• pos Json structure

• Example

• 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 Set enable video blocking

IVY_CTRL_MSG_SET_EANBLE_VIDEO_MASK = 36063

• supporting device

• input

• output

• pos Json structure

• Example

• 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 Set the device sleep timer status (reset/no reset), mainly used for IVY low-power devices

IVY_CTRL_MSG_SET_SLEEP_TIMER = 34073

• supporting device

• input

• output

• Remark

It can be judged to be a low-power device through the UID, and the device is an IVY device. If these two conditions are met, it can be judged to support this command.

• Example

• input

{
    "state": 1
}

• output

{
    "ret": 0
}

2.17 Set video source index (V4 BIT9)

IVY_CTRL_MSG_SET_VIDEO_STREAM_SOURCE = 24116

• supporting device

• input

• output

• Remark

If the setting is successful, event IVY_CTRL_MSG_VIDEO_STREAM_SOURCE_CHG 42061 will be received

• Example

• input

{
    "src": 0
}

• output

{
    "ret": 0
}

2.18 Get the current video source index (V4 BIT9)

IVY_CTRL_MSG_GET_VIDEO_STREAM_SOURCE = 24118

• supporting device

• input

• output

• Example

• input

{
    "channel": 0
}

• output

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

2.19 Set screen display duration of camera with screen

IVY_CTRL_MSG_SET_SCREEN_DISPLAY_TIME = 26195

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret": 0,
}

2.20 Get screen display duration of camera with screen

IVY_CTRL_MSG_GET_SCREEN_DISPLAY_TIME = 26197

• supporting device

• input

• output

• Example

• input

{
    "channel": 0
}

• output

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

3. Network

3.1 Get WIFI list

IVY_CTRL_MSG_GET_WIFI_AP_LIST = 30029

Foscam device can directly call this interface, because when startNo is 0, the SDK will automatically call a refresh command internally.

• input

• output

• apInfo Json structure

• encryType type

• Example

• 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 Set WIFI parameters

IVY_CTRL_MSG_SET_WIFI_PARAM = 30023

• supporting device

• input

• output

• encType encryption type

• Remark

Mode has no effect on FI devices and can be ignored.

• Example

• input

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

• output

{
    "ret":0
}

3.3 Test WIFI

IVY_CTRL_MSG_TEST_WIFI = 30031

• supporting device

• input

• output

• errno error code

• Example

• input

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

• output

{
    "ret":0,
}

3.4. Set up network adaptation

IVY_CTRL_MSG_SET_NETWORK_ADAPTATION = 30041

• input

• output

• Example

• input

{
    "enable":0
}

• output

{
    "ret":0
}

3.5 Get network adaptation

IVY_CTRL_MSG_GET_NETWORK_ADAPTATION = 30043

• input

• output

• Example

• input

none

• output

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

3.6 Get network parameters

IVY_CTRL_MSG_GET_NET_PARAM = 30021

• supporting device

• input

Ignore this parameter and do not need to pass it. Currently, there is no function to obtain the device on the channel.

• output

• Example

• 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 Set network parameters

IVY_CTRL_MSG_SET_NET_PARAM = 30019

• supporting device

• input

• output

• Example

• 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 Get DDNS

IVY_CTRL_MSG_GET_DDNS_CONFIG = 30035

• supporting device

• output

• Example

• 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 Set up DDNS

IVY_CTRL_MSG_SET_DDNS_CONFIG = 30033

• supporting device

• input

• output

• Example

• 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 Get WIFI parameters

IVY_CTRL_MSG_GET_WIFI_PARAM = 30025

• supporting device

• output

• encType encryption type

• Remark

For FI devices, mode has no meaning and can be ignored.

• Example

• input

None

• output

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

3.11 Get network connection mode

IVY_CTRL_MSG_GET_NET_MODE = 30060

• supporting device

• output

• Example

• input

None

• output

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

3.12 Set up hotspot

IVY_CTRL_MSG_SET_WIFI_AP_INFO = 30068

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret": 0
}

3.13 Get hotspot information

IVY_CTRL_MSG_GET_WIFI_AP_INFO = 30070

• supporting device

• input

• output

• Example

• input

{
    "channel": 0
}

• output

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

4 System

4.1 Upgrade/Patch/Import Configuration

4.1.1 Online upgrade

IVY_CTRL_MSG_SET_ONLINE_UPGRADE = 26035

• supporting device

• input

• output

• type definition

• Remark

Foscam IPC upgrade, bitCh can be ignored
IVY IPC upgrade, bitCh can be ignored
IVY NVR, bitwise indicates the channel to be upgraded, bit0-bit31, if you want to upgrade the NVR, fill in 0 for channel.

• Example

• 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 Import configuration file

IVY_CTRL_MSG_IMPORT_CONFIG_FILE = 26103

• supporting device

• input

• output

• Remark

The ret result only indicates that the device has received the configuration file, but whether the file has actually been imported can be checked through the event IVY_CTRL_MSG_IMPORT_CFG_RESULT_CHG

• Example

• input

{
    "url":"YzpcXGNvbmZpZy5iaW4="
}

• output

{
    "ret":0
}

4.1.3 Get configuration file name

IVY_CTRL_MSG_GET_CONFIG_FILE_NAME = 26105

• supporting device

• output

• Example

• input

None

• output

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

4.1.4 Upgrade/patch through local files

IVY_CTRL_MSG_UPGRADE_BY_FILE = 26107

• supporting device

• input

• output

• Remark

type is only for FosNvr

• Example

• input

{
    "fileName":"YzpcXHBhdGNoLmJpbg=="
}

• output

{
    "ret":0
}

4.1.5 Remove patch

IVY_CTRL_MSG_REMOVE_PATCH = 26109

• supporting device

• output

• Example

• input

None

• output

{
    "ret":0
}

4.1.6 Upgrade IPC on NVR channel through file

IVY_CTRL_MSG_UPGRADE_IPC_BY_FILE = 26129

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.1.7 Upgrade IPC on NVR channel via URL

IVY_CTRL_MSG_UPGRADE_IPC_ONLINE = 26131

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.2 Get the power frequency

IVY_CTRL_MSG_GET_ENVIRONMENT = 24041

• supporting device

• input

• output

• Example

• input

// Foscam IPC
None


// Foscam NVR
{
    "channel":0
}

• output

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

4.3 Set power frequency

IVY_CTRL_MSG_SET_ENVIRONMENT = 24039

• supporting device

• input

• output

• Example

• input

// Foscam IPC
None


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

// Foscam IPC
{
    "mode":2
}

• output

{
    "ret":0
}

4.4 Restore factory settings

IVY_CTRL_MSG_FACTORY_RESET = 26027

• supporting device

• output

• Example

• input

None

• output

{
    "ret":0
}

4.5 Modify user information

IVY_CTRL_MSG_CHANGE_USER_INFO = 22023

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.6 Set voice prompts

IVY_CTRL_MSG_SET_VOICE_STATE = 26065

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.7 Get voice prompts

IVY_CTRL_MSG_GET_VOICE_STATE = 26067

• supporting device

• input

• output

• Example

• input

{
    "channel": 0
}

• output

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

4.8 Set LED light status

IVY_CTRL_MSG_SET_LED_STATE = 26061

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.9 Get LED light status

IVY_CTRL_MSG_GET_LED_STATE = 26063

• supporting device

• input

• output

• Example

• input

{
    "channel": 0
}

• output

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

4.10 Set maintenance mode

IVY_CTRL_MSG_SET_MAINTAIN_CONFIG = 26049

• supporting device

• input

• output

• date

• Example

• input

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

• output

{
    "ret":0
}

4.11 Get maintenance mode

IVY_CTRL_MSG_GET_MAINTAIN_CONFIG = 26051

• supporting device

• output

• Example

• input

None

• output

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

4.12 Set up silent upgrade

IVY_CTRL_MSG_SET_SILENT_UPGRADE_CONFIG = 26053

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.13 Get silent upgrade

IVY_CTRL_MSG_GET_SILENT_UPGRADE_CONFIG = 26055

• output

• Example

• input

None

• output

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

4.14 Time setting

4.14.1 Set system time (obsolete)

IVY_CTRL_MSG_SET_SYSTEM_TIME = 26019

• input

• IVY NVR input parameters

• output

• Remark

If the Foscam IPC time needs to be converted to UTC time according to the current time zone, for example: +08:00, if you want to set the IPC time to 2019/1/18 9:00:00, the correct UTC time is 2019/1/18 1: 00:00;
aheadOfTime only works if isDst is 1 and is Foscam IPC

• Foscam IPC / NVR input parameters

• dst_month/dst_week/dst_day/dst_hour Json format

• Example

• 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 Get system time (obsolete)

IVY_CTRL_MSG_GET_SYSTEM_TIME = 26021

• input

• output

• Foscam IPC / NVR output parameters

• dst_month/dst_week/dst_day/dst_hour Json format

• Example

• 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 Set Daylight Saving Time(obsolete)

IVY_CTRL_MSG_SET_DST = 26125

• supporting device

• input

• output

• Json structure

• Remark

  {
    "month":{"s":1, "e":2}, // from January to February
    "week":{"s":1, "e":2}, // from the first week to the second week
    "day":{"s":1, "e":2}, // from Monday to Tuesday
    "hour":{"s":1, "e":23}, // from 1 o'clock to 23 o'clock
  }

• Example

• 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 Get Daylight Saving Time (obsolete)

IVY_CTRL_MSG_GET_DST = 26127

• supporting device

• output

• Remark

The meaning of each value is the same as the setting. The advance time refers to the IVY_CTRL_MSG_SET_SYSTEM_TIME command.
aheadOfTime

• Example

• 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 Set system time (recommended)

IVY_CTRL_MSG_SET_SYSTEM_TIME = 26019

• input

• dst_month/dst_week/dst_day/dst_hour Json format

• output

• Remark

If the Foscam IPC time needs to be converted to UTC time according to the current time zone, for example: +08:00, if you want to set the IPC time to 2019/1/18 9:00:00, the correct UTC time is 2019/1/18 1: 00:00;
aheadOfTime only works if isDst is 1 and is Foscam IPC

• Example

• 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 Get system time (recommended)

IVY_CTRL_MSG_GET_SYSTEM_TIME = 26021

• input

• output

• Example

• 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 Restart the system

• supporting device

IVY_CTRL_MSG_REBOOT_SYSTEM = 26023

• input

• output

• Example

• input

{
    "channel":0
}

• output

{
    "ret":0
}

4.17 Set device volume

IVY_CTRL_MSG_SET_AUDIO_VOLUME = 24047

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.18 Get device volume

IVY_CTRL_MSG_GET_AUDIO_VOLUME = 24049

• supporting device

• input

• output

• Example

• input

{
    "channel":0
}

• output

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

4.19 Switch buzzer

IVY_CTRL_MSG_SWITCH_BUZZER = 26057

• supporting device

• input

• output

• Example

• input

{
    "switch":0
}

• output

{
    "ret":0
}

4.20 Get battery power

IVY_CTRL_MSG_SWITCH_BUZZER = 26059

• supporting device

• input

• output

• Example

• input

{
    "channel":0
}

• output

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

4.21 Get Night Light

• supporting device

IVY_CTRL_MSG_GET_NIGHT_LIGHT = 24071

• output

• Example

• input

None

• output

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

4.22 Set up night light

IVY_CTRL_MSG_SET_NIGHT_LIGHT = 24069

• supporting device

• output

• Example

• input

{
    "onoff":1
}

• output

{
    "ret":0
}

4.23 Set audio status

IVY_CTRL_MSG_SET_AUDIO_ENABLE_STATE = 26073

• supporting device

• input

• output

• Example

• input

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

• output

{
    "ret":0
}

4.24 Get audio status

IVY_CTRL_MSG_GET_AUDIO_ENABLE_STATE = 26075

• supporting device

• input

• output

• Example

• input

{
    "channel":1
}

• output

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

4.25 Get session list

IVY_CTRL_MSG_GET_SESSION_LIST = 26081

• supporting device

• output

• Example

• input

None

• output

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

4.26 Get log information

IVY_CTRL_MSG_GET_LOG = 26083

• supporting device

• output

• Remark

If it is FoscamIPC, just use start / count
If it is FoscamNVR, the parameters page/logType/channel/startTime/endTime are required, and the log format is chn+starttime+endtime+user+ip+type+ida+ido

FoscamNVR type value definition:

• Example

• 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
}