Define

camera

define <Name> SSCAM <camera name in SVS> <ServerAddr> [Port] [Protocol]

SVS-device

define <Name> SSCAM SVS <ServerAddr> [Port] [Protocol]

SVS

Name	the name of the new device to use in FHEM
Cameraname	camera name as defined in Synology Surveillance Station if camera-device, "SVS" if SVS-Device. Spaces are not allowed in camera name.
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 disc station. If not set, the default "5000" is used
Protocol	optional - the protocol (http or https) to access the synology disc station. If not set, the default "http" is used

Examples:

      define CamCP SSCAM Carport 192.168.2.20 [5000] [http]
      define CamCP SSCAM Carport 192.168.2.20 [5001] [https]
      # creates a new camera device CamCP

      define DS1 SSCAM SVS 192.168.2.20 [5000] [http]
      define DS1 SSCAM SVS 192.168.2.20 [5001] [https]
      # creares a new SVS device DS1

command

"set <name> on [rectime]"

"set <name> on 0"

command

"set <name> createPTZcontrol"

Credentials

 
     set <name> credentials <username> <password>

2-step verification

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

Attribute

minimum rights

set ... on	session: ServeillanceStation - observer with enhanced privilege "manual recording"
set ... off	session: ServeillanceStation - observer with enhanced privilege "manual recording"
set ... snap	session: ServeillanceStation - observer
set ... delPreset	session: ServeillanceStation - observer
set ... disable	session: ServeillanceStation - manager with edit camera right
set ... enable	session: ServeillanceStation - manager with edit camera right
set ... expmode	session: ServeillanceStation - manager
set ... extevent	session: DSM - user as member of admin-group
set ... goPreset	session: ServeillanceStation - observer with privilege objective control of camera
set ... homeMode	ssession: ServeillanceStation - observer with privilege Home Mode switch (valid for SVS-device ! )
set ... motdetsc	session: ServeillanceStation - manager
set ... runPatrol	session: ServeillanceStation - observer with privilege objective control of camera
set ... goAbsPTZ	session: ServeillanceStation - observer with privilege objective control of camera
set ... move	session: ServeillanceStation - observer with privilege objective control of camera
set ... runView	session: ServeillanceStation - observer with privilege liveview of camera
set ... setHome	session: ServeillanceStation - observer
set ... setPreset	session: ServeillanceStation - observer
set ... snap	session: ServeillanceStation - observer
set ... snapGallery	session: ServeillanceStation - observer
set ... stopView	-
set ... credentials	-
get ... caminfo[all]	session: ServeillanceStation - observer
get ... eventlist	session: ServeillanceStation - observer
get ... listLog	session: ServeillanceStation - observer
get ... listPresets	session: ServeillanceStation - observer
get ... scanVirgin	session: ServeillanceStation - observer
get ... svsinfo	session: ServeillanceStation - observer
get ... snapfileinfo	session: ServeillanceStation - observer
get ... snapinfo	session: ServeillanceStation - observer
get ... stmUrlPath	session: ServeillanceStation - observer

HTTP-Timeout Settings

Set

set <name> autocreateCams (valid for SVS)

set <name> createStreamDev [generic | mjpeg | switched] (valid for CAM)

generic	- the streaming device playback a content determined by attribute "genericStrmHtmlTag"
mjpeg	- the streaming device playback a permanent MJPEG video stream (Streamkey method)
switched	- playback of different streaming types. Buttons for mode control are provided.

Example:

attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
                                 <source src='http://192.168.2.10:32000/$NAME.m3u8' type='application/x-mpegURL'>
                               </video>

set <name> createPTZcontrol (valid for PTZ-CAM)

set <name> createReadingsGroup [<name of readingsGroup>] (valid for CAM/SVS)

set <name> createSnapGallery (valid for CAM)

Note

set <name> credentials <username> <password> (valid for CAM/SVS)

set <name> delPreset <PresetName> (valid for PTZ-CAM)

set <name> [enable|disable] (valid for CAM)

deactivating / activating

     define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
     define a14 at 21:46 set Cam.* disable (enable)

     define allcams dummy
     attr allcams eventMap on:enable off:disable
     attr allcams room Cams
     attr allcams webCmd enable: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] (valid for CAM)

Note:

set <name> extevent [ 1-10 ] (valid for SVS)

set <name> goAbsPTZ [ X Y | up | down | left | right ] (valid for CAM)

    set <name> goAbsPTZ 120 450

    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)

   set <name> goAbsPTZ up [down|left|right]

set <name> goPreset <Preset> (valid for CAM)

    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

  
   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> homeMode [on|off] (valid for SVS)

Synology Onlinehelp

set <name> motdetsc [camera|SVS|disable] (valid for CAM)

set <name> motdetsc SVS [sensitivity] [threshold]	# command pattern
set <name> motdetsc SVS 91 30	# set the sensitivity to 91 and threshold to 30
set <name> motdetsc SVS 0 40	# keep the old value of sensitivity, set threshold to 40
set <name> motdetsc SVS 15	# set the sensitivity to 15, threshold keep unchanged

set <name> motdetsc camera [sensitivity] [threshold] [percentage]	# command pattern
set <name> motdetsc camera 89 0 20	# set the sensitivity to 89, percentage to 20
set <name> motdetsc camera 0 40 10	# keep old value for sensitivity, set threshold to 40, percentage to 10
set <name> motdetsc camera 30	# set the sensitivity to 30, other values keep unchanged

   CamMotDetSc    SVS, sensitivity: 76, threshold: 55

set <name> move [ right | up | down | left | dir_X ] [Sekunden] (valid for CAM up to SVS version 7.1)

    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> [on [<rectime>] | off] (valid for CAM)

Attribute "recextend = 0" or not set (default):

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.

Attribute "recextend = 1" is set:

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.

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>

set <name> optimizeParams [mirror:<value>] [flip:<value>] [rotate:<value>] [ntp:<value>] (gilt für CAM)

mirror, flip, rotate: true | false
ntp: the name or the IP-address of time server

Examples:

set <name> optimizeParams mirror:true flip:true ntp:time.windows.com

set <name> optimizeParams ntp:Surveillance%20Station

set <name> optimizeParams mirror:true flip:false rotate:true

set <name> pirSensor [activate | deactivate] (valid for CAM)

set <name> runPatrol <Patrolname> (valid for CAM)

set <name> runView [live_fw | live_link | live_open [<room>] | lastrec_fw | lastrec_fw_MJPEG | lastrec_fw_MPEG4/H.264 | lastrec_open [<room>] | lastsnap_fw] (valid for CAM)

live_fw	- MJPEG-Livestream. Audio playback is provided if possible.
live_fw_hls	- HLS-Livestream (currently only Mac Safari Browser and mobile iOS/Android-Devices)
live_link	- Link of a MJPEG-Livestream
live_open [<room>]	- opens MJPEG-Livestream in separate Browser window
lastrec_fw	- playback last recording as iFrame object
lastrec_fw_MJPEG	- usable if last recording has format MJPEG
lastrec_fw_MPEG4/H.264	- usable if last recording has format MPEG4/H.264
lastrec_open [<room>]	- playback last recording in a separate Browser window
lastsnap_fw	- playback last snapshot

"live_fw, live_link"

"live_open"

"live_fw_hls"

"lastrec_fw.*"

"lastrec_open"

"lastrec_fw"

"lastrec_open"

"set <name> runView lastsnap_fw"

Examples:

    attr <name> htmlattr width="500" height="375"
    attr <name> htmlattr width="700",height="525",top="200",left="300"

"set <name> runView live_open"

"set <name> runView live_open <room>"

reading

Example:

    attr <name> livestreamprefix https://<Servername>:<Port>

"set <name> stopView"

Start Recording	- starts an endless recording
Stop Recording	- stopps the recording
Take Snapshot	- take a snapshot
Switch off	- stops a running playback

Note for HLS (HTTP Live Streaming):

set <name> setHome <PresetName> (valid for PTZ-CAM)

set <name> setPreset <PresetNumber> [<PresetName>] [<Speed>] (valid for PTZ-CAM)

set <name> snap (valid for CAM)

 
     set <name> snap

taking snapshots

     define he1_snap_3 notify CamHE1:Record.*on define h3 at +*{3}00:00:02 set CamHE1 snap

     define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap

set <name> snapGallery [1-10] (valid for CAM)

"get <name> snapGallery"

Note

set <name> startTracking (valid for CAM with tracking capability)

set <name> stopTracking (valid for CAM with tracking capability)

Get

get <name> caminfoall (valid for CAM/SVS)

get <name> caminfo

get <name> eventlist (valid for CAM)

get <name> homeModeState (valid for SVS)

get <name> listLog [severity:<Loglevel>] [limit:<Number of lines>] [match:<Searchstring>] (valid for SVS)

<Loglevel> - Information, Warning or Error. Only datasets having this severity are retrieved (default: all)
<Number of lines> - the specified number of lines (newest) of the log are retrieved (default: all)
<Searchstring> - only log entries containing the searchstring are retrieved (Note: no Regex possible, the searchstring will be given into the call to SVS)

Examples

get <name> listLog severity:Error limit:5

get <name> listLog severity:Information match:Carport

get <name> listLog severity:Warning

reading

Synology Online-Help

get <name> listPresets (valid for PTZ-CAM)

get <name> scanVirgin (valid for CAM/SVS)

get <name> snapGallery [1-10] (valid for CAM)

snapGalleryBoost
snapGalleryColumns
snapGalleryHtmlAttr
snapGalleryNumber
snapGallerySize

Note:

get <name> snapfileinfo (valid for CAM)

"get <name> snap"

get <name> snapinfo (valid for CAM)

get <name> stmUrlPath (valid for CAM)

http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"

Note:

get <name> storedCredentials (valid for CAM/SVS)

get <name> svsinfo (valid for CAM/SVS)

get <name> versionNotes [hints | rel | <key>] (valid for CAM/SVS)

Polling of Camera/SVS-Properties

PollState = Active - automatic polling will be executed with interval correspondig value of attribute "pollcaminfoall"
PollState = Inactive - automatic polling won't be executed

here

Notes:

49_SSCam: Fragen, Hinweise, Neuigkeiten und mehr rund um dieses Modul

Internals

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
COMPATIBILITY - information up to which SVS-version the module version is currently released/tested (see also Reading "compstate")
CREDENTIALS - the value is "Set" if Credentials are set
NAME - the cameraname in FHEM
MODEL - distinction between camera device (CAM) and Surveillance Station device (SVS)
OPMODE - the last executed operation of the module
SERVERADDR - IP-Address of SVS Host
SERVERPORT - SVS-Port

Attributes

debugactivetoken
if set the state of active token will be logged - only for debugging, don't use it in normal operation !

disable
deactivates the device definition

genericStrmHtmlTag
This attribute contains HTML-Tags for video-specification in a Streaming-Device of type "generic". (see also "set <name> createStreamDev generic")

httptimeout
Timeout-Value of HTTP-Calls to Synology Surveillance Station, Default: 4 seconds (if httptimeout = "0" or not set)

htmlattr
additional specifications to inline oictures to manipulate the behavior of stream, e.g. size of the image.

Example:

livestreamprefix
Overwrites the specifications of protocol, servername and port for further use in livestream address and StmKey.*-readings , e.g. as a link for external use.
It can be specified of two ways as follows:

DEF	: the protocol, servername and port as specified in device definition is used
http(s)://<servername>:<port>	: your own address specification is used

Servername can be the name or the IP-address of your Synology Surveillance Station.

loginRetries
set the amount of login-repetitions in case of failure (default = 3)

noQuotesForSID
this attribute may be helpful 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

ptzPanel_Home
In the PTZ-control panel the Home-Icon (in attribute "ptzPanel_row02") is automatically assigned to the value of Reading "PresetHome". With "ptzPanel_Home" you can change the assignment to another preset from the available Preset list.

ptzPanel_iconPath
Path for icons used in PTZ-control panel, default is "www/images/sscam". The attribute value will be used for all icon-files except *.svg.
For further information execute "get <name> versionNotes 2,6".

ptzPanel_iconPrefix
Prefix for icons used in PTZ-control panel, default is "black_btn_". The attribute value will be used for all icon-files except *.svg.
If the used icon-files begin with e.g. "black_btn_" ("black_btn_CAMDOWN.png"), the icon needs to be defined in attributes "ptzPanel_row[00-09]" just with the subsequent part of name, e.g. "CAMDOWN.png".

ptzPanel_row[00-09] <command>:<icon>,<command>:<icon>,...
For PTZ-cameras the attributes "ptzPanel_row00" to "ptzPanel_row04" are created automatically for usage by the PTZ-control panel.
The attributes contain a comma spareated list of command:icon-combinations (buttons) each panel line. One panel line can contain a random number of buttons. The attributes "ptzPanel_row00" to "ptzPanel_row04" can't be deleted because of they are created automatically again in that case. The user can change or complement the attribute values. These changes are conserved.
If needed the assignment for Home-button in "ptzPanel_row02" can be changed by attribute "ptzPanel_Home".
The icons are searched in path "ptzPanel_iconPath". The value of "ptzPanel_iconPrefix" is prepend to the icon filename. Own extensions of the PTZ-control panel can be done using the attributes "ptzPanel_row05" to "ptzPanel_row09". For creation of own icons a template is provided in the SVN. Further information can be get by "get <name> versionNotes 2".

Note:
For an empty field please use ":CAMBLANK.png" respectively ":CAMBLANK.png,:CAMBLANK.png,:CAMBLANK.png,..." for an empty line.

ptzPanel_use
Switch the usage of a PTZ-control panel in detail view respectively a created StreamDevice off or on (default: on).
The PTZ panel use its own icons. Thereby the system find the icons, in FHEMWEB device the attribute "iconPath" has to be completed by "sscam" (e.g. "attr WEB iconPath default:fhemSVG:openautomation:sscam").

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.
For establish a sesion with Surveillance Station you have to create a user with suitable privilege profile in SVS. If you need more infomations please execute "get <name> versionNotes 5".

simu_SVSversion
simulates another SVS version. (only a lower version than the installed one is possible !)

snapGalleryBoost
If set, the last snapshots (default 3) will be retrieved by Polling, will be stored in the FHEM-servers main memory and can be displayed by the "set/get ... snapGallery" command.
This mode is helpful if many or full size images shall be displayed. If the attribute is set, you can't specify arguments in addition to the "set/get ... snapGallery" command. (see also attribut "snapGalleryNumber")

snapGalleryColumns
The number of snapshots which shall appear in one row of the gallery popup (default 3).

snapGalleryHtmlAttr
the image parameter can be controlled by this attribute.
If the attribute isn't set, the value of attribute "htmlattr" will be used.
If "htmlattr" is also not set, default parameters are used instead (width="500" height="325").

snapGalleryNumber
The number of snapshots to retrieve (default 3).

snapGallerySize
By this attribute the quality of the snapshot images can be controlled (default "Icon").
If mode "Full" is set, the images are retrieved with their original available resolution. That requires more ressources and may slow down the display. By setting attribute "snapGalleryBoost=1" the display may accelerated, because in that case the images will be retrieved by continuous polling and need only bring to display.

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

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 !

readingFnAttributes

Readings

CamAudioType	- Indicating audio type
Availability	- Availability of Camera (disabled, enabled, disconnected, other)
CamEventNum	- delivers the total number of in SVS registered events of the camera
CamExposureControl	- indicating type of exposure control
CamExposureMode	- current exposure mode (Day, Night, Auto, Schedule, Unknown)
CamForceEnableMulticast	- Is the camera forced to enable multicast.
CamIP	- IP-Address of Camera
CamLastRec	- Path / name of the last recording
CamLastRecTime	- date / starttime / endtime of the last recording
CamLiveFps	- Frames per second of Live-Stream
CamLiveMode	- Source of Live-View (DS, Camera)
camLiveQuality	- Live-Stream quality set in SVS
camLiveResolution	- Live-Stream resolution set in SVS
camLiveStreamNo	- used Stream-number for Live-Stream
CamModel	- Model of camera
CamMotDetSc	- state of motion detection source (disabled, by camera, by SVS) and their parameter
CamNTPServer	- set time server
CamPort	- IP-Port of Camera
CamPreRecTime	- Duration of Pre-Recording (in seconds) adjusted in SVS
CamPtSpeed	- adjusted value of Pan/Tilt-activities (setup in SVS)
CamRecShare	- shared folder on disk station for recordings
CamRecVolume	- Volume on disk station for recordings
CamStreamFormat	- the current format of video streaming
CamVideoType	- Indicating video type
CamVendor	- Identifier of camera producer
CamVideoFlip	- Is the video flip
CamVideoMirror	- Is the video mirror
CamVideoRotate	- Is the video rotate
CapAudioOut	- Capability to Audio Out over Surveillance Station (false/true)
CapChangeSpeed	- Capability to various motion speed
CapPIR	- has the camera a PIR sensor feature
CapPTZAbs	- Capability to perform absolute PTZ action
CapPTZAutoFocus	- Capability to perform auto focus action
CapPTZDirections	- the PTZ directions that camera support
CapPTZFocus	- mode of support for focus action
CapPTZHome	- Capability to perform home action
CapPTZIris	- mode of support for iris action
CapPTZObjTracking	- Capability to perform objekt-tracking
CapPTZPan	- Capability to perform pan action
CapPTZPresetNumber	- The maximum number of preset supported by the model. 0 stands for preset incapability
CapPTZTilt	- mode of support for tilt action
CapPTZZoom	- Capability to perform zoom action
DeviceType	- device type (Camera, Video_Server, PTZ, Fisheye)
Error	- message text of last error
Errorcode	- error code of last error
HomeModeState	- HomeMode-state (SVS-version 8.1.0 and above)
LastLogEntry	- the neweset entry of Surveillance Station Log (only if SVS-device and if attribute pollcaminfoall is set)
LastSnapFilename	- the filename of the last snapshot
LastSnapId	- the ID of the last snapshot
LastSnapTime	- timestamp of the last snapshot
LastUpdateTime	- date / time the last update of readings by "caminfoall"
LiveStreamUrl	- the livestream URL if stream is started (is shown if attribute "showStmInfoFull" is set)
Patrols	- in Synology Surveillance Station predefined patrols (at PTZ-Cameras)
PollState	- shows the state of automatic polling
PresetHome	- Name of Home-position (at PTZ-Cameras)
Presets	- in Synology Surveillance Station predefined Presets (at PTZ-Cameras)
Record	- if recording is running = Start, if no recording is running = Stop
StmKey	- current streamkey. it can be used to open livestreams without session id
StmKeyUnicst	- Uni-cast stream path of the camera. (attribute "showStmInfoFull" has to be set)
StmKeymjpegHttp	- Mjpeg stream path(over http) of the camera (attribute "showStmInfoFull" has to be set)
SVScustomPortHttp	- Customized port of Surveillance Station (HTTP) (to get with "svsinfo")
SVScustomPortHttps	- Customized port of Surveillance Station (HTTPS) (to get with "svsinfo")
SVSlicenseNumber	- The total number of installed licenses (to get with "svsinfo")
SVSuserPriv	- The effective rights of the user used for log in (to get with "svsinfo")
SVSversion	- package version of the installed Surveillance Station (to get with "svsinfo")
UsedSpaceMB	- used disk space of recordings by Camera
VideoFolder	- Path to the recorded video
compstate	- state of compatibility (compares current/simulated SVS-version with Internal COMPATIBILITY)

=end html =begin html_DE

SSCam

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 incl. Audiowiedergabe, anzeigen der letzten Aufnahme oder des letzten Schnappschusses
Abruf und Ausgabe der Kamera Streamkeys sowie Stream-Urls (Nutzung von Kamera-Livestreams ohne Session Id)
abspielen der letzten Aufnahme bzw. Anzeige des letzten Schnappschusses
anzeigen der gespeicherten Anmeldeinformationen (Credentials)
Ein- bzw. Ausschalten des Surveillance Station HomeMode und abfragen des HomeMode-Status
abrufen des Surveillance Station Logs, auswerten des neuesten Eintrags als Reading
erzeugen einer Gallerie der letzten 1-10 Schnappschüsse (als Popup oder permanentes Device)
Start bzw. Stop Objekt Tracking (nur unterstützte PTZ-Kameras mit dieser Fähigkeit)
Setzen/Löschen eines Presets (bei PTZ-Kameras)
Setzen der Home-Position (bei PTZ-Kameras)
erstellen eines Paneels zur Kamera-Steuerung. (bei PTZ-Kameras)
erzeugen unterschiedlicher Typen von separaten Streaming-Devices (createStreamDev)
Aktivierung / Deaktivierung eines kamerainternen PIR-Sensors
Erzeugung einer readingsGroup zur Anzeige aller definierten SSCam-Devices (createReadingsGroup)
Automatisiertes Anlegen aller in der SVS vorhandenen Kameras in FHEM (autocreateCams)

SSCAM - Steuerung von Kameras in Synology Surveillance Station

Vorbereitung

sudo apt-get install libjson-perl

Definition

Kamera

define <Name> SSCAM <Kameraname in SVS> <ServerAddr> [Port] [Protocol]

SVS-Device

define <Name> SSCAM SVS <ServerAddr> [Port] [Protocol]

SVS

Name	der Name des neuen Gerätes in FHEM
Kameraname	Kameraname wie er in der Synology Surveillance Station angegeben ist für Kamera-Device, "SVS" für SVS-Device. 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 Disc Station. Wenn nicht angegeben, wird der Default-Port "5000" genutzt
Protocol	optional - das Protokoll (http oder https) zum Funktionsaufruf. Wenn nicht angegeben, wird der Default "http" genutzt

Beispiel:

      define CamCP SSCAM Carport 192.168.2.20 [5000] [http] 
      define CamCP SSCAM Carport 192.168.2.20 [5001] [https]
      # erstellt ein neues Kamera-Device CamCP

      define DS1 SSCAM SVS 192.168.2.20 [5000] [http] 
      define DS1 SSCAM SVS 192.168.2.20 [5001] [https] 
      # erstellt ein neues SVS-Device DS1

Befehl

"set <name> on [rectime]"

"set <name> on 0"

Attributen

Befehl

"set <name> createPTZcontrol"

Credentials

 
     set <name> credentials <Username> <Passwort>

2-Stufen Verifizierung

DSM-User als Mitglied der Admin-Gruppe: uneingeschränkter Test aller Modulfunktionen -> session: DSM
SVS-User als Manager oder Betrachter: angepasstes Privilegienprofil -> session: SurveillanceStation

Mindestanforderungen

set ... credentials	-
set ... delPreset	session: ServeillanceStation - Betrachter
set ... disable	session: ServeillanceStation - Manager mit dem Kamera bearbeiten Recht
set ... enable	session: ServeillanceStation - Manager mit dem Kamera bearbeiten Recht
set ... expmode	session: ServeillanceStation - Manager
set ... extevent	session: DSM - Nutzer Mitglied von Admin-Gruppe
set ... goPreset	session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera
set ... homeMode	session: ServeillanceStation - Betrachter mit Privileg Home-Modus schalten ( gilt für SVS-Device ! )
set ... goAbsPTZ	session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera
set ... move	session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera
set ... motdetsc	session: ServeillanceStation - Manager
set ... on	session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme"
set ... off	session: ServeillanceStation - Betrachter mit erweiterten Privileg "manuelle Aufnahme"
set ... runView	session: ServeillanceStation - Betrachter mit Privileg Liveansicht für Kamera
set ... runPatrol	session: ServeillanceStation - Betrachter mit Privileg Objektivsteuerung der Kamera
set ... setHome	session: ServeillanceStation - Betrachter
set ... setPreset	session: ServeillanceStation - Betrachter
set ... snap	session: ServeillanceStation - Betrachter
set ... snapGallery	session: ServeillanceStation - Betrachter
set ... stopView	-
get ... caminfo[all]	session: ServeillanceStation - Betrachter
get ... eventlist	session: ServeillanceStation - Betrachter
get ... listLog	session: ServeillanceStation - Betrachter
get ... listPresets	session: ServeillanceStation - Betrachter
get ... scanVirgin	session: ServeillanceStation - Betrachter
get ... svsinfo	session: ServeillanceStation - Betrachter
get ... snapfileinfo	session: ServeillanceStation - Betrachter
get ... snapGallery	session: ServeillanceStation - Betrachter
get ... snapinfo	session: ServeillanceStation - Betrachter
get ... stmUrlPath	session: ServeillanceStation - Betrachter

HTTP-Timeout setzen

Attributes

Set

set <name> autocreateCams (gilt für SVS)

set <name> createStreamDev [generic | mjpeg | switched] (gilt für CAM)

generic	- das Streaming-Device gibt einen durch das Attribut "genericStrmHtmlTag" bestimmten Content wieder
mjpeg	- das Streaming-Device gibt einen permanenten MJPEG Kamerastream wieder (Streamkey Methode)
switched	- Wiedergabe unterschiedlicher Streamtypen. Drucktasten zur Steuerung werden angeboten.

Beispiel:

attr <name> genericStrmHtmlTag <video $HTMLATTR controls autoplay>
                                 <source src='http://192.168.2.10:32000/$NAME.m3u8' type='application/x-mpegURL'>
                               </video>

set <name> createPTZcontrol (gilt für PTZ-CAM)

Attributen

set <name> createReadingsGroup [<Name der readingsGroup>] (gilt für CAM/SVS)

set <name> createSnapGallery (gilt für CAM)

Attributen

Hinweis

set <name> credentials <username> <password> (gilt für CAM/SVS)

set <name> delPreset <PresetName> (gilt für PTZ-CAM)

set <name> [enable|disable] (gilt für CAM)

deaktivieren

aktivieren

     define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
     define a14 at 21:46 set Cam.* disable (enable)

     define allcams dummy
     attr allcams eventMap on:enable off:disable
     attr allcams room Cams
     attr allcams webCmd enable: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] (gilt für CAM)

Hinweis:

set <name> extevent [ 1-10 ] (gilt für SVS)

set <name> goAbsPTZ [ X Y | up | down | left | right ] (gilt für CAM)

    set <name> goAbsPTZ 120 450

    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)

   set <name> goAbsPTZ [up|down|left|right]

set <name> goPreset <Preset> (gilt für CAM)

    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

  
   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> homeMode [on|off] (gilt für SVS)

Synology Onlinehilfe

set <name> motdetsc [camera|SVS|disable] (gilt für CAM)

set <name> motdetsc SVS [Empfindlichkeit] [Schwellwert]	# Befehlsmuster
set <name> motdetsc SVS 91 30	# setzt die Empfindlichkeit auf 91 und den Schwellwert auf 30
set <name> motdetsc SVS 0 40	# behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40
set <name> motdetsc SVS 15	# setzt die Empfindlichkeit auf 15, Schwellwert bleibt unverändert

set <name> motdetsc camera [Empfindlichkeit] [Schwellwert] [Prozentsatz]	# Befehlsmuster
set <name> motdetsc camera 89 0 20	# setzt die Empfindlichkeit auf 89, Prozentsatz auf 20
set <name> motdetsc camera 0 40 10	# behält gesetzten Wert für Empfindlichkeit bei, setzt Schwellwert auf 40, Prozentsatz auf 10
set <name> motdetsc camera 30	# setzt die Empfindlichkeit auf 30, andere Werte bleiben unverändert

  CamMotDetSc    SVS, sensitivity: 76, threshold: 55

set <name> move [ right | up | down | left | dir_X ] [Sekunden] (gilt für CAM bis SVS Version 7.1)

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> [on [<rectime>] | off] (gilt für CAM)

Attribut "recextend = 0" bzw. nicht gesetzt (Standard):

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.

Attribut "recextend = 1" gesetzt:

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.

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>

set <name> optimizeParams [mirror:<value>] [flip:<value>] [rotate:<value>] [ntp:<value>] (gilt für CAM)

mirror, flip, rotate: true | false
ntp: der Name oder die IP-Adresse des Zeitservers

Beispiele:

set <name> optimizeParams mirror:true flip:true ntp:time.windows.com

set <name> optimizeParams ntp:Surveillance%20Station

set <name> optimizeParams mirror:true flip:false rotate:true

set <name> pirSensor [activate | deactivate] (gilt für CAM)

set <name> runPatrol <Patrolname> (gilt für CAM)

set <name> runView [live_fw | live_fw_hls | live_link | live_open [<room>] | lastrec_fw | lastrec_fw_MJPEG | lastrec_fw_MPEG4/H.264 | lastrec_open [<room>] | lastsnap_fw] (gilt für CAM)

live_fw	- MJPEG-LiveStream. Audiowiedergabe wird mit angeboten wenn verfügbar.
live_fw_hls	- HLS-LiveStream (aktuell nur Mac Safari und mobile iOS/Android-Geräte)
live_link	- Link zu einem MJPEG-Livestream
live_open [<room>]	- öffnet MJPEG-Stream in separatem Browser-Fenster
lastrec_fw	- letzte Aufnahme als iFrame Objekt
lastrec_fw_MJPEG	- nutzbar wenn Aufnahme im Format MJPEG vorliegt
lastrec_fw_MPEG4/H.264	- nutzbar wenn Aufnahme im Format MPEG4/H.264 vorliegt
lastrec_open [<room>]	- letzte Aufnahme wird in separatem Browser-Fenster geöffnet
lastsnap_fw	- letzter Schnappschuss wird dargestellt

"live_fw, live_link, live_open"

"live_open"

"live_fw_hls"

"lastrec_fw.*"

"lastrec_open"

"lastrec_fw.*"

"set <name> runView lastsnap_fw"

"lastrec_open"

Beispiel:

    attr <name> htmlattr width="500" height="375"
    attr <name> htmlattr width="500" height="375" top="200" left="300"

"set <name> runView live_open"

"set <name> runView live_open <room>"

Beispiel:

    attr <name> livestreamprefix https://<Servername>:<Port>

"set <name> stopView"

Start Recording	- startet eine Endlosaufnahme
Stop Recording	- stoppt eine Aufnahme
Take Snapshot	- löst einen Schnappschuß aus
Switch off	- stoppt eine laufende Wiedergabe

Hinweis zu HLS (HTTP Live Streaming):

set <name> setHome <PresetName> (gilt für PTZ-CAM)

set <name> setPreset <PresetNummer> [<PresetName>] [<Speed>] (gilt für PTZ-CAM)

set <name> snap (gilt für CAM)

Schnappschuß

 
     set <name> snap

Auslösung von Schnappschüssen

     define he1_snap_3 notify CamHE1:Record.*Start define h3 at +*{3}00:00:02 set CamHE1 snap

     define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap

set <name> snapGallery [1-10] (gilt für CAM)

"get <name> snapGallery"

"get <name> snapGallery"

Hinweis

set <name> startTracking (gilt für CAM mit Tracking Fähigkeit)

set <name> stopTracking (gilt für CAM mit Tracking Fähigkeit)

Get

get <name> caminfoall (gilt für CAM/SVS)

get <name> caminfo

get <name> eventlist (gilt für CAM)

     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]')})

get <name> homeModeState (gilt für SVS)

get <name> listLog [severity:<Loglevel>] [limit:<Zeilenzahl>] [match:<Suchstring>] (gilt für SVS)

<Loglevel> - Information, Warning oder Error. Nur Sätze mit dem Schweregrad werden abgerufen (default: alle)
<Zeilenzahl> - die angegebene Anzahl der Logzeilen (neueste) wird abgerufen (default: alle)
<Suchstring> - nur Logeinträge mit dem angegeben String werden abgerufen (Achtung: kein Regex, der Suchstring wird im Call an die SVS mitgegeben)

Beispiele

get <name> listLog severity:Error limit:5

get <name> listLog severity:Information match:Carport

get <name> listLog severity:Warning

Synology Online-Hlfe

get <name> listPresets (gilt für PTZ-CAM)

get <name> scanVirgin (gilt für CAM/SVS)

get <name> snapGallery [1-10] (gilt für CAM)

Attribute

snapGalleryBoost
snapGalleryColumns
snapGalleryHtmlAttr
snapGalleryNumber
snapGallerySize

Hinweis:

get <name> snapfileinfo (gilt für CAM)

"get <name> snap"

get <name> snapinfo (gilt für CAM)

get <name> stmUrlPath (gilt für CAM)

http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"

Hinweis:

get <name> storedCredentials (gilt für CAM/SVS)

get <name> svsinfo (gilt für CAM/SVS)

get <name> versionNotes [hints | rel | <key>] (gilt für CAM/SVS)

Polling der Kamera/SVS-Eigenschaften:

PollState = Active - automatisches Polling wird mit Intervall entsprechend "pollcaminfoall" ausgeführt
PollState = Inactive - automatisches Polling wird nicht ausgeführt

Readings

Hinweise: