Villa 服务器参数配置 - housekeeper-software/soft GitHub Wiki

简介

服务器配置包含全局配置,家庭配置,设备配置三个层级
全局配置:影响所有家庭,比如webrtc通道,呼叫,移动侦测配置等
家庭配置:只影响指定家庭,比如人脸,二维码,NFC,电话号码
设备配置:目前只有三个音量可以调,只影响指定序列号的设备

global.json

{
	"content": {
		"common": {
			"videoRecordDuration": 60, #移动侦测最长录制时长,1分钟
			"miniMotionDuration": 10, #移动侦测最短录制时长,10秒,低于10秒将被放弃
			"videoRecordWithFace":true, #录制时需要检测到人脸,没有抓到人脸放弃
			"videoRecordWithAudio":false, #录制时是否包含声音,目前没有配置
			"snapshotScale": 0.5, #快照的缩放比例,
			"snapshotQuality":90, #快照压缩质量因子,就是jpeg压缩质量
			"videoScale": 0.5, #移动侦测视频的缩放因子
			"enableQRCode": true, #是否使能软件二维码识别
			"enableUserEndCall":false #是否允许按键终止会话,目前不允许
		},
		"intercom": {
			"openDoorDTMF": "*#", #配置电话开门数字键
			"maxCallPhone": 2, #至多可以呼叫几个电话
			"declineTerminate": true, #只要一个设备结束会话,整个会话结束,否则,其他会话继续等待
			"maxRingingTime": 30, #最长振铃时间(秒)
			"maxConnectTime": 120, #最长连接时间(秒),用于控制网络异常
			"maxEstablishTime": 10, #最长呼叫建立等待时间,用于控制网络异常
			"maxInviteTime": 5, #最长邀请等待时间,对方不在线,5秒之后对此设备的呼叫自动结束
			"callMobileMaxDelay": 30, #30秒之后,自动向移动端推送呼叫请求

			"openDoorCmd":"open door", #sip版本专用
			"sessionKey":"session",#sip版本专用
			"maxMonitorTime":120,#sip版本专用
			"maxMonitorSession":6,#sip版本专用

			"signalingChannel": [ #webrtc通道信息,目前两个通道
				{
					"name": "tablet",
					"priority": 1,
					"connection": {
						"addr": "保密"
						"path": "/保密",
						"security": "AllowSelfSigned",
						"heartbeat": "20,60"
					}
				},
				{
					"name": "mobile",
					"priority": 1,
					"connection": {
						"addr": "保密",
						"port": 13443,
						"path": "/保密",
						"security": "AllowSelfSigned",
						"heartbeat": "20,60"
					}
				}
			],

			"callSequence":[ #sip版本专用
				{
					"router":"auto",
					"delay":0,
					"maxRingTime":30,
					"maxConnectTime":120
				},
				{
					"router":"server",
					"delay":0,
					"maxRingTime":30,
					"maxConnectTime":120
				},
				{
					"router":"cloud",
					"delay":30,
					"maxRingTime":30,
					"maxConnectTime":120
				},
				{
					"router":"telephone",
					"delay":45,
					"maxRingTime":60,
					"maxConnectTime":120
				}
			],
			"callRouter":[ #sip版本专用
				{
					"name":"auto",
					"type":1,
					"proxy":"",
					"stun":"",
					"dialPrefix":""
				},
				{
					"name":"server",
					"type":2,
					"proxy":"保密",
					"stun":"保密",
					"dialPrefix":""
				},
				{
					"name":"cloud",
					"type":3,
					"proxy":"保密",
					"stun":"保密",
					"prefix":"",
					"dialPrefix":""
				},
				{
					"name":"telephone",
					"type":4,
					"proxy":"保密",
					"stun":"",
					"dialPrefix":"保密"
				}
			]
		}
	}
}

family.json

家庭配置
{
   "content":{
      "access":{
         "card":[
            "IC卡号"
         ],
         "face":[ #人脸
            {
               "hash":"保密",
               "id":"保密",
               "name":"zz",
               "resId":"保密",
               "feature":"base64", //optional
               "expired":"UTC"  //optional
            },
            {
               "hash":"保密",
               "id":"保密",
               "name":"by",
               "resId":"保密",
               "feature":"base64", //optional
               "expired":"UTC"  //optional
            },
            {
               "hash":"保密",
               "id":"保密",
               "name":"ww",
               "resId":"保密",
               "feature":"base64", //optional
               "expired":"UTC"  //optional
            },
            {
               "hash":"保密",
               "id":"保密",
               "name":"yyy",
               "resId":"保密",
               "feature":"base64", //optional
               "expired":"UTC"  //optional
            }
         ]
      },
      "property":{ #家庭个性化配置
         "closeDoorDelay":0, #目前无用
         "enableMotionDetection":true, #是否使能移动侦测
         "enableOpendoorReport":true #是否使能开门报告
      },
      "telephone":[
         "xxxx" #电话号码,用于拨打电话
      ]
   }
}

device.json

{
	"content":{
		"name":"",
		"volume":{
			"voipVolume":100, #通话音量
			"mediaVolume":100, #音效音量
			"buttonVolume":100 #按键音量,目前无用
		}
	}
}

登录返回

{
   "code":200,
   "message":"Success",
   "data":{
      "name":"dev",#家庭名称
      "serverTime":"2023-10-31T00:11:48.764Z", #服务器时间,用于校准本地时间
      "mqtt":{ #mqtt服务器和账号
         "host":"保密",
         "userName":"保密",
         "password":"保密"
      },
      "sip":[ #sip版本专用
         {
            "router":"server",
            "userId":"保密",
            "password":"保密"
         }
      ]
   }
}