IPC基础产品方案配置说明

本文将对涂鸦 IPC 方案标准功能 DP（Data point,）进行详细说明，开发者可根据实际产品需求自行添加功能。

创建产品

在涂鸦开发者平台上，选择创建产品 > 安防监控 > 智能摄像机 > 自定义方案，完善产品信息后产品创建完成， 平台会自动生成 PID 信息。

创建产品的详细步骤请参考 选品类创建产品。

添加功能

此为涂鸦 IPC 方案提供的标准功能，开发者可根据产品的实际功能选择，功能开启后对应的图标将在 APP 操作页面和设备设置页面展示。

控制面板功能

隐私模式

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 105 隐私模式	basic_private	可下发可上报（rw）	布尔型（Bool）	-	-

WDR

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 107 宽动态范围模式	basic_wdr	可下发可上报（rw）	布尔型（Bool）	-	true：则打开宽动态范围模式 false：则关闭宽动态范围

夜视模式

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 124 夜间模式	nightvision_mode	可下发可上报（rw）	枚举型（Enum）	枚举值: auto, ir_mode, color_mode	智能模式、红外模式、彩光模式

红外夜视

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 108 红外夜视	basic_nightvision	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2	0：自动 1：关 2：开

微光全彩

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 180 微光全彩开关	basic_shimmer	可下发可上报（rw）	布尔型（Bool）	-	-

抗闪烁

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 188 抗闪烁	basic_anti_flicker	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2	0：关闭功能 1：50Hz 2：60Hz

设备音量

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 160 设备音量控制	basic_device_volume	可下发可上报（rw）	数值型（Value）	数值范围: 1~100, 间距: 1, 倍数: 0, 单位: %	控制设备端播放对讲声音的音量

移动追踪

DP 定义如下：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 161 移动追踪开关	motion_tracking	可下发可上报（rw）	布尔型（Bool）	-	-

移动侦测

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 115 检测到移动	movement_detect_pic	只上报（ro）	透传型（Raw）	该功能实现请参考 SDK ------------------------- {“dp_id”,“bucket;object;key”}/{“dp_id”,“bucket;object;”}bucket:根文件夹；objcet:文件路径；key:加密	-
DP 134 移动报警开关	motion_switch	可下发可上报（rw）	布尔型（Bool）	-	-

注意：DP 134 控制移动侦测开关，当设备检测到移动后通过 SDK 接口及 DP 115 上报移动侦测图片，用户 App 能及时收到推送消息，支持在 App 消息中心查看告警消息，设备消息推送中需配置配置告警事件，DP 115 也可用 DP 185 替代。

PIR 设置

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 115 检测到移动	movement_detect_pic	只上报（ro）	透传型（Raw）	该功能实现请参考 SDK ------------------------- {“dp_id”,“bucket;object;key”}/{“dp_id”,“bucket;object;”}bucket:根文件夹；objcet:文件路径；key:加密	-
DP 152 PIR 开关及灵敏度	pir_switch	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2, 3	-

注意：DP 152 用于带 PIR 的设备进行移动侦测告警，通常用于低功耗门铃、低功耗电池摄像机、摄像头灯等 PIR 功能的设备，当设备 PIR 检测到移动后通过 SDK 接口及 DP 115 上报移动侦测图片，用户 App 能及时收到推送消息，支持在 App 消息中心查看告警消息，设备消息推送中需配置配置告警事件，DP 115 也可用 DP 185 替代。

PIR

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 181 PIR 1 开关	flight_pir_a	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示
DP 182 PIR 2 开关	flight_pir_b	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示
DP 183 PIR 3 开关	flight_pir_c	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示
DP 184 PIR 灵敏度	pir_sensitivity	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2 分别对应低，中，高	PID 中添加此 DP 点即可展示

选择 PIR 灯开关 DP ID:181（标识符 flight_pir_a）后，控制面板将出现 PIR 图标，PIR 的数量根据设备实际情况进行选择，可以选择单 PIR 灯，双 PIR 灯和三 PIR 灯（增加对应的 PIR 开关 DP 点即可）；增加 PIR 灵敏度 DP ID：184 之后，界面出现灵敏度的设置；
点击定时，可以设置具体的 PIR 的开启或者关闭，定时的名称，定时执行时间，是否每天重复等

声音检测

DP 点定义如下所示：：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 139 声音侦测报警开关	decibel_switch	可下发可上报（rw）	布尔型（Bool）	-	-
DP 185 告警消息上报	alarm_message	只上报（ro）	透传型（Raw）	-	实现方式参考嵌入式 SDK 使用文档

注意：DP 139 控制声音侦测开关，当设备检测到声音超过阈值后可通过接口上报事件，用户 App 能及时收到推送消息，支持在 App 消息中心查看告警消息，设备消息推送中需配置配置告警事件，如需上报图片，需通过 SDK 内部接口进行上报，并联系涂鸦项目经理配置 DP 185 消息告警类型。

巡航

DP 点定义如下所示：：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 174 巡航开关	cruise_switch	可下发可上报（rw）	布尔型（Bool）	-	-
DP 175 巡航模式	cruise_mode	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1	0：全景巡航 1：预设点巡航
DP 176 巡航时间模式	cruise_time_mode	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1	0：全天巡航 1：自定义巡航
DP 177 巡航时间	cruise_time	可下发可上报（rw）	字符型（String）	-	数据格式： t_start:开始时间 t_end:结束时间 多个时间由";"分隔
DP 178 收藏点	memory_point_set	可下发可上报（rw）	字符型（String）	-	数据格式： { “type”: 1, //type 表示操作类型 1 添加收藏点，2 删除收藏点 ，3 跳转到具体的收藏点。 “data”: { “name”: “xxx” // 收藏点名称，添加的时候传 “seq”: 1, //删除以及添加的时候传入 “pan”: 3456, //删除以及添加的时候传入 “tilt”: 234, //删除以及添加的时候传入 “zoom”: 899 //删除以及添加的时候传入 } } 返回数据格式： { “type”: 1, “data”: { “error”: 10001 //(0 成功，10001 个数超限 ， 10002 巡航中 } }
DP 179 巡航状态	cruise_status	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2	0：全景巡航中 1：收藏点巡航 2：非巡航模式

警笛

DP 点定义如下所示：：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 159 警笛开关	siren_switch	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示

添加 DP ID：159 后，控制面板会出现警笛开关控制图标，如果设备支持设置警笛声音的大小和响声的时长，可添加以下两个 DP 点：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP194 蜂鸣器时长	ipc_siren_duration	可下发可上报（rw）	数值型（Value）	数值范围: 10~600, 间距: 10, 倍数: 0, 单位: s	PID 中添加此 DP 点即可展示
DP195 蜂鸣器音量	ipc_siren_volume	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %	PID 中添加此 DP 点即可展示

灯

DP 点定义如下所示：：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP138 灯-开关	floodlight_switch	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示
DP158 灯光亮度	floodlight_lightness	可下发可上报（rw）	数值型（Value）	数值范围: 1~100, 间距: 1, 倍数: 0, 单位:	PID 中添加此 DP 点即可展示
DP173 亮灯警示时长设置	flight_warn_time	可下发可上报（rw）	数值型（Value）	数值范围: 1-3600, 间距: 1, 倍数: 0, 单位:	PID 中添加此 DP 点即可展示

添加 DP ID：138 后，控制面板出现 灯 图标，点击进入可开关灯和设置定时，添加 DP ID：158，控制面板便会出现灯光亮度和色温的控制，增加 DP ID: 173 会出现亮灯警示时长的设置，即延时亮灯设置

灯控制还支持模式选择，需添加自定义 DP 点开启，详见摄像头灯方案配置说明。

锁

DP 点定义如下所示：：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 148 锁-开关	accessory_lock	可下发可上报（rw）	布尔型（Bool）	-	PID 中添加此 DP 点即可展示

方向

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 116 停止转动	ptz_stop	可下发可上报（rw）	布尔型（Bool）	-	-
DP 119 云台转动	ptz_control	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9	direction：方向，共 8 个 0：上 1：右上 2：右 3：右下 4：下 5：左下 6：左 7：左上

收藏点

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 178 收藏点	memory_point_set	可下发可上报（rw）	字符型（String）	-	数据格式： { “type”: 1, //type 表示操作类型 1 添加收藏点，2 删除收藏点 ，3 跳转到具体的收藏点。 “data”: { “name”: “xxx” // 收藏点名称，添加的时候传 “seq”: 1, //删除以及添加的时候传入 “pan”: 3456, //删除以及添加的时候传入 “tilt”: 234, //删除以及添加的时候传入 “zoom”: 899 //删除以及添加的时候传入 } } 返回数据格式： { “type”: 1, “data”: { “error”: 10001 //(0 成功，10001 个数超限 ， 10002 巡航中 } }
190 收藏点联动	ipc_preset_action	只下发（wr）	枚举型（Enum）	枚举值: 1, 2, 3, 4, 5, 6	用于创建摇头机收藏点联动，需配合涂鸦开发者平台上的配置。 枚举值 1-6 对应收藏点 1-6。

设置菜单

基本功能设置

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 101 状态指示灯	basic_indicator	可下发可上报（rw）	布尔型（Bool）	-	设备设置页面-基本功能设置 设备指示灯是否打开，true 打开，false 关闭
DP 102 画面翻转方式	ipc_flip	可下发可上报（rw）	枚举型（Enum）	枚举值: flip_none, flip_horizontal_mirror, flip_vertical_mirror, flip_rotate_180	新画面翻转 DP，可实现更多种类的翻转方式。无需配置 103
DP 103 画面翻转	basic_flip	可下发可上报（rw）	布尔型（Bool）	-	设备设置页面-基本功能设置 使直播画面垂直翻转，true 打开翻转，false 关闭翻转
DP 104 时间水印	basic_osd	可下发可上报（rw）	布尔型（Bool）	-	设备设置页面-基本功能设置时间水印功能开关，true 打开水印，false 关闭水印
DP 180 微光全彩开关	basic_shimmer	可下发可上报（rw）	布尔型（Bool）	-	-
DP 107 宽动态范围模式	basic_wdr	可下发可上报（rw）	布尔型（Bool）	-	true 则打开宽动态范围模式，false 则关闭宽动态范围
DP 188 抗闪烁	basic_anti_flicker	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2	0：关闭功能 1：50Hz 2：60Hz
DP 132 云台校准	ptz_calibration	可下发可上报（rw）	布尔型（Bool）	-	摄像机校准
DP 153 电池锁开关	wireless_batterylock	可下发可上报（rw）	布尔型（Bool）	-	true 上锁，false 解锁

画面调节

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP123 锐度调节	ipc_sharp	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %	用于调整画面锐度
DP 192 画面对比度	ipc_contrast	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %
DP 193 画面亮度	ipc_bright	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %

侦测报警设置

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 134 移动报警开关	motion_switch	可下发可上报（rw）	布尔型（Bool）	-	-
DP 106 移动侦测灵敏度	motion_sensitivity	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1, 2	0-2，灵敏度依次增加；仅为灵敏度，0 并不是关闭移动侦测报警；规定 0 为低灵敏度，1 为中灵敏度，2 为高灵敏度。
DP 115 检测到移动	movement_detect_pic	只上报（ro）	透传型（Raw）	该功能实现请参考 SDK ------------------------- {“dp_id”,“bucket;object;key”}/{“dp_id”,“bucket;object;”}bucket:根文件夹；objcet:文件路径；key:加密	-
DP 168 报警区域开关	motion_area_switch	可下发可上报（rw）	布尔型（Bool）	-	-
DP 169 报警区域	motion_area	可下发可上报（rw）	字符型（String）	-	-
DP 170 人形过滤	humanoid_filter	可下发可上报（rw）	布尔型（Bool）	-	-
DP 161 移动追踪开关	motion_tracking	可下发可上报（rw）	布尔型（Bool）	-	-
DP 187 宠物检测开关	pet_detection	可下发可上报（rw）	布尔型（Bool）	-	-
DP 198 智能对象画框	ipc_object_outline	可下发可上报（rw）	布尔型（Bool）	-	-
DP 139 声音侦测报警开关	decibel_switch	可下发可上报（rw）	布尔型（Bool）	-	-
DP 140 声音侦测灵敏度	decibel_sensitivity	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1	0 代表低灵敏度；1 代表高灵敏度
DP 141 检测到声音	decibel_upload	只上报（ro）	字符型（String）	-	用于报警消息推送，app 上会显示通知
DP 167 哭声侦测开关	cry_detection_switch	可下发可上报（rw）	布尔型（Bool）	-	true 开启哭声侦测，false 关闭哭声侦测
DP 133 报警间歇	motion_interval	可下发可上报（rw）	枚举型（Enum）	枚举值: 1, 3, 5	报警间歇，单位为分钟。 枚举值，客户端会根据枚举值的数值显示对应的分钟选项
DP 120 联动蜂鸣器	ipc_auto_siren	可下发可上报（rw）	布尔型（Bool）	-	-

蜂鸣器调节

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 125 报警音	siren_sound	可下发可上报（rw）	枚举型（Enum）	枚举值: item_1, item_2, item_3, item_4, item_5, item_6, item_7, item_8, item_9, item_10	-
DP 194 蜂鸣器时长	ipc_siren_duration	可下发可上报（rw）	数值型（Value）	数值范围: 10~600, 间距: 10, 倍数: 0, 单位: s	-
DP 195 蜂鸣器音量	ipc_siren_volume	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %	-

预设点

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 199 预设点设置	ipc_preset_set	可下发可上报（rw）	枚举型（Enum）	枚举值: 1, 2, 3, 4	-

存储设置

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 109 获取存储卡容量	sd_storge	只上报（ro）	字符型（String）	-	单位改为 kb :---- 3503775744
DP 110 存储卡状态	sd_status	只上报（ro）	数值型（Value）	数值范围: 1-5, 间距: 1, 倍数: 0, 单位:	status：sd 卡状态，1-正常，2-异常，3-空间不足，4-正在格式化，5-无 SD 卡；
DP 111 存储卡格式化	sd_format	可下发可上报（rw）	布尔型（Bool）	-	-
DP 112 卸载存储卡	sd_umount	可下发可上报（rw）	布尔型（Bool）	-	true 为存储卡已退出，false 为存储卡未退出
DP 121 循环录像	record_loop	可下发可上报（rw）	布尔型（Bool）	-	开启与关闭 SD 卡循环录制
DP 150 SD 卡录像开关	record_switch	可下发可上报（rw）	布尔型（Bool）	-	设备设置页面-存储卡设置 SD 卡录像开关，true 为打开，false 为关闭 功能关闭时，不录像到 SD 卡
DP 151 录像模式	record_mode	可下发可上报（rw）	枚举型（Enum）	枚举值: 1, 2	设备设置页面-存储卡设置 SD 卡录像模式选择，1 为事件录像（检测到移动再录像到 SD 卡），2 为连续录像
DP 197 SD 卡无声录制	ipc_mute_record	可下发可上报（rw）	布尔型（Bool）	-	-
DP 117 格式化状态	sd_format_state	只上报（ro）	数值型（Value）	数值范围: -20000-200000, 间距: 1, 倍数: 0, 单位:	返回错误码： -2000：SD 卡正在格式化 -2001：SD 卡格式化异常 -2002：无 SD 卡 -2003：SD 卡错误 //正数为格式化进度

工作模式

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 189 工作模式	ipc_work_mode	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1	该 DP 点用于低功耗 IPC 工作模式选择 0 低功耗模式 1 连续工作模式

电源管理

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 145 电量	wireless_electricity	只上报（ro）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位: %	-
DP 146 供电方式	wireless_powermode	只上报（ro）	枚举型（Enum）	枚举值: 0, 1	设备主动上报当前供电状态，供电状态发生变化时上报。0 为电池供电状态，1 为插电供电状态（或电池充电状态）
DP 147 低电量报警	wireless_lowpower	可下发可上报（rw）	数值型（Value）	数值范围: 10-50, 间距: 1, 倍数: 0, 单位:	若电量百分比低于该阈值，则触发报警；App 端设置，设备本身无须关心该 dp 点。

铃铛设置

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 155 铃铛配对	doorbell_ring_exist	可下发可上报（rw）	枚举型（Enum）	枚举值: 0, 1	0：为没有铃铛 1：为铃铛配对成功 开始配对时，App 下发 1，设备收到后回复配对结果是 1 还是 0 解绑时，App 下发 0，设备收到后回复解绑结果是 1 还是 0
DP 156 铃声	chime_ring_tune	可下发可上报（rw）	枚举型（Enum）	枚举值: 1, 2, 3, 4	-
DP 166 响铃时长	chime_time	可下发可上报（rw）	数值型（Value）	数值范围: 5-30, 间距: 1, 倍数: 0, 单位: s	-
DP 157 铃声音量	chime_ring_volume	可下发可上报（rw）	数值型（Value）	数值范围: 0~100, 间距: 1, 倍数: 0, 单位:	设置铃铛的音量，0~100

重启设备

DP 点定义如下所示：

功能点名称	标识符	数据传输类型	数据类型	功能点属性	备注
DP 162 设备重启	device_restart	可下发可上报（rw）	布尔型（Bool）	-	无参数，页面操作为按钮类型，用户点击远程重启，直接发送 ture 的命令。

面板配置

在 设备面板 步骤中选择 IPC 通用面板 (App 最低版本 3.17.0)

硬件开发

涂鸦 IPC 方案使用涂鸦 IPC SDK 方式对接，流程如下：

1. 根据硬件平台交叉编译工具名称确认是否已有 SDK，如果没有请联系涂鸦项目经理提供。
2. 按照 IPC SDK 开发手册 进行对接。

设备消息推送设置

设备消息推送是产品的告知提醒，您可以自定义产品的告警条件，实时监控产品状态。运行产品时，如果某项功能的值超出常规状态，或者您需要通知用户某些实时信息时，即可第一时间将消息触达用户，保障产品正常运行。

开发者平台操作页面如下图所示：

注意：开发者账号须为企业版或旗舰版才支持配置设备消息推送。

这里提供参考 PID 的消息推送配置，开发者也可根据自己的实际需求进行配置并匹配好固件，消息推送配置好后需联系涂鸦项目经理进行审核后才可开启，操作说明。

移动侦测：

快速创建产品

以下是 OEM PID 链接，点击可快速在您的 IoT 账号下复制示例 PID 的配置。
全功能机
卡片机
摇头机