From 098b2e8ab77e617f96d55cc575adbe864094bb65 Mon Sep 17 00:00:00 2001 From: DS_Starter Date: Sun, 9 Dec 2018 13:07:53 +0000 Subject: [PATCH] 49_SSCam: contrib 7.7.0 git-svn-id: https://svn.fhem.de/fhem/trunk@17931 2b470e98-0d58-463d-a4d8-8e2adae1ed80 --- fhem/contrib/DS_Starter/49_SSCamSTRM.pm | 493 ++++++++++++++++++++++++ 1 file changed, 493 insertions(+) create mode 100644 fhem/contrib/DS_Starter/49_SSCamSTRM.pm diff --git a/fhem/contrib/DS_Starter/49_SSCamSTRM.pm b/fhem/contrib/DS_Starter/49_SSCamSTRM.pm new file mode 100644 index 000000000..2ee90688c --- /dev/null +++ b/fhem/contrib/DS_Starter/49_SSCamSTRM.pm @@ -0,0 +1,493 @@ +######################################################################################################################## +# $Id: 49_SSCamSTRM.pm 17891 2018-12-03 21:52:16Z DS_Starter $ +######################################################################################################################### +# 49_SSCamSTRM.pm +# +# (c) 2018 by Heiko Maaz +# forked from 98_weblink.pm by Rudolf König +# e-mail: Heiko dot Maaz at t-online dot de +# +# This Module is used by module 49_SSCam to create Streaming devices. +# It can't be used without any SSCam-Device. +# +# This script is part of fhem. +# +# Fhem is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 2 of the License, or +# (at your option) any later version. +# +# Fhem is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with fhem. If not, see . +# +######################################################################################################################### + +package main; + +use strict; +use warnings; + +# Versions History intern +our %SSCamSTRM_vNotesIntern = ( + "2.0.0" => "09.12.2018 get command \"popupStream\" ", + "1.5.0" => "02.12.2018 new attribute \"popupWindowSize\" ", + "1.4.1" => "31.10.2018 attribute \"autoLoop\" changed to \"autoRefresh\", new attribute \"autoRefreshFW\" ", + "1.4.0" => "29.10.2018 readingFnAttributes added ", + "1.3.0" => "28.10.2018 direct help for attributes, new attribute \"autoLoop\" ", + "1.2.4" => "27.10.2018 fix undefined subroutine &main::SSCam_ptzpanel (https://forum.fhem.de/index.php/topic,45671.msg850505.html#msg850505) ", + "1.2.3" => "03.07.2018 behavior changed if device is disabled ", + "1.2.2" => "26.06.2018 make changes for generic stream dev ", + "1.2.1" => "23.06.2018 no name add-on if MODEL is snapgallery ", + "1.2.0" => "20.06.2018 running stream as human readable entry for SSCamSTRM-Device ", + "1.1.0" => "16.06.2018 attr hideDisplayName regarding to Forum #88667 ", + "1.0.1" => "14.06.2018 commandref revised ", + "1.0.0" => "14.06.2018 switch to longpoll refresh ", + "0.4.0" => "13.06.2018 new attribute \"noDetaillink\" (deleted in V1.0.0) ", + "0.3.0" => "12.06.2018 new attribute \"forcePageRefresh\" ", + "0.2.0" => "11.06.2018 check in with SSCam 5.0.0 ", + "0.1.0" => "10.06.2018 initial Version " +); + +# Standardvariablen und Forward-Declaration +sub SSCam_ptzpanel($;$$); +sub SSCam_StreamDev($$$); +sub SSCam_getclhash($;$$); + +################################################################ +sub SSCamSTRM_Initialize($) { + my ($hash) = @_; + + my $fwd = join(",",devspec2array("TYPE=FHEMWEB:FILTER=STATE=Initialized")); + + $hash->{DefFn} = "SSCamSTRM_Define"; + $hash->{GetFn} = "SSCamSTRM_Get"; + $hash->{AttrList} = "autoRefresh:selectnumbers,120,0.2,1800,0,log10 ". + "autoRefreshFW:$fwd ". + "disable:1,0 ". + "forcePageRefresh:1,0 ". + "htmlattr ". + "hideDisplayName:1,0 ". + "popupWindowSize ". + $readingFnAttributes; + $hash->{FW_summaryFn} = "SSCamSTRM_FwFn"; + $hash->{FW_detailFn} = "SSCamSTRM_FwFn"; + $hash->{AttrFn} = "SSCamSTRM_Attr"; + $hash->{FW_hideDisplayName} = 1; # Forum 88667 + # $hash->{FW_addDetailToSummary} = 1; + # $hash->{FW_atPageEnd} = 1; # wenn 1 -> kein Longpoll ohne informid in HTML-Tag +} + + +################################################################ +sub SSCamSTRM_Define($$) { + my ($hash, $def) = @_; + my ($name, $type, $link) = split("[ \t]+", $def, 3); + + if(!$link) { + return "Usage: define SSCamSTRM "; + } + + my $arg = (split("[()]",$link))[1]; + $arg =~ s/'//g; + ($hash->{PARENT},$hash->{MODEL}) = ((split(",",$arg))[0],(split(",",$arg))[2]); + + $hash->{VERSION} = $hash->{VERSION} = (reverse sort(keys %SSCamSTRM_vNotesIntern))[0]; + $hash->{LINK} = $link; + + readingsSingleUpdate($hash,"state", "initialized", 1); # Init für "state" + +return undef; +} + +################################################################ +sub SSCamSTRM_Get($@) { + my ($hash, @a) = @_; + return "\"set X\" needs at least an argument" if ( @a < 2 ); + my $name = $a[0]; + my $opt = $a[1]; + my $prop = $a[2]; + + return if(IsDisabled($name)); + + my $getlist = "Unknown argument $opt, choose one of ". + "popupStream:noArg " + ; + + if ($opt eq "popupStream") { + my $txt = SSCam_getclhash($hash); + return $txt if($txt); + + my $parent = $hash->{PARENT}; + my $parentHash = $defs{$parent}; + + my $htmlCode = $hash->{HELPER}{STREAM}; + + for (my $k=1; (defined($hash->{HELPER}{CL}{$k})); $k++ ) { + if ($hash->{HELPER}{CL}{$k}->{COMP}) { + # CL zusammengestellt (Auslösung durch Notify) + asyncOutput($hash->{HELPER}{CL}{$k}, "$htmlCode"); + } else { + # Output wurde über FHEMWEB ausgelöst + return $htmlCode; + } + } + delete($hash->{HELPER}{CL}); + + } else { + return "$getlist"; + } + +return; +} + +################################################################ +sub SSCamSTRM_Attr($$$$) { + my ($cmd,$name,$aName,$aVal) = @_; + my $hash = $defs{$name}; + my ($do,$val); + + # $cmd can be "del" or "set" + # $name is device name + # aName and aVal are Attribute name and value + + if ($aName eq "disable") { + if($cmd eq "set") { + $do = ($aVal) ? 1 : 0; + } + $do = 0 if($cmd eq "del"); + $val = ($do == 1 ? "disabled" : "initialized"); + + readingsSingleUpdate($hash, "state", $val, 1); + } + +return undef; +} + +################################################################ +sub SSCamSTRM_FwFn($;$$$) { + my ($FW_wname, $d, $room, $pageHash) = @_; # pageHash is set for summaryFn. + my $hash = $defs{$d}; + my $link = $hash->{LINK}; + + RemoveInternalTimer($hash); + $hash->{HELPER}{FW} = $FW_wname; + + $link = AnalyzePerlCommand(undef, $link) if($link =~ m/^{(.*)}$/s); + my $show = $defs{$hash->{PARENT}}->{HELPER}{ACTSTRM} if($hash->{MODEL} =~ /switched/); + $show = $show?"($show)":""; + + my $alias = AttrVal($d, "alias", $d); # Linktext als Aliasname oder Devicename setzen + my $dlink = "$alias"; + + my $ret = ""; + $ret .= "$dlink $show
" if(!AttrVal($d,"hideDisplayName",0)); + if(IsDisabled($d)) { + if(AttrVal($d,"hideDisplayName",0)) { + $ret .= "Stream-device $d is disabled"; + } else { + $ret .= "Stream-device is disabled"; + } + } else { + $ret .= $link; + } + + # Autorefresh nur des aufrufenden FHEMWEB-Devices + my $al = AttrVal($d, "autoRefresh", 0); + if($al) { + InternalTimer(gettimeofday()+$al, "SSCamSTRM_refresh", $hash, 0); + Log3($d, 5, "$d - next start of autoRefresh: ".FmtDateTime(gettimeofday()+$al)); + } + +return $ret; +} + +################################################################ +sub SSCamSTRM_refresh($) { + my ($hash) = @_; + my $d = $hash->{NAME}; + + # Seitenrefresh festgelegt durch SSCamSTRM-Attribut "autoRefresh" und "autoRefreshFW" + my $rd = AttrVal($d, "autoRefreshFW", $hash->{HELPER}{FW}); + { map { FW_directNotify("#FHEMWEB:$_", "location.reload('true')", "") } $rd } + + my $al = AttrVal($d, "autoRefresh", 0); + if($al) { + InternalTimer(gettimeofday()+$al, "SSCamSTRM_refresh", $hash, 0); + Log3($d, 5, "$d - next start of autoRefresh: ".FmtDateTime(gettimeofday()+$al)); + } else { + RemoveInternalTimer($hash); + } + +return; +} + +1; + +=pod +=item summary define a Streaming device by SSCam module +=item summary_DE Erstellung eines Streaming-Device durch das SSCam-Modul +=begin html + + +

SSCamSTRM

+
+The module SSCamSTRM is a special device module synchronized to the SSCam module. It is used for definition of +Streaming-Devices.
+Dependend of the Streaming-Device state, different buttons are provided to start actions: +
    + + + + + + + + + + + + + + +
    Switch off - stops a running playback
    Refresh - refresh a view (no page reload)
    Restart - restart a running content (e.g. a HLS-Stream)
    MJPEG - starts a MJPEG Livestream
    HLS - starts HLS (HTTP Live Stream)
    Last Record - playback the last recording as iFrame
    Last Rec H.264 - playback the last recording if available as H.264
    Last Rec MJPEG - playback the last recording if available as MJPEG
    Last SNAP - show the last snapshot
    Start Recording - starts an endless recording
    Stop Recording - stopps the recording
    Take Snapshot - take a snapshot
    +
+
+ +
    + + Define + +
      + A SSCam Streaming-device is defined by the SSCam "set <name> createStreamDev" command. + Please refer to SSCam "createStreamDev" command. +

      +
    + + + Set
      N/A

    + + + Get +
      + +
        +
      • popupStream
        + + The current streaming content is depicted in an Ok-Popup window. By setting attribute "popupWindowSize" the + size of display can be adjusted. +
        • +
      +
      + +
    +
    + + + Attributes +

    + +
      +
        + + +
      • autoRefresh
        + If set, active browser pages of the FHEMWEB-Device which has called the SSCamSTRM-Device, are new reloaded after + the specified time (seconds). Browser pages of a particular FHEMWEB-Device to be refreshed can be specified by + attribute "autoRefreshFW" instead. + This may stabilize the video playback in some cases. +
        • +
        + + +
      • autoRefreshFW
        + If "autoRefresh" is activated, you can specify a particular FHEMWEB-Device whose active browser pages are refreshed + periodically. +
        • +
        + + +
      • disable
        + Deactivates the device. +
        • +
        + + +
      • forcePageRefresh
        + The attribute is evaluated by SSCam.
        + If set, a reload of all browser pages with active FHEMWEB connections will be enforced when particular camera operations + were finished. + This may stabilize the video playback in some cases. +
        • +
        + + +
      • hideDisplayName
        + Hide the device/alias name (link to detail view). +
        • +
        + + +
      • htmlattr
        + Additional HTML tags to manipulate the streaming device. +

        +
          + Example:
          + attr <name> htmlattr width="480" height="560"
          +
        +
        • +
        + + +
      • popupWindowSize
        + If the content of playback (Videostream or Snapshot gallery) is suitable, by clicking the content a popup window will + appear. + The size of display can be setup by this attribute. + It is also valid for the get-fenction "popupStream". +

        +
          + Example:
          + attr <name> popupWindowSize width="600" height="425"
          +
        +
        • + +
      +
    + +
+ +=end html +=begin html_DE + + +

SSCamSTRM

+ +
+Das Modul SSCamSTRM ist ein mit SSCam abgestimmtes Gerätemodul zur Definition von Streaming-Devices.
+Abhängig vom Zustand des Streaming-Devices werden zum Start von Aktionen unterschiedliche Drucktasten angeboten: +
    + + + + + + + + + + + + + + +
    Switch off - stoppt eine laufende Wiedergabe
    Refresh - auffrischen einer Ansicht (kein Browser Seiten-Reload)
    Restart - neu starten eines laufenden Contents (z.B. eines HLS-Streams)
    MJPEG - Startet MJPEG Livestream
    HLS - Startet HLS (HTTP Live Stream)
    Last Record - spielt die letzte Aufnahme als iFrame
    Last Rec H.264 - spielt die letzte Aufnahme wenn als H.264 vorliegend
    Last Rec MJPEG - spielt die letzte Aufnahme wenn als MJPEG vorliegend
    Last SNAP - zeigt den letzten Snapshot
    Start Recording - startet eine Endlosaufnahme
    Stop Recording - stoppt eine Aufnahme
    Take Snapshot - löst einen Schnappschuß aus
    +
+
+ +
    + + Define + +
      + Ein SSCam Streaming-Device wird durch den SSCam Befehl "set <name> createStreamDev" erstellt. + Siehe auch die Beschreibung zum SSCam "createStreamDev" Befehl. +

      +
    + + + Set
      N/A

    + + + Get +
      + +
        +
      • popupStream
        + + Der aktuelle Streaminhalt wird in einem Ok-Popup dargestellt. Mit dem Attribut "popupWindowSize" kann die + Darstellungsgröße eingestellt werden. +
        • +
      +
      + +
    +
    + + + Attributes +

    + +
      +
        + + +
      • autoRefresh
        + Wenn gesetzt, werden aktive Browserseiten des FHEMWEB-Devices welches das SSCamSTRM-Device aufgerufen hat, nach der + eingestellten Zeit (Sekunden) neu geladen. Sollen statt dessen Broserseiten eines bestimmten FHEMWEB-Devices neu + geladen werden, kann dieses Device mit dem Attribut "autoRefreshFW" festgelegt werden. + Dies kann in manchen Fällen die Wiedergabe innerhalb einer Anwendung stabilisieren. +
        • +
        + + +
      • autoRefreshFW
        + Ist "autoRefresh" aktiviert, kann mit diesem Attribut das FHEMWEB-Device bestimmt werden dessen aktive Browserseiten + regelmäßig neu geladen werden sollen. +
        • +
        + + +
      • disable
        + Aktiviert/deaktiviert das Device. +
        • +
        + + +
      • forcePageRefresh
        + Das Attribut wird durch SSCam ausgewertet.
        + Wenn gesetzt, wird ein Reload aller Browserseiten mit aktiven FHEMWEB-Verbindungen nach dem Abschluß bestimmter + SSCam-Befehle erzwungen. + Dies kann in manchen Fällen die Wiedergabe innerhalb einer Anwendung stabilisieren. +
        • +
        + + +
      • hideDisplayName
        + Verbirgt den Device/Alias-Namen (Link zur Detailansicht). +
        • +
        + + +
      • htmlattr
        + Zusätzliche HTML Tags zur Darstellungsänderung im Streaming Device. +

        +
          + Beispiel:
          + attr <name> htmlattr width="480" height="560"
          +
        +
        • +
        + + +
      • popupWindowSize
        + Bei geeigneten Wiedergabeinhalten (Videostream oder Schnappschußgalerie) öffnet ein Klick auf den Bildinhalt ein + Popup-Fenster mit diesem Inhalt. Die Darstellungsgröße kann mit diesem Attribut eingestellt werden. + Das Attribut gilt ebenfalls für die get-Funktion "popupStream". +

        +
          + Beispiel:
          + attr <name> popupWindowSize width="600" height="425"
          +
        +
        • + +
      +
    + +
+ +=end html_DE +=cut