The Alarm Menu :: Actions
- The Alarm Menu :: Actions
- param.cgi?cmd=getalarmattr
- param.cgi?cmd=getmuteattr
- param.cgi?cmd=setmutealarm
- param.cgi?cmd=getmutealarm
- param.cgi?cmd=getaudioalarmattr
- param.cgi?cmd=getpirattr
- param.cgi?cmd=getpirnightmode
- param.cgi?cmd=switchrelay
- param.cgi?cmd=getsdaction
- param.cgi?cmd=getftpaction
- param.cgi?cmd=getftpactionattr
- param.cgi?cmd=getsdactionattr
- param.cgi?cmd=getioattr
- param.cgi?cmd=getcloudaction
- param.cgi?cmd=getrelayaction
- param.cgi?cmd=getalarmrecattr
- param.cgi?cmd=getmaaction
- param.cgi?cmd=getmaactionattr
- param.cgi?cmd=getaudioaction
- param.cgi?cmd=playalarmsound
- param.cgi?cmd=getmanualsoundattr
- param.cgi?cmd=stopalarmsound
- param.cgi?cmd=getrecordstatus
- param.cgi?cmd=getalarmsnapattr
- param.cgi?cmd=getodattr
- param.cgi?cmd=getodthresh
- param.cgi?cmd=getuiodattr
- param.cgi?cmd=pollobjects
- param.cgi?cmd=insu\&-arg=70467840/1
- Debugging
- param.cgi?cmd=getrelaytimeattr
param.cgi?cmd=getalarmattr
Set Motion Detection
armed
: Disable alarm completly by ignoring all alarm triggers [0, 1]linkpir
: Link (AND) the PIR motion sensor with the internal motion detection [0, 1]linkpirareas
: By default iflinkpir
is activated all areas will be coupled with the camera's PIR sensor. The areas are assigned numbers according to the arabic number deduction of the third mantra in the sacred scrolls of Kuvah'magh as referenced in the Paq'bath book of honor. The number0
means that all areas are linked. To link area 1 with the PIR sensor add 1. To link area 2 add 2. For area 3 add 4 and for area 4 add 8. The number5
stands for areas one and two.8
is area 4 and 11 stands for areas 1,2 and 4. [0 - 255]linkio
: Link (AND) the alarm input with the internal alarm [0, 1]linkperif
: Link (AND) PIR with IO [0, 1]linkiopir
: Link (AND) internal motion detection with PIR and IO [0, 1]linkperson
: Link (AND) link with person detection [0, 1]linkvehicle
: Link (AND) link with car detection [0, 1]linkanimal
: Link (AND) link with animal detection [0, 1]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getalarmattr
cmd="getalarmattr";
armed="1";
linkpir="1";
linkpirareas="0";
linkio="0";
linkperson="0";
linkvehicle="0";
linkanimal="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getalarmattr&user=admin&pwd=instar
cmd="getalarmattr";
armed="1";
linkpir="1";
linkpirareas="0";
linkio="0";
linkperson="0";
linkvehicle="0";
linkanimal="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setalarmattr&linkpir=1
cmd="setalarmattr";
response="200";
SET: http://192.168.2.168/param.cgi?cmd=setalarmattr&armed=0&user=admin&pwd=instar
cmd="setalarmattr";
response="200";
param.cgi?cmd=getmuteattr
Configure the Default Alarm Mute Interval
interval
: Set the default interval you want to mute the alarm between 1s and 12hrs. Set it to0
to manually unmute your camera alarm. The alarm is then muted withcmd=setmutealarm
(s. below). [0, 43200]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getmuteattr
cmd="getmuteattr";
interval="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getmuteattr&user=admin&pwd=instar
cmd="getmuteattr";
interval="60";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setmuteattr&interval=60
cmd="setmuteattr";
response="200";
param.cgi?cmd=setmutealarm
Trigger the Alarm Mute Function
interval
: Optional - Set the interval you want to mute the alarm between 1s and 12hrs. Set it to0
to manually unmute your camera alarm. If the interval is omitted the default interval (seecmd=getmuteattr
above) is used. [0, 43200]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=setmutealarm&interval=60
cmd="setmutealarm";
response="200";
param.cgi?cmd=getmutealarm
Check Alarm Mute State
active
: The alarm is muted1
or not muted0
[0,1]interval
: Interval that the alarm is muted between 1s and 12hrs. The interval is0
when the mute function is inactive [0, 43200].
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getmutealarm
cmd="getmutealarm";
active="1";
interval="97";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getmutealarm&user=admin&pwd=instar
cmd="getmutealarm";
active="0";
interval="0";
response="200";
param.cgi?cmd=getaudioalarmattr
Set Audio Detection Parameter
enable
: De/Activate Audio Detection [0, 1]threshold
: Sensitivity [1 - 10]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getaudioalarmattr
cmd="getaudioalarmattr";
enable="0";
threshold="5";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getaudioalarmattr&user=admin&pwd=instar
cmd="getaudioalarmattr";
enable="1";
threshold="60";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setaudioalarmattr&enable=1
cmd="setaudioalarmattr";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setaudioalarmattr&enable=0&threshold=10
cmd="setaudioalarmattr";
response="200";
param.cgi?cmd=getpirattr
Set Passive Infrared Motion Detection Sensor Parameter
enable
: De/Activate PIR Sensor [0, 1]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getpirattr
cmd="getpirattr";
enable="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getpirattr&user=admin&pwd=instar
cmd="getpirattr";
enable="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setpirattr&enable=0
cmd="setpirattr";
response="200";
param.cgi?cmd=getpirnightmode
enable
: Only activate IR LEDs when the PIR Sensor is triggered [0,1]interval
: Period that the IR LEDs will be active. This time-window will be reset by a new trigger event [0,3600]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getpirnightmode
cmd="getpirnightmode";
enable="0";
interval="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getpirnightmode&user=admin&pwd=instar
cmd="getpirnightmode";
enable="0";
interval="60";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setpirnightmode&enable=1
cmd="setpirnightattr";
response="200";
param.cgi?cmd=switchrelay
Switch the Alarm Output Relay
state
: [0]: NC (normally closed), [1]: NO (normally open)
Example
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=switchrelay&state=0
cmd="setrelayattr";
response="200";
param.cgi?cmd=getsdaction
Set SD Storage Parameter
Recording options on SD card:
enable
: De/Activate alarm recording [0, 1]interval
: Recording interval / Cooldown time [1 - 3600] stype
:rec
,snap
,timedsnap
rec
: Alarm video recordingsnap
: Alarm snapshot recordingtimedsnap
: Manual snapshot recording
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getsdaction
cmd="getsdaction";
enable['snap']="0";
interval['snap']="120";
enable['timersnap']="0";
interval['timersnap']="120";
enable['rec']="0";
interval['rec']="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getsdaction&type=rec&user=admin&pwd=instar
cmd="getsdaction";
enable="0";
interval="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setsdaction&type=snap&enable=0&interval=60
cmd="setsdaction";
response="200";
param.cgi?cmd=getftpaction
Set FTP Storage Parameter
Recording options on FTP server:
enable
: Enable / Disables specified upload action to the FTP server [0, 1]interval
: Cooldown time between Uploads [1 - 3600] stype
:rec
,snap
,timersnap
rec
: Alarm video recordingsnap
: Alarm snapshot recordingtimersnap
: Planned snapshot recording
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getftpaction
cmd="getftpaction";
enable['rec']="0";
interval['rec']="0";
enable['snap']="0";
interval['snap']="15";
enable['timersnap']="0";
interval['timersnap']="820";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getftpaction&type=snap&user=admin&pwd=instar
cmd="getftpaction";
enable="0";
interval="15";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setftpaction&type=rec&enable=1&interval=60
cmd="setftpaction";
response="200";
param.cgi?cmd=getftpactionattr
Function | Get Snapshot Count for the Alarm FTP Upload
snapcount
: Count of snapshots uploaded to the FTP server with every alarm event [1-10]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getftpactionattr
cmd="getftpactionattr";
snapcount="5";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getftpactionattr&user=admin&pwd=instar
cmd="getftpactionattr";
snapcount="5";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setftpactionattr&snapcount=10
cmd="setftpactionattr";
response="200";
param.cgi?cmd=getsdactionattr
Set SD Snapshot Count
snapcount
: Number of snapshots uploaded to SD
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getsdactionattr
cmd="getsdactionattr";
snapcount="5";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getsdactionattr&type=rec&user=admin&pwd=instar
cmd="getsdactionattr";
snapcount="5";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setsdactionattr&snapcount=6
cmd="setsdactionattr";
response="200";
param.cgi?cmd=getioattr
Set Alarm Input Parameter
Enable the alarm input and set it to trigger when closed/opened:
enable
: De/Activate alarm input [0, 1]idle
: Circuit Normally Closed N.C. [0] or Normally Open N.O. [1]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getioattr
cmd="getioattr";
enable="0";
idle="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getioattr&user=admin&pwd=instar
cmd="getioattr";
enable="0";
idle="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setioattr&enable=1&idle=0
cmd="setioattr";
response="200";
param.cgi?cmd=getcloudaction
Set INSTAR Cloud Storage Parameter
Enable / Disables upload to the INSTAR Cloud:
enable
: De/Activate alarm recording [0, 1]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getcloudaction
cmd="getcloudaction";
enable="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getcloudaction&user=admin&pwd=instar
cmd="getcloudaction";
enable="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setcloudaction&enable=1
cmd="setcloudaction";
response="200";
param.cgi?cmd=getrelayaction
Set Passive Infrared Motion Detection Sensor Parameter
enable
: De/Activate alarm output relay [0, 1]idle
: Circuit Normally Closed N.C. [0] or Normally Open N.O. [1]time
: Relay kept open/close after trigger in seconds [1-3600]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getrelayaction
cmd="getrelayaction";
enable="0";
idle="1";
time="15";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getrelayaction&user=admin&pwd=instar
cmd="getrelayaction";
enable="0";
idle="1";
time="15";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setrelayaction&enable=0&idle=0&time=60
cmd="setrelayaction";
response="200";
param.cgi?cmd=getalarmrecattr
Set Alarm Video Recording
resolution
: Resolution of the alarm recording full resolution [11] or reduced resolution [12], [13]time
: Length of alarm recordings in seconds [15,30,45,60]pre
: Length of alarm pre-recording in seconds [0-15]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getalarmrecattr
cmd="getalarmrecattr";
resolution="11";
time="15";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getalarmrecattr&user=admin&pwd=instar
cmd="getalarmrecattr";
resolution="11";
time="15";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=setalarmrecattr&resolution=11&time=30
cmd="setalarmrecattr";
response="200";
param.cgi?cmd=getmaaction
Enable / Disables Alarm EMail Snapshots
enable
: De/Activate alarm recording [0, 1]interval
: Cooldown time between Mails [1 - 3600] s
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getmaaction
cmd="getmaaction";
enable="0";
interval="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getmaaction&user=admin&pwd=instar
cmd="getmaaction";
enable="0";
interval="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=setmaaction&enable=1
cmd="setalarmrecattr";
response="200";
param.cgi?cmd=getmaactionattr
Attach Alarm Snapshots EMail
snapcount
: Attach snapshot to email [0-10]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getmaactionattr
cmd="getmaactionattr";
snapcount="5";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getmaactionattr&user=admin&pwd=instar
cmd="getmaactionattr";
snapcount="10";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=setmaactionattr&snapcount=3
cmd="setmaactionattr";
response="200";
param.cgi?cmd=getaudioaction
Set Alarm Audio Signal
enable
: Enable / Disables alarm tone that gets played through the speaker or line-out [0, 1]interval
: Alarm cooldown [5 - 60]duration
: Alarm signal duration [0* - 60] (*0
= sound file will be played completely once)
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getaudioaction
cmd="getaudioaction";
enable="0";
interval="15";
duration="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getaudioaction&user=admin&pwd=instar
cmd="getaudioaction";
enable="0";
interval="15";
duration="60";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=setaudioaction&enable=1
cmd="setalarmrecattr";
response="200";
param.cgi?cmd=playalarmsound
Manually trigger an Audio Signal
Trigger the alarm signal (s. above) manually.
Example
GET: http://192.168.2.168/param.cgi?cmd=playalarmsound
cmd="playalarmsound";
response="200";
param.cgi?cmd=getmanualsoundattr
Manual Audio Signal Duration
Configure the length of the manually triggered an Audio Signal.
duration
: Audio signal duration [0* - 600] (*0
= sound file will be played completely once)
Example
GET: http://192.168.2.168/param.cgi?cmd=getmanualsoundattr
cmd="getmanualsoundattr";
duration="15";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=setmanualsoudnattr&duration=15
cmd="getmanualsoundattr";
response="200";
param.cgi?cmd=stopalarmsound
Stop the manually triggered Audio Signal
Stop the manually triggered alarm signal (s. above). The maximum duration is set by the cmd=setaudioaction
command (s. above).
Example
GET: http://192.168.2.168/param.cgi?cmd=stopalarmsound
cmd="stopalarmsound";
response="200";
param.cgi?cmd=getrecordstatus
Alarm Video Recording Status
recstatus
: Recording status not recording [0], alarm recording [1], scheduled recording [2], manual recording [3]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getrecordstatus
cmd="getrecordstatus";
recstatus="0";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getrecordstatus&user=admin&pwd=instar
cmd="getrecordstatus";
recstatus="0";
response="200";
param.cgi?cmd=getalarmsnapattr
Set Resolution of Alarm Snapshots
resolution
: Set Snapshot Resolution to Video Channel [11 -13]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getalarmsnapattr
cmd="getalarmsnapattr";
resolution="11";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getalarmsnapattr&user=admin&pwd=instar
cmd="getalarmsnapattr";
resolution="11";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setalarmsnapattr&resolution=12&count=2&interval=20
cmd="setalarmsnapattr";
response="200";
param.cgi?cmd=getodattr
Enable the Object Detection (Person, Car, Animal)
enable
: Activate / Deactivate the Object Detection [1,0]
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getodattr
cmd="getodattr";
enable="1";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getodattr&user=admin&pwd=instar
cmd="getodattr";
enable="0";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setodattr&enable=1
cmd="setodattr";
response="200";
param.cgi?cmd=getodthresh
Thresholds for the Object Detection (Person, Car, Animal)
enable
: Activate / Deactivate the Object Detection for the classperson
,car
oranimal
[1,0]threshold
: Threshold is the certainty required to trigger a detection [0-100]minwidth
: Exclude objects that are less wide than the selected bounding box.maxwidth
: Exclude objects that are wider than the selected bounding box.minheight
: Exclude objects that are less high than the selected bounding box.maxheight
: Exclude objects that are higher than the selected bounding box.
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getodthresh
cmd="getodthresh";
enable['person']="1";
threshold['person']="60";
minwidth['person']="48";
maxwidth['person']="455";
minheight['person']="73";
maxheight['person']="504";
enable['vehicle']="1";
threshold['vehicle']="60";
minwidth['vehicle']="40";
maxwidth['vehicle']="2560";
minheight['vehicle']="40";
maxheight['vehicle']="1440";
enable['animal']="1";
threshold['animal']="60";
minwidth['animal']="339";
maxwidth['animal']="750";
minheight['animal']="318";
maxheight['animal']="741";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getodthresh&object=person&user=admin&pwd=instar
cmd="getodthresh";
enable="1";
threshold="60";
minwidth="48";
maxwidth="455";
minheight="73";
maxheight="504";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setodthresh&object=animal&threshold=75
cmd="setodthresh";
response="200";
param.cgi?cmd=getuiodattr
Location of bounding box for object detection (Person, Car, Animal)
This value is only used to display the bounding box in the camera webUI. It does not affect the object detection in any way.
x
: X position of the selected bounding box (Person, Car, Animal).y
: Y position of the selected bounding box (Person, Car, Animal).
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getuiodattr
cmd="getuiodattr";
x['person']="1127";
y['person']="725";
x['vehicle']="1280";
y['vehicle']="720";
x['animal']="1940";
y['animal']="983";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getuiodattr&odbox=person&user=admin&pwd=instar
cmd="getuiodattr";
x="1127";
y="725";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setuiodattr&odbox=vehicle&x=1280&y=720
cmd="setuiodattr";
response="200";
param.cgi?cmd=pollobjects
Configure the Object Detection (Person, Car, Animal)
type
: Detected object type [person
,car
,animal
]moving
:0
object is standing,1
object is movingx
: X position of detected objecty
: Y position of detected objectw
: Width of detected objecth
: Height of detected object
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=pollobjects
cmd="pollobjects";
type="0";
x="289";
y="34";
w="124";
h="1003";
GET: http://192.168.2.168/param.cgi?cmd=pollobjects&user=admin&pwd=instar
cmd="pollobjects";
type="0";
x="124";
y="1003";
w="289";
h="34";
param.cgi?cmd=insu&-arg=70467840/1
Pause all Alarm Actions
arg
: Pause all alarm actions:70467840
. Unpause all alarm actions:70467841
Example
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=insu&-arg=70467840
SET: http://192.168.2.168param.cgi?cmd=insu&-arg=70467841&-usr=admin&-pwd=instar
Debugging
param.cgi?cmd=pushhostalarm
Trigger an Alarm Event. Trigger will show up as 2022-04-26 08:51:38: Manual alarm triggered
in System/Log.
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=pushhostalarm
cmd="pushhostalarm";
response="200";
param.cgi?cmd=getstressalarm
Trigger continuous Alarm Events
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getstressalarm
cmd="getstressalarm";
enable="0";
response="200";
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=setstressalarm&enable=1
cmd="setstressalarm";
response="200";
param.cgi?cmd=getrelaytimeattr
Get Pan&Tilt Tour Schedule Parameter
enable
: De/Activate Alarm Relay Schedule [0, 1]open
/close
: Corresponding list of times of the day the relay should be closed/opened (0s
=00:00:00
-86340s
=23:59:00
) and days of the week from Mon - Sun, e.g. take a snapshot at 10 o'clock (36000s
) every:- Mon:
36000-1
- Tue:
36000-2
- Wed:
36000-4
- Thu:
36000-8
- Fri:
36000-16
- Sat:
36000-32
- Sun:
36000-64
- Mon-Tue:
36000-3
- Mon-Tue,Sun:
36000-67
- Mon-Sun:
36000-127
- Mon:
Example
GET: http://admin:instar@192.168.2.168/param.cgi?cmd=getrelaytimeattr
cmd="getrelaytimeattr";
enable="1";
open="0-127,600-127";
close="3600-127";
response="200";
GET: http://192.168.2.168/param.cgi?cmd=getrelaytimeattr&user=admin&pwd=instar
cmd="getrelaytimeattr";
enable="1";
open="0-127,600-127";
close="3600-127";
response="200";
SET: http://admin:instar@192.168.2.168/param.cgi?cmd=setrelaytimeattr&enable=1
cmd="setrelaytimeattr";
response="200";