About MichaelS

Question   What is the SDK functionality in Bosch Video Management System and how to create a scriptlet? This article will provide a basic explanation and simple examples of the interfacing (scripting, calling functions by external applications) functionality in Bosch Video Management System. Also, this article contains the BVMS SDK Help files. The interfacing functionality is based on Bosch VMS SDKs. The Bosch VMS SDKs contain all interfaces, object types and methods that are needed for automation and integration to and of Bosch VMS.     Answer The system supports executables in any .NET language and script files in C# and VB.net but only one or the other. When you start the scripting editor the first time you have to decide which programming language you want to use. The SDKs provide:  Server API  Client API  Client Enterprise API  Cameo SDK Of course you can also use the basic commands that are provided by the programming language (for example .Net Framework). When connecting to Bosch VMS by a 3rd party application you can use those APIs to remotely control Bosch VMS. Thereby the SDK provides a powerful integration into other systems.   SDKs purpose and overview Server SDK The Server SDK is meant to control and monitor Bosch VMS by scripts and external applications. You can use those interfaces with a valid administrator account. Client SDK The Client SDK is meant to control and monitor Bosch VMS Operator Client by external applications and scripts (these scripts depend on the connected server). Client Enterprise SDK The Client Enterprise SDK is meant to control and monitor the behavior of Bosch VMS Enterprise Operator Client of a multisite system by external applications. The SDK allows browsing devices that are accessible by the running, connected Operator Client and to control some UI functionalities. Cameo SDK The Cameo SDK is meant to embed Bosch VMS live and playback cameos into your external third-party application. The cameos will follow the Bosch VMS based user permissions. The Cameo SDK provides a subset of the Bosch VMS Operator Client functionalities that enables you to create applications similar to the Operator Client   Server SDK, Client SDK and Client Enterprise SDK The following command set is offered: For the complete Server-, Client- and Client Enterprise-command set please refer to the SDK-help manuals. Example: SDK-help for method “DisplayCamera”   Client Scripts, Client Enterprise and Server Scripts There are two general types of script files; the server script and the client (Enterprise) script. Each one serves different purposes: The client (Enterprise) script file contains subroutines (so-called scriptlets) which can be added to the logical tree to be started manually from the client machine by a user. E.g. the user double-clicks a scriptlet on a map and automatically a camera is loaded in full-screen on the second monitor. The client script can also be added to an alarm workflow (i.e. a client script can by triggered when an alarm is accepted). The server script file contains scriptlets which are triggered automatically on the server by an event. Server scripts can be selected in the Event table in the “Script” column. E.g. in response to an event the server automatically switches a relay. NOTE: In a configured and running system only the scriptlets are called up, never the whole script file. The constructor and static classes will be called up as soon as the scripting engine is initialized. Client scriptlet function: 1) A Client (Enterprise) scriptlet is started from a client workstation by a user action or automatically (startup script). The script can be located in the logical tree or on a map. The scriptlet is started by double click or context menu on that icon. A Client scriptlet can also be started when the operator accepts an alarm. 2) The client scriptlet code is processed on the client workstation immediately. It can contain client commands and (Client SDK only) server commands because the Client SDK is always bound to a specific Management server. A Client Enterprise scriptlet may NOT use server commands because the Enterprise client is connected to multiple management servers. Use the Server SDK to control VMS servers explicitly. 3) Client commands invoke client actions (e.g. loading a camera in the image window) whereas server commands invoke actions controlled by a dedicated Management Server (e.g. switching relays). Server scriptlet function: 1) A server scriptlet is initiated by an event. This can be any event, e.g. the activation of a schedule, a digital input, a user button, etc. 2) The scriptlet code is processed on the Management server which also takes care of all the events. This happens automatically. No user action is required. The scriptlet can also use several arguments that come with each event such as event time, devices name, device state, etc. This way, you can build the system behaviour dependent on the values of the arguments. 3) Server commands invoke actions controlled by the Management server (e.g. switching relays). You can use the same scriptlet for different events. Each event carries data in the Event argument. To get to the individual event data/information (e.g. the device name) you have to look into it.   Creating a scriptlet   Step by step introduction: 1) Open command script editor. 2) Choose language. 3) Right click client script node or server script node. 4) Select menu item New Scriptlet. 5) Name the scriptlet in a reasonable way so that you can find it later. 6) Start programming where the automatically created code says “//Insert code here”. Each scriptlet gets a scriptlet GUID (Globally Unique Identifier) from the system when it is created. It is important to always create a new scriptlet in the script tree on the left side of the command script editor. It is not sufficient to write the code manually to the script file. Also avoid using the same scriptlet GUID twice when copying and pasting scriptlet code. NOTE: New scriptlets must be added with the command script editor function “Add scriptlet”.   Changing the programming language The system supports two languages, C# and VB.net. You have to decide once per System in which language you want to program your script files. NOTE: If you want to change the language afterwards, all scriptlet code will be deleted (method bodies will be replaced by empty bodies) so that you will lose the functionality behind. All parts of the configuration where scripts are used will NOT be lost.   Starting an Client scriptlet on accepting a specific alarm When one of the operators accepts a certain alarm you can execute a client scriptlet automatically. You can configure it for a Management Server (that creates the alarm) under ‘Alarms’: Example: When the operator accepts an alarm his workstation enters Playback mode, loads a specific camera and sets the time to 1 minute before accepting the alarm.   Starting a scriptlet on startup of a workstation Right after an operator has logged in on a specific workstation Bosch VMS can start a Client (Enterprise) script automatically. The startup script can be configured on the configuration page of a workstation: Example: With the Start-up script you can load a default layout on a specific workstation each time an operator logs in to it.   Starting a server scriptlet in response to an event In response to each event that happens in Bosch VMS you can execute a server scriptlet. You don’t have to trigger an alarm for that, but of course you can do both, even schedule dependent. Example: When the door Input opens (Input 2) the server automatically exports the last 2 minutes of the door camera recordings to a Network drive, but only during the night.   Structure of a script file Client scripts C# - Client script VB.net - Client script [BvmsScriptClass()] public class ClientScript : IDisposable { private readonly IClientApi Api; private readonly ILog Logger; public ClientScript(IClientApi api) { this.Logger = LogManager.GetLogger("ClientScript"); this.Api = api; } [Scriptlet("computer generated GUID")] public void MyScriptlet() { Camera camera = Api.CameraManager.GetCameraByName("Cam01"); Api.ContentManager.DisplayCamera (new ImagePane(1, 1), camera); } public void Dispose() { // Use this method to cleanup any resources here (consider fully implementing the Dispose pattern). // For example, stop and dispose any started timers. Ensure that all threads that were started are stopped here. // DO NOT BLOCK in this method for a very long time, as this may block the applications current activity. } } Imports System Imports System.Diagnostics Imports System.Collections.Generic Imports log4net Imports Bosch.Vms.Core Imports Bosch.Vms.SDK <BvmsScriptClass()> _ Public Class ClientScript Implements IDisposable Private Shared Logger As ILog Private Shared Api As IClientApi Sub New(api As IClientApi) Logger = LogManager.GetLogger("ClientScript") Me.Api = api End Sub <Scriptlet("computer generated GUID")> _ Public Sub MyScriptlet() Dim camera As Camera = Me.Api.CameraManager.GetCameraByName("Cam01") Api.ContentManager.DisplayCamera(New ImagePane(1, 1), camera) End Sub Public Sub Dispose() Implements IDisposable.Dispose ' Use this method to cleanup any resources here (consider fully implementing the Dispose pattern). ' For example, stop and dispose any started timers. Ensure that all threads that were started are stopped here. ' DO NOT BLOCK in this method for a very long time, as this may block the applications current activity. End Sub End Class End Class   The “using” / ”Imports” declarations bring in different sets of commands that are provided by so called “name spaces”. Comments can be entered by putting “//” (C#) or “’” (VB.net) at the beginning of a line. The “public class” is the body of the script file. Between the first “{“ and the last “}” of the file you can add different subroutines (C#). New scriptlets will be added after the last scriptlet in the file. The computer generated GUID (Globally Unique Identifier) has to be in the headline of each scriptlet. Never enter that line manually. A typical GUID looks like "24af66fc-5015-45ee-b27b-a60597f4196d". Use the Dispose method to clean up resources. For client scripts, the Dispose method gets called when the Operator Client application exits. For server scripts, the Dispose method gets called when a new configuration is activated. Server scripts C# - Server script VB.net – Server script using System; using System.Diagnostics; using System.Collections.Generic; using log4net; using Bosch.Vms.Core; using Bosch.Vms.SDK; [BvmsScriptClass()] public class ServerScript : IDisposable { private readonly IServerApi Api; private readonly ILog Logger; public ServerScript(IServerApi api) { this.Logger = LogManager.GetLogger("ServerScript"); this.Api = api; } public void Dispose() { // Use this method to cleanup any resources here (consider fully implementing the Dispose pattern). // For example, stop and dispose any started timers. Ensure that all threads that were started are stopped here. // DO NOT BLOCK in this method for a very long time, as this may block the applications current activity. } [Scriptlet("computer generated GUID")] public void ServerScriptlet(EventData e) { // Insert code here } } Imports System Imports System.Diagnostics Imports System.Collections.Generic Imports log4net Imports Bosch.Vms.Core Imports Bosch.Vms.SDK <BvmsScriptClass()> _ Public Class ServerScript Implements IDisposable Private Shared Logger As ILog Private Shared Api As IServerApi Sub New(api As IServerApi) Logger = LogManager.GetLogger("ServerScript") Me.Api = api End Sub Public Sub Dispose() Implements IDisposable.Dispose ' Use this method to cleanup any resources here (consider fully implementing the Dispose pattern). ' For example, stop and dispose any started timers. Ensure that all threads that were started are stopped here. ' DO NOT BLOCK in this method for a very long time, as this may block the applications current activity. End Sub <Scriptlet("computer generated GUID")> _ Public Sub ServerScriptlet(e As EventData) ' Insert code here End Sub End Class     Quick start (Client Enterprise SDK)   The RemoteClientApiEnterprise class is the entry point of the SDK. Create an object of the class RemoteClientApiEnterprise by passing the client address and the user credentials to the constructor. RemoteClientApiEnterprise class Create an object of this class by passing the client address and the user credentials. The created object provides properties to access different kind of functionalities: AlarmManager: gives access to alarm management as accept, unaccept, clear alarms… ApplicationManager: gives access to application status (logged in user, group, live or playback status…) CameraManager: gives access to all cameras and helper methods for camera identification ContentManager: gives access to methods that control the UI of the Operator Client (display a camera, document, change to full-screen mode, control Image window…) DeviceManager: gives access to all devices and helper methods for device identification DocumentManager: gives access to all documents and helper methods for document identification DomeCameraManager: give access to all dome cameras and helper methods to control the cameras (PanTiltZoom, prepositions…) TimelineManager: gives access to methods that control the playback mode of the Operator Client (change playback speed, move to a specific position, control playback direction…) The class RemoteClientApiEnterprise provides an event ConnectionLostEvent that is triggered when the remote Api has lost the connection to the Operator Client.   Quick Reference (Client Enterprise SDK)   IAlarmManagerEnterprise To be able to receive Alarms a class derived from AlarmReceiverEnterprise must be defined and an object created. OnAlarm(IEnumerable alarmData) is called by the SDK to submit alarms and their state changes to the 3rd party client application. IAlarmManagerEnterprise provides methods to manage alarms (accept, clear, unaccept), to get a list of current alarms and to register/unregister to receive alarms with the above described callback method OnAlarm(…).   IApplicationManagerEnterprise The application manager interface IApplicationManagerEnterprise provides methods to get the following information: – logged in user: user name, user group – Operator Client mode: live or playback – Server information: list of server Info objects that contain the display name, the network name and the serverId of each server The application manager interface IApplicationManagerEnterprise provides methods to control the following: – Change the Operator Client mode to live or playback – Fire user events – Post a message that is shown on the Operator Client system – Speak a submitted text on the Operator Client system   IDeviceManagerEnterprise The device manager interface provides methods to get the following: – Device object by providing an Instance Id or a name – Name of a Device object   ICameraManagerEnterprise The camera manager interface is inherited from the IDeviceManagerEnterprise providing methods to get the following: – List of Camera objects that are added to the Logical Tree of the Operator Client – Camera object by providing an InstanceId, a name or a local or a logical number IContentManagerEnterprise The content manager interface provides methods to control the UI of the Operator Client and to get status information about the content of the Image window. The document manager interface provides methods to browse all documents (html documents and maps) and to get a document object by passing an id or name.   IDocumentManagerEnterprise The document manager interface provides methods to browse all documents (html documents and maps) and to get a document object by passing an id or name. IDomeCameraManagerEnterprise The dome camera manager interface provides methods to browse all dome cameras, to get a dome camera object by passing an ID or name and to control a dome camera (PTZ, focus, Aux, Iris…) ITimelineManagerEnterprise The timeline manager interface provides methods to remote control the playback mode of the connected Operator Client. For example the current timeline position can be set, the playback direction and speed can be changed.   Cameo SDK   This chapter provides information on how to get started with Cameo SDK documentation and the Cameo SDK Test Application including a complete C# project.   NOTICE! You must have selected the Cameo SDK Manuals checkbox during setup to install the manuals and the test application an your computer.   To display the Cameo SDK reference help: – Click Start, then select Bosch VMS, select Cameo SDK, and then click Cameo SDK Help. The Cameo SDK reference help is started. To start the Cameo SDK test application: – Click Start, then select Bosch VMS, select Cameo SDK, and then click Cameo SDK Test Application C# Project. The test application is started. To start the Cameo SDK test project: – Click Start, then select Bosch VMS, select Cameo SDK, and then click Cameo SDK Test Project. A C# project is started in your development environment containing the source code of the Cameo SDK Test Application C#Project.   Installation   This chapter provides information on the installation of Cameo SDK and Client Enterprise SDK NOTICE! You can install CameoSDK as a bosch VMS component using the Bosch VMS Setup.   Quick start This chapter provides information on how to get started with CameoSDK and with Client Enterprise SDK. Bosch VMS Cameo SDK is represented by Bosch.Vms.CameoSdk.dll file that is available on the target computer after CameoSDK installation (\CameoSdk\ folder). To use this assembly just add it to the referenced assemblies list in your C# project. Here is a code sample for Cameo SDK: CameoSdkParameters parameters = new CameoSdkParameters(uniqueId, pathToCameoSdkBinaries, useInternalLoggingSettings, mainForm); Sdk = EntryPoint.GetSdk(parameters); Sdk.ConnectionStateChanged += SdkConnectionStateChanged; Sdk.ScheduleLogoffRequired += SdkScheduleLogoffRequired; Sdk.ConfigurationStateChanged += SdkConfigurationStateChanged; StartupResult result = Sdk.Startup(serverAddress, userName, userPassword, StartupMode.TryUpdateConfiguration); if (result == StartupResult.Ok) { // user code } Sdk.Shutdown();   Here are a few tips that should be kept in mind for successful Cameo SDK assembly usage: – all DiBos components should be properly registered (by installation of compatible Bosch VMS Operator or Config Client) – the folder which contains core components (Bosch.Vms.CameoSdk.Core.dll) should contain all VideoSDK required files (folders: "Bosch.VideoSDK5.BVIP", "Bosch.VideoSDK5.Core", "Bosch.VideoSDK5.DiBos", "Bosch.VideoSDK5.Divar700", "Bosch.VideoSDK5.Experimental", "Bosch.VideoSDK5.ONVIF", "Bosch.VideoSDK5.RTSP"; files: "Bosch.VideoSDK5.manifest").   To start using the CameoSDK create a CameoSdkParameters object and an EntryPoint object, then call the GetSdk (...) method of the EntryPoint class by passing the object CameoSdkParameters to get an ICameoSdk interface.   EntryPoint class Create an object of this class to start using the CameoSDK. Call the method GetSdk and pass a CameoSdkParameters object to get an ICameoSDK interface. CameoSdkParameters class Create an object of this class to be passed to the EntryPoint method GetSdk(...).In the constructor of this class, pass a unique host id that identifies the hosting application, a path to the binary folder of the CameoSDK and the Form object of the hosting application. ICameoSdk This interface is returned by the EntryPoint constructor and provides functionality of the CameoSdk, like Startup/shutdown, connection state, configuration state. Other features of the CameoSdk are exposed via properties of type IDeviceManager, ControlFactory, MediaPlayerFactory and ExporterFactory and are described in the following chapter.   Quick Reference IDeviceManager This interface provides functionality to discover devices. The RemoteServerApi (from Bosch VMS SDK) has to be used to receive events of device states.   IDevice This interface provides methods to get the name, the id and the network address of the device ICamera This interface represents a camera object. It provides methods to get camera infromation (name, id, network address...) and a PTZ property if the camera is a PTZ camera. IPtz, IPtzControl, IPtzSettings These interfaces provide methods to control PTZ cameras IControlFactory Provides methods to create live or playback cameo controls, which can be placed in the 3rd party application UI. In case a playback control has to be created then a MediaPlayer object must be passed.   IVideoCameoControl This interface is returned by the methods provided by the IControlFactory to create Image pane controls. this interface provides methods to assign a camera to the control, to get a snapshot of the currently displayed image (live or playback), to check the connection state to the camrea and to get a UI control that can be placed in the 3rd party application. IMediaPlayerFactory This interface provides functionality to create media player controls (playback control). A single media player can be created and associated with several VideoCameoControls, in this case all associated controls will be synchronized (by CurrentPosition) IMediaPlayer This interface provides functionality to create a media player control (play, stop change playback direction or speed...)   Note: If the same MediaPlayer object is passed to multiple Image pane controls, their playback is synchronized. This case is similar to the playback mode of the Operator Client application. A MediaPlayer control can also be created for each Image pane control. In this case the playback is not synchronized and the playback can be controlled differently for each control. This case is similar to instant playback in the Live Mode of Operator Client.   IExporterFactory This interface allows creating ASF exporter objects of the interface type IExporter. IExporter Provides methods for adding cameras to the export, for starting/canceling the export and tracking the progress.   Examples in C# Example scriptlet 1: Using a Hardware decoder and showing an OSD-Message When creating a new scriptlet in the Bosch VMS Command Script editor, the identifier and the method frame of the scriptlet are written automatically into the script file. You only have to enter the code between the curly brackets. Read the comments for further explanation of what is programmed in the code. [Scriptlet("system generated script ID")]  public void ShowCameraOnDecoder()  { Camera c = Api.CameraManager.GetCameraByName("Camera Name"); Decoder d = Api.DecoderManager.GetDecoderByName("Decoder Name");  Api.DecoderManager.DisplayCamera(d, c);  System.Threading.Thread.Sleep(100);  Api.DecoderManager.SetOsd(d, "Hello out there!"); } Comments (line-wise): 1: The first attribute is the automatically generated identifier, do not change manually! 2: Initializing the subroutine with the Name of the scriptlet. You can change that name in the code. 4: Initialize a camera object by name, use the system name as you see it the logical tree (hint: you may also identify cameras by their logical number) 5: Initialize a decoder object by name, use the system name as you see it in the device tree (hint: you may also identify cameras by their logical number) 6: Call up method from decoder manager with camera and decoder as parameters 7: Hold the thread for 100 milliseconds. This is inserted because the decoder tends to drop commands when they arrive almost immediately. In this case the OSD Message might get lost when the sleep command is deactivated. 8: Display a string on the decoder using the decoder manager again. NOTE: You should ONLY use decoders that are not part of any Analog Monitor Group (AMG). Otherwise the AMG control will interfere with the script actions. Example scriptlet 2: Open and close a relay This scriptlet opens and closes a specific relay. This scriptlet is meant to be used in a server script [Scriptlet("system generated script ID")] public void OpenAndCloseRelays() { Relay r = Api.RelayManager.GetRelayByName("Relay 1"); Api.RelayManager.Open(r); System.Threading.Thread.Sleep(1000); Api.RelayManager.Close(r); }     Comments (line-wise): 1: Get the relay as specified in Bosch VMS (by name) 2: Open the relay 3: Wait for 1000 ms = 1 second 4: Close the relay   Example scriptlet 3: Toggle a set of relays This scriptlet toggles a set of relays based on each relay state. Open relays are closed and vice versa. Therefore it uses a simple „foreach“ loop. In each case there is an „if – else“ decision if the relay should be opened or closed, depending on the current state of the relay. This scriptlet is meant to be used in a server script. [Scriptlet("system generated script ID")] public void ToggleRelays() { Relay[] relay_array = new Relay[3] { Api.RelayManager.GetRelayByName("Relay 1"), Api.RelayManager.GetRelayByName("Relay 2"), Api.RelayManager.GetRelayByName("Relay 3") };  foreach (Relay r in relay_array) { if (Api.RelayManager.GetState(r) == RelayState.On) { Api.RelayManager.Open(r); } else { Api.RelayManager.Close(r); } } }     Comments (line-wise): 1: Open a new array of relays 2: Initializing the for each loop which checks each relay state and inverts it.   Example scriptlet 4: A scriptlet with a switch case block In this example a server scriptlet is presented which switches different sets of relays in dependency of an argument string. In this special case we use the event arguments (“e”) which provide for example the device name (“e.DeviceName”). Take motion detection as the event that triggers this script. If “Camera 1” triggers then the script does that, if “Camera 2” triggers it does something else, and so on… In the switch case block you define the different behaviors per option. The default behavior can be set in the default block, E.g. in the default case don’t do anything. [Scriptlet("system generated script ID")] public void OnCameraEventSwitchRelays(Event e) { List RelayList = new List(); Boolean Toggle = true; switch(e.DeviceName) { case "Camera 1": RelayList.Add(Api.RelayManager.GetRelayByName("TR01")); break; case "Camera 2": RelayList.Add(Api.RelayManager.GetRelayByName("TR02")); break; case "Camera 3": RelayList.Add(Api.RelayManager.GetRelayByName("TR03")); RelayList.Add(Api.RelayManager.GetRelayByName("TR04")); RelayList.Add(Api.RelayManager.GetRelayByName("TR05")); break; default: Toggle = false; Logger.Info("unknown Devicename"); break; } if (Toggle) // closing all relays in the relay list { foreach (Relay r in RelayList) { Api.RelayManager.Close(r); } } }   Example scriptlet 5: Fill a monitor with cameras 1-9 This example uses the client script API. It changes the layout on the client and fills the image panes with different cameras.   Api.ContentManager.ResetMonitor(1); // clears monitor 1 and sets it to a standard 3x3 grid for (int i = 1; i <= 9; i++) // counts i from 1 to 9 { Api.ContentManager.DisplayCamera(new ImagePane(1, i), Api.CameraManager.GetCameraByLogicalNumber(i)); // opens camera i in imagepane i }   Comments (line-wise): 1: Resets the monitor 1. That means that the 1st monitor is cleared and set to a regular 3x3 grid. 2: A “for”-loop that counts the variable integer variable “i” from 1 to 9 4: for each loop camera i (logical camera number) is opened in image pane i, so that the whole image window is finally filled up with different cameras   Example scriptlet 6: If an input is “on” then reposition a dome camera This example is just one command, using an if-construct and the command to reposition a dome camera. Here the camera is found by logical number. public void DomeCameraInRespondToInput() { if (Api.InputManager.GetState(Api.InputManager.GetInputByName("Input Test 1")) == InputState.On) { Camera cam= Api.DomeCameraManager.GetDomeCameraByLogicalNumber(42); Api.DomeCameraManager.MoveToPredefinedPosition (cam, 3); } }   Example scriptlet 7: Remote connection with Exception Handler Use “ConnectToServerApi()” to connect remotely to a Bosch VMS client or server. The connection commands are protected with try/catch blocks, so that the application does not crash if the connection to the Remote API fails. IServerApi ServerApi; IClientApi ClientApi; void ConnectToServerApi() { try { ServerApi = new RemoteServerApi(serveraddress, username, password); //"localhost:5390", "Admin", ""); //Important: right port number } catch (Exception mye) { MessageBox.Show(mye.Message, "Connection to server failed!"); } } void ConnectToClientApi() { try { ClientApi = new RemoteClientApi(serveraddress, username, password); //"localhost:5394", "Admin", ""); //Important: right port number } catch (Exception mye) { MessageBox.Show(mye.Message, "Connection to client failed"); ClientConnected = false; } }   Example executable 8: Control Operator Client in response to a Virtual Input Data event and read out the data This example shows you how to react within the Operator client on a certain event (e.g. by opening a dedicated cameo).. An executable reads out the EventData and switches through the Virtual Input Data field one. Different data causes different reactions. The default block defines the behavior if the value is not matching or unknown. string serverIpAdr = "192.168.2.3:5390"; // server IP address, followed by port number 5390 string clientIpAdr = "192.168.2.17:5394"; // client IP address, followed by port number 5394 string loginName = ; // login name string loginPassword = ; // login password RemoteServerApi ServerApi = new RemoteServerApi(serverIpAdr, loginName, loginPassword); RemoteClientApi ClientApi = new RemoteClientApi(clientIpAdr, loginName, loginPassword); MyReceiver er = new MyReceiver(); ServerApi.EventManager.Register(er); public class MyReceiver : EventReceiver { public override void OnEvent(EventData e) { //Do something here. switch (e["Data1"]) //reads out the EventData for the 1st Virtual Input Data String (Data1) { case "camera01": //If it is "camera01" it will execute this case // open a certain cameo, e.g. for camera1 break; case "camera02": //If it is "camera02" it will execute this case // open a certain cameo, e.g. for camera1 break; default: //If no cases fit it will execute the default case Logger.InfoFormat("Content of Data1 unknown - event: {0}", e.ToString()); break; } } }     Question and Answers Q: Do I have to be a .NET developer to create a command script? A: No, you don’t. Using the SDK only requires a basic programming understanding. It uses the .net languages VB.net or C# to be 100% compatible with the application code which is also .NET based. Q: Why did you choose VB.net or C# as the language for the SDK and for the command scripts? A: The top 3 reasons for that are: 1) .NET languages are the most modern languages you may use. Especially C# was invented to get the advantages of C and Java into a new language, being code reducing, restrictive and straight. 2) The complete application runs in a .NET environment. Using the same language makes command scripts and SKD actions 100% compatible to the main software. This way we benefit from a higher stability and performance. 3) C# is not C++, it is much easier, plus we hide the mystery of object orientated languages to the user. All you need to do is program a scriptlet (like a macro) which anyway contains more or less the SDK commands only. VB.net might be the preferred language for those of you who have already experience in Visual Basic. Q: Can I use the same script file on another Bosch VMS? A: Yes, you can. Easiest you would export the script file in the command script editor and import it on the other Bosch VMS. Note: In this case you would overwrite the existing script file on the other Bosch VMS (if there is one). Q: How can I use the SDK from a 3rd party application? A: See example executable 8. You need to instantiate the Client (Enterprise) and/ or the Server API in the 3rd party context. And you need to reference the Bosch.Vms.SDK.dll in your development environment. To control an operator client depending on server states or alarms you shall access the server SDK from the dedicated operator client. Q: What SDK commands can I use in the client script? A: You can use ALL commands that are provided by the Bosch VMS Client SDK and the Bosch VMS Server SDK. Q: What SDK commands can I use in the client Enterprise script? A: You can use ALL commands that are provided by the Bosch VMS Client Enterprise SDK. Q: What SDK commands can I use in the server script? A: You can use all server commands (look into the interface IServerApi in the Bosch VMS SDK help). Please do not use the client SDK from within a server script! Q: Why does my camera not load in response to a command script? AKA: Why does my relay not switch in response to a command script? A: The command script editor is very restrictive. It allows saving the script file only if it does not contain any errors. So in 95% of the cases (raw estimation) a typo in the name argument of the “Get…ByName” method is the cause of a malfunction. Please check it very thoroughly: Mind case sensitivity and spaces inside device names.         ... View more

Question   Which are the keyboard shortcuts that can be used by operators when operating the BVMS system?   Answer   F8* → *Note: You cannot display more Image pane rows than the configured maximum, which is set by a parameter in the BVMS Configuration Client Bosch VMS - PC Keyboard Layout:   ... View more

Question   Which are the components that establish a connection between BVMS& 3rd party management system? This article describes the different components that Bosch Video Management System offers to to establish a connection between Bosch Video Management System and a 3rd party management system. This description helps you in writing your own commands for controlling Bosch VMS from inside your management system.    Answer   Notice! Please note, that OPC is not the preferred solution for connecting Bosch VMS to 3rd party components. BU-ESS/MKP rather recommends using our existing .NET SDKs.   List of used abbreviations: – AE: Alarms and Events – Bosch VMS: Bosch Video Management System – DA: Data Access – HTML: Hypertext Markup Language – I/O: Input/ Output – OPC: OLE for Process Control (OLE: Object Linking and Embedding) – XML: Extensible Markup Language For details regarding Bosch VMS OPC Server, see Bosch VMS OPC Server. For details regarding Bosch VMS Proxy, see Bosch VMS Proxy. Installation section from this article describes how to install a connection between Bosch VMS and a 3rd party management system. The files needed by OPC Server and Bosch VMS Proxy, are described in Configuration files. Example for 3rd party client (HTML file), gives an example for a 3rd party application in form of an HTML file.   Components The following software components are used to realize a connection: – Bosch VMS OPC Server Forwards events from Bosch VMS to the 3rd party software and forwards commands from 3rd party software to Bosch VMS. It is installed but not automatically registered in Windows where Bosch VMS Management Server software is installed. – Bosch VMS Proxy Forwards events from Bosch VMS to the 3rd party software and forwards commands from 3rd party software to Bosch VMS. It is installed on each computer where Bosch VMS Operator Client and/or Bosch VMS Management Server software is installed. – 3rd party application As an example we provide an HTML page with code (JScript) to send commands like Show Live or Show Playback to Bosch VMS Proxy. This HTML page can be integrated in a 3rd party management system. It is installed on a computer where Bosch VMS Operator Client software is installed. You can use Softing OPC Toolbox as a 3rd party application on a Bosch VMS Operator Client computer or on a standalone computer to send commands like open/close a relays to the Bosch VMS OPC Server.   The following image shows the connection between a 3rd party application and Bosch VMS Server via OPC Server and Bosch VMS Proxy: Figure 1.1: Connection 3rd party application – Bosch VMS Management Server   See Bosch VMS Proxy commands that you can send from an application on 3rd party side to Bosch VMS Operator Client. The connection between a 3rd party application and Bosch VMS Operator Client does not need OPC Server. The commands being sent by the 3rd party application can be processed by an HTML file with code. For an example for such an HTML file, see Example for 3rd party client (HTML file). See section OPC Server events that are sent from 3rd party server to Bosch VMS OPC Server. See section OPC Server commands that you can send from 3rd party server to Bosch VMS OPC Server.   1. Bosch VMS OPC Server The Bosch VMS OPC Server software is used for sending state changes of the following items from Bosch VMS to a 3rd party management system like Softing OPC Toolbox. The following items are available: – Input – Relay – Encoder – Decoder – Virtual Input – Camera Bosch VMS OPC Server has the following features: – Notification of state changes in cameras, decoders, encoders – Start and stop recording – Control of relays and virtual inputs, status notification of I/O objects in Bosch VMS On startup, OPC Server reads a Bosch VMS configuration file where all items like cameras, relays, inputs, decoders, encoders, virtual inputs are listed. OPC Server supports DA V.2. DA helps creating the namespace and sending commands to devices like open or close a relay. Note: It is not supported to directly send commands to devices via DA by changing the item’s value. To send commands use the DA item CMD. Also it is not supported to query the current state of a device using DA. Use AE instead when you want to be notified about a state change of a device.   The 3rd party system DA namespace looks like this: This picture was made with Softing OPC Toolbox.   1.1. OPC Server events OPC server notifies state changes on the Bosch VMS side with an AE event to the 3rd party Server. OPC Server events section describes the notified values. The following table lists all error events which Bosch OPC Server can generate. Interface Type Event Name State Value State Id Camera / Signal Presence Bosch.Vms.Server.VideoDevice SignalPresence Unknown 0 Bosch.Vms.Server.VideoDevice SignalPresence Present 5 Bosch.Vms.Server.VideoDevice SignalPresence NotPresent 353 Camera / Brightness Bosch.Vms.Server.VideoDevice SignalTooBright SignalOK 5 Bosch.Vms.Server.VideoDevice SignalTooBright Signal-NotOk 360 Bosch.Vms.Server.VideoDevice SignalTooDark SignalOK 5 Bosch.Vms.Server.VideoDevice SignalTooDark Signal-NotOk 361 Camera / Noise Bosch.Vms.Server.VideoDevice SignalTooNoisy SignalOK 5 Bosch.Vms.Server.VideoDevice SignalTooNoisy Signal-NotOk 362 Camera / Too blurry Bosch.Vms.Server.VideoDevice SignalTooBlurryState SignalOK 5 Bosch.Vms.Server.VideoDevice SignalTooBlurryState Signal-NotOK 377 Camera / Motion Bosch.Vms.Server.VideoDevice MotionDetect Motion Detected 367 Bosch.Vms.Server.VideoDevice MotionDetect Motion Stopped 363 Camera / Recording Mode Bosch.Vms.Server.VideoDevice RecordingMode Alarm 365 Bosch.Vms.Server.VideoDevice RecordingMode None 364 Bosch.Vms.Server.VideoDevice RecordingMode Manual 365 Bosch.Vms.Server.VideoDevice RecordingMode Continuous 368 Bosch.Vms.Server.VideoDevice RecordingMode Motion 367 Camera / Visibility Bosch.Vms.Server.VideoDevice VisibilityState On 790 Bosch.Vms.Server.VideoDevice VisibilityState Off 791 Camera / Protected Recording Bosch.Vms.Server.VideoDevice ExternalData   792 Camera / Global Change Bosch.Vms.Server.VideoDevice GlobalChangeState Global Change not detected 378 Bosch.Vms.Server.VideoDevice GlobalChangeState Global Change detected 379 Relay Bosch.Vms.Server.RelayDevice RelayState Relay Error 27 Bosch.Vms.Server.RelayDevice RelayState Relay Closed 301 Bosch.Vms.Server.RelayDevice RelayState Relay Opened 300 Input Bosch.Vms.Server.InputDevice InputState Input Error 27 Bosch.Vms.Server.InputDevice InputState Input Closed 24 Bosch.Vms.Server.InputDevice InputState Input Opened 25 Virtual Input Bosch.Vms.Server.VirtualInput InputState Input Closed 24 Bosch.Vms.Server.VirtualInput InputState Input Opened 25 Encoder Bosch.Vms.Server.EncoderDevice EncoderState On 25 Bosch.Vms.Server.EncoderDevice EncoderState Off 24 Bosch.Vms.Server.EncoderDevice ConnectionState NotAuthorized 0 Bosch.Vms.Server.EncoderDevice ConnectionState Connected 25 Bosch.Vms.Server.EncoderDevice ConnectionState Disconnected 24 Decoder Bosch.Vms.Server.Decoder DecoderState On 25 Bosch.Vms.Server.Decoder DecoderState Off 24 Bosch.Vms.Server.Decoder ConnectionState NotAuthorized 0 Bosch.Vms.Server.Decoder ConnectionState Connected 25 Bosch.Vms.Server.Decoder ConnectionState Disconnected 24 IntrusionPanel / Area IntrusionPanelArea AreaState Armed 304 IntrusionPanelArea AreaState Disarmed 307 IntrusionPanel / Door IntrusionPanelDoor IntrusionPanelDoorState Locked 314 IntrusionPanelDoor IntrusionPanelDoorState Unlocked 313 IntrusionPanelDoor IntrusionPanelDoorState Secured 315 IntrusionPanel / Point IntrusionPanelPoint IntrusionPanelAlarmState Normal 5 IntrusionPanelPoint IntrusionPanelAlarmState Alarm 1000 IntrusionPanelPoint IntrusionPanelAlarmState Bypassed 2818 IntrusionPanelPoint KeypadPanicAlarmState Normal 5 IntrusionPanelPoint KeypadPanicAlarmState Alarm 1191 IntrusionPanelPoint KeypadPanicAlarmState Bypassed 2818 IntrusionPanelPoint DoorLeftOpenedState Normal 5 IntrusionPanelPoint DoorLeftOpenedState Alarm 1059 IntrusionPanelPoint DoorLeftOpenedState Bypassed 2818 IntrusionPanelPoint FireAlarmState Normal 5 IntrusionPanelPoint FireAlarmState Alarm 1086 IntrusionPanelPoint FireAlarmState Bypassed 2818 IntrusionPanelPoint GasAlarmState Normal 5 IntrusionPanelPoint GasAlarmState Alarm 1106 IntrusionPanelPoint GasAlarmState Bypassed 2818 IntrusionPanelPoint MedicalAlarmState Normal 5 IntrusionPanelPoint MedicalAlarmState Alarm 1156 IntrusionPanelPoint MedicalAlarmState Bypassed 2818 Table 2.1: Bosch VMS OPC Server Event Details   Table 2.2: Bosch VMS OPC Server / Bosch VMS Proxy Error Events   1.2. OPC Server commands The following table lists the commands that you can send with OPC Server: Table 2.3: List of commands (OPC Server)   2. Installation This chapter describes the steps required to install the connection between a 3rd party system and Bosch VMS 2.1. Bosch VMS Server   Ensure that Bosch VMS Version 1.1.3 or higher is installed and that the Management Server is started on the Bosch VMS server computer.   To install: 1. Start Bosch VMS Configuration Client on the Management Server. 2. Create a user group with one or more users and no password (see Bosch VMS online help for details). 3. Export the configuration of Bosch VMS to BVMSConfig.xml via the menu BVMS Configuration Client (the application should be started under administrator Windows user) System->Export Device Information for OPC. The export destination folder must be \Bosch\VMS\bin\. Each time the Bosch VMS configuration is changed, repeat this step and restart BVMSOpcServer.exe. You perform this restart with restarting Softing OPC Toobox.   BVMSOpcServer.exe is automatically installed with Bosch VMS Server installation. The Server installation also automatically installs OPC Core Components 2.00 Redistributable 2.20.msi which is required for running the Bosch VMS OPC Server. 1. Create a Windows user with the name MgtS-Service with a password that complies with the password policy of the server concerned. Note: Ensure that this password is also configured on the BIS Server. 2. For registering the OPC Server and setting appropriate DCOM settings, run: \Bosch\VMS\bin\RegisterBvmsOpcServer.exe Note: run in in terminal started under administrator Windows user 3. Confirm the password for the MgtS-Service user configured earlier. 4. Edit Bosch.Vms.BISProxy.config for the user credentials of the administrator user (see Bosch VMS Proxy Configuration File, page 17 for details).</installation directory></installation directory>   2.2. Bosch VMS Operator Client and 3rd party client We recommend using a dual monitor system. Configure the IE security settings: 1. On the Tools menu, click Internet Options. 2. Select the Security tab. 3. Select Trusted Sites. 4. Click Custom Level. 5. Enable the options Download unsigned ActiveX controls and Initialize and script ActiveX controls not marked as safe and click OK. 6. Click Sites: 7. Deactivate the option Require server verification (https:) for all sites in this zone and add the name of the 3rd party server computer. 8. Add your custom web page to the trusted sites.   In one particular case editing the configuration file Bosch.VMS.BISProxy.config is recommended: if the client computer has multiple network adapters installed, enter the IP address of the LAN network adapter manually in the configuration file.   Enter the IP address of the client computer. Example: <?xml version="1.0" encoding="utf-8" ?>   <configuration> <appSettings> <add IsServerMode="o"> <!–<add Host="127.0.0.1"/>→ <add Login="Admin"/> <add Password=""/> </appSettings> </configuration> Start the Operator Client of Bosch VMS, select the Bosch VMS server and log on using the same account as configured with Configuration Client.     3. Bosch VMS Proxy Bosch VMS VMS Proxy has the following features: – Displaying a selected camera on a Bosch VMS monitor (Bosch VMS supports maximum 4 digital monitors) – Starting instant playback for a pre-configured time period – Starting and stopping Bosch VMS Operator Client from the 3rd party side The Bosch VMS Proxy is implemented as a COM server, i.e. the delivery is a DLL which is installed and registered as part of the Bosch VMS server and client installation. The COM server implementation allows for accessing the Bosch VMS Proxy functionality from either C++/C# code but also from scripting code like JScript. Currently both ways to access the Bosch VMS Proxy functionality are used for the 3rd party system/Bosch VMS connection: access via JScript from within the 3rd party system client (browser based client using HTML with embedded JScript code) and access via C++ code from within OPC Server. Bosch VMS Proxy forwards 3rd party system-triggered commands to Bosch VMS, see Bosch VMS Proxy commands section.   3.1. Bosch VMS Proxy commands Some commands like Show Live Image or Playback are forwarded directly to the Bosch VMS Client via Bosch VMS Proxy without OPC Server due to performance reasons. The following table lists the available commands that can be forwarded from the 3rd party client to Bosch VMS via Bosch VMS Proxy. Table 4.4: List of commands (Bosch VMS Proxy)   Use the GUIDs from BVMSConfig.xml. Show Live / Show playback image These commands display a camera image in the next free Image pane of Bosch VMS Operator Client or in the selected Image pane if all Image panes already display camera images.   Start/Stop Bosch VMS Operator Client Bosch VMS Operator Client is started/stopped after 3rd party system logon, via JScript. To achieve this, a Proxy method is called which starts/stops the Bosch VMS Operator Client. The method gets an XML string as parameter which describes the command. Additionally the command has another parameter containing the user name of the Bosch VMS user. Note: Do not configure a password for this user. The command looks like this: <nsPV:Command xmlns:nsPV=file:///S3K/Proxymanager Name=”LaunchOperatorClient”> <nsPV:Parameters> <nsPV:Parameter Name=”Login” display name=”Login” ... >[Bosch VMS user]</ nsPV:Parameter> </nsPV:Parameters> </nsPV:Command> To stop the Bosch VMS Operator Client: <nsPV:Command xmlns:nsPV=file:///S3K/Proxymanager Name=”TerminateOperatorClient” /> The user is asked to confirm exiting the application.   4. Configuration files This section describes all configuration files that are required for the connection of the 3rd party system and Bosch VMS. To initialize the OPC Server correctly, its configuration is built during the startup of the server by reading BVMSConfig.xml. and BVMSCommand.xml. To obtain BVMSConfig.xml, you export this file from within Bosch VMS Configuration Client after each configuration change. Note: Bosch VMS OPC Server discards state changes from unknown addresses and ignores commands on unknown addresses (filtering via GUID).   BVMSConfig.xml To create BVMSConfig.xml use Bosch VMS Configuration Client (see Bosch VMS Server section). This file lists all Bosch VMS devices with their name and their unique identifier. This file is used as input for the OPC server. Structure of a configuration file: Descriptions: – Camera: Data of a Camera item (name and identifier of the component). – Relay: Data of a Relay item (name and identifier of the component). – Input: Data of a Detector item (name and identifier of the component). – VirtualInput: Data of a Detector item (name and identifier of the component). – Decoder: Data of a Decoder item (name and identifier of the component). – Encoder: Data of an Encoder item (name and identifier of the component). Description of the attributes: – Name: name of the component – id: unique 128 bit key of the component (identifier realized as GUID)   BVMSCommand.xml The Bosch VMS Proxy command file is automatically installed on the Bosch VMS server machine (for example, in \Bosch\VMS\AppData\BVMSCommand.xml).   The definition of an item’s command is stored in BVMSCommand.xml. The OPC server also reads these data on startup and depending on the item type (camera, relay, etc.) these data is stored in the properties of the CMD item. Additionally all command items have an attribute id as GUID, which identifies a relay, virtual input, or camera. A possible structure of the file can look like this: Descriptions: – Camera: definition of the commands for the item type Camera – VirtualInput: definition of the commands for the item type Virtual Input – Relay: definition of the commands for the item type Relay An example for displaying a camera on a monitor can look like this: <nsPV:Commands> <nsPV:Command Name="ShowLive" OPCServerKlasse="OPCBVMSOpcServer" Anzeigename="Show Camera" Description="Display images on a monitor" ID=“id as GUID“> </nsPV:Command> </nsPV:Commands>   BVMSOpcServer.xml The OPC Server reads this file during initialization. If the file is not present, the OPC Server uses default values which are displayed in the example below.   Example of a file: <BVMSOpcServer debg="0" disconnectionTimeout="0"/> The file evaluates two values: debug and disconnectionTimeout. The following values are possible for debug: 1 or 0. If debug = 1, OPC Server logs all notifications coming from Bosch VMS in %CommonApplicationData%\Bosch\VMS\Log \BVMSOpcServer.xml On an English Windows OS, %CommonApplicationData% usually is C:\Documents and Settings\All Users\Application Data disconnectionTimeout specifies the number of seconds to wait for the next update of the Error item (Malfunction), when the connection to Bosch VMS gets lost. disconnectionTimeout is only required when the connection to Bosch VMS is lost very often for a short time (< 20 s). BVMSOpcServer_Commands.log contains commands received from BIS Server to send to the Bosch VMS Proxy. BVMSOpcServer.log contains connect/disconnect messages and processed Bosch VMS events. BVMSOpcServer_Events.log contains events received from Bosch VMS Proxy.   Bosch VMS Proxy Configuration File The Bosch VMS Proxy configuration file is automatically installed when installing either a BVMS client or a BVMS server (for example, in \Bosch\VMS\AppData \Bosch.Vms.BISProxy.dll.config). This file contains information about the Bosch VMS Proxy execution mode, an optional client host IP and the credentials to be used for logging on to the Bosch VMS SDK.</installation directory>   For server installations, the configuration file defaults are: <add IsServerMode="1"/> <add Login="Admin"/> <add Password=" "/> These settings cause that the Bosch VMS Proxy is started in server mode (which is a precondition for properly collaborating with OPC Server) and that SDK commands are executed using the given user credentials.   For client installations, the configuration file defaults are: <add IsServerMode="0"/> <!–<add Host="127.0.0.1"/>→ <add Login="Admin"/> <add Password=" "/> These settings cause that the Bosch VMS Proxy is started in client mode (which is a precondition for triggering client commands like ShowLive) and that Bosch VMS SDK commands are executed using the given user credentials. The Host setting is optional and should only be set to the IP of the LAN network card in case of multiple network cards (e.g. a WLAN or a second LAN network card) being installed in the client system     Bosch VMS Proxy Logging Configuration File The Bosch VMS Proxy logging configuration file is automatically installed on the Bosch VMS client machine (e.g. in \Bosch\VMS\AppData\BISProxyLogCfg.xml for English Windows). This file configures the Bosch VMS Proxy Log4Net logging settings.   Example for 3rd party client (HTML file) A sample HTML file with JScript code used for sending commands to Bosch VMS is available in \Bosch\VMS\Samples\BVMSProxySample.htm. For the list of commands used in this sample, see Bosch VMS Proxy commands, from above. The GUIDs are taken from an example BVMSConfig.xml.   Other OPC commands : The up to date sample commands can be found in C:\Program Files\Bosch\VMS\Samples\OPCServer, such as: Close Relay Close Virtual Input Open Relay Open Virtual Input Start Recording Stop Recording   BVMS‑BIS Connectivity Third party integrations with BVMS ... View more

Question   Where can be found the guide for Adding Mobile Video Service (MVS) to BVMS?   Answer   The attached manual provides information for Mobile Video Service (MVS) within Bosch Video Management System. You can find:  - how to configure the router and Internet Information Service (IIS) - how to add MVS to BVMS - user guide - some troubleshooting tips   This document can also be found online here. ... View more

Question   What does contain the installation package of BVMS (Deployment guide)?   Answer   This article contains documents attached which describes the installation package for BVMS. Operating system support of the specific BVMS version is listed in the BVMS release notes. The BVMS installation package is distributed by ZIP file from our product download web page and comes with all components that are required to deploy the BVMS on the target system. The installation package is based on InstallShield technology. Windows Installer V.4.5 or later is required. The setup requires administrative rights. ... View more