Range

Function

This API is used to get Thermal > Measurement parameter scale

Request Message

Parameter Description

Table 1

ParameterRangeTypedescription
channel"CH1"…"CHx",
"IP_CH1"…"IP_CHx",
"WIFI_CH1"…"WIFI_CHx"
Channels supported by the device
string arrayIPC can only be used "CH1"。
page_type“ChannelConfig”
“AlarmConfig”
stringData used to distinguish between the channel configuration page and the alarm configuration page

Sample:

POST /API/Thermal/Setup/Measurement/Range HTTP/1.1
{
    "version": "1.0",
    "data":{
        "page_type":"ChannelConfig"
        }

}

Response Message

Parameter Description

Table 2

ParameterRangeTypedescription
channel_infoJson ObjectChannel information see Table 3
page_type"ChannelConfig", "AlarmConfig"stringThe data used to distinguish between the channel configuration page and the alarm configuration page is only needed when setting.
channel_maxintTotal number of channels on the device

Table 3

ParameterRangeTypedescription
CH1Json ObjectJSON see Table 4
...Json Object
IP_CH1Json Object
...Json Object
WIFI_CH1Json Object
...Json Object

Table 4

ParameterRangeTypedescription
status"Offline"
"Online"
stringChannel online status, only for digital channels.
Note: This field does not exist when the channel is online
alarm_out“Local->1”
”Local->x”
“IP_CH1->1”
“IP_CH1->2”
” IP_CHx->1”
” IP_CHx->2”...
The number of channels depends on the performance of the device
arrayAlarm output channel
latch_time"5s","10s","20s","30s"stringAlarm output time Ipc value 5 10 20 30
record_enableboolchannel video switch
post_recording"OFF","5s","10s","20s","30s"stringVideo delay time Ipc value 0 5 10 20 30
send_emailtrue, falseboolSend Email switch
ftp_picture_uploadtrue, falseboolFTP upload switch of channel capture
ftp_video_uploadtrue, falseboolChannel video FTP upload switch
picture_to_cloudtrue, falseboolPicture upload switch
video_to_cloudtrue, falseboolVideo cloud upload switch
light_linkagetrue, falseboolLinkage switch of the white light. When motion is triggered, the linkage triggers the white light
enforcerlight_linkagetrue, falseboolRed and blue light alarm switch
siren_linkagetrue, falseboolsiren alarm switch
http_listeningtrue, falseboolPush switch
switchtrue, falseboolswitch
colorbar_switchtrue, falseboolTemperature color bar switch Switch
display_temp_on_streamtrue, falseboolThe temperature is displayed on the stream switch
display_temp_on_opticaltrue, falseboolThe temperature is displayed on the optical channel switch
display_max_temptrue, falseboolDisplays the maximum temperature switch
display_min_temptrue, falseboolDisplays the minimum temperature switch
display_average_temptrue, falseboolDisplays the average temperature switch
spot_measurementtrue, falseboolClick anywhere in the image to get a temperature reading for a specific location, which takes 5 seconds to display in the preview screen. Default off
display_pos"Near Target","Top Left"stringTemperature display location option
temp_unit"Degree Celsius"
"Degree Fahrenheit"
"Degree Kelvin"
stringTemperature unit option
reflective_tempJson ObjectReflective Temperature value(rangeVaries with temperature units and gain options)
( high gain:
{C:-40~200 F: -40~392 K:233.15~473.15}
low gain:
{ C:-40~600 F: -40~1112 K:233.15~873.15})Json see Table 5
emissivity0.01~ 1doubleemissivity
distance_unit"Meter"
"Feet"
stringMeter and Feet, default Meter
target_distanceJson ObjectTarget Distance unit m、ft Json see Table 6
target_distance0~100doubleTarget Distance unit m
record_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”
arrayVideo alarm output channel
ftp_picture_upload_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”
arrayCapture image FTP upload alarm output channel
ftp_video_upload_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”
arrayVideo FTP upload alarm output channel
picture_cloud_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”
arrayImage upload alarm output channel
video_cloud_channel“CH1”…”CH1x”
“IP_CH1”…” IP_CH1x”
“WIFI_CH1”…”
WIFI_CH1x”
arrayVideo cloud upload alarm output channel
scheduleJSON arraySchedule see Table 7

Table 5

ParameterRangeTypedescription
Degree Celsius[-20,150]double
Degree Fahrenheit[-4,302]double
Degree Kelvin[253,423]double

Table 6

ParameterRangeTypedescription
Meter[0,200]double
Feet[0,656]double

Table 7

ParameterRangeTypedescription
schedule_type“Record”stringtime schedule:Record,AlarmOut,SendEmail
weekJSON arrayweek json see Table 8

Table 8

ParameterRangeTypedescription
daySun,Mon,Tue,Wed
Thu,Fri,Sat
stringMark the day of the week
time0: disables the time range
1: enables the time range
arrayEach array bit identifies half an hour

Sample:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "channel_max": 1,
        "channel_info": {
            "type": "object",
            "items": {"CH2": {
                "type": "object",
                "items": {
                    "status": {
                        "description": "Only offline channel has this variable.",
                        "type": "string",
                        "mode": "r",
                        "items": [
                            "Offline",
                            "Online"
                        ]
                    },
                    "switch": {"type": "bool"},
                    "colorbar_switch": {"type": "bool"},
                    "display_temp_on_stream": {"type": "bool"},
                    "display_temp_on_optical": {"type": "bool"},
                    "display_max_temp": {"type": "bool"},
                    "display_min_temp": {"type": "bool"},
                    "display_average_temp": {"type": "bool"},
                    "display_pos": {
                        "type": "string",
                        "items": [
                            "Near Target",
                            "Top Left"
                        ]
                    },
                    "spot_measurement": {"type": "bool"},
                    "temp_unit": {
                        "type": "string",
                        "items": [
                            "Degree Celsius",
                            "Degree Fahrenheit",
                            "Degree Kelvin"
                        ]
                    },
                    "emissivity": {
                        "type": "double",
                        "mode": "r",
                        "min": 0.01,
                        "max": 1,
                        "default_value": 0.98
                    },
                    "distance_unit": {
                        "type": "string",
                        "items": [
                            "Meter",
                            "Feet"
                        ]
                    },
                    "target_distance": {
                        "type": "object",
                        "items": {
                            "Meter": {
                                "type": "double",
                                "mode": "r",
                                "min": 0,
                                "max": 200,
                                "default_value": 1
                            },
                            "Feet": {
                                "type": "double",
                                "mode": "r",
                                "min": 0,
                                "max": 656,
                                "default_value": 3
                            }
                        }
                    },
                    "reflective_temp": {
                        "type": "object",
                        "items": {
                            "Degree Celsius": {
                                "type": "double",
                                "mode": "r",
                                "min": -20,
                                "max": 150,
                                "default_value": 25
                            },
                            "Degree Fahrenheit": {
                                "type": "double",
                                "mode": "r",
                                "min": -4,
                                "max": 302,
                                "default_value": 77
                            },
                            "Degree Kelvin": {
                                "type": "double",
                                "mode": "r",
                                "min": 253,
                                "max": 423,
                                "default_value": 298
                            }
                        }
                    }
                }
            }}
        }
    }
}

Error Code

See Response message body and general error_code for more information.