Nebula指令集1

描述： Use this function to request the device to start playing video stream with AV JSON control. Please note that "IOTCAV:" should be removed from the control string before sending it.

版本： 1.0

指令集： IOTCAV:videoStreaming

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

AV指令请求例子：

AV指令回复内容：

描述： Use this function to request the device to start playing audio stream with AV JSON control. Please note that "IOTCAV:" should be removed from the control string before sending it.

版本： 1.0

指令集： IOTCAV:audioStreaming

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

AV指令请求例子：

AV指令回复内容：

描述： Use this function to request the device to recieve audio stream from client. Please note that "IOTCAV:" should be removed from the control string before sending it.

版本： 1.0

指令集： IOTCAV:speaker

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

AV指令请求例子：

AV指令回复内容：

描述： Use this function to request the device to start playing video stream with AV JSON control. Please note that "IOTCAV:" should be removed from the control string before sending it.

版本： 1.0

指令集： IOTCAV:playback

请求参数：

Enumeration of ctrl

0 - pause: Device should continue to play video stream after receiving control "play" not "pause"
1 - play
2 - stop

返回值： 200, 400

返回内容： Empty

Profile定义：

AV指令请求例子：

AV指令回复内容：

描述： Use this function to get the currently utilized video format present, please check getCameraCapability for the information of video format presets.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set the current video format present, please check getCameraCapability for the information of video format presets.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Get the brightness value of the video stream.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Set the brightness value of the video stream.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Get the contrast value of the video stream.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Set the contrast value of the video stream.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Setup target could recording url of the device, this function is supported internally by Nebula Device.

版本： 1.2

指令集： cloudRecording

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

Nebula command request example no channel old format：

Nebula command request example no channel：

Nebula command request example with channel：

Nebula指令回复内容：

描述： Use this function to get the currently configured cloud recording endpoint information of the device, which is internally supported by Nebula Device.

版本： 1.2

指令集： cloudRecording

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to enable or disable the cloud recording function of the device, which takes effect based on the configured cloud recording endpoint.

版本： 1.2

指令集： cloudRecording

请求参数：

返回值： 200, 400

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the current running status of the device's cloud recording function.

版本： 1.2

指令集： cloudRecording

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the hardware capability information of the camera device, including supported video format presets and resolution ranges.

版本： 1.0

指令集： videoConfiguration

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to configure the WiFi connection parameters of the device and make the device connect to the specified WiFi hotspot.

版本： 1.1

指令集： wifiConfiguration

请求参数：

返回值： 200, 400, 408, 500

说明： 400=parameter error; 408=connection timeout; 500=connection failed

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the list of WiFi hotspots scannable by the device around.

版本： 1.1

指令集： wifiConfiguration

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the information of the WiFi hotspot currently connected by the device.

版本： 1.1

指令集： wifiConfiguration

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the list of mounted storage devices on the device (such as SD card, internal storage).

版本： 1.0

指令集： storageManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the detailed information of the specified storage device according to the storage device ID.

版本： 1.0

指令集： storageManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to format the specified storage device. Note: Formatting will clear all data on the device.

版本： 1.0

指令集： storageManagement

请求参数：

返回值： 200, 400, 404, 500

说明： 400=parameter error; 404=storage device not found; 500=format failed

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to create a new access credential (username and password) for the device to authenticate user access.

版本： 1.1

指令集： deviceSecurity

请求参数：

返回值： 200, 400, 409

说明： 400=parameter error; 409=identity already exists

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to delete an existing access credential (username) from the device.

版本： 1.1

指令集： deviceSecurity

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error; 404=identity does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the list of all existing access identities (usernames) and their corresponding permission levels on the device.

版本： 1.1

指令集： deviceSecurity

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the basic hardware and software information of the TUTK device.

版本： 1.0

指令集： deviceManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set a custom display name for the TUTK device.

版本： 1.0

指令集： deviceManagement

请求参数：

返回值： 200, 400

说明： 400=parameter error (invalid name length or format)

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the current custom display name of the TUTK device.

版本： 1.0

指令集： deviceManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to get the current battery level and charging status of the battery-powered TUTK device.

版本： 1.1

指令集： deviceManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to add a push notification service configuration to the device (support FCM, APNs, etc.).

版本： 1.2

指令集： pushNotification

请求参数：

返回值： 200, 400, 409

说明： 400=parameter error; 409=serviceId already exists

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to delete an existing push notification service configuration from the device by serviceId.

版本： 1.2

指令集： pushNotification

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error; 404=serviceId does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the list of all existing push notification service configurations on the device.

版本： 1.2

指令集： pushNotification

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to trigger the device to perform firmware upgrade (need to pre-configure firmware source via writeFirmware).

版本： 1.2

指令集： deviceMaintenance

请求参数：

返回值： 200, 400, 403, 409

说明： 400=parameter error; 403=no valid firmware found; 409=upgrade is already in progress

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the current progress and status of the device firmware upgrade.

版本： 1.2

指令集： deviceMaintenance

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to upload and write firmware binary data or firmware download URL to the device (preparation for upgrade).

版本： 1.2

指令集： deviceMaintenance

请求参数：

返回值： 200, 400, 413

说明： 400=parameter error (missing url/binary for corresponding source); 413=firmware file is too large

返回内容： Empty

Profile定义：

Nebula指令请求（URL方式）：

Nebula指令回复内容：

描述： Use this function to get all current system configuration settings of the device (including video, network, security, etc.).

版本： 1.2

指令集： deviceManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to control the pan (horizontal) and tilt (vertical) movement of the PTZ camera by step distance.

版本： 1.1

指令集： cameraControl

请求参数：

返回值： 200, 400, 405

说明： 400=parameter error (step out of range); 405=device does not support PTZ function

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the historical event list of the device (e.g. motion detection, alarm, etc.) by time range.

版本： 1.2

指令集： eventManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to initiate a WebRTC connection between the client and the device for real-time media streaming.

版本： 1.2

指令集： webRtcManagement

请求参数：

返回值： 200, 400, 405, 409

说明： 400=parameter error; 405=device does not support WebRTC; 409=WebRTC session already exists

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to terminate an existing WebRTC connection between the client and the device.

版本： 1.2

指令集： webRtcManagement

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error; 404=specified WebRTC session does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to exchange SDP (Session Description Protocol) information between client and device for WebRTC connection establishment.

版本： 1.2

指令集： webRtcManagement

请求参数：

返回内容：

返回值： 200, 400, 404

说明： 400=parameter error; 404=specified WebRTC session does not exist

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to initiate multiple WebRTC media streams (main stream + sub stream) between client and device simultaneously.

版本： 1.2

指令集： webRtcManagement

请求参数：

返回值： 200, 400, 405, 409

说明： 400=parameter error; 405=device does not support multi-stream WebRTC; 409=multi-stream session already exists

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to terminate an existing multi-stream WebRTC connection (main stream + sub stream) between the client and the device.

版本： 1.2

指令集： webRtcManagement

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error; 404=specified multi-stream WebRTC session does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the live stream capabilities of the device (including supported stream types, resolutions, and protocols).

版本： 1.2

指令集： liveStreamManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to initiate a live stream broadcast from the device to the specified remote server (e.g. RTMP server).

版本： 1.2

指令集： liveStreamManagement

请求参数：

返回值： 200, 400, 405, 409

说明： 400=parameter error; 405=device does not support live stream; 409=live stream is already in progress

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the playback capabilities of the device (including supported playback formats, time ranges, and storage sources).

版本： 1.2

指令集： playbackManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to initiate historical video playback from the specified storage source of the device.

版本： 1.2

指令集： playbackManagement

请求参数：

返回值： 200, 400, 404, 409

说明： 400=parameter error; 404=no video found in the specified time range; 409=playback is already in progress

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set the event types that trigger local or cloud recording on the device.

版本： 1.2

指令集： recordingManagement

请求参数：

返回值： 200, 400

说明： 400=parameter error (invalid event type or recording type)

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the current event recording trigger settings of the device.

版本： 1.2

指令集： recordingManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to enable or disable all local recording functions (event recording + continuous recording) of the device.

版本： 1.2

指令集： recordingManagement

请求参数：

返回值： 200, 400, 405

说明： 400=parameter error; 405=device does not support local recording

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query whether all local recording functions of the device are currently enabled.

版本： 1.2

指令集： recordingManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set the schedule for continuous automatic recording of the device (supports different schedules for different weekdays).

版本： 1.2

指令集： recordingManagement

请求参数：

返回值： 200, 400

说明： 400=parameter error (invalid weekday or time range)

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the current continuous recording schedule settings of the device.

版本： 1.2

指令集： recordingManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to enable or disable the continuous schedule recording function of the device.

版本： 1.2

指令集： recordingManagement

请求参数：

返回值： 200, 400, 405

说明： 400=parameter error; 405=device does not support continuous schedule recording

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query whether the continuous schedule recording function of the device is currently enabled.

版本： 1.2

指令集： recordingManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set the event types that trigger push notifications on the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回值： 200, 400

说明： 400=parameter error (invalid event type)

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the current push notification trigger settings of the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to enable or disable the push notification function for a single specific event type of the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error; 404=specified event type does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to batch enable or disable push notification functions for multiple event types of the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回值： 200, 400

说明： 400=parameter error (invalid event type in list)

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to batch query the push notification status of multiple event types of the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the push notification status of a single specific event type of the device.

版本： 1.2

指令集： notificationManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the detailed information of a specific channel of the device (for NVR/DVR multi-channel devices).

版本： 1.2

指令集： channelManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to set a custom name for a specific channel of the device (for NVR/DVR multi-channel devices).

版本： 1.2

指令集： channelManagement

请求参数：

返回值： 200, 400, 404

说明： 400=parameter error (invalid channel name length); 404=specified channel does not exist

返回内容： Empty

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the custom name of a specific channel of the device (for NVR/DVR multi-channel devices).

版本： 1.2

指令集： channelManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to batch query the custom names of all supported channels of the device (for NVR/DVR multi-channel devices).

版本： 1.2

指令集： channelManagement

请求参数： Empty

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the date list that contains recorded events of the device (for quick calendar-based event navigation).

版本： 1.2

指令集： eventManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：

描述： Use this function to query the latest N pieces of event records of the device (batch query by specified event count).

版本： 1.2

指令集： eventManagement

请求参数：

返回内容：

Profile定义：

Nebula指令请求：

Nebula指令回复内容：