" .weblink_FwDetail($d); } elsif($wltype eq "iframe") { $ret = "" .weblink_FwDetail($d); } elsif($wltype eq "link") { $alias = $hash->{HELPER}{ALIAS}; $ret = "$alias
"; # wenn attr target=_blank neuer Browsertab } # FW_directNotify("FILTER=room=$room", "#FHEMWEB:$FW_wname", "location.reload('true')", "") if($d eq $name); return $ret; } ###################################################################################### # initiale Startroutinen nach Restart FHEM ###################################################################################### sub initonboot ($) { my ($hash) = @_; my $name = $hash->{NAME}; if ($init_done == 1) { RemoveInternalTimer($hash); # alle Timer löschen delete($defs{$name}{READINGS}{LiveStreamUrl}) if($defs{$name}{READINGS}{LiveStreamUrl}); # LiveStream URL zurücksetzen # check ob alle Recordings = "Stop" nach Reboot -> sonst stoppen if (ReadingsVal($hash->{NAME}, "Record", "Stop") eq "Start") { Log3($name, 2, "$name - Recording of $hash->{CAMNAME} seems to be still active after FHEM restart - try to stop it now"); camstoprec($hash); } # Konfiguration der Synology Surveillance Station abrufen if (!$hash->{CREDENTIALS}) { Log3($name, 2, "$name - Credentials of $name are not set - make sure you've set it with \"set $name credentials username password\""); } else { # allg. SVS-Eigenschaften abrufen getsvsinfo($hash); # Kameraspezifische Infos holen getcaminfo($hash); getcapabilities($hash); # Preset/Patrollisten in Hash einlesen zur PTZ-Steuerung getptzlistpreset($hash); getptzlistpatrol($hash); } # Subroutine Watchdog-Timer starten (sollen Cam-Infos regelmäßig abgerufen werden ?), verzögerter zufälliger Start 0-30s RemoveInternalTimer($hash, "watchdogpollcaminfo"); InternalTimer(gettimeofday()+int(rand(30)), "watchdogpollcaminfo", $hash, 0); } else { RemoveInternalTimer($hash, "initonboot"); InternalTimer(gettimeofday()+1, "initonboot", $hash, 0); } return; } ###################################################################################### # Username / Paßwort speichern ###################################################################################### sub setcredentials ($@) { my ($hash, @credentials) = @_; my $name = $hash->{NAME}; my $success; my $credstr; my $index; my $retcode; my (@key,$len,$i); $credstr = encode_base64(join(':', @credentials)); # Beginn Scramble-Routine @key = qw(1 3 4 5 6 3 2 1 9); $len = scalar @key; $i = 0; $credstr = join "", map { $i = ($i + 1) % $len; chr((ord($_) + $key[$i]) % 256) } split //, $credstr; # End Scramble-Routine $index = $hash->{TYPE}."_".$hash->{NAME}."_credentials"; $retcode = setKeyValue($index, $credstr); if ($retcode) { Log3($name, 2, "$name - Error while saving the Credentials - $retcode"); $success = 0; } else { getcredentials($hash,1); # Credentials nach Speicherung lesen und in RAM laden ($boot=1) $success = 1; } return ($success); } ###################################################################################### # Username / Paßwort abrufen ###################################################################################### sub getcredentials ($$) { my ($hash,$boot) = @_; my $name = $hash->{NAME}; my $success; my $username; my $passwd; my $index; my ($retcode, $credstr); my (@key,$len,$i); if ($boot eq 1) { # mit $boot=1 Credentials von Platte lesen und als scrambled-String in RAM legen $index = $hash->{TYPE}."_".$hash->{NAME}."_credentials"; ($retcode, $credstr) = getKeyValue($index); if ($retcode) { Log3($name, 2, "$name - Unable to read password from file: $retcode"); $success = 0; } if ($credstr) { # beim Boot scrambled Credentials in den RAM laden $hash->{HELPER}{CREDENTIALS} = $credstr; # "Credentials" wird als Statusbit ausgewertet. Wenn nicht gesetzt -> Warnmeldung und keine weitere Verarbeitung $hash->{CREDENTIALS} = "Set"; $success = 1; } } else { # boot = 0 -> Credentials aus RAM lesen, decoden und zurückgeben $credstr = $hash->{HELPER}{CREDENTIALS}; # Beginn Descramble-Routine @key = qw(1 3 4 5 6 3 2 1 9); $len = scalar @key; $i = 0; $credstr = join "", map { $i = ($i + 1) % $len; chr((ord($_) - $key[$i] + 256) % 256) } split //, $credstr; # Ende Descramble-Routine ($username, $passwd) = split(":",decode_base64($credstr)); my $logpw = AttrVal($name, "showPassInLog", "0") == 1 ? $passwd : "********"; Log3($name, 4, "$name - Credentials read from RAM: $username $logpw"); $success = (defined($passwd)) ? 1 : 0; } return ($success, $username, $passwd); } ###################################################################################### # Polling Überwachung ###################################################################################### sub watchdogpollcaminfo ($) { # Überwacht die Wert von Attribut "pollcaminfoall" und Reading "PollState" # wenn Attribut "pollcaminfoall" > 10 und "PollState"=Inactive -> start Polling my ($hash) = @_; my $name = $hash->{NAME}; my $camname = $hash->{CAMNAME}; my $watchdogtimer = 90; if (defined($attr{$name}{pollcaminfoall}) and $attr{$name}{pollcaminfoall} > 10 and ReadingsVal("$name", "PollState", "Active") eq "Inactive" and !IsDisabled($name)) { # Polling ist jetzt aktiv readingsSingleUpdate($hash,"PollState","Active",0); Log3($name, 3, "$name - Polling Camera $camname is activated - Pollinginterval: ".$attr{$name}{pollcaminfoall}."s"); # in $hash eintragen für späteren Vergleich (Changes von pollcaminfoall) $hash->{HELPER}{OLDVALPOLL} = $attr{$name}{pollcaminfoall}; &getcaminfoall($hash); } if (defined($hash->{HELPER}{OLDVALPOLL}) and defined($attr{$name}{pollcaminfoall}) and $attr{$name}{pollcaminfoall} > 10) { if ($hash->{HELPER}{OLDVALPOLL} != $attr{$name}{pollcaminfoall}) { Log3($name, 3, "$name - Polling Camera $camname was changed to new Pollinginterval: ".$attr{$name}{pollcaminfoall}."s"); $hash->{HELPER}{OLDVALPOLL} = $attr{$name}{pollcaminfoall}; } } if (defined($attr{$name}{pollnologging})) { if ($hash->{HELPER}{OLDVALPOLLNOLOGGING} ne $attr{$name}{pollnologging}) { if ($attr{$name}{pollnologging} == "1") { Log3($name, 3, "$name - Log of Polling Camera $camname is deactivated"); # in $hash eintragen für späteren Vergleich (Changes von pollnologging) $hash->{HELPER}{OLDVALPOLLNOLOGGING} = $attr{$name}{pollnologging}; } else { Log3($name, 3, "$name - Log of Polling Camera $camname is activated"); # in $hash eintragen für späteren Vergleich (Changes von pollnologging) $hash->{HELPER}{OLDVALPOLLNOLOGGING} = $attr{$name}{pollnologging}; } } } else { # alter Wert von "pollnologging" war 1 -> Logging war deaktiviert if ($hash->{HELPER}{OLDVALPOLLNOLOGGING} == "1") { Log3($name, 3, "$name - Log of Polling Camera $camname is activated"); $hash->{HELPER}{OLDVALPOLLNOLOGGING} = "0"; } } RemoveInternalTimer($hash, "watchdogpollcaminfo"); InternalTimer(gettimeofday()+$watchdogtimer, "watchdogpollcaminfo", $hash, 0); return undef; } ############################################################################################################ # OpMode-Startroutinen # # $hash->{HELPER}{ACTIVE} = Funktionstoken # # $hash->{HELPER}{ACTIVE} = "on" -> eine Routine läuft, Start anderer Routine erst wenn "off". # # $hash->{HELPER}{ACTIVE} = "off" -> keine andere Routine läuft, sofortiger Start möglich # ############################################################################################################ ############################################################################### # Kamera Aufnahme starten ############################################################################### sub camstartrec ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Start Recording of Camera $camname can't be executed - $error"); return; } if (ReadingsVal("$name", "Record", undef) eq "Start" and !AttrVal($name, "recextend", undef)) { Log3($name, 3, "$name - another recording is already running - new start-command will be ignored"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { # Aufnahme starten Log3($name, 4, "$name - Recording of Camera $camname will be started now"); $hash->{OPMODE} = "Start"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camstartrec"); InternalTimer(gettimeofday()+0.3, "camstartrec", $hash); } } ############################################################################### # Kamera Aufnahme stoppen ############################################################################### sub camstoprec ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Stop Recording of Camera $camname can't be executed - $error"); return; } if (ReadingsVal("$name", "Record", undef) eq "Stop") { Log3($name, 3, "$name - recording is already stopped - new stop-command will be ignored"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { # Aufnahme stoppen Log3($name, 4, "$name - Recording of Camera $camname will be stopped now"); $hash->{OPMODE} = "Stop"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camstoprec"); InternalTimer(gettimeofday()+0.3, "camstoprec", $hash, 0); } } ############################################################################### # Kamera Auto / Day / Nightmode setzen ############################################################################### sub camexpmode ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Setting exposure mode of Camera $camname can't be executed - $error"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { Log3($name, 4, "$name - Setting of exposure mode of Camera $camname will be started now"); $hash->{OPMODE} = "ExpMode"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camexpmode"); InternalTimer(gettimeofday()+0.5, "camexpmode", $hash, 0); } } ############################################################################### # Art der Bewegungserkennung setzen ############################################################################### sub cammotdetsc ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Setting of motion detection source of Camera $camname can't be executed - $error"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { Log3($name, 4, "$name - Setting of motion detection source of Camera $camname will be started now"); $hash->{OPMODE} = "MotDetSc"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "cammotdetsc"); InternalTimer(gettimeofday()+0.5, "cammotdetsc", $hash, 0); } } ############################################################################### # Kamera Schappschuß aufnehmen ############################################################################### sub camsnap ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Snapshot of Camera $camname can't be executed - $error"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { # einen Schnappschuß aufnehmen Log3($name, 4, "$name - Take Snapshot of Camera $camname"); $hash->{OPMODE} = "Snap"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camsnap"); InternalTimer(gettimeofday()+0.3, "camsnap", $hash, 0); } } ############################################################################### # Kamera Liveview starten ############################################################################### sub runliveview ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = &experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - Liveview of Camera $camname can't be started - $error"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { # Liveview starten Log3($name, 4, "$name - Start Liveview of Camera $camname"); $hash->{OPMODE} = "runliveview"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; # erzwingen die Camid zu ermitteln und bei bei login-Fehler neu SID zu holen delete $hash->{CAMID}; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } readingsSingleUpdate($hash,"state","startview",1); sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "runliveview"); InternalTimer(gettimeofday()+0.5, "runliveview", $hash, 0); } } ############################################################################### # Kamera Liveview stoppen ############################################################################### sub stopliveview ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # kurzer state-switch -> Browser aktualisieren readingsSingleUpdate($hash,"state","stopview",1); # Liveview stoppen Log3($name, 4, "$name - Stop Liveview of Camera $camname now"); $hash->{OPMODE} = "stopliveview"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } # Link aus Helper-hash löschen delete $hash->{HELPER}{LINK}; # Reading LiveStreamUrl löschen delete($defs{$name}{READINGS}{LiveStreamUrl}) if ($defs{$name}{READINGS}{LiveStreamUrl}); # vorhandenen Aufnahmestatus wieder herstellen if (ReadingsVal("$name", "Record", "") eq "Start") { readingsSingleUpdate( $hash,"state", "on", 1); } else { readingsSingleUpdate($hash,"state", "off", 1); } $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } } else { RemoveInternalTimer($hash, "stopliveview"); InternalTimer(gettimeofday()+0.5, "stopliveview", $hash, 0); } } ############################################################################### # Filename zu Schappschuß ermitteln ############################################################################### sub getsnapfilename ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $snapid = ReadingsVal("$name", "LastSnapId", " "); return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # den Filenamen zu einem Schnappschuß ermitteln Log3($name, 4, "$name - Get filename of present Snap-ID $snapid"); $hash->{OPMODE} = "getsnapfilename"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getsnapfilename"); InternalTimer(gettimeofday()+0.5, "getsnapfilename", $hash, 0); } } ############################################################################### # external Event 1-10 auslösen ############################################################################### sub extevent ($) { my ($hash) = @_; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { Log3($name, 4, "$name - trigger external event \"$hash->{HELPER}{EVENTID}\""); $hash->{OPMODE} = "extevent"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "extevent"); InternalTimer(gettimeofday()+0.5, "extevent", $hash, 0); } } ############################################################################### # PTZ-Kamera auf Position fahren ############################################################################### sub doptzaction ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my $errorcode; my $error; return if(IsDisabled($name)); if (ReadingsVal("$name", "DeviceType", "Camera") ne "PTZ") { Log3($name, 2, "$name - ERROR - Operation \"$hash->{HELPER}{PTZACTION}\" is only possible for cameras of DeviceType \"PTZ\" - please compare with device Readings"); return; } if ($hash->{HELPER}{PTZACTION} eq "goabsptz" && !ReadingsVal("$name", "CapPTZAbs", "false")) { Log3($name, 2, "$name - ERROR - Operation \"$hash->{HELPER}{PTZACTION}\" is only possible if camera supports absolute PTZ action - please compare with device Reading \"CapPTZAbs\""); return; } if ( $hash->{HELPER}{PTZACTION} eq "movestart" && ReadingsVal("$name", "CapPTZDirections", "0") < 1) { Log3($name, 2, "$name - ERROR - Operation \"$hash->{HELPER}{PTZACTION}\" is only possible if camera supports \"Tilt\" and \"Pan\" operations - please compare with device Reading \"CapPTZDirections\""); return; } if ($hash->{HELPER}{PTZACTION} eq "gopreset") { if (!defined($hash->{HELPER}{ALLPRESETS}{$hash->{HELPER}{GOPRESETNAME}})) { $errorcode = "600"; # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - goPreset to position \"$hash->{HELPER}{GOPRESETNAME}\" of Camera $camname can't be executed - $error"); return; } } if ($hash->{HELPER}{PTZACTION} eq "runpatrol") { if (!defined($hash->{HELPER}{ALLPATROLS}{$hash->{HELPER}{GOPATROLNAME}})) { $errorcode = "600"; # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - runPatrol to patrol \"$hash->{HELPER}{GOPATROLNAME}\" of Camera $camname can't be executed - $error"); return; } } if (ReadingsVal("$name", "state", "") =~ /^dis.*/) { if (ReadingsVal("$name", "state", "") eq "disabled") { $errorcode = "402"; } elsif (ReadingsVal("$name", "state", "") eq "disconnected") { $errorcode = "502"; } # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - $hash->{HELPER}{PTZACTION} of Camera $camname can't be executed - $error"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { if ($hash->{HELPER}{PTZACTION} eq "gopreset") { Log3($name, 4, "$name - Move Camera $camname to position \"$hash->{HELPER}{GOPRESETNAME}\" with ID \"$hash->{HELPER}{ALLPRESETS}{$hash->{HELPER}{GOPRESETNAME}}\" now"); } elsif ($hash->{HELPER}{PTZACTION} eq "runpatrol") { Log3($name, 4, "$name - Start patrol \"$hash->{HELPER}{GOPATROLNAME}\" with ID \"$hash->{HELPER}{ALLPATROLS}{$hash->{HELPER}{GOPATROLNAME}}\" of Camera $camname now"); } elsif ($hash->{HELPER}{PTZACTION} eq "goabsptz") { Log3($name, 4, "$name - Start move Camera $camname to position posX=\"$hash->{HELPER}{GOPTZPOSX}\" and posY=\"$hash->{HELPER}{GOPTZPOSY}\" now"); } elsif ($hash->{HELPER}{PTZACTION} eq "movestart") { Log3($name, 4, "$name - Start move Camera $camname to direction \"$hash->{HELPER}{GOMOVEDIR}\" with duration of $hash->{HELPER}{GOMOVETIME} s"); } if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } $hash->{OPMODE} = $hash->{HELPER}{PTZACTION}; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "doptzaction"); InternalTimer(gettimeofday()+0.5, "doptzaction", $hash, 0); } } ############################################################################### # stoppen continues move ############################################################################### sub movestop ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { Log3($name, 4, "$name - Stop Camera $camname moving to direction \"$hash->{HELPER}{GOMOVEDIR}\" now"); $hash->{OPMODE} = "movestop"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}");; } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "movestop"); InternalTimer(gettimeofday()+0.3, "movestop", $hash, 0); } } ############################################################################### # Kamera aktivieren ############################################################################### sub camenable ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); # if (ReadingsVal("$name", "Availability", "disabled") eq "enabled") {return;} # Kamera ist bereits enabled if ($hash->{HELPER}{ACTIVE} eq "off") { # eine Kamera aktivieren Log3($name, 4, "$name - Enable Camera $camname"); $hash->{OPMODE} = "Enable"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camenable"); InternalTimer(gettimeofday()+0.5, "camenable", $hash, 0); } } ############################################################################### # Kamera deaktivieren ############################################################################### sub camdisable ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); # if (ReadingsVal("$name", "Availability", "enabled") eq "disabled") {return;} # Kamera ist bereits disabled if ($hash->{HELPER}{ACTIVE} eq "off" and ReadingsVal("$name", "Record", "Start") ne "Start") { # eine Kamera deaktivieren Log3($name, 4, "$name - Disable Camera $camname"); $hash->{OPMODE} = "Disable"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "camdisable"); InternalTimer(gettimeofday()+0.5, "camdisable", $hash, 0); } } ############################################################################### # Kamera alle Informationen abrufen (Get) bzw. Einstieg Polling ############################################################################### sub getcaminfoall { my ($hash,$mode) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; my ($now,$new); return if(IsDisabled($name)); geteventlist($hash); RemoveInternalTimer($hash, "getcaminfo"); InternalTimer(gettimeofday()+0.5, "getcaminfo", $hash, 0); RemoveInternalTimer($hash, "getmotionenum"); InternalTimer(gettimeofday()+0.8, "getmotionenum", $hash, 0); RemoveInternalTimer($hash, "getcapabilities"); InternalTimer(gettimeofday()+1.3, "getcapabilities", $hash, 0); RemoveInternalTimer($hash, "getptzlistpreset"); InternalTimer(gettimeofday()+1.6, "getptzlistpreset", $hash, 0); RemoveInternalTimer($hash, "getptzlistpatrol"); InternalTimer(gettimeofday()+1.9, "getptzlistpatrol", $hash, 0); RemoveInternalTimer($hash, "getStmUrlPath"); InternalTimer(gettimeofday()+2.1, "getStmUrlPath", $hash, 0); # wenn gesetzt = manuelle Abfrage, if ($mode) { getsvsinfo($hash); return; } if (defined($attr{$name}{pollcaminfoall}) and $attr{$name}{pollcaminfoall} > 10) { # Pollen wenn pollcaminfo > 10, sonst kein Polling $new = gettimeofday()+$attr{$name}{pollcaminfoall}; InternalTimer($new, "getcaminfoall", $hash, 0); if (!$attr{$name}{pollnologging}) { $now = FmtTime(gettimeofday()); $new = FmtTime(gettimeofday()+$attr{$name}{pollcaminfoall}); Log3($name, 3, "$name - Polling now: $now , next Polling: $new"); } } else { # Beenden Polling aller Caminfos readingsSingleUpdate($hash,"PollState","Inactive",0); Log3($name, 3, "$name - Polling of Camera $camname is deactivated"); } return; } ########################################################################### # allgemeine Infos über Synology Surveillance Station ########################################################################### sub getsvsinfo ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # Kamerainfos abrufen Log3($name, 4, "$name - Retrieval of Surveillance Station related informations starts now"); $hash->{OPMODE} = "Getsvsinfo"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getsvsinfo"); InternalTimer(gettimeofday()+1, "getsvsinfo", $hash, 0); } } ########################################################################### # Kamera allgemeine Informationen abrufen (Get), sub von getcaminfoall ########################################################################### sub getcaminfo ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # Kamerainfos abrufen Log3($name, 4, "$name - Retrieval Camera-Informations of $camname starts now"); $hash->{OPMODE} = "Getcaminfo"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getcaminfo"); InternalTimer(gettimeofday()+2, "getcaminfo", $hash, 0); } } ################################################################################ # Kamera Stream Urls abrufen (Get), Aufruf aus getcaminfoall ################################################################################ sub getStmUrlPath ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # Stream-Urls abrufen Log3($name, 4, "$name - Retrieval Stream-URLs of $camname starts now"); $hash->{OPMODE} = "getStmUrlPath"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getStmUrlPath"); InternalTimer(gettimeofday()+2, "getStmUrlPath", $hash, 0); } } ########################################################################### # query SVS-Event information , sub von getcaminfoall ########################################################################### sub geteventlist ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # Kamerainfos abrufen Log3($name, 4, "$name - Query event informations of $camname starts now"); $hash->{OPMODE} = "geteventlist"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "geteventlist"); InternalTimer(gettimeofday()+2, "geteventlist", $hash, 0); } } ########################################################################### # Enumerate motion detection parameters, sub von getcaminfoall ########################################################################### sub getmotionenum ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { Log3($name, 4, "$name - Enumerate motion detection parameters of $camname starts now"); $hash->{OPMODE} = "getmotionenum"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getmotionenum"); InternalTimer(gettimeofday()+2, "getmotionenum", $hash, 0); } } ########################################################################## # Capabilities von Kamera abrufen (Get), sub von getcaminfoall ########################################################################## sub getcapabilities ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if ($hash->{HELPER}{ACTIVE} eq "off") { # PTZ-ListPresets abrufen Log3($name, 4, "$name - Retrieval Capabilities of Camera $camname starts now"); $hash->{OPMODE} = "Getcapabilities"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getcapabilities"); InternalTimer(gettimeofday()+2, "getcapabilities", $hash, 0); } } ########################################################################## # PTZ Presets abrufen (Get), sub von getcaminfoall ########################################################################## sub getptzlistpreset ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if (ReadingsVal("$name", "DeviceType", "") ne "PTZ") { Log3($name, 4, "$name - Retrieval of Presets for $camname can't be executed - $camname is not a PTZ-Camera"); return; } if (ReadingsVal("$name", "CapPTZTilt", "") eq "false" | ReadingsVal("$name", "CapPTZPan", "") eq "false") { Log3($name, 4, "$name - Retrieval of Presets for $camname can't be executed - $camname has no capability to tilt/pan"); return; } if ($hash->{HELPER}{ACTIVE} eq "off") { # PTZ-ListPresets abrufen Log3($name, 4, "$name - Retrieval PTZ-ListPresets of $camname starts now"); $hash->{OPMODE} = "Getptzlistpreset"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getptzlistpreset"); InternalTimer(gettimeofday()+2, "getptzlistpreset", $hash, 0); } } ########################################################################## # PTZ Patrols abrufen (Get), sub von getcaminfoall ########################################################################## sub getptzlistpatrol ($) { my ($hash) = @_; my $camname = $hash->{CAMNAME}; my $name = $hash->{NAME}; return if(IsDisabled($name)); if (ReadingsVal("$name", "DeviceType", "") ne "PTZ") { Log3($name, 4, "$name - Retrieval of Patrols for $camname can't be executed - $camname is not a PTZ-Camera"); return; } if (ReadingsVal("$name", "CapPTZTilt", "") eq "false" | ReadingsVal("$name", "CapPTZPan", "") eq "false") { Log3($name, 4, "$name - Retrieval of Patrols for $camname can't be executed - $camname has no capability to tilt/pan"); return; } if ($hash->{HELPER}{ACTIVE} ne "on") { # PTZ-ListPatrols abrufen Log3($name, 4, "$name - Retrieval PTZ-ListPatrols of $camname starts now"); $hash->{OPMODE} = "Getptzlistpatrol"; $hash->{HELPER}{ACTIVE} = "on"; $hash->{HELPER}{LOGINRETRIES} = 0; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token was set by OPMODE: $hash->{OPMODE}"); } sscam_getapisites($hash); } else { RemoveInternalTimer($hash, "getptzlistpatrol"); InternalTimer(gettimeofday()+2, "getptzlistpatrol", $hash, 0); } } ############################################################################################################################# ####### Begin Kameraoperationen mit NonblockingGet (nicht blockierender HTTP-Call) ####### ############################################################################################################################# sub sscam_getapisites { my ($hash) = @_; my $serveraddr = $hash->{SERVERADDR}; my $serverport = $hash->{SERVERPORT}; my $name = $hash->{NAME}; my $apiinfo = $hash->{HELPER}{APIINFO}; # Info-Seite für alle API's, einzige statische Seite ! my $apiauth = $hash->{HELPER}{APIAUTH}; my $apiextrec = $hash->{HELPER}{APIEXTREC}; my $apiextevt = $hash->{HELPER}{APIEXTEVT}; my $apicam = $hash->{HELPER}{APICAM}; my $apitakesnap = $hash->{HELPER}{APISNAPSHOT}; my $apiptz = $hash->{HELPER}{APIPTZ}; my $apisvsinfo = $hash->{HELPER}{APISVSINFO}; my $apicamevent = $hash->{HELPER}{APICAMEVENT}; my $apievent = $hash->{HELPER}{APIEVENT}; my $apivideostm = $hash->{HELPER}{APIVIDEOSTM}; my $apistm = $hash->{HELPER}{APISTM}; my $url; my $param; # API-Pfade und MaxVersions ermitteln Log3($name, 4, "$name - ####################################################"); Log3($name, 4, "$name - ### start new cam operation ##"); Log3($name, 4, "$name - ####################################################"); Log3($name, 4, "$name - --- Begin Function sscam_getapisites nonblocking ---"); if ($hash->{HELPER}{APIPARSET}) { # API-Hashwerte sind bereits gesetzt -> Abruf überspringen Log3($name, 4, "$name - API hashvalues already set - ignore get apisites"); return sscam_checksid($hash); } my $httptimeout = $attr{$name}{httptimeout} ? $attr{$name}{httptimeout} : "4"; Log3($name, 5, "$name - HTTP-Call will be done with httptimeout-Value: $httptimeout s"); # URL zur Abfrage der Eigenschaften der API's $url = "http://$serveraddr:$serverport/webapi/query.cgi?api=$apiinfo&method=Query&version=1&query=$apiauth,$apiextrec,$apicam,$apitakesnap,$apiptz,$apisvsinfo,$apicamevent,$apievent,$apivideostm,$apiextevt,$apistm"; Log3($name, 4, "$name - Call-Out now: $url"); $param = { url => $url, timeout => $httptimeout, hash => $hash, method => "GET", header => "Accept: application/json", callback => \&sscam_getapisites_parse }; HttpUtils_NonblockingGet ($param); } #################################################################################### # Auswertung Abruf apisites #################################################################################### sub sscam_getapisites_parse ($) { my ($param, $err, $myjson) = @_; my $hash = $param->{hash}; my $name = $hash->{NAME}; my $serveraddr = $hash->{SERVERADDR}; my $serverport = $hash->{SERVERPORT}; my $apiauth = $hash->{HELPER}{APIAUTH}; my $apiextrec = $hash->{HELPER}{APIEXTREC}; my $apiextevt = $hash->{HELPER}{APIEXTEVT}; my $apicam = $hash->{HELPER}{APICAM}; my $apitakesnap = $hash->{HELPER}{APISNAPSHOT}; my $apiptz = $hash->{HELPER}{APIPTZ}; my $apisvsinfo = $hash->{HELPER}{APISVSINFO}; my $apicamevent = $hash->{HELPER}{APICAMEVENT}; my $apievent = $hash->{HELPER}{APIEVENT}; my $apivideostm = $hash->{HELPER}{APIVIDEOSTM}; my $apistm = $hash->{HELPER}{APISTM}; my ($apicammaxver,$apicampath); if ($err ne "") { # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist Log3($name, 2, "$name - error while requesting ".$param->{url}." - $err"); readingsSingleUpdate($hash, "Error", $err, 1); # ausgeführte Funktion ist abgebrochen, Freigabe Funktionstoken $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } elsif ($myjson ne "") { # Evaluiere ob Daten im JSON-Format empfangen wurden ($hash, my $success) = &evaljson($hash,$myjson,$param->{url}); unless ($success) { Log3($name, 4, "$name - Data returned: $myjson"); $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } my $data = decode_json($myjson); # Logausgabe decodierte JSON Daten Log3($name, 5, "$name - JSON returned: ". Dumper $data); $success = $data->{'success'}; if ($success) { my $logstr; # Pfad und Maxversion von "SYNO.API.Auth" ermitteln my $apiauthpath = $data->{'data'}->{$apiauth}->{'path'}; $apiauthpath =~ tr/_//d if (defined($apiauthpath)); my $apiauthmaxver = $data->{'data'}->{$apiauth}->{'maxVersion'}; $logstr = defined($apiauthpath) ? "Path of $apiauth selected: $apiauthpath" : "Path of $apiauth undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apiauthmaxver) ? "MaxVersion of $apiauth selected: $apiauthmaxver" : "MaxVersion of $apiauth undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.ExternalRecording" ermitteln my $apiextrecpath = $data->{'data'}->{$apiextrec}->{'path'}; $apiextrecpath =~ tr/_//d if (defined($apiextrecpath)); my $apiextrecmaxver = $data->{'data'}->{$apiextrec}->{'maxVersion'}; $logstr = defined($apiextrecpath) ? "Path of $apiextrec selected: $apiextrecpath" : "Path of $apiextrec undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apiextrecmaxver) ? "MaxVersion of $apiextrec selected: $apiextrecmaxver" : "MaxVersion of $apiextrec undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.Camera" ermitteln $apicampath = $data->{'data'}->{$apicam}->{'path'}; $apicampath =~ tr/_//d if (defined($apicampath)); $apicammaxver = $data->{'data'}->{$apicam}->{'maxVersion'}; $logstr = defined($apicampath) ? "Path of $apicam selected: $apicampath" : "Path of $apicam undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apiextrecmaxver) ? "MaxVersion of $apicam: $apicammaxver" : "MaxVersion of $apicam undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.SnapShot" ermitteln my $apitakesnappath = $data->{'data'}->{$apitakesnap}->{'path'}; $apitakesnappath =~ tr/_//d if (defined($apitakesnappath)); my $apitakesnapmaxver = $data->{'data'}->{$apitakesnap}->{'maxVersion'}; $logstr = defined($apitakesnappath) ? "Path of $apitakesnap selected: $apitakesnappath" : "Path of $apitakesnap undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apitakesnapmaxver) ? "MaxVersion of $apitakesnap: $apitakesnapmaxver" : "MaxVersion of $apitakesnap undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.PTZ" ermitteln my $apiptzpath = $data->{'data'}->{$apiptz}->{'path'}; $apiptzpath =~ tr/_//d if (defined($apiptzpath)); my $apiptzmaxver = $data->{'data'}->{$apiptz}->{'maxVersion'}; $logstr = defined($apiptzpath) ? "Path of $apiptz selected: $apiptzpath" : "Path of $apiptz undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apiptzmaxver) ? "MaxVersion of $apiptz: $apiptzmaxver" : "MaxVersion of $apiptz undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.Info" ermitteln my $apisvsinfopath = $data->{'data'}->{$apisvsinfo}->{'path'}; $apisvsinfopath =~ tr/_//d if (defined($apisvsinfopath)); my $apisvsinfomaxver = $data->{'data'}->{$apisvsinfo}->{'maxVersion'}; $logstr = defined($apisvsinfopath) ? "Path of $apisvsinfo selected: $apisvsinfopath" : "Path of $apisvsinfo undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apisvsinfomaxver) ? "MaxVersion of $apisvsinfo: $apisvsinfomaxver" : "MaxVersion of $apisvsinfo undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.Surveillance.Camera.Event" ermitteln my $apicameventpath = $data->{'data'}->{$apicamevent}->{'path'}; $apicameventpath =~ tr/_//d if (defined($apicameventpath)); my $apicameventmaxver = $data->{'data'}->{$apicamevent}->{'maxVersion'}; $logstr = defined($apicameventpath) ? "Path of $apicamevent selected: $apicameventpath" : "Path of $apicamevent undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apicameventmaxver) ? "MaxVersion of $apicamevent: $apicameventmaxver" : "MaxVersion of $apicamevent undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.Surveillance.Event" ermitteln my $apieventpath = $data->{'data'}->{$apievent}->{'path'}; $apieventpath =~ tr/_//d if (defined($apieventpath)); my $apieventmaxver = $data->{'data'}->{$apievent}->{'maxVersion'}; $logstr = defined($apieventpath) ? "Path of $apievent selected: $apieventpath" : "Path of $apievent undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apieventmaxver) ? "MaxVersion of $apievent: $apieventmaxver" : "MaxVersion of $apievent undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.Surveillance.VideoStream" ermitteln my $apivideostmpath = $data->{'data'}->{$apivideostm}->{'path'}; $apivideostmpath =~ tr/_//d if (defined($apivideostmpath)); my $apivideostmmaxver = $data->{'data'}->{$apivideostm}->{'maxVersion'}; $logstr = defined($apivideostmpath) ? "Path of $apivideostm selected: $apivideostmpath" : "Path of $apivideostm undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apivideostmmaxver) ? "MaxVersion of $apivideostm: $apivideostmmaxver" : "MaxVersion of $apivideostm undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.ExternalEvent" ermitteln my $apiextevtpath = $data->{'data'}->{$apiextevt}->{'path'}; $apiextevtpath =~ tr/_//d if (defined($apiextevtpath)); my $apiextevtmaxver = $data->{'data'}->{$apiextevt}->{'maxVersion'}; $logstr = defined($apiextevtpath) ? "Path of $apiextevt selected: $apiextevtpath" : "Path of $apiextevt undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apiextevtmaxver) ? "MaxVersion of $apiextevt selected: $apiextevtmaxver" : "MaxVersion of $apiextevt undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # Pfad und Maxversion von "SYNO.SurveillanceStation.Streaming" ermitteln my $apistmpath = $data->{'data'}->{$apistm}->{'path'}; $apistmpath =~ tr/_//d if (defined($apistmpath)); my $apistmmaxver = $data->{'data'}->{$apistm}->{'maxVersion'}; $logstr = defined($apistmpath) ? "Path of $apistm selected: $apistmpath" : "Path of $apistm undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); $logstr = defined($apistmmaxver) ? "MaxVersion of $apistm selected: $apistmmaxver" : "MaxVersion of $apistm undefined - Surveillance Station may be stopped"; Log3($name, 4, "$name - $logstr"); # aktuelle oder simulierte SVS-Version für Fallentscheidung setzen no warnings 'uninitialized'; my $major = $hash->{HELPER}{SVSVERSION}{MAJOR}; my $minor = $hash->{HELPER}{SVSVERSION}{MINOR}; my $build = $hash->{HELPER}{SVSVERSION}{BUILD}; my $actvs = $major.$minor.$build; Log3($name, 4, "$name - saved SVS version is: $actvs"); use warnings; if(!$actvs and AttrVal($name, "simu_SVSversion", undef)) { my @vl = split (/\.|-/,AttrVal($name, "simu_SVSversion", "")); $actvs = $vl[0]; $actvs .= $vl[1]; $actvs .= $vl[2]."-simu" if($vl[2]); } # Simulation anderer SVS-Versionen Log3($name, 4, "$name - ------- Begin of simulation section -------"); if (AttrVal($name, "simu_SVSversion", undef)) { Log3($name, 4, "$name - SVS version $actvs will be simulated"); if ($actvs =~ /^71/) { $apicammaxver = 8; Log3($name, 4, "$name - MaxVersion of $apicam adapted to: $apicammaxver"); $apiauthmaxver = 4; Log3($name, 4, "$name - MaxVersion of $apiauth adapted to: $apiauthmaxver"); $apiextrecmaxver = 2; Log3($name, 4, "$name - MaxVersion of $apiextrec adapted to: $apiextrecmaxver"); $apiptzmaxver = 4; Log3($name, 4, "$name - MaxVersion of $apiptz adapted to: $apiptzmaxver"); } elsif ($actvs =~ /^72/) { $apicammaxver = 8; Log3($name, 4, "$name - MaxVersion of $apicam adapted to: $apicammaxver"); $apiauthmaxver = 6; Log3($name, 4, "$name - MaxVersion of $apiauth adapted to: $apiauthmaxver"); $apiextrecmaxver = 3; Log3($name, 4, "$name - MaxVersion of $apiextrec adapted to: $apiextrecmaxver"); $apiptzmaxver = 5; Log3($name, 4, "$name - MaxVersion of $apiptz adapted to: $apiptzmaxver"); } } else { Log3($name, 4, "$name - no simulations done !"); } Log3($name, 4, "$name - ------- End of simulation section -------"); # Downgrades für nicht kompatible API-Versionen Log3($name, 4, "$name - ------- Begin of adaption section -------"); $apiptzmaxver = 4; Log3($name, 4, "$name - MaxVersion of $apiptz adapted to: $apiptzmaxver"); $apicammaxver = 8; Log3($name, 4, "$name - MaxVersion of $apicam adapted to: $apicammaxver"); Log3($name, 4, "$name - ------- End of adaption section -------"); # ermittelte Werte in $hash einfügen $hash->{HELPER}{APIAUTHPATH} = $apiauthpath; $hash->{HELPER}{APIAUTHMAXVER} = $apiauthmaxver; $hash->{HELPER}{APIEXTRECPATH} = $apiextrecpath; $hash->{HELPER}{APIEXTRECMAXVER} = $apiextrecmaxver; $hash->{HELPER}{APICAMPATH} = $apicampath; $hash->{HELPER}{APICAMMAXVER} = $apicammaxver; $hash->{HELPER}{APITAKESNAPPATH} = $apitakesnappath; $hash->{HELPER}{APITAKESNAPMAXVER} = $apitakesnapmaxver; $hash->{HELPER}{APIPTZPATH} = $apiptzpath; $hash->{HELPER}{APIPTZMAXVER} = $apiptzmaxver; $hash->{HELPER}{APISVSINFOPATH} = $apisvsinfopath; $hash->{HELPER}{APISVSINFOMAXVER} = $apisvsinfomaxver; $hash->{HELPER}{APICAMEVENTPATH} = $apicameventpath; $hash->{HELPER}{APICAMEVENTMAXVER} = $apicameventmaxver; $hash->{HELPER}{APIEVENTPATH} = $apieventpath; $hash->{HELPER}{APIEVENTMAXVER} = $apieventmaxver; $hash->{HELPER}{APIVIDEOSTMPATH} = $apivideostmpath; $hash->{HELPER}{APIVIDEOSTMMAXVER} = $apivideostmmaxver; $hash->{HELPER}{APIEXTEVTPATH} = $apiextevtpath; $hash->{HELPER}{APIEXTEVTMAXVER} = $apiextevtmaxver; $hash->{HELPER}{APISTMPATH} = $apistmpath; $hash->{HELPER}{APISTMMAXVER} = $apistmmaxver; readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode","none"); readingsBulkUpdate($hash,"Error","none"); readingsEndUpdate($hash,1); # API Hash values sind gesetzt $hash->{HELPER}{APIPARSET} = 1; } else { my $error = "couldn't call API-Infosite"; readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode","none"); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); Log3($name, 2, "$name - ERROR - the API-Query couldn't be executed successfully"); # ausgeführte Funktion ist abgebrochen, Freigabe Funktionstoken $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } } return sscam_checksid($hash); } ############################################################################################# # Check ob Session ID gesetzt ist - ggf. login ############################################################################################# sub sscam_checksid ($) { my ($hash) = @_; my $name = $hash->{NAME}; # SID holen bzw. login my $sid = $hash->{HELPER}{SID}; if(!$sid) { Log3($name, 3, "$name - no session ID found - get new one"); sscam_login($hash,'sscam_getcamid'); return; } return sscam_getcamid($hash); } ############################################################################################# # Abruf der installierten Cams ############################################################################################# sub sscam_getcamid ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $serveraddr = $hash->{SERVERADDR}; my $serverport = $hash->{SERVERPORT}; my $apicam = $hash->{HELPER}{APICAM}; my $apicampath = $hash->{HELPER}{APICAMPATH}; my $apicammaxver = $hash->{HELPER}{APICAMMAXVER}; my $sid = $hash->{HELPER}{SID}; # die Kamera-Id wird aus dem Kameranamen (Surveillance Station) ermittelt Log3($name, 4, "$name - --- Begin Function sscam_getcamid nonblocking ---"); if ($hash->{CAMID}) { # Camid ist bereits ermittelt -> Abruf überspringen Log3($name, 4, "$name - CAMID already set - ignore get camid"); return sscam_camop($hash); } my $httptimeout = $attr{$name}{httptimeout} ? $attr{$name}{httptimeout} : "4"; Log3($name, 5, "$name - HTTP-Call will be done with httptimeout-Value: $httptimeout s"); my $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=$apicam&version=$apicammaxver&method=List&basic=true&streamInfo=true&camStm=true&_sid=\"$sid\""; Log3($name, 4, "$name - Call-Out now: $url"); my $param = { url => $url, timeout => $httptimeout, hash => $hash, method => "GET", header => "Accept: application/json", callback => \&sscam_getcamid_parse }; HttpUtils_NonblockingGet($param); } ############################################################################################# # Auswertung installierte Cams, Selektion Cam , Ausführung Operation ############################################################################################# sub sscam_getcamid_parse ($) { my ($param, $err, $myjson) = @_; my $hash = $param->{hash}; my $name = $hash->{NAME}; my $camname = $hash->{CAMNAME}; my $apicammaxver = $hash->{HELPER}{APICAMMAXVER}; my ($data,$success,$error,$errorcode,$camid); my ($i,$n,$id); my %allcams; if ($err ne "") { # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist Log3($name, 2, "$name - error while requesting ".$param->{url}." - $err"); readingsSingleUpdate($hash, "Error", $err, 1); return sscam_login($hash,'sscam_getapisites'); } elsif ($myjson ne "") { # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes) # evaluiere ob Daten im JSON-Format empfangen wurden, Achtung: sehr viele Daten mit verbose=5 ($hash, $success) = evaljson($hash,$myjson,$param->{url}); unless ($success) { Log3($name, 4, "$name - Data returned: ".$myjson); $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } $data = decode_json($myjson); # lesbare Ausgabe der decodierten JSON-Daten Log3($name, 5, "$name - JSON returned: ". Dumper $data); $success = $data->{'success'}; if ($success) { # die Liste aller Kameras konnte ausgelesen werden, Anzahl der definierten Kameras ist in Var "total" $i = 0; # Namen aller installierten Kameras mit Id's in Assoziatives Array einlesen %allcams = (); while ($data->{'data'}->{'cameras'}->[$i]) { if ($apicammaxver <= 8) { $n = $data->{'data'}->{'cameras'}->[$i]->{'name'}; } else { $n = $data->{'data'}->{'cameras'}->[$i]->{'newName'}; # Änderung ab SVS 8.0.0 } $id = $data->{'data'}->{'cameras'}->[$i]->{'id'}; $allcams{"$n"} = "$id"; $i += 1; } # Ist der gesuchte Kameraname im Hash enhalten (in SVS eingerichtet ?) if (exists($allcams{$camname})) { $camid = $allcams{$camname}; # in hash eintragen $hash->{CAMID} = $camid; # Logausgabe Log3($name, 4, "$name - Detection Camid successful - $camname ID: $camid"); } else { # Kameraname nicht gefunden, id = "" # Setreading readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode","none"); readingsBulkUpdate($hash,"Error","Camera(ID) not found in Surveillance Station"); readingsEndUpdate($hash, 1); # Logausgabe Log3($name, 2, "$name - ERROR - Cameraname $camname wasn't found in Surveillance Station. Check Userrights, Cameraname and Spelling"); $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } } else { # Errorcode aus JSON ermitteln $errorcode = $data->{'error'}->{'code'}; # Fehlertext zum Errorcode ermitteln $error = experror($hash,$errorcode); readingsBeginUpdate($hash); readingsBulkUpdate($hash,"Errorcode",$errorcode); readingsBulkUpdate($hash,"Error",$error); readingsEndUpdate($hash, 1); if ($errorcode =~ /(105|401)/) { # neue Login-Versuche Log3($name, 2, "$name - ERROR - $errorcode - $error -> try new login"); return sscam_login($hash,'sscam_getapisites'); } else { # ausgeführte Funktion ist abgebrochen, Freigabe Funktionstoken $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } Log3($name, 2, "$name - ERROR - ID of Camera $camname couldn't be selected. Errorcode: $errorcode - $error"); return; } } } return sscam_camop($hash); } ############################################################################################# # Auswertung installierte Cams, Selektion Cam , Ausführung Operation ############################################################################################# sub sscam_camop ($) { my ($hash) = @_; my $name = $hash->{NAME}; my $serveraddr = $hash->{SERVERADDR}; my $serverport = $hash->{SERVERPORT}; my $apicam = $hash->{HELPER}{APICAM}; my $apicampath = $hash->{HELPER}{APICAMPATH}; my $apicammaxver = $hash->{HELPER}{APICAMMAXVER}; my $apiextrec = $hash->{HELPER}{APIEXTREC}; my $apiextrecpath = $hash->{HELPER}{APIEXTRECPATH}; my $apiextrecmaxver = $hash->{HELPER}{APIEXTRECMAXVER}; my $apiextevt = $hash->{HELPER}{APIEXTEVT}; my $apiextevtpath = $hash->{HELPER}{APIEXTEVTPATH}; my $apiextevtmaxver = $hash->{HELPER}{APIEXTEVTMAXVER}; my $apitakesnap = $hash->{HELPER}{APISNAPSHOT}; my $apitakesnappath = $hash->{HELPER}{APITAKESNAPPATH}; my $apitakesnapmaxver = $hash->{HELPER}{APITAKESNAPMAXVER}; my $apiptz = $hash->{HELPER}{APIPTZ}; my $apiptzpath = $hash->{HELPER}{APIPTZPATH}; my $apiptzmaxver = $hash->{HELPER}{APIPTZMAXVER}; my $apisvsinfo = $hash->{HELPER}{APISVSINFO}; my $apisvsinfopath = $hash->{HELPER}{APISVSINFOPATH}; my $apisvsinfomaxver = $hash->{HELPER}{APISVSINFOMAXVER}; my $apicamevent = $hash->{HELPER}{APICAMEVENT}; my $apicameventpath = $hash->{HELPER}{APICAMEVENTPATH}; my $apicameventmaxver = $hash->{HELPER}{APICAMEVENTMAXVER}; my $apievent = $hash->{HELPER}{APIEVENT}; my $apieventpath = $hash->{HELPER}{APIEVENTPATH}; my $apieventmaxver = $hash->{HELPER}{APIEVENTMAXVER}; my $apivideostm = $hash->{HELPER}{APIVIDEOSTM}; my $apivideostmpath = $hash->{HELPER}{APIVIDEOSTMPATH}; my $apivideostmmaxver = $hash->{HELPER}{APIVIDEOSTMMAXVER}; my $apistm = $hash->{HELPER}{APISTM}; my $apistmpath = $hash->{HELPER}{APISTMPATH}; my $apistmmaxver = $hash->{HELPER}{APISTMMAXVER}; my $sid = $hash->{HELPER}{SID}; my $OpMode = $hash->{OPMODE}; my $camid = $hash->{CAMID}; my ($livestream,$winname,$attr,$room,$param); my ($url,$snapid,$httptimeout,$expmode,$motdetsc); Log3($name, 4, "$name - --- Begin Function $OpMode nonblocking ---"); $httptimeout = $attr{$name}{httptimeout} ? $attr{$name}{httptimeout} : "4"; Log3($name, 5, "$name - HTTP-Call will be done with httptimeout-Value: $httptimeout s"); if ($OpMode eq "Start") { $url = "http://$serveraddr:$serverport/webapi/$apiextrecpath?api=$apiextrec&method=Record&version=$apiextrecmaxver&cameraId=$camid&action=start&_sid=\"$sid\""; if($apiextrecmaxver >= 3) { $url = "http://$serveraddr:$serverport/webapi/$apiextrecpath?api=$apiextrec&method=Record&version=$apiextrecmaxver&cameraIds=$camid&action=start&_sid=\"$sid\""; } } elsif ($OpMode eq "Stop") { $url = "http://$serveraddr:$serverport/webapi/$apiextrecpath?api=$apiextrec&method=Record&version=$apiextrecmaxver&cameraId=$camid&action=stop&_sid=\"$sid\""; if($apiextrecmaxver >= 3) { $url = "http://$serveraddr:$serverport/webapi/$apiextrecpath?api=$apiextrec&method=Record&version=$apiextrecmaxver&cameraIds=$camid&action=stop&_sid=\"$sid\""; } } elsif ($OpMode eq "Snap") { # ein Schnappschuß wird ausgelöst $url = "http://$serveraddr:$serverport/webapi/$apitakesnappath?api=\"$apitakesnap\"&dsId=\"0\"&method=\"TakeSnapshot\"&version=\"$apitakesnapmaxver\"&camId=\"$camid\"&blSave=\"true\"&_sid=\"$sid\""; readingsSingleUpdate($hash,"state", "snap", 0); readingsSingleUpdate($hash, "LastSnapId", "", 0); } elsif ($OpMode eq "getsnapfilename") { # der Filename der aktuellen Schnappschuß-ID wird ermittelt $snapid = ReadingsVal("$name", "LastSnapId", " "); $url = "http://$serveraddr:$serverport/webapi/$apitakesnappath?api=\"$apitakesnap\"&method=\"List\"&version=\"$apitakesnapmaxver\"&imgSize=\"0\"&idList=\"$snapid\"&_sid=\"$sid\""; } elsif ($OpMode eq "gopreset") { # Preset wird angefahren $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=\"$apiptz\"&version=\"$apiptzmaxver\"&method=\"GoPreset\"&position=\"$hash->{HELPER}{ALLPRESETS}{$hash->{HELPER}{GOPRESETNAME}}\"&cameraId=\"$camid\"&_sid=\"$sid\""; readingsSingleUpdate($hash,"state", "moving", 0); } elsif ($OpMode eq "runpatrol") { # eine Überwachungstour starten $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=\"$apiptz\"&version=\"$apiptzmaxver\"&method=\"RunPatrol\"&patrolId=\"$hash->{HELPER}{ALLPATROLS}{$hash->{HELPER}{GOPATROLNAME}}\"&cameraId=\"$camid\"&_sid=\"$sid\""; readingsSingleUpdate($hash,"state", "moving", 0); } elsif ($OpMode eq "goabsptz") { $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=\"$apiptz\"&version=\"$apiptzmaxver\"&method=\"AbsPtz\"&cameraId=\"$camid\"&posX=\"$hash->{HELPER}{GOPTZPOSX}\"&posY=\"$hash->{HELPER}{GOPTZPOSY}\"&_sid=\"$sid\""; readingsSingleUpdate($hash,"state", "moving", 0); } elsif ($OpMode eq "movestart") { $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=\"$apiptz\"&version=\"$apiptzmaxver\"&method=\"Move\"&cameraId=\"$camid\"&direction=\"$hash->{HELPER}{GOMOVEDIR}\"&speed=\"3\"&moveType=\"Start\"&_sid=\"$sid\""; } elsif ($OpMode eq "movestop") { $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=\"$apiptz\"&version=\"$apiptzmaxver\"&method=\"Move\"&cameraId=\"$camid\"&direction=\"$hash->{HELPER}{GOMOVEDIR}\"&moveType=\"Stop\"&_sid=\"$sid\""; } elsif ($OpMode eq "Enable") { $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=$apicam&version=$apicammaxver&method=Enable&cameraIds=$camid&_sid=\"$sid\""; } elsif ($OpMode eq "Disable") { $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=$apicam&version=$apicammaxver&method=Disable&cameraIds=$camid&_sid=\"$sid\""; } elsif ($OpMode eq "Getsvsinfo") { $url = "http://$serveraddr:$serverport/webapi/$apisvsinfopath?api=\"$apisvsinfo\"&version=\"$apisvsinfomaxver\"&method=\"GetInfo\"&_sid=\"$sid\""; } elsif ($OpMode eq "Getcaminfo") { $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=\"$apicam\"&version=\"$apicammaxver\"&method=\"GetInfo\"&cameraIds=\"$camid\"&deviceOutCap=\"true\"&streamInfo=\"true\"&ptz=\"true\"&basic=\"true\"&camAppInfo=\"true\"&optimize=\"true\"&fisheye=\"true\"&eventDetection=\"true\"&_sid=\"$sid\""; } elsif ($OpMode eq "getStmUrlPath") { $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=\"$apicam\"&version=\"$apicammaxver\"&method=\"GetStmUrlPath\"&cameraIds=\"$camid\"&_sid=\"$sid\""; } elsif ($OpMode eq "geteventlist") { # Abruf der Events einer Kamera $url = "http://$serveraddr:$serverport/webapi/$apieventpath?api=\"$apievent\"&version=\"$apieventmaxver\"&method=\"List\"&cameraIds=\"$camid\"&locked=\"0\"&blIncludeSnapshot=\"false\"&reason=\"\"&limit=\"2\"&includeAllCam=\"false\"&_sid=\"$sid\""; } elsif ($OpMode eq "Getptzlistpreset") { $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=$apiptz&version=$apiptzmaxver&method=ListPreset&cameraId=$camid&_sid=\"$sid\""; } elsif ($OpMode eq "Getcapabilities") { # Capabilities einer Cam werden abgerufen $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=$apicam&version=$apicammaxver&method=GetCapabilityByCamId&cameraId=$camid&_sid=\"$sid\""; } elsif ($OpMode eq "Getptzlistpatrol") { # PTZ-ListPatrol werden abgerufen $url = "http://$serveraddr:$serverport/webapi/$apiptzpath?api=$apiptz&version=$apiptzmaxver&method=ListPatrol&cameraId=$camid&_sid=\"$sid\""; } elsif ($OpMode eq "ExpMode") { if ($hash->{HELPER}{EXPMODE} eq "auto") { $expmode = "0"; } elsif ($hash->{HELPER}{EXPMODE} eq "day") { $expmode = "1"; } elsif ($hash->{HELPER}{EXPMODE} eq "night") { $expmode = "2"; } $url = "http://$serveraddr:$serverport/webapi/$apicampath?api=\"$apicam\"&version=\"$apicammaxver\"&method=\"SaveOptimizeParam\"&cameraIds=\"$camid\"&expMode=\"$expmode\"&camParamChkList=32&_sid=\"$sid\""; } elsif ($OpMode eq "MotDetSc") { # Hash für Optionswerte sichern für Logausgabe in Befehlsauswertung my %motdetoptions = (); if ($hash->{HELPER}{MOTDETSC} eq "disable") { $motdetsc = "-1"; $url = "http://$serveraddr:$serverport/webapi/$apicameventpath?api=\"$apicamevent\"&version=\"$apicameventmaxver\"&method=\"MDParamSave\"&camId=\"$camid\"&source=$motdetsc&keep=true&_sid=\"$sid\""; } elsif ($hash->{HELPER}{MOTDETSC} eq "camera") { $motdetsc = "0"; $motdetoptions{SENSITIVITY} = $hash->{'HELPER'}{'MOTDETSC_PROP1'} if ($hash->{'HELPER'}{'MOTDETSC_PROP1'}); $motdetoptions{OBJECTSIZE} = $hash->{'HELPER'}{'MOTDETSC_PROP2'} if ($hash->{'HELPER'}{'MOTDETSC_PROP2'}); $motdetoptions{PERCENTAGE} = $hash->{'HELPER'}{'MOTDETSC_PROP3'} if ($hash->{'HELPER'}{'MOTDETSC_PROP3'}); $url = "http://$serveraddr:$serverport/webapi/$apicameventpath?api=\"$apicamevent\"&version=\"$apicameventmaxver\"&method=\"MDParamSave\"&camId=\"$camid\"&source=$motdetsc&_sid=\"$sid\""; if ($hash->{HELPER}{MOTDETSC_PROP1} || $hash->{HELPER}{MOTDETSC_PROP2} || $hash->{HELPER}{MOTDETSC_PROP13}) { # umschalten und neue Werte setzen $url .= "&keep=false"; } else { # nur Umschaltung, alte Werte beibehalten $url .= "&keep=true"; } if ($hash->{HELPER}{MOTDETSC_PROP1}) { # der Wert für Bewegungserkennung Kamera -> Empfindlichkeit ist gesetzt my $sensitivity = delete $hash->{HELPER}{MOTDETSC_PROP1}; $url .= "&sensitivity=\"$sensitivity\""; } if ($hash->{HELPER}{MOTDETSC_PROP2}) { # der Wert für Bewegungserkennung Kamera -> Objektgröße ist gesetzt my $objectsize = delete $hash->{HELPER}{MOTDETSC_PROP2}; $url .= "&objectSize=\"$objectsize\""; } if ($hash->{HELPER}{MOTDETSC_PROP3}) { # der Wert für Bewegungserkennung Kamera -> Prozentsatz für Auslösung ist gesetzt my $percentage = delete $hash->{HELPER}{MOTDETSC_PROP3}; $url .= "&percentage=\"$percentage\""; } } elsif ($hash->{HELPER}{MOTDETSC} eq "SVS") { $motdetsc = "1"; $motdetoptions{SENSITIVITY} = $hash->{'HELPER'}{'MOTDETSC_PROP1'} if ($hash->{'HELPER'}{'MOTDETSC_PROP1'}); $motdetoptions{THRESHOLD} = $hash->{'HELPER'}{'MOTDETSC_PROP2'} if ($hash->{'HELPER'}{'MOTDETSC_PROP2'}); # nur Umschaltung, alte Werte beibehalten $url = "http://$serveraddr:$serverport/webapi/$apicameventpath?api=\"$apicamevent\"&version=\"$apicameventmaxver\"&method=\"MDParamSave\"&camId=\"$camid\"&source=$motdetsc&keep=true&_sid=\"$sid\""; if ($hash->{HELPER}{MOTDETSC_PROP1}) { # der Wert für Bewegungserkennung SVS -> Empfindlichkeit ist gesetzt my $sensitivity = delete $hash->{HELPER}{MOTDETSC_PROP1}; $url .= "&sensitivity=\"$sensitivity\""; } if ($hash->{HELPER}{MOTDETSC_PROP2}) { # der Wert für Bewegungserkennung SVS -> Schwellwert ist gesetzt my $threshold = delete $hash->{HELPER}{MOTDETSC_PROP2}; $url .= "&threshold=\"$threshold\""; } } # Optionswerte in Hash sichern für Logausgabe in Befehlsauswertung $hash->{HELPER}{MOTDETOPTIONS} = \%motdetoptions; } elsif ($OpMode eq "getmotionenum") { $url = "http://$serveraddr:$serverport/webapi/$apicameventpath?api=\"$apicamevent\"&version=\"$apicameventmaxver\"&method=\"MotionEnum\"&camId=\"$camid\"&_sid=\"$sid\""; } elsif ($OpMode eq "extevent") { $url = "http://$serveraddr:$serverport/webapi/$apiextevtpath?api=$apiextevt&version=$apiextevtmaxver&method=Trigger&eventId=$hash->{HELPER}{EVENTID}&eventName=$hash->{HELPER}{EVENTID}&_sid=\"$sid\""; } elsif ($OpMode eq "runliveview") { if ($hash->{HELPER}{RUNVIEW} =~ m/live/) { # externe URL $livestream = !AttrVal($name, "livestreamprefix", undef) ? "http://$serveraddr:$serverport" : AttrVal($name, "livestreamprefix", undef); $livestream .= "/webapi/$apivideostmpath?api=$apivideostm&version=$apivideostmmaxver&method=Stream&cameraId=$camid&format=mjpeg&_sid=\"$sid\""; # interne URL $url = "http://$serveraddr:$serverport/webapi/$apivideostmpath?api=$apivideostm&version=$apivideostmmaxver&method=Stream&cameraId=$camid&format=mjpeg&_sid=\"$sid\""; readingsSingleUpdate($hash,"LiveStreamUrl", $livestream, 1) if(AttrVal($name, "showStmInfoFull", undef)); } else { # Abspielen der letzten Aufnahme (EventId) $url = "http://$serveraddr:$serverport/webapi/$apistmpath?api=$apistm&version=$apistmmaxver&method=EventStream&eventId=$hash->{HELPER}{CAMLASTRECID}&_sid=$sid"; } # Liveview-Link in Hash speichern -> Anzeige über SSCam_FWview, in Reading setzen für Linkversand $hash->{HELPER}{LINK} = $url; Log3($name, 4, "$name - Set Streaming-URL: $url"); # livestream sofort in neuem Browsertab öffnen if ($hash->{HELPER}{OPENWINDOW}) { $winname = $name."_view"; $attr = AttrVal($name, "htmlattr", ""); # öffnen streamwindow für die Instanz die "VIEWOPENROOM" oder Attr "room" aktuell geöffnet hat if ($hash->{HELPER}{VIEWOPENROOM}) { $room = $hash->{HELPER}{VIEWOPENROOM}; map {FW_directNotify("FILTER=room=$room", "#FHEMWEB:$_", "window.open ('$url','$winname','$attr')", "")} devspec2array("WEB.*"); } else { map {FW_directNotify("#FHEMWEB:$_", "window.open ('$url','$winname','$attr')", "")} devspec2array("WEB.*"); } } if (ReadingsVal("$name", "Record", "") eq "Start") { readingsSingleUpdate( $hash,"state", "on", 1); } else { readingsSingleUpdate($hash,"state", "off", 1); } $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } Log3($name, 4, "$name - Call-Out now: $url"); $param = { url => $url, timeout => $httptimeout, hash => $hash, method => "GET", header => "Accept: application/json", callback => \&sscam_camop_parse }; HttpUtils_NonblockingGet ($param); } ################################################################################### # Check ob Kameraoperation erfolgreich wie in "OpMOde" definiert # danach Verarbeitung Nutzdaten und weiter zum Logout ################################################################################### sub sscam_camop_parse ($) { my ($param, $err, $myjson) = @_; my $hash = $param->{hash}; my $name = $hash->{NAME}; my $camname = $hash->{CAMNAME}; my $OpMode = $hash->{OPMODE}; my ($rectime,$data,$success); my ($error,$errorcode); my ($snapid,$camLiveMode,$update_time); my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst); my ($deviceType,$camStatus); my ($patrolcnt,$patrolid,$patrolname,@patrolkeys,$patrollist); my ($recStatus,$exposuremode,$exposurecontrol); my ($userPriv,$verbose,$motdetsc); my ($sensitivity_camCap,$sensitivity_value,$sensitivity_ssCap); my ($threshold_camCap,$threshold_value,$threshold_ssCap); my ($percentage_camCap,$percentage_value,$percentage_ssCap); my ($objectSize_camCap,$objectSize_value,$objectSize_ssCap); if ($err ne "") { # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist Log3($name, 2, "$name - error while requesting ".$param->{url}." - $err"); readingsSingleUpdate($hash, "Error", $err, 1); # ausgeführte Funktion ist abgebrochen, Freigabe Funktionstoken $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } elsif ($myjson ne "") { # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes) # Evaluiere ob Daten im JSON-Format empfangen wurden ($hash, $success) = &evaljson($hash,$myjson,$param->{url}); unless ($success) { Log3($name, 4, "$name - Data returned: ".$myjson); # ausgeführte Funktion ist abgebrochen, Freigabe Funktionstoken $hash->{HELPER}{ACTIVE} = "off"; if ($attr{$name}{debugactivetoken}) { Log3($name, 3, "$name - Active-Token deleted by OPMODE: $hash->{OPMODE}"); } return; } $data = decode_json($myjson); # Logausgabe decodierte JSON Daten Log3($name, 5, "$name - JSON returned: ". Dumper $data); $success = $data->{'success'}; if ($success) { # Kameraoperation entsprechend "OpMode" war erfolgreich if ($OpMode eq "Start") { # Die Aufnahmezeit setzen # wird "set
SSCam
-
Using this Module you are able to operate cameras which are defined in Synology Surveillance Station (SVS).
- Start a Recording
- Stop a Recording (using command or automatically after the <RecordTime> period
- Trigger a Snapshot
- Deaktivate a Camera in Synology Surveillance Station
- Activate a Camera in Synology Surveillance Station
- Control of the exposure modes day, night and automatic
- switchover the motion detection by camera, by SVS or to deactivate
- control of motion detection parameters sensitivity, threshold, object size and percentage for release
- Retrieval of Camera Properties (also by Polling) as well as informations about the installed SVS-package
- Move to a predefined Preset-position (at PTZ-cameras)
- Start a predefined Patrol (at PTZ-cameras)
- Positioning of PTZ-cameras to absolute X/Y-coordinates
- continuous moving of PTZ-camera lense
- trigger of external events 1-10 (action rules in SVS)
- start and stop of camera livestreams
- fetch of livestream-Url's with key (login not needed in that case)
- playback of last recording
At present the following functions are available:
For example the recordings are stored for a defined time in Surveillance Station and will be deleted after that period.
If you like to discuss or help to improve this module please use FHEM-Forum with link:
49_SSCam: Fragen, Hinweise, Neuigkeiten und mehr rund um dieses Modul.
Prerequisites
This module uses the CPAN-module JSON. Please consider to install this package (Debian: libjson-perl).
SSCam is completely using the nonblocking functions of HttpUtils respectively HttpUtils_NonblockingGet.
In DSM respectively in Synology Surveillance Station an User has to be created. The login credentials are needed later when using a set-command to assign the login-data to a device.
Further informations could be find among Credentials.
Overview which Perl-modules SSCam is using:
JSON
Data::Dumper
MIME::Base64
Time::HiRes
HttpUtils (FHEM-module)
Define
define <name> SSCAM <Cameraname in SVS> <ServerAddr> [Port] Defines a new camera device for SSCam. At first the devices have to be set up and operable in Synology Surveillance Station 7.0 and above.
The Modul SSCam ist based on functions of Synology Surveillance Station API.
Please refer the Web API Guide.
Currently only HTTP-protocol is supported to call Synology DS.
The parameters are in detail:
| name: | the name of the new device to use in FHEM |
| Cameraname: | Cameraname as defined in Synology Surveillance Station, Spaces are not allowed in Cameraname ! |
| ServerAddr: | IP-address of Synology Surveillance Station Host. Note: avoid using hostnames because of DNS-Calls are not unblocking in FHEM |
| Port: | optional - the port of synology surveillance station, if not set the default of 5000 (HTTP only) is used |
Example:
define CamCP SSCAM Carport 192.168.2.20 [5000]
When a new Camera is defined, as a start the recordingtime of 15 seconds will be assigned to the device.Using the attribute "rectime" you can adapt the recordingtime for every camera individually.
The value of "0" for rectime will lead to an endless recording which has to be stopped by a "set <name> off" command.
Due to a Log-Entry with a hint to that circumstance will be written.
If the attribute "rectime" would be deleted again, the default-value for recording-time (15s) become active.
With command "set <name> on [rectime]" a temporary recordingtime is determinded which would overwrite the dafault-value of recordingtime
and the attribute "rectime" (if it is set) uniquely.
In that case the command "set <name> on 0" leads also to an endless recording as well.
If you have specified a pre-recording time in SVS it will be considered too.
Credentials
After a camera-device is defined, firstly it is needed to save the credentials. This will be done with command:
set <name> credentials <username> <password>
The operator can, dependend on what functions are planned to execute, create an user in DSM respectively in Synology Surveillance Station as well. If the user is member of admin-group, he has access to all module functions. Without this membership the user can only execute functions with lower need of rights.
The required minimum rights to execute functions are listed in a table further down.
Alternatively to DSM-user a user created in SVS can be used. Also in that case a user of type "manager" has the right to execute all functions,
whereat the access to particular cameras can be restricted by the privilege profile (please see help function in SVS for details).
As best practice it is proposed to create an user in DSM as well as in SVS too:
- DSM-User as member of admin group: unrestricted test of all module functions -> session: DSM
- SVS-User as Manager or observer: adjusted privilege profile -> session: SurveillanceStation
Using the Attribute "session" can be selected, if the session should be established to DSM or the SVS instead.
If the session will be established to DSM, SVS Web-API methods are available as well as further API methods of other API's what possibly needed for processing.
After device definition the default is "login to DSM", that means credentials with admin rights can be used to test all camera-functions firstly.
After this the credentials can be switched to a SVS-session with a restricted privilege profile as needed on dependency what module functions are want to be executed.
The following list shows the minimum rights what the particular module function needs.
- set ... on
- set ... off
- set ... snap
- set ... disable
- set ... enable
- set ... expmode
- set ... motdetsc
- set ... goPreset
- set ... runPatrol
- set ... goAbsPTZ
- set ... move
- set ... runView
- set ... extevent
- set ... stopView
- set ... credentials
- get ... caminfoall
- get ... eventlist
- get ... scanVirgin
- get ... svsinfo
- get ... snapfileinfo
- get ... stmUrlPath
| session: ServeillanceStation - observer with enhanced privilege "manual recording" | |
| session: ServeillanceStation - observer with enhanced privilege "manual recording" | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - manager | |
| session: ServeillanceStation - manager | |
| session: ServeillanceStation - manager | |
| session: ServeillanceStation - manager | |
| session: ServeillanceStation - observer with privilege objective control of camera | |
| session: ServeillanceStation - observer with privilege objective control of camera | |
| session: ServeillanceStation - observer with privilege objective control of camera | |
| session: ServeillanceStation - observer with privilege objective control of camera | |
| session: ServeillanceStation - observer with privilege liveview of camera | |
| session: DSM - user as member of admin-group | |
| - | |
| - | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - observer | |
| session: ServeillanceStation - observer |
HTTP-Timeout Settings
All functions of SSCam use HTTP-calls to SVS Web API.
The default-value of HTTP-Timeout amounts 4 seconds. You can set the attribute "httptimeout" > 0 to adjust the value as needed in your technical environment.
Set
-
Currently there are the following options for "Set <name> ..." :
- set <name> [on] [off]
- if, for example, a recording with rectimeme=22 is started, no other startcommand (for a recording) will be accepted until this started recording is finished. A hint will be logged in case of verboselevel = 3.
- a before started recording will be extend by the recording time "rectime" if a new start command is received. That means, the timer for the automatic stop-command will be renewed to "rectime" given bei the command, attribute or default value. This procedure will be repeated every time a new start command for recording is received. Therefore a running recording will be extended until no start command will be get.
- a before started endless-recording will be stopped after recordingtime 2rectime" if a new "set
on"-command is received (new set of timer). If it is unwanted make sure you don't set the attribute "recextend" in case of endless-recordings. - set <name> snap
| "on [rectime]": | starts a recording. The recording will be stopped automatically after a period of [rectime] |
| if [rectime] = 0 an endless recording will be started | |
| "off" : | stopps a running recording manually or using other events (e.g. with at, notify) |
| "snap": | triggers a snapshot of the relevant camera and store it into Synology Surveillance Station |
| "disable": | deactivates a camera in Synology Surveillance Station |
| "enable": | activates a camera in Synology Surveillance Station |
| "credentials <username> <password>": | save a set of credentils |
| "expmode [ day | night | auto ]": | set the exposure mode to day, night or auto |
| "extevent [ 1-10 ]": | triggers the external event 1-10 (see actionrule editor in SVS) |
| "motdetsc [ camera | SVS | disable ]": | set motion detection to the desired mode |
| "goPreset <Presetname>": | moves a PTZ-camera to a predefinied Preset-position |
| "runPatrol <Patrolname>": | starts a predefinied patrol (PTZ-cameras) |
| "goAbsPTZ [ X Y | up | down | left | right ]": | moves a PTZ-camera to a absolute X/Y-coordinate or to direction up/down/left/right |
| "move [ up | down | left | right | dir_X ]": | starts a continuous move of PTZ-camera to direction up/down/left/right or dir_X |
| "runView [image | lastrec | lastrec_open | link | link_open <room> ]": | starts a livestream as embedded image or link |
| "stopView": | stops a camera livestream |
The command "set <name> on" starts a recording. The default recording time takes 15 seconds. It can be changed by the attribute "rectime" individualy. With the attribute (respectively the default value) provided recording time can be overwritten once by "set <name> on [rectime]". The recording will be stopped after processing time "rectime"automatically.
A special case is the start using "set <name> on 0" respectively the attribute value "rectime = 0". In that case a endless-recording will be started. One have to stop this recording by command "set <name> off" explicitely.
The recording behavior can be impacted with attribute "recextend" furthermore as explained as follows.
Attribute "recextend = 0" or not set (default):
Attribute "recextend = 1" is set:
Examples for simple Start/Stop a Recording:
| set <name> on [rectime] | starts a recording of camera <name>, stops automatically after [rectime] (default 15s or defined by attribute) |
| set <name> off | stops the recording of camera <name> |
A snapshot can be triggered with:
set <name> snap
Subsequent some Examples for taking snapshots: If a serial of snapshots should be released, it can be done using the following notify command. For the example a serial of snapshots are to be triggerd if the recording of a camera starts.
When the recording of camera "CamHE1" starts (Attribut event-on-change-reading -> "Record" has to be set), then 3 snapshots at intervals of 2 seconds are triggered.
define he1_snap_3 notify CamHE1:Record.*on define h3 at +*{3}00:00:02 set CamHE1 snap
Release of 2 Snapshots of camera "CamHE1" at intervals of 6 seconds after the motion sensor "MelderHE1" has sent an event, can be done e.g. with following notify-command:
define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap
The ID and the filename of the last snapshot will be displayed as value of variable "LastSnapId" respectively "LastSnapFilename" in the device-Readings. - set <name> [enable] [disable]
For deactivating / activating a list of cameras or all cameras by Regex-expression, subsequent two examples using "at":
define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
define a14 at 21:46 set Cam.* disable (enable)
A bit more convenient is it to use a dummy-device for enable/disable all available cameras in Surveillance Station.At first the Dummy will be created.
define allcams dummy
attr allcams eventMap on:enable off:disable
attr allcams room Cams
attr allcams webCmd enable:disable
With combination of two created notifies, respectively one for "enable" and one for "diasble", you are able to switch all cameras into "enable" or "disable" state at the same time if you set the dummy to "enable" or "disable".
define all_cams_disable notify allcams:.*off set CamCP1,CamFL,CamHE1,CamTER disable
attr all_cams_disable room Cams
define all_cams_enable notify allcams:on set CamCP1,CamFL,CamHE1,CamTER enable
attr all_cams_enable room Cams
- set <name> expmode [day] [night] [auto]
With this command you are able to control the exposure mode and can set it to day, night or automatic mode. Thereby, for example, the behavior of camera LED's will be suitable controlled. The successful switch will be reported by the reading CamExposureMode (command "get ... caminfoall").
Note:
The successfully execution of this function depends on if SVS supports that functionality of the connected camera. Is the field for the Day/Night-mode shown greyed in SVS -> IP-camera -> optimization -> exposure mode, this function will be probably unsupported.
- set <name> motdetsc [camera] [SVS] [disable]
The command "motdetsc" (stands for "motion detection source") switchover the motion detection to the desired mode. If motion detection will be done by camera / SVS without any parameters, the original camera motion detection settings are kept. The successful execution of that opreration one can retrace by the state in SVS -> IP-camera -> event detection -> motion.
For the motion detection further parameter can be specified. The available options for motion detection by SVS are "sensitivity" and "threshold".
| set | # command pattern |
| set | # set the sensitivity to 91 and threshold to 30 |
| set | # keep the old value of sensitivity, set threshold to 40 |
| set | # set the sensitivity to 15, threshold keep unchanged |
If the motion detection is used by camera, there are the options "sensitivity", "object size", "percentage for release" available.
| set | # command pattern |
| set | # set the sensitivity to 89, percentage to 20 |
| set | # keep old value for sensitivity, set threshold to 40, percentage to 10 |
| set | # set the sensitivity to 30, other values keep unchanged |
Please consider always the sequence of parameters. Unwanted options have to be set to "0" if further options which have to be changed are follow (see example above). The numerical values are between 1 - 99 (except special case "0").
The each available options are dependend of camera type respectively the supported functions by SVS. Only the options can be used they are available in SVS -> edit camera -> motion detection. Further informations please read in SVS online help.
With the command "get ... caminfoall" the Reading "CamMotDetSc" also will be updated which documents the current setup of motion detection. Only the parameters and parameter values supported by SVS at present will be shown. The camera itself may offer further options to adjust.
Example:
CamMotDetSc SVS, sensitivity: 76, threshold: 55
- set <name> goPreset <Preset>
Using this command you can move PTZ-cameras to a predefined position.
The Preset-positions have to be defined first of all in the Synology Surveillance Station. This usually happens in the PTZ-control of IP-camera setup in SVS. The Presets will be read ito FHEM with command "get <name> caminfoall" (happens automatically when FHEM restarts). The import process can be repeated regular by camera polling. A long polling interval is recommendable in this case because of the Presets are only will be changed if the user change it in the IP-camera setup itself.
Here it is an example of a PTZ-control depended on IR-motiondetector event:
define CamFL.Preset.Wandschrank notify MelderTER:on.* set CamFL goPreset Wandschrank, ;; define CamFL.Preset.record at +00:00:10 set CamFL on 5 ;;;; define s3 at +*{3}00:00:05 set CamFL snap ;; define CamFL.Preset.back at +00:00:30 set CamFL goPreset Home
Operating Mode: The IR-motiondetector registers a motion. Hereupon the camera "CamFL" moves to Preset-posion "Wandschrank". A recording with the length of 5 seconds starts 10 seconds later. Because of the prerecording time of the camera is set to 10 seconds (cf. Reading "CamPreRecTime"), the effectice recording starts when the camera move begins.
When the recording starts 3 snapshots with an interval of 5 seconds will be taken as well.
After a time of 30 seconds in position "Wandschrank" the camera moves back to postion "Home".
An extract of the log illustrates the process:
2016.02.04 15:02:14 2: CamFL - Camera Flur_Vorderhaus has moved to position "Wandschrank" 2016.02.04 15:02:24 2: CamFL - Camera Flur_Vorderhaus Recording with Recordtime 5s started 2016.02.04 15:02:29 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:30 2: CamFL - Camera Flur_Vorderhaus Recording stopped 2016.02.04 15:02:34 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:39 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:44 2: CamFL - Camera Flur_Vorderhaus has moved to position "Home"
- set <name> runPatrol <Patrolname>
This commans starts a predefined patrol (tour) of a PTZ-camera.
At first the patrol has to be predefined in the Synology Surveillance Station. It can be done in the PTZ-control of IP-Kamera Setup -> PTZ-control -> patrol. The patrol tours will be read with command "get <name> caminfoall" which is be executed automatically when FHEM restarts. The import process can be repeated regular by camera polling. A long polling interval is recommendable in this case because of the patrols are only will be changed if the user change it in the IP-camera setup itself. Further informations for creating patrols you can get in the online-help of Surveillance Station.
- set <name> goAbsPTZ [ X Y | up | down | left | right ]
This command can be used to move a PTZ-camera to an arbitrary absolute X/Y-coordinate, or to absolute position using up/down/left/right. The option is only available for cameras which are having the Reading "CapPTZAbs=true". The property of a camera can be requested with "get <name> caminfoall" .
Example for a control to absolute X/Y-coordinates:
set <name> goAbsPTZ 120 450
In this example the camera lense moves to position X=120 und Y=450. The valuation is:
X = 0 - 640 (0 - 319 moves lense left, 321 - 640 moves lense right, 320 don't move lense)
Y = 0 - 480 (0 - 239 moves lense down, 241 - 480 moves lense up, 240 don't move lense)
The lense can be moved in smallest steps to very large steps into the desired direction.
If necessary the procedure has to be repeated to bring the lense into the desired position. If the motion should be done with the largest possible increment the following command can be used for simplification:
set <name> goAbsPTZ up [down ] [left] [right]In this case the lense will be moved with largest possible increment into the given absolute position. Also in this case the procedure has to be repeated to bring the lense into the desired position if necessary.
- set <name> move [ up | down | left | right | dir_X ] [seconds]
With this command a continuous move of a PTZ-camera will be started. In addition to the four basic directions up/down/left/right is it possible to use angular dimensions "dir_X". The grain size of graduation depends on properties of the camera and can be identified by the Reading "CapPTZDirections".
The radian measure of 360 degrees will be devided by the value of "CapPTZDirections" and describes the move drections starting with "0=right" counterclockwise. That means, if a camera Reading is "CapPTZDirections = 8" it starts with dir_0 = right, dir_2 = top, dir_4 = left, dir_6 = bottom and respectively dir_1, dir_3, dir_5 and dir_7 the appropriate directions between. The possible moving directions of cameras with "CapPTZDirections = 32" are correspondingly divided into smaller sections.
In opposite to the "set <name> goAbsPTZ"-command starts "set <name> move" a continuous move until a stop-command will be received. The stop-command will be generated after the optional assignable time of [seconds]. If that retention period wouldn't be set by the command, a time of 1 second will be set implicit.
Examples:
set <name> move up 0.5 : moves PTZ 0,5 Sek. (plus processing time) to the top
set <name> move dir_1 1.5 : moves PTZ 1,5 Sek. (plus processing time) to top-right
set <name> move dir_20 0.7 : moves PTZ 1,5 Sek. (plus processing time) to left-bottom ("CapPTZDirections = 32)"
- set <name> runView live_fw | live_link | live_open [<room>] | lastrec_fw | lastrec_open [<room>]
With "live_fw, live_link, live_open" a livestream (mjpeg-stream) of a camera will be started, either as embedded image or as a generated link.
The option "live_open" starts a new browser window. If the optional <room> was set, the window will only be started if the specified room is currently opend in a browser session.
Access to the last recording of a camera can be done using "lastrec_fw" respectively "lastrec_open". The recording will be opened in iFrame. So there are some control elements available, e.g. to increase/descrease reproduce speed.
The art of windows in FHEMWEB can be affected by HTML-tags in attribute "htmlattr".
Examples:
attr <name> htmlattr target=_blank width="500" height="375"
attr <name> htmlattr target=_blank width=500,height=375
attr <name> htmlattr width=700,height=525,top=200,left=300
With these attribute values a streaming link will be opened (by click on) in a new browser tab or windows. If the stream will be started as an image, the size changes appropriately the
values of width and hight. The command "set <name> runView live_open" starts the stream immediately in a new browser window (longpoll=1 must be set for WEB). A browser window will be initiated to open for every FHEM session which is active. If you want to change this behavior, you can use command "set <name> runView live_open <room>". It initiates open a browser window in that FHEM session which has just opend the room <room>. The settings of attribute "livestreamprefix" overwrites the data for protocol, servername and port in reading "LiveStreamUrl". By "livestreamprefix" the LivestreamURL (is shown if attribute "showStmInfoFull" is set) can be modified and used for distribution and external access to SVS livestream.
Example:
attr <name> livestreamprefix https://<Servername>:<Port>
The livestream can be stopped again by command "set <name> stopView".
- set <name> extevent [ 1-10 ]
This command triggers an external event (1-10) in SVS. The actions which will are used have to be defined in the actionrule editor of SVS at first. There are the events 1-10 possible. In the message application of SVS you may select Email, SMS or Mobil (DS-Cam) messages to release if an external event has been triggerd. Further informations can be found in the online help of the actionrule editor. The used user needs to be a member of the admin-group and DSM-session is needed too.
Get
-
With SSCam the properties of SVS and defined Cameras could be retrieved. Actually it could be done by following commands:
get <name> caminfoall
get <name> eventlist
get <name> scanVirgin
get <name> stmUrlPath
get <name> svsinfo
get <name> snapfileinfo
With command "get <name> caminfoall" dependend of the type of Camera (e.g. Fix- or PTZ-Camera) the available properties will be retrieved and provided as Readings.For example the Reading "Availability" will be set to "disconnected" if the Camera would be disconnected from Synology Surveillance Station and can be used for further processing like creating events.
By command "get <name> eventlist" the Reading "CamEventNum" and "CamLastRecord" will be refreshed which containes the total number of in SVS registered camera events and the path / name of the last recording. This command will be implicit executed when "get ... caminfoall" is running.
The attribute "videofolderMap" replaces the content of reading "VideoFolder". You can use it for example if you have mounted the videofolder of SVS under another name or path and want to access by your local pc. Using "get <name> snapfileinfo" the filename of the last snapshot will be retrieved. This command will be executed with "get <name> snap" automatically.
The command "get <name> svsinfo" is not really dependend on a camera, but rather a command to determine common informations about the installed SVS-version and other properties.
The functions "caminfoall" and "svsinfo" will be executed automatically once-only after FHEM restarts to collect some relevant informations for camera control.
Please consider to save the credentials what will be used for login to DSM or SVS !
- get <name> scanVirgin
This command is similar to get caminfoall, informations relating to SVS and the camera will be retrieved. In difference to caminfoall in either case a new session ID will be generated (do a new login), the camera ID will be new identified and all necessary API-parameters will be new investigated.
- get <name> stmUrlPath
This command is to fetch the streamkey information and streamurl using that streamkey. The reading "StmKey" will be filled when this command will be executed and can be used to send it and run by your own application like a browser (see example). If the attribute "showStmInfoFull" is set, additional stream readings like "StmKeyUnicst", "StmKeymjpegHttp" will be shown and can be used to run the appropriate livestream without session id. Is the attribute "livestreamprefix" (usage: "http(s)://<hostname><port>) used, the servername / port will be replaced if necessary. The strUrlPath function will be included automatically if polling is used.
Example to create an http-call to a livestream using StmKey:
http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"
cameraId (INTERNAL), StmKey has to be replaced by valid values. Note:
If you use the stream-call from external and replace hostname / port with valid values and open your router ip ports, please make shure that no unauthorized person could get this sensible data !
Polling of Camera-Properties:
-
Retrieval of Camera-Properties can be done automatically if the attribute "pollcaminfoall" will be set to a value > 10.
- PollState = Active - automatic polling will be executed with interval correspondig value of attribute "pollcaminfoall"
- PollState = Inactive - automatic polling won't be executed
As default that attribute "pollcaminfoall" isn't be set and the automatic polling isn't be active.
The value of that attribute determines the interval of property-retrieval in seconds. If that attribute isn't be set or < 10 the automatic polling won't be started
respectively stopped when the value was set to > 10 before.
The attribute "pollcaminfoall" is monitored by a watchdog-timer. Changes of the attribute-value will be checked every 90 seconds and transact corresponding.
Changes of the pollingstate and pollinginterval will be reported in FHEM-Logfile. The reporting can be switched off by setting the attribute "pollnologging=1".
Thereby the needless growing of the logfile can be avoided. But if verbose level is set to 4 or above even though the attribute "pollnologging" is set as well, the polling
will be actived due to analysis purposes.
If FHEM will be restarted, the first data retrieval will be done within 60 seconds after start.
The state of automatic polling will be displayed by reading "PollState":
The readings are described here.
Notes:
If polling is used, the interval should be adjusted only as short as needed due to the detected camera values are predominantly static.
A feasible guide value for attribute "pollcaminfoall" could be between 600 - 1800 (s).
Per polling call and camera approximately 10 - 20 Http-calls will are stepped against Surveillance Station.
Because of that if HTTP-Timeout (pls. refer Attribut "httptimeout") is set to 4 seconds, the theoretical processing time couldn't be higher than 80 seconds.
Considering a safety margin, in that example you shouldn't set the polling interval lower than 160 seconds.
If several Cameras are defined in SSCam, attribute "pollcaminfoall" of every Cameras shouldn't be set exactly to the same value to avoid processing bottlenecks
and thereby caused potential source of errors during request Synology Surveillance Station.
A marginal difference between the polling intervals of the defined cameras, e.g. 1 second, can already be faced as sufficient value.
-
The meaning of used Internals is depicted in following list:
- CAMID - the ID of camera defined in SVS, the value will be retrieved automatically on the basis of SVS-cameraname
- CAMNAME - the name of the camera in SVS
- CREDENTIALS - the value is "Set" if Credentials are set
- NAME - the cameraname in FHEM
- OPMODE - the last executed operation of the module
- SERVERADDR - IP-Address of SVS Host
- SERVERPORT - SVS-Port
- Availability
- CamEventNum
- CamExposureControl
- CamExposureMode
- CamForceEnableMulticast
- CamIP
- CamLastRec
- CamLastRecTime
- CamLiveMode
- CamModel
- CamMotDetSc
- CamPort
- CamPreRecTime
- CamRecShare
- CamRecVolume
- CamVendor
- CamVideoFlip
- CamVideoMirror
- CapAudioOut
- CapChangeSpeed
- CapPTZAbs
- CapPTZAutoFocus
- CapPTZDirections
- CapPTZFocus
- CapPTZHome
- CapPTZIris
- CapPTZPan
- CapPTZTilt
- CapPTZZoom
- DeviceType
- Error
- Errorcode
- LastSnapFilename
- LastSnapId
- LastUpdateTime
- LiveStreamUrl
- Patrols
- PollState
- Presets
- Record
- StmKey
- StmKeyUnicst
- StmKeymjpegHttp
- SVScustomPortHttp
- SVScustomPortHttps
- SVSlicenseNumber
- SVSuserPriv
- SVSversion
- UsedSpaceMB
- VideoFolder
Using the polling mechanism or retrieval by "get"-call readings are provieded, The meaning of the readings are listed in subsequent table:
The transfered Readings can be deversified dependend on the type of camera.
| - Availability of Camera (disabled, enabled, disconnected, other) | |
| - delivers the total number of in SVS registered events of the camera | |
| - indicating type of exposure control | |
| - current exposure mode (Day, Night, Auto, Schedule, Unknown) | |
| - Is the camera forced to enable multicast. | |
| - IP-Address of Camera | |
| - Path / name of the last recording | |
| - date / starttime / endtime of the last recording | |
| - Source of Live-View (DS, Camera) | |
| - Model of camera | |
| - state of motion detection source (disabled, by camera, by SVS) and their parameter | |
| - IP-Port of Camera | |
| - Duration of Pre-Recording (in seconds) adjusted in SVS | |
| - shared folder on disk station for recordings | |
| - Volume on disk station for recordings | |
| - Identifier of camera producer | |
| - Is the video flip | |
| - Is the video mirror | |
| - Capability to Audio Out over Surveillance Station (false/true) | |
| - Capability to various motion speed | |
| - Capability to perform absolute PTZ action | |
| - Capability to perform auto focus action | |
| - the PTZ directions that camera support | |
| - mode of support for focus action | |
| - Capability to perform home action | |
| - mode of support for iris action | |
| - Capability to perform pan action | |
| - mode of support for tilt action | |
| - Capability to perform zoom action | |
| - device type (Camera, Video_Server, PTZ, Fisheye) | |
| - message text of last error | |
| - error code of last error | |
| - the filename of the last snapshot | |
| - the ID of the last snapshot | |
| - date / time the last update of readings by "caminfoall" | |
| - the livestream URL if stream is started (is shown if attribute "showStmInfoFull" is set) | |
| - in Synology Surveillance Station predefined patrols (at PTZ-Cameras) | |
| - shows the state of automatic polling | |
| - in Synology Surveillance Station predefined Presets (at PTZ-Cameras) | |
| - if recording is running = Start, if no recording is running = Stop | |
| - current streamkey. it can be used to open livestreams without session id | |
| - Uni-cast stream path of the camera. (attribute "showStmInfoFull" has to be set) | |
| - Mjpeg stream path(over http) of the camera (attribute "showStmInfoFull" has to be set) | |
| - Customized port of Surveillance Station (HTTP) (to get with "svsinfo") | |
| - Customized port of Surveillance Station (HTTPS) (to get with "svsinfo") | |
| - The total number of installed licenses (to get with "svsinfo") | |
| - The effective rights of the user used for log in (to get with "svsinfo") | |
| - package version of the installed Surveillance Station (to get with "svsinfo") | |
| - used disk space of recordings by Camera | |
| - Path to the recorded video |
- debugactivetoken
if set the state of active token will be logged - only for debugging, don't use it in normal operation ! - disable
deactivates the module (device definition) - httptimeout
Timeout-Value of HTTP-Calls to Synology Surveillance Station, Default: 4 seconds (if httptimeout = "0" or not set) - htmlattr
additional specifications to livestream-Url to manipulate the behavior of stream, e.g. size of the image - livestreamprefix
overwrites the specifications of protocol, servername and port for further use of the livestream address, e.g. as an link to external use. It has to be specified as "http(s)://<servername>:<port>" - loginRetries
set the amount of login-repetitions in case of failure (default = 1) - noQuotesForSID
this attribute may be helpfull in some cases to avoid errormessage "402 - permission denied" and makes login possible. - pollcaminfoall
Interval of automatic polling the Camera properties (if < 10: no polling, if > 10: polling with interval) - pollnologging
"0" resp. not set = Logging device polling active (default), "1" = Logging device polling inactive - rectime
determines the recordtime when a recording starts. If rectime = 0 an endless recording will be started. If it isn't defined, the default recordtime of 15s is activated - recextend
"rectime" of a started recording will be set new. Thereby the recording time of the running recording will be extended - session
selection of login-Session. Not set or set to "DSM" -> session will be established to DSM (Sdefault). "SurveillanceStation" -> session will be established to SVS - simu_SVSversion
simulates another SVS version. (only a lower version than the installed one is possible !) - showStmInfoFull
additional stream informations like LiveStreamUrl, StmKeyUnicst, StmKeymjpegHttp will be created - showPassInLog
if set the used password will be shown in logfile with verbose 4. (default = 0) - videofolderMap
replaces the content of reading "VideoFolder", Usage if e.g. folders are mountet with different names than original (SVS) - verbose
- readingFnAttributes
-
Example:
attr <name> htmlattr width=500 height=325 top=200 left=300
-
Different Verbose-Level are supported.
Those are in detail:
| 0 | - Start/Stop-Event will be logged |
| 1 | - Error messages will be logged |
| 2 | - messages according to important events were logged |
| 3 | - sended commands will be logged |
| 4 | - sended and received informations will be logged |
| 5 | - all outputs will be logged for error-analyses. Caution: a lot of data could be written into logfile ! |
=end html =begin html_DE
SSCam
-
Mit diesem Modul können Operationen von in der Synology Surveillance Station (SVS) definierten Kameras ausgeführt werden.
- Start einer Aufnahme
- Stop einer Aufnahme (per Befehl bzw. automatisch nach Ablauf der Aufnahmedauer)
- Aufnehmen eines Schnappschusses und Ablage in der Synology Surveillance Station
- Deaktivieren einer Kamera in Synology Surveillance Station
- Aktivieren einer Kamera in Synology Surveillance Station
- Steuerung der Belichtungsmodi Tag, Nacht bzw. Automatisch
- Umschaltung der Ereigniserkennung durch Kamera, durch SVS oder deaktiviert
- steuern der Erkennungsparameterwerte Empfindlichkeit, Schwellwert, Objektgröße und Prozentsatz für Auslösung
- Abfrage von Kameraeigenschaften (auch mit Polling) sowie den Eigenschaften des installierten SVS-Paketes
- Bewegen an eine vordefinierte Preset-Position (bei PTZ-Kameras)
- Start einer vordefinierten Überwachungstour (bei PTZ-Kameras)
- Positionieren von PTZ-Kameras zu absoluten X/Y-Koordinaten
- kontinuierliche Bewegung von PTZ-Kameras
- auslösen externer Ereignisse 1-10 (Aktionsregel SVS)
- starten und beenden von Kamera-Livestreams
- Abruf und Ausgabe der Kamera Streamkeys sowie Stream-Urls (Nutzung von Kamera-Livestreams ohne Session Id)
- abspielen der letzten Aufnahme
Zur Zeit werden folgende Funktionen unterstützt:
So werden zum Beispiel die Aufnahmen entsprechend ihrer Archivierungsfrist gespeichert und dann gelöscht.
Wenn sie über dieses Modul diskutieren oder zur Verbesserung des Moduls beitragen möchten, ist im FHEM-Forum ein Sammelplatz unter:
49_SSCam: Fragen, Hinweise, Neuigkeiten und mehr rund um dieses Modul.
Weitere Infomationen zum Modul sind im FHEM-Wiki zu finden:
SSCAM - Steuerung von Kameras in Synology Surveillance Station.
Vorbereitung
Dieses Modul nutzt das CPAN Module JSON. Bitte darauf achten dieses Paket zu installieren. (Debian: libjson-perl).
Das Modul verwendet für HTTP-Calls die nichtblockierenden Funktionen von HttpUtils bzw. HttpUtils_NonblockingGet.
Im DSM bzw. der Synology Surveillance Station muß ein Nutzer angelegt sein. Die Zugangsdaten werden später über ein Set-Kommando dem angelegten Gerät zugewiesen.
Nähere Informationen dazu unter Credentials
Überblick über die Perl-Module welche von SSCam genutzt werden:
JSON
Data::Dumper
MIME::Base64
Time::HiRes
HttpUtils (FHEM-Modul)
Definition
define <name> SSCAM <Kameraname in SVS> <ServerAddr> [Port] Definiert eine neue Kamera für SSCam. Zunächst muß diese Kamera in der Synology Surveillance Station 7.0 oder höher eingebunden sein und entsprechend funktionieren.
Das Modul SSCam basiert auf Funktionen der Synology Surveillance Station API.
Weitere Informationen unter: Web API Guide.
Momentan wird nur das HTTP-Protokoll unterstützt um die Web-Services der Synology DS aufzurufen.
Die Parameter beschreiben im Einzelnen:
| name: | der Name des neuen Gerätes in FHEM |
| Kameraname: | Kameraname wie er in der Synology Surveillance Station angegeben ist. Leerzeichen im Namen sind nicht erlaubt ! |
| ServerAddr: | die IP-Addresse des Synology Surveillance Station Host. Hinweis: Es sollte kein Servername verwendet werden weil DNS-Aufrufe in FHEM blockierend sind. |
| Port: | optional - der Port der Synology Surveillance Station. Wenn nicht angegeben wird der Default-Port 5000 (nur HTTP) gesetzt |
Beispiel:
define CamCP SSCAM Carport 192.168.2.20 [5000]
Wird eine neue Kamera definiert, wird diesem Device zunächst eine Standardaufnahmedauer von 15 zugewiesen. Über das Attribut "rectime" kann die Aufnahmedauer für jede Kamera individuell angepasst werden. Der Wert "0" für "rectime" führt zu einer Endlosaufnahme, die durch "set <name> off" wieder gestoppt werden muß.
Ein Logeintrag mit einem entsprechenden Hinweis auf diesen Umstand wird geschrieben.
Wird das Attribut "rectime" gelöscht, greift wieder der Default-Wert (15s) für die Aufnahmedauer.
Mit dem Befehl "set <name> on [rectime]" wird die Aufnahmedauer temporär festgelegt und überschreibt einmalig sowohl den Defaultwert als auch den Wert des gesetzten Attributs "rectime".
Auch in diesem Fall führt "set <name> on 0" zu einer Daueraufnahme.
Eine eventuell in der SVS eingestellte Dauer der Voraufzeichnung wird weiterhin berücksichtigt.
Credentials
Nach dem Definieren des Gerätes müssen zuerst die Zugangsparameter gespeichert werden. Das geschieht mit dem Befehl:
set <name> credentials <Username> <Passwort>
Der Anwender kann in Abhängigkeit der beabsichtigten einzusetzenden Funktionen einen Nutzer im DSM bzw. in der Surveillance Station einrichten. Ist der DSM-Nutzer der Gruppe Administratoren zugeordnet, hat er auf alle Funktionen Zugriff. Ohne diese Gruppenzugehörigkeit können nur Funktionen mit niedrigeren
Rechtebedarf ausgeführt werden. Die benötigten Mindestrechte der Funktionen sind in der Tabelle weiter unten aufgeführt.
Alternativ zum DSM-Nutzer kann ein in der SVS angelegter Nutzer verwendet werden. Auch in diesem Fall hat ein Nutzer vom Typ Manager das Recht alle Funktionen
auszuführen, wobei der Zugriff auf bestimmte Kameras/ im Privilegienprofil beschränkt werden kann (siehe Hilfefunktion in SVS).
Als Best Practice wird vorgeschlagen jeweils einen User im DSM und einen in der SVS anzulegen:
- DSM-User als Mitglied der Admin-Gruppe: uneingeschränkter Test aller Modulfunktionen -> session:DSM
- SVS-User als Manager oder Betrachter: angepasstes Privilegienprofil -> session: SurveillanceStation
Über das Attribut "session" kann ausgewählt werden, ob die Session mit dem DSM oder der SVS augebaut werden soll.
Erfolgt der Session-Aufbau mit dem DSM, stehen neben der SVS Web-API auch darüber hinaus gehende API-Zugriffe zur Verfügung die unter Umständen zur Verarbeitung benötigt werden.
Nach der Gerätedefinition ist die Grundeinstellung "Login in das DSM", d.h. es können Credentials mit Admin-Berechtigungen genutzt werden um zunächst alle
Funktionen der Kameras testen zu können. Danach können die Credentials z.B. in Abhängigkeit der benötigten Funktionen auf eine SVS-Session mit entsprechend beschränkten Privilegienprofil umgestellt werden.
Die nachfolgende Aufstellung zeigt die Mindestanforderungen der jeweiligen Modulfunktionen an die Nutzerrechte.
- set ... on
- set ... off
- set ... snap
- set ... disable
- set ... enable
- set ... expmode
- set ... motdetsc
- set ... goPreset
- set ... runPatrol
- set ... goAbsPTZ
- set ... move
- set ... runView
- set ... stopView
- set ... credentials
- set ... extevent
- get ... caminfoall
- get ... eventlist
- get ... scanVirgin
- get ... svsinfo
- get ... snapfileinfo
- get ... stmUrlPath
| session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme" | |
| session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme" | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Manager | |
| session: ServeillanceStation - Manager | |
| session: ServeillanceStation - Manager | |
| session: ServeillanceStation - Manager | |
| session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera | |
| session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera | |
| session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera | |
| session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera | |
| session: ServeillanceStation - Betrachter mit Privileg Liveansicht für Kamera | |
| - | |
| - | |
| session: DSM - Nutzer Mitglied von Admin-Gruppe | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Betrachter | |
| session: ServeillanceStation - Betrachter |
HTTP-Timeout setzen
Alle Funktionen dieses Moduls verwenden HTTP-Aufrufe gegenüber der SVS Web API.
Der Standardwert für den HTTP-Timeout beträgt 4 Sekunden. Durch Setzen des Attributes "httptimeout" > 0 kann dieser Wert bei Bedarf entsprechend den technischen Gegebenheiten angepasst werden.
Set
-
Es gibt zur Zeit folgende Optionen für "set <name> ...":
- set <name> [on] [off]
- wird eine Aufnahme mit z.B. rectime=22 gestartet, wird kein weiterer Startbefehl für eine Aufnahme akzeptiert bis diese gestartete Aufnahme nach 22 Sekunden beendet ist. Ein Hinweis wird bei verbose=3 im Logfile protokolliert.
- eine zuvor gestartete Aufnahme wird bei einem erneuten "set
on" -Befehl um die Aufnahmezeit "rectime" verlängert. Das bedeutet, dass der Timer für den automatischen Stop auf den Wert "rectime" neu gesetzt wird. Dieser Vorgang wiederholt sich mit jedem Start-Befehl. Dadurch verlängert sich eine laufende Aufnahme bis kein Start-Inpuls mehr registriert wird. - eine zuvor gestartete Endlos-Aufnahme wird mit einem erneuten "set
on"-Befehl nach der Aufnahmezeit "rectime" gestoppt (Timerneustart). Ist dies nicht gewünscht, ist darauf zu achten dass bei der Verwendung einer Endlos-Aufnahme das Attribut "recextend" nicht verwendet wird. - set <name> snap
| "on [rectime]": | startet eine Aufnahme. Die Aufnahme wird automatisch nach Ablauf der Zeit [rectime] gestoppt. |
| Mit rectime = 0 wird eine Daueraufnahme gestartet die durch "set <name> off" wieder gestoppt werden muß. | |
| "off" : | stoppt eine laufende Aufnahme manuell oder durch die Nutzung anderer Events (z.B. über at, notify) |
| "snap": | löst einen Schnappschuß der entsprechenden Kamera aus und speichert ihn in der Synology Surveillance Station |
| "disable": | deaktiviert eine Kamera in der Synology Surveillance Station |
| "enable": | aktiviert eine Kamera in der Synology Surveillance Station |
| "credentials <username> <password>": | speichert die Zugangsinformationen |
| "expmode [ day | night | auto ]": | aktiviert den Belichtungsmodus Tag, Nacht oder Automatisch |
| "extevent [ 1-10 ]": | löst das externe Ereignis 1-10 aus (Aktionsregel in SVS) |
| "motdetsc [ camera | SVS | disable ]": | schaltet die Bewegungserkennung in den gewünschten Modus (durch Kamera, SVS, oder deaktiviert) |
| "goPreset <Presetname>": | bewegt eine PTZ-Kamera zu einer vordefinierten Preset-Position |
| "runPatrol <Patrolname>": | startet eine vordefinierte Überwachungstour einer PTZ-Kamera |
| "goAbsPTZ [ X Y | up | down | left | right ]": | positioniert eine PTZ-camera zu einer absoluten X/Y-Koordinate oder maximalen up/down/left/right-position |
| "move [ up | down | left | right | dir_X ]": | startet kontinuerliche Bewegung einer PTZ-Kamera in Richtung up/down/left/right bzw. dir_X |
| "runView live_fw | live_link | live_open [<room>] | lastrec_fw | lastrec_open [<room>]": | startet einen Livestream als eingbettetes Image, IFrame bzw. Link |
| "stopView": | stoppt einen Kamera-Livestream |
Der Befehl "set <name> on" startet eine Aufnahme. Die Standardaufnahmedauer beträgt 15 Sekunden. Sie kann mit dem Attribut "rectime" individuell festgelegt werden. Die im Attribut (bzw. im Standard) hinterlegte Aufnahmedauer kann einmalig mit "set <name> on [rectime]" überschrieben werden. Die Aufnahme stoppt automatisch nach Ablauf der Zeit "rectime".
Ein Sonderfall ist der Start einer Daueraufnahme mit "set <name> on 0" bzw. dem Attributwert "rectime = 0". In diesem Fall wird eine Daueraufnahme gestartet die explizit wieder mit dem Befehl "set <name> off" gestoppt werden muß.
Das Aufnahmeverhalten kann weiterhin mit dem Attribut "recextend" wie folgt beeinflusst werden.
Attribut "recextend = 0" bzw. nicht gesetzt (Standard):
Attribut "recextend = 1" gesetzt:
Beispiele für einfachen Start/Stop einer Aufnahme:
| set <name> on [rectime] | startet die Aufnahme der Kamera <name>, automatischer Stop der Aufnahme nach Ablauf der Zeit [rectime] (default 15s oder wie im Attribut "rectime" angegeben) |
| set <name> off | stoppt die Aufnahme der Kamera <name> |
Ein Schnappschuß kann ausgelöst werden mit:
set <name> snap
Nachfolgend einige Beispiele für die Auslösung von Schnappschüssen. Soll eine Reihe von Schnappschüssen ausgelöst werden wenn eine Aufnahme startet, kann das z.B. durch folgendes notify geschehen.
Sobald der Start der Kamera CamHE1 ausgelöst wird (Attribut event-on-change-reading -> "Record" setzen), werden abhängig davon 3 Snapshots im Abstand von 2 Sekunden getriggert.
define he1_snap_3 notify CamHE1:Record.*Start define h3 at +*{3}00:00:02 set CamHE1 snap
Triggern von 2 Schnappschüssen der Kamera "CamHE1" im Abstand von 6 Sekunden nachdem der Bewegungsmelder "MelderHE1" einen Event gesendet hat, kann z.B. mit folgendem notify geschehen:
define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap
Es wird die ID und der Filename des letzten Snapshots als Wert der Variable "LastSnapId" bzw. "LastSnapFilename" in den Readings der Kamera ausgegeben. - set <name> [enable] [disable]
Um eine Liste von Kameras oder alle Kameras (mit Regex) zum Beispiel um 21:46 zu deaktivieren / zu aktivieren zwei Beispiele mit at:
define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
define a14 at 21:46 set Cam.* disable (enable)
Etwas komfortabler gelingt das Schalten aller Kameras über einen Dummy. Zunächst wird der Dummy angelegt:
define allcams dummy
attr allcams eventMap on:enable off:disable
attr allcams room Cams
attr allcams webCmd enable:disable
Durch Verknüpfung mit zwei angelegten notify, jeweils ein notify für "enable" und "disable", kann man durch Schalten des Dummys auf "enable" bzw. "disable" alle Kameras auf einmal aktivieren bzw. deaktivieren.
define all_cams_disable notify allcams:.*off set CamCP1,CamFL,CamHE1,CamTER disable
attr all_cams_disable room Cams
define all_cams_enable notify allcams:on set CamCP1,CamFL,CamHE1,CamTER enable
attr all_cams_enable room Cams
- set <name> expmode [day] [night] [auto]
Mit diesem Befehl kann der Belichtungsmodus der Kameras gesetzt werden. Dadurch wird z.B. das Verhalten der Kamera-LED's entsprechend gesteuert. Die erfolgreiche Umschaltung wird durch das Reading CamExposureMode ("get ... caminfoall") reportet.
Hinweis:
Die erfolgreiche Ausführung dieser Funktion ist davon abhängig ob die SVS diese Funktionalität der Kamera unterstützt. Ist in SVS -> IP-Kamera -> Optimierung -> Belichtungsmodus das Feld für den Tag/Nachtmodus grau hinterlegt, ist nicht von einer lauffähigen Unterstützung dieser Funktion auszugehen.
set <name> motdetsc [camera] [SVS] [disable]
Der Befehl "motdetsc" (steht für motion detection source) schaltet die Bewegungserkennung in den gewünschten Modus. Wird die Bewegungserkennung durch die Kamera / SVS ohne weitere Optionen eingestellt, werden die momentan gültigen Bewegungserkennungsparameter der Kamera / SVS beibehalten. Die erfolgreiche Ausführung der Operation lässt sich u.a. anhand des Status von SVS -> IP-Kamera -> Ereigniserkennung -> Bewegung nachvollziehen.
Für die Bewegungserkennung durch SVS bzw. durch Kamera können weitere Optionen angegeben werden. Die verfügbaren Optionen bezüglich der Bewegungserkennung durch SVS sind "Empfindlichkeit" und "Schwellwert".
| set | # Befehlsmuster |
| set | # setzt die Empfindlichkeit auf 91 und den Schwellwert auf 30 |
| set | # behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40 |
| set | # setzt die Empfindlichkeit auf 15, Schwellwert bleibt unverändert |
Wird die Bewegungserkennung durch die Kamera genutzt, stehen die Optionen "Empfindlichkeit", "Objektgröße" und "Prozentsatz für Auslösung" zur Verfügung.
| set | # Befehlsmuster |
| set | # setzt die Empfindlichkeit auf 89, Prozentsatz auf 20 |
| set | # behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40, Prozentsatz auf 10 |
| set | # setzt die Empfindlichkeit auf 30, andere Werte bleiben unverändert |
Es ist immer die Reihenfolge der Optionswerte zu beachten. Nicht gewünschte Optionen sind mit "0" zu besetzen sofern danach Optionen folgen deren Werte verändert werden sollen (siehe Beispiele oben). Der Zahlenwert der Optionen beträgt 1 - 99 (außer Sonderfall "0").
Die jeweils verfügbaren Optionen unterliegen der Funktion der Kamera und der Unterstützung durch die SVS. Es können jeweils nur die Optionen genutzt werden die in SVS -> Kamera bearbeiten -> Ereigniserkennung zur Verfügung stehen. Weitere Infos sind der Online-Hilfe zur SVS zu entnehmen.
Über den Befehl "get ... caminfoall" wird auch das Reading "CamMotDetSc" aktualisiert welches die gegenwärtige Einstellung der Bewegungserkennung dokumentiert. Es werden nur die Parameter und Parameterwerte angezeigt, welche die SVS aktiv unterstützt. Die Kamera selbst kann weiterführende Einstellmöglichkeiten besitzen.
Beipiel:
CamMotDetSc SVS, sensitivity: 76, threshold: 55
- set <name> goPreset <Preset>
Mit diesem Kommando können PTZ-Kameras in eine vordefininierte Position bewegt werden.
Die Preset-Positionen müssen dazu zunächst in der Synology Surveillance Station angelegt worden sein. Das geschieht in der PTZ-Steuerung im IP-Kamera Setup. Die Presets werden über das Kommando "get <name> caminfoall" eingelesen (geschieht bei restart von FHEM automatisch). Der Einlesevorgang kann durch ein Kamerapolling regelmäßig wiederholt werden. Ein langes Pollingintervall ist in diesem Fall empfehlenswert, da sich die Presetpositionen nur im Fall der Neuanlage bzw. Änderung verändern werden.
Hier ein Beispiel einer PTZ-Steuerung in Abhängigkeit eines IR-Melder Events:
define CamFL.Preset.Wandschrank notify MelderTER:on.* set CamFL goPreset Wandschrank, ;; define CamFL.Preset.record at +00:00:10 set CamFL on 5 ;;;; define s3 at +*{3}00:00:05 set CamFL snap ;; define CamFL.Preset.back at +00:00:30 set CamFL goPreset Home
Funktionsweise: Der IR-Melder "MelderTER" registriert eine Bewegung. Daraufhin wird die Kamera CamFL in die Preset-Position "Wandschrank" gebracht. Eine Aufnahme mit Dauer von 5 Sekunden startet 10 Sekunden später. Da die Voraufnahmezeit der Kamera 10s beträgt (vgl. Reading "CamPreRecTime"), startet die effektive Aufnahme wenn der Kameraschwenk beginnt.
Mit dem Start der Aufnahme werden drei Schnappschüsse im Abstand von 5 Sekunden angefertigt.
Nach einer Zeit von 30 Sekunden fährt die Kamera wieder zurück in die "Home"-Position.
Ein Auszug aus dem Log verdeutlicht den Ablauf:
2016.02.04 15:02:14 2: CamFL - Camera Flur_Vorderhaus has moved to position "Wandschrank" 2016.02.04 15:02:24 2: CamFL - Camera Flur_Vorderhaus Recording with Recordtime 5s started 2016.02.04 15:02:29 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:30 2: CamFL - Camera Flur_Vorderhaus Recording stopped 2016.02.04 15:02:34 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:39 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully 2016.02.04 15:02:44 2: CamFL - Camera Flur_Vorderhaus has moved to position "Home"
- set <name> runPatrol <Patrolname>
Dieses Kommando startet die vordefinierterte Überwachungstour einer PTZ-Kamera.
Die Überwachungstouren müssen dazu zunächst in der Synology Surveillance Station angelegt worden sein. Das geschieht in der PTZ-Steuerung im IP-Kamera Setup -> PTZ-Steuerung -> Überwachung. Die Überwachungstouren (Patrols) werden über das Kommando "get <name> caminfoall" eingelesen, welches beim Restart von FHEM automatisch abgearbeitet wird. Der Einlesevorgang kann durch ein Kamerapolling regelmäßig wiederholt werden. Ein langes Pollingintervall ist in diesem Fall empfehlenswert, da sich die Überwachungstouren nur im Fall der Neuanlage bzw. Änderung verändern werden. Nähere Informationen zur Anlage von Überwachungstouren sind in der Hilfe zur Surveillance Station enthalten.
- set <name> goAbsPTZ [ X Y | up | down | left | right ]
Mit diesem Kommando wird eine PTZ-Kamera in Richtung einer wählbaren absoluten X/Y-Koordinate bewegt, oder zur maximalen Absolutposition in Richtung up/down/left/right. Die Option ist nur für Kameras verfügbar die das Reading "CapPTZAbs=true" (die Fähigkeit für PTZAbs-Aktionen) besitzen. Die Eigenschaften der Kamera kann mit "get <name> caminfoall" abgefragt werden.
Beispiel für Ansteuerung absoluter X/Y-Koordinaten:
set <name> goAbsPTZ 120 450
Dieses Beispiel bewegt die Kameralinse in die Position X=120 und Y=450. Der Wertebereich ist dabei:
X = 0 - 640 (0 - 319 bewegt nach links, 321 - 640 bewegt nach rechts, 320 bewegt die Linse nicht)
Y = 0 - 480 (0 - 239 bewegt nach unten, 241 - 480 bewegt nach oben, 240 bewegt die Linse nicht)
Die Linse kann damit in kleinsten bis sehr großen Schritten in die gewünschte Richtung bewegt werden.
Dieser Vorgang muß ggf. mehrfach wiederholt werden um die Kameralinse in die gewünschte Position zu bringen. Soll die Bewegung mit der maximalen Schrittweite erfolgen, kann zur Vereinfachung der Befehl:
set <name> goAbsPTZ up [down ] [left] [right]verwendet werden. Die Optik wird in diesem Fall mit der größt möglichen Schrittweite zur Absolutposition in der angegebenen Richtung bewegt. Auch in diesem Fall muß der Vorgang ggf. mehrfach wiederholt werden um die Kameralinse in die gewünschte Position zu bringen.
- set <name> move [ up | down | left | right | dir_X ] [Sekunden]
Mit diesem Kommando wird eine kontinuierliche Bewegung der PTZ-Kamera gestartet. Neben den vier Grundrichtungen up/down/left/right stehen auch Zwischenwinkelmaße "dir_X" zur Verfügung. Die Feinheit dieser Graduierung ist von der Kamera abhängig und kann dem Reading "CapPTZDirections" entnommen werden.
Das Bogenmaß von 360 Grad teilt sich durch den Wert von "CapPTZDirections" und beschreibt die Bewegungsrichtungen beginnend mit "0=rechts" entgegen dem Uhrzeigersinn. D.h. bei einer Kamera mit "CapPTZDirections = 8" bedeutet dir_0 = rechts, dir_2 = oben, dir_4 = links, dir_6 = unten bzw. dir_1, dir_3, dir_5 und dir_7 die entsprechenden Zwischenrichtungen. Die möglichen Bewegungsrichtungen bei Kameras mit "CapPTZDirections = 32" sind dementsprechend kleinteiliger.
Im Gegensatz zum "set <name> goAbsPTZ"-Befehl startet der Befehl "set <name> move" eine kontinuierliche Bewegung bis ein Stop-Kommando empfangen wird. Das Stop-Kommando wird nach Ablauf der optional anzugebenden Zeit [Sekunden] ausgelöst. Wird diese Laufzeit nicht angegeben, wird implizit Sekunde = 1 gesetzt.
Beispiele:
set <name> move up 0.5 : bewegt PTZ 0,5 Sek. (zzgl. Prozesszeit) nach oben
set <name> move dir_1 1.5 : bewegt PTZ 1,5 Sek. (zzgl. Prozesszeit) nach rechts-oben
set <name> move dir_20 0.7 : bewegt PTZ 1,5 Sek. (zzgl. Prozesszeit) nach links-unten ("CapPTZDirections = 32)"
- set <name> runView live_fw | live_link | live_open [<room>] | lastrec_fw | lastrec_open [<room>]
Mit "live_fw, live_link, live_open" wird ein Livestream (mjpeg-Stream) der Kamera, entweder als eingebettetes Image oder als generierter Link, gestartet.
Die Option "live_open" startet ein separates Browserfenster mit dem Lifestream. Wird dabei optional der Raum mit angegeben, wird das Browserfenster nur gestartet wenn dieser Raum aktuell im Browser geöffnet ist.
Der Zugriff auf die letzte Aufnahme einer Kamera kann über die Optionen "lastrec_fw" bzw. "lastrec_open" erfolgen. Bei Verwendung von "lastrec_fw" wird die letzte Aufnahme als eingebettetes iFrame-Objekt abgespielt. Es stehen entsprechende Steuerungselemente zur Wiedergabegeschwindigkeit usw. zur Verfügung.
Durch Angabe des optionalen Raumes bei "lastrec_open" erfolgt die gleiche Einschränkung wie bei "live_open".
Die Gestaltung der Fenster im FHEMWEB kann durch HTML-Tags im Attribut "htmlattr" beeinflusst werden.
Beispiel:
attr <name> htmlattr target=_blank width="500" height="375"
attr <name> htmlattr target=_blank width=500,height=375
attr <name> htmlattr width=700,height=525,top=200,left=300
Mit diesen Attributwerten öffnet der Link (mit Klick) als weiteres Fenster/Browsertab. Wird der Stream als live_fw gestartet,
ändert sich die Größe entsprechend der Angaben von Width und Hight. Das Kommando "set <name> runView live_open" startet den Livestreamlink sofort in einem neuen Browserfenster (longpoll=1 muß für WEB gesetzt sein). Dabei wird für jede aktive FHEM-Session eine Fensteröffnung initiiert. Soll dieses Verhalten geändert werden, kann "set <name> runView live_open <room>" verwendet werden um das Öffnen des Browserwindows in einem beliebigen, in einer FHEM-Session angezeigten Raum <room>, zu initiieren.
Das gesetzte Attribut "livestreamprefix" überschreibt im Reading "LiveStreamUrl" die Angaben für Protokoll, Servername und Port. Damit kann z.B. die LiveStreamUrl für den Versand und externen Zugriff auf die SVS modifiziert werden.
Beispiel:
attr <name> livestreamprefix https://<Servername>:<Port>
Der Livestream wird über das Kommando "set <name> stopView" wieder beendet.
- set <name> extevent [ 1-10 ]
Dieses Kommando triggert ein externes Ereignis (1-10) in der SVS. Die Aktionen, die dieses Ereignis auslöst, sind zuvor in dem Aktionsregeleditor der SVS einzustellen. Es stehen die Ereignisse 1-10 zur Verfügung. In der Banchrichtigungs-App der SVS können auch Email, SMS oder Mobil (DS-Cam) Nachrichten ausgegeben werden wenn ein externes Ereignis ausgelöst wurde. Nähere Informationen dazu sind in der Hilfe zum Aktionsregeleditor zu finden. Der verwendete User benötigt Admin-Rechte in einer DSM-Session.
Get
-
Mit SSCam können die Eigenschaften der Surveillance Station und der Kameras abgefragt werden. Zur Zeit stehen dazu
folgende Befehle zur Verfügung:
get <name> caminfoall
get <name> eventlist
get <name> scanVirgin
get <name> stmUrlPath
get <name> svsinfo
get <name> snapfileinfo
Mit dem Befehl "get <name> caminfoall" werden abhängig von der Art der Kamera (z.B. Fix- oder PTZ-Kamera) die
verfügbaren Eigenschaften ermittelt und als Readings zur Verfügung gestellt. So wird zum Beispiel das Reading "Availability" auf "disconnected" gesetzt falls die Kamera von der Surveillance Station getrennt wird und kann für weitere Verarbeitungen genutzt werden.
Durch "get <name> eventlist" wird das Reading "CamEventNum" und "CamLastRec" aktualisiert, welches die Gesamtanzahl der registrierten Kameraevents und den Pfad / Namen der letzten Aufnahme enthält. Dieser Befehl wird implizit mit "get ... caminfoall" ausgeführt.
Mit dem Attribut "videofolderMap" kann der Inhalt des Readings "VideoFolder" überschrieben werden. Dies kann von Vortel sein wenn das Surveillance-Verzeichnis der SVS an dem lokalen PC unter anderem Pfadnamen gemountet ist und darüber der Zugriff auf die Aufnahmen erfolgen soll (z.B. Verwendung Email-Versand).
Ein DOIF-Beispiel für den Email-Versand von Snapshot und Aufnahmelink per Non-blocking sendmail:
define CamHE1.snap.email DOIF ([CamHE1:"LastSnapFilename"])
({DebianMailnbl ('Recipient@Domain','Bewegungsalarm CamHE1','Eine Bewegung wurde an der Haustür registriert. Aufnahmelink: \
\[CamHE1:VideoFolder]\[CamHE1:CamLastRec]','/media/sf_surveillance/@Snapshot/[CamHE1:LastSnapFilename]')})
Mit "get <name> snapfileinfo" wird der Filename des letzten Schnapschusses ermittelt. Der Befehl wird implizit mit "get <name> snap" ausgeführt. Der Befehl "get <name> svsinfo" ist eigentlich nicht von der Kamera abhängig, sondern ermittelt vielmehr allgemeine Informationen zur installierten SVS-Version und andere Eigenschaften.
Die Funktionen "caminfoall" und "svsinfo" werden einmalig automatisch beim Start von FHEM ausgeführt um steuerungsrelevante Informationen zu sammeln.
Es ist darauf zu achten dass die Credentials gespeichert wurden !
- get <name> scanVirgin
Wie mit get caminfoall werden alle Informationen der SVS und Kamera abgerufen. Allerdings wird in jedem Fall eine neue Session ID generiert (neues Login), die Kamera-ID neu ermittelt und es werden alle notwendigen API-Parameter neu eingelesen.
- get <name> stmUrlPath
Mit diesem Kommando wird der aktuelle Streamkey der Kamera abgerufen und das Reading mit dem Key-Wert gefüllt. Dieser Streamkey kann verwendet werden um eigene Aufrufe eines Livestreams aufzubauen (siehe Beispiel). Wenn das Attribut "showStmInfoFull" gesetzt ist, werden zusaätzliche Stream-Informationen wie "StmKeyUnicst", "StmKeymjpegHttp" ausgegeben. Diese Readings enthalten die gültigen Stream-Pfade zu einem Livestream und können z.B. versendet und von einer entsprechenden Anwendung ohne session Id geöffnet werden. Wenn das Attribut "livestreamprefix" (Format: "http(s)://<hostname><port>) gesetzt ist, wird der Servername und Port überschrieben soweit es sinnvoll ist. Wird Polling der Kameraeigenschaften genutzt, wird die stmUrlPath-Funktion automatisch mit ausgeführt.
Beispiel für den Aufbau eines Http-Calls zu einem Livestream mit StmKey:
http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"
cameraId (INTERNAL), StmKey müssen durch gültige Werte ersetzt werden. Hinweis:
Falls der Stream-Aufruf versendet und von extern genutzt wird sowie hostname / port durch gültige Werte ersetzt und die Routerports entsprechend geöffnet werden, ist darauf zu achten dass diese sensiblen Daten nicht durch unauthorisierte Personen für den Zugriff genutzt werden können !
Polling der Kameraeigenschaften:
Die Abfrage der Kameraeigenschaften erfolgt automatisch, wenn das Attribut "pollcaminfoall" (siehe Attribute) mit einem Wert > 10 gesetzt wird.
Per Default ist das Attribut "pollcaminfoall" nicht gesetzt und das automatische Polling nicht aktiv.
Der Wert dieses Attributes legt das Intervall der Abfrage in Sekunden fest. Ist das Attribut nicht gesetzt oder < 10 wird kein automatisches Polling
gestartet bzw. gestoppt wenn vorher der Wert > 10 gesetzt war.
Das Attribut "pollcaminfoall" wird durch einen Watchdog-Timer überwacht. Änderungen des Attributwertes werden alle 90 Sekunden ausgewertet und entsprechend umgesetzt.
Eine Änderung des Pollingstatus / Pollingintervalls wird im FHEM-Logfile protokolliert. Diese Protokollierung kann durch Setzen des Attributes "pollnologging=1" abgeschaltet werden.
Dadurch kann ein unnötiges Anwachsen des Logs vermieden werden. Ab verbose=4 wird allerdings trotz gesetzten "pollnologging"-Attribut ein Log des Pollings
zu Analysezwecken aktiviert.
Wird FHEM neu gestartet, wird bei aktivierten Polling der ersten Datenabruf innerhalb 60s nach dem Start ausgeführt.
Der Status des automatischen Pollings wird durch das Reading "PollState" signalisiert:
- PollState = Active - automatisches Polling wird mit Intervall entsprechend "pollcaminfoall" ausgeführt
- PollState = Inactive - automatisches Polling wird nicht ausgeführt
Die Bedeutung der Readingwerte ist unter Readings beschrieben.
Hinweise:
Wird Polling eingesetzt, sollte das Intervall nur so kurz wie benötigt eingestellt werden da die ermittelten Werte überwiegend statisch sind.
Das eingestellte Intervall sollte nicht kleiner sein als die Summe aller HTTP-Verarbeitungszeiten. Pro Pollingaufruf und Kamera werden ca. 10 - 20 Http-Calls gegen die Surveillance Station abgesetzt.
Bei einem eingestellten HTTP-Timeout (siehe Attribut) "httptimeout") von 4 Sekunden kann die theoretische Verarbeitungszeit nicht höher als 80 Sekunden betragen.
In dem Beispiel sollte man das Pollingintervall mit einem Sicherheitszuschlag auf nicht weniger 160 Sekunden setzen.
Ein praktikabler Richtwert könnte zwischen 600 - 1800 (s) liegen.
Sind mehrere Kameras in SSCam definiert, sollte "pollcaminfoall" nicht bei allen Kameras auf exakt den gleichen Wert gesetzt werden um Verarbeitungsengpässe
und dadurch versursachte potentielle Fehlerquellen bei der Abfrage der Synology Surveillance Station zu vermeiden.
Ein geringfügiger Unterschied zwischen den Pollingintervallen der definierten Kameras von z.B. 1s kann bereits als ausreichend angesehen werden.
Internals
-
Die Bedeutung der verwendeten Internals stellt die nachfolgende Liste dar:
- CAMID - die ID der Kamera in der SVS, der Wert wird automatisch anhand des SVS-Kameranamens ermittelt.
- CAMNAME - der Name der Kamera in der SVS
- CREDENTIALS - der Wert ist "Set" wenn die Credentials gesetzt wurden
- NAME - der Kameraname in FHEM
- OPMODE - die zuletzt ausgeführte Operation des Moduls
- SERVERADDR - IP-Adresse des SVS Hostes
- SERVERPORT - der SVS-Port
- Availability
- CamEventNum
- CamExposureControl
- CamExposureMode
- CamForceEnableMulticast
- CamIP
- CamLastRec
- CamLastRecTime
- CamLiveMode
- CamModel
- CamMotDetSc
- CamPort
- CamPreRecTime
- CamRecShare
- CamRecVolume
- CamVendor
- CamVideoFlip
- CamVideoMirror
- CapAudioOut
- CapChangeSpeed
- CapPTZAbs
- CapPTZAutoFocus
- CapPTZDirections
- CapPTZFocus
- CapPTZHome
- CapPTZIris
- CapPTZPan
- CapPTZTilt
- CapPTZZoom
- DeviceType
- Error
- Errorcode
- LastSnapFilename
- LastSnapId
- LastUpdateTime
- LiveStreamUrl
- Patrols
- PollState
- Presets
- Record
- StmKey
- StmKeyUnicst
- StmKeymjpegHttp
- SVScustomPortHttp
- SVScustomPortHttps
- SVSlicenseNumber
- SVSuserPriv
- SVSversion
- UsedSpaceMB
- VideoFolder
Über den Pollingmechanismus bzw. durch Abfrage mit "Get" werden Readings bereitgestellt, deren Bedeutung in der nachfolgenden Tabelle dargestellt sind.
Die übermittelten Readings können in Abhängigkeit des Kameratyps variieren.
| - Verfügbarkeit der Kamera (disabled, enabled, disconnected, other) | |
| - liefert die Gesamtanzahl der in SVS registrierten Events der Kamera | |
| - zeigt den aktuell eingestellten Typ der Belichtungssteuerung | |
| - aktueller Belichtungsmodus (Day, Night, Auto, Schedule, Unknown) | |
| - sagt aus ob die Kamera verpflichet ist Multicast einzuschalten. | |
| - IP-Adresse der Kamera | |
| - Pfad / Name der letzten Aufnahme | |
| - Datum / Startzeit - Stopzeit der letzten Aufnahme | |
| - Quelle für Live-Ansicht (DS, Camera) | |
| - Kameramodell | |
| - Status der Bewegungserkennung (disabled, durch Kamera, durch SVS) und deren Parameter | |
| - IP-Port der Kamera | |
| - Dauer der der Voraufzeichnung in Sekunden (Einstellung in SVS) | |
| - gemeinsamer Ordner auf der DS für Aufnahmen | |
| - Volume auf der DS für Aufnahmen | |
| - Kamerahersteller Bezeichnung | |
| - Ist das Video gedreht | |
| - Ist das Video gespiegelt | |
| - Fähigkeit der Kamera zur Audioausgabe über Surveillance Station (false/true) | |
| - Fähigkeit der Kamera verschiedene Bewegungsgeschwindigkeiten auszuführen | |
| - Fähigkeit der Kamera für absolute PTZ-Aktionen | |
| - Fähigkeit der Kamera für Autofokus Aktionen | |
| - die verfügbaren PTZ-Richtungen der Kamera | |
| - Art der Kameraunterstützung für Fokussierung | |
| - Unterstützung der Kamera für Home-Position | |
| - Unterstützung der Kamera für Iris-Aktion | |
| - Unterstützung der Kamera für Pan-Aktion | |
| - Unterstützung der Kamera für Tilt-Aktion | |
| - Unterstützung der Kamera für Zoom-Aktion | |
| - Kameratyp (Camera, Video_Server, PTZ, Fisheye) | |
| - Meldungstext des letzten Fehlers | |
| - Fehlercode des letzten Fehlers | |
| - der Filename des letzten Schnapschusses | |
| - die ID des letzten Schnapschusses | |
| - Datum / Zeit der letzten Aktualisierung durch "caminfoall" | |
| - die LiveStream-Url wenn der Stream gestartet ist. (Attribut "showStmInfoFull" muss gesetzt sein) | |
| - in Surveillance Station voreingestellte Überwachungstouren (bei PTZ-Kameras) | |
| - zeigt den Status des automatischen Pollings an | |
| - in Surveillance Station voreingestellte Positionen (bei PTZ-Kameras) | |
| - Aufnahme läuft = Start, keine Aufnahme = Stop | |
| - aktueller StreamKey. Kann zum öffnen eines Livestreams ohne Session Id genutzt werden. | |
| - Uni-cast Stream Pfad der Kamera. (Attribut "showStmInfoFull" muss gesetzt sein) | |
| - Mjpeg Stream Pfad (über http) der Kamera. (Attribut "showStmInfoFull" muss gesetzt sein) | |
| - benutzerdefinierter Port der Surveillance Station (HTTP) im DSM-Anwendungsportal (get mit "svsinfo") | |
| - benutzerdefinierter Port der Surveillance Station (HTTPS) im DSM-Anwendungsportal (get mit "svsinfo") | |
| - die Anzahl der installierten Kameralizenzen (get mit "svsinfo") | |
| - die effektiven Rechte des verwendeten Users nach dem Login (get mit "svsinfo") | |
| - die Paketversion der installierten Surveillance Station (get mit "svsinfo") | |
| - durch Aufnahmen der Kamera belegter Plattenplatz auf dem Volume | |
| - Pfad zu den aufgenommenen Videos |
- debugactivetoken
wenn gesetzt wird der Status des Active-Tokens gelogged - nur für Debugging, nicht im normalen Betrieb benutzen ! - disable
deaktiviert das Gerätemodul bzw. die Gerätedefinition - httptimeout
Timeout-Wert für HTTP-Aufrufe zur Synology Surveillance Station, Default: 4 Sekunden (wenn httptimeout = "0" oder nicht gesetzt) - htmlattr
ergänzende Angaben zur Livestream-Url um das Verhalten wie Bildgröße zu beeinflussen
-
Beispiel:
attr <name> htmlattr width=500 height=325 top=200 left=300
- livestreamprefix
überschreibt die Angaben zu Protokoll, Servernamen und Port zur Weiterverwendung der Livestreamadresse als z.B. externer Link. Anzugeben in der Form "http(s)://<servername>:<port>" - loginRetries
setzt die Anzahl der Login-Wiederholungen im Fehlerfall (default = 1) - noQuotesForSID
dieses Attribut kann in bestimmten Fällen die Fehlermeldung "402 - permission denied" vermeiden und ein login ermöglichen. - pollcaminfoall
Intervall der automatischen Eigenschaftsabfrage (Polling) einer Kamera (kleiner 10: kein Polling, größer 10: Polling mit Intervall) - pollnologging
"0" bzw. nicht gesetzt = Logging Gerätepolling aktiv (default), "1" = Logging Gerätepolling inaktiv - rectime
festgelegte Aufnahmezeit wenn eine Aufnahme gestartet wird. Mit rectime = 0 wird eine Endlosaufnahme gestartet. Ist "rectime" nicht gesetzt, wird der Defaultwert von 15s verwendet. - recextend
"rectime" einer gestarteten Aufnahme wird neu gesetzt. Dadurch verlängert sich die Aufnahemzeit einer laufenden Aufnahme - session
Auswahl der Login-Session. Nicht gesetzt oder "DSM" -> session wird mit DSM aufgebaut (Standard). "SurveillanceStation" -> Session-Aufbau erfolgt mit SVS - simu_SVSversion
simuliert eine andere SVS-Version. (es ist nur eine niedrigere als die installierte SVS Version möglich !) - showStmInfoFull
zusaätzliche Streaminformationen wie LiveStreamUrl, StmKeyUnicst, StmKeymjpegHttp werden ausgegeben - showPassInLog
wenn gesetzt wird das verwendete Passwort im Logfile (verbose 4) angezeigt. (default = 0) - videofolderMap
ersetzt den Inhalt des Readings "VideoFolder", Verwendung z.B. bei gemounteten Verzeichnissen - verbose
- readingFnAttributes
-
Es werden verschiedene Verbose-Level unterstützt.
Dies sind im Einzelnen:
| 0 | - Start/Stop-Ereignisse werden geloggt |
| 1 | - Fehlermeldungen werden geloggt |
| 2 | - Meldungen über wichtige Ereignisse oder Alarme |
| 3 | - gesendete Kommandos werden geloggt |
| 4 | - gesendete und empfangene Daten werden geloggt |
| 5 | - alle Ausgaben zur Fehleranalyse werden geloggt. ACHTUNG: möglicherweise werden sehr viele Daten in das Logfile geschrieben! |
=end html_DE =cut