MLIPCamera Plugin

From Cinemar Wiki
Jump to: navigation, search

About

Welcome to the MLServer MLIPCamera PlugIn

This plugin enables a user to build scenes that incorporate IP based network cameras quickly and easily. Panasonic users should see the important note at the end of this document.

Software Requirements

  • MLServer 3
  • MLIPCamera Supported Driver
  • MLIPCamera Family Plugin


Getting Started

Before installing anything, we recommend consulting your Network Camera user manual. Verify your camera is working properly before moving forward and that you have actually viewed the camera’s image either via a web browser or software included with your camera. Visit the manufacturer website to download the latest Firmware for your camera. Some features may not work if you are using an older firmware.

Installation

Shut down MLServer if it is currently running.

Download and install the MLIPCamera Family Plugin available from the Cinemar website.

Download and install your IP camera driver. Follow the onscreen prompts. We recommend installing to the default locations.

Adding Network Cameras to the MLIPCamera PlugIn

1. Start MLServer if it is not currently running.

2. Select the MLIPCamera plugin from the PlugIns window then press Settings. An MLIPCamera window will pop up.

3. From this window, select Add Cam. Another window will pop open.

4. Select the appropriate Camera Model from the drop down list. (For Generic Camera see Generic IP Camera Setup)

5. Then type in a Camera Alias name (such as the location of the camera, i.e.: front door) – any name will do; however, each camera should have a unique name.

6. Enter the IP Address of the camera that you have configured via your camera’s web server software then press Add.

The IP Address should be formatted properly:

xxx.xxx.xxx.xxx:port

example: 192.168.1.101

example: 192.168.1.101:84

If your camera is configured for port 80, the additional colon and port number are not required.

The camera will now appear in the window listing. Step and repeat if you have more cameras on your network.


Generic IP Camera Setup

To add a Generic IP Camera follow the steps for adding a camera.

Once you have selected the Generic IP Camera as the model you will then be allowed to enter the commands that your particular camera uses to perform the operations.

You will first need to select the type of camera that you are adding, either Stationary or PTZ (Pan, Tilt, Zoom). If your camera is a stationary camera then you just need to enter the URL to the image on your camera. If your camera is a PTZ camera then you have the option of entering the commands specific to your camera to perform a given action.

Example:

Image = http://<<IPADDRESS>>/liveimage.jpg

NOTE: Verify that the address you put in goes directly to the file and is not a html redirect. Example: http://camera.redirectme.net/cgi-bin/viewer/video.jpg will not display a picture in Mainlobby. But http://camera.redirectme.net/pic/video.jpg will display a picture in Mainlobby. If I view the properties of the first video.jpg picture, it will reference the second url location. Also the ipaddress for this is: picture.redirectme.net  :-)

Controls

TiltUp = http://<<IPADDRESS>>/?action=tiltup

PanLeft = http://<<IPADDRESS>>/?action=panleft


Presets

Register= http://<<IPADDRESS>>/?action=register&number=<<PRESET>>

Move = http://<<IPADDRESS>>/?action=move&number=<<PRESET>>

Note

You may enter <<IPADDRESS>> in place of the cameras IP address, it will then be filled for you when the command is called. You may also enter <<PRESET>> in place of a number so that you are not limited to setting just the one preset.


Removing a Camera

To remove a camera from the MLIPCamera PlugIn, simply select the Camera from the list and select Remove Cam.


Camera Settings

Some camera models settings can be configured by selecting the camera and then pressing Cam Settings. These options may vary from model to model.

Archive Settings

After some time, your snapshots may start to increase in number. Having large numbers of snapshots in your folder can increase the time it takes to review snapshot images. Our archive option allows you to configure based on the number of days or images when you prefer to push your images to an Archive folder. The images will not be erased, but stored for later review on your hard drive. C:\Program Files\MLServer\Images\MLIPCamera\Archive\


To locate and configure your Archive Settings, select SnapShots from the MLIPCamera plugin and then Archive followed by Settings. Users also can select Archive > Now for immediate archive of their snapshots.


Designing Scenes in MainLobby

If you’ve configured your MLIPCamera plugin, you should be all set to start viewing your cameras from some of the predesigned scenes included with your PlugIn.

Open MainLobby then move your mouse to the top of the screen to reveal the MainLobby menu bar.

Select Open, and browse to your Cinemar folder.

Select the scene name

0019_security.camera1.mls.

There are up and down arrows located around the image area for cameras that support pan and tilt.


MLIPCamera|Control

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|Control~Aias/IP/Cam#~Direction~RepeatCommand

(Literal)

MLServeCmd.MLIPCamera|Control~1~panLeft~6

MLServeCmd.MLIPCamera|Control~192.168.1.192~tiltUp

MLServeCmd.MLIPCamera|Control~Front Door~tiltDown~3

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

Direction = panLeft, panRight, tiltUp, tiltDown, Center, ZoomIn, ZoomOut, AutoPan*, AutoPatrol*

RepeatCommand = (1..x)

Returns

Nothing

Description

Moves camera based on alias, ip address or ID# in the specified direction.

Notes

The Zoom commands are only supported by the Toshiba IKWB15A.

The AutoPan and AutoPatrol commands are only supported for Toshiba models.



MLIPCamera|Preset

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|Preset~Aias/IP/Cam#~type~presetID

(Literal)

MLServeCmd.MLIPCamera|Preset~1~Move~4

MLServeCmd.MLIPCamera|Preset~192.168.1.192~Register~1

MLServeCmd.MLIPCamera|Preset~Front Door~Delete~3

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

Type = (Move, Register, Delete)

PresetID = (1..10)

Returns

Nothing Description

Move to, delete or Register/Create presets for your network camera.

Notes

This command is not supported for Axis cameras.

Panasonic models are unable to Register Presets. Presets may be registered using the camera’s web server.

MLIPCamera|Active

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|Active~Aias/IP/Cam#

(Literal)

MLServeCmd.MLIPCamera|Active~1

MLServeCmd.MLIPCamera|Active~192.168.1.192

MLServeCmd.MLIPCamera|Active~Front Door

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

Returns

mlipcamera_active_alias

mlipcamera_active_image

mlipcamera_active_ipaddress

mlipcamera_active_id

Description

When designing scenes with only one visible IP Camera at a time, it’s a good idea to use the

MLIPCamera|Active command to tell the plugin which camera is currently the active source.

After setting the active camera, all the Return variables will be updated with that camera’s information.

Notes

MLIPCamera|SnapShot

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|SnapShot~Aias/IP/Cam# or first, last, next ,previous, delete~ #/All

(Literal)

MLServeCmd.MLIPCamera|SnapShot~1

MLServeCmd.MLIPCamera|SnapShot~Next

MLServeCmd.MLIPCamera|SnapShot~Previous

MLServeCmd.MLIPCamera|SnapShot~First

MLServeCmd.MLIPCamera|SnapShot~Last

MLServeCmd.MLIPCamera|SnapShot~Delete

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

First = Sets variables to point to the first snap shot

Last = Sets variables to point to last snap shot

Next = Sets variables to point to next snap shot

Previous = Sets variables to point to previous snapshot

Delete = Deletes the snapshot with the id present in the last parameter.

  1. /All = Optional. The id number of the snapshot to delete or the word all to delete all snapshots

Returns

mlipcamera_active_snapshot_id

mlipcamera_active_snapshot_image

mlipcamera_active_snapshot_timestamp

mlipcamera_active_snapshot_imagecount

Description

This command handles all snapshot commands to traverse the list of snapshots and delete shapshots.

Notes

The last parameter is optional except for when deleting snapshot(s).

MLIPCamera|UpdateImage

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|UpdateImage~Aias/IP/Cam#~Update Image Rate

(Literal)

MLServeCmd.MLIPCamera|UpdateImage~001 (Defaults to 1 Image Every Second)

MLServeCmd.MLIPCamera|UpdateImage~192.168.1.192~2 (Updates Image Every 2 Seconds)

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

Update Image Rate = Optional. Updates the streaming image stored on your hard drive every x seconds. Defaults to 1.

Returns

Description

Polls the Toshiba IKWB15A camera and stores that image on the MLServer hard drive. This image is then provided to clients via the web server for display in MainLobby.

Notes

This command is only applicable to the Toshiba IKWB15A.

By default, the Toshiba IKWB15A will be set to update the streaming image every second.

MLIPCamera|StopUpdateImage

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|StopUpdateImage~Aias/IP/Cam#

(Literal)

MLServeCmd.MLIPCamera|StopUpdateImage~001

MLServeCmd.MLIPCamera|StopUpdateImage~192.168.1.192

Parameters

Alias/IP/cam# = Information configured in MLIPCamera Plugin

Returns


Description

Stops the specified camera from storing the image on the MLServer hard drive. This will also prevent MainLobby clients from being able to see a live updated image.

Notes

This command is only applicable to the Toshiba IKWB15A.

By default, the Toshiba IKWB15A

will be set to update the streaming image every second.

MLIPCamera|ArchiveNow

{MLServeCmd}Script Usage

MLServeCmd.MLIPCamera|ArchiveNow

(Literal)

MLServeCmd.MLIPCamera|ArchiveNow

Parameters

None

Returns

Description

Archives images based on your archive settings within the MLIPCamera plugin. All images are moved to an Archive folder: C:\Program Files\MLServer\Images\MLIPCamera\Archive

MLServer Variables

The MLIPCamera plugin

will auto generate variables in MLServer based on the settings you

have entered. It will also update variables in certain circumstances such as changing the active

camera.

mlipcamera_alias_id

mlipcamera_image_id

mlipcamera_ipaddress_id

mlipcamera_model_id

where:

id is the 3 digit number for that camera as shown in the family plugin database

mlipcamera_active_alias

mlipcamera_active_image

mlipcamera_active_ipaddress

mlipcamera_active_id

mlipcamera_active_model

mlipcamera_active_snapshot_id

mlipcamera_active_snapshot_image

mlipcamera_active_snapshot_timestamp

mlipcamera_active_snapshot_imagecount


Supported Models

  • Toshiba IKWB01A
  • Toshiba IKWB11A
  • Toshiba IKWB15A
  • Panasonic BLC10 (1.20 or later)
  • Panasonic BLC30 (1.20 or later)
  • Panasonic BBHCM311 (1.03 or later)
  • Panasonic BBHCM331 (1.03 or later)
  • Panasonic BBHCM371 (1.03 or later)
  • Panasonic BBHCM381 (1.03 or later)
  • Panasonic HCM280 (1.80 or later)
  • Panasonic HCM270 (1.80 or later)
  • Panasonic HCM250 (1.80 or later)
  • Panasonic HCM230 (1.80 or later)
  • Panasonic HCM10 (1.80 or later)
  • Panasonic HCM8 (1.80 or later)
  • Generic IP Camera
  • Axis 230
  • Axis 250S
  • Axis 206
  • Axis 206M
  • Axis 207
  • Axis 207W
  • Axis 210
  • Axis 210A
  • Axis 211
  • Axis 211A
  • Axis 213
  • Axis 221
  • Axis 231D
  • Axis 232D
  • Axis 240Q
  • Axis 241S
  • Axis 241SA
  • Axis 241Q
  • Axis 241QA
  • Axis 262
  • Axis 292


Panasonic Requirements

o From Internet Explorer

  • Tools > Internet Options
  • From Temporary Internet Files select Settings
  • Change Check for newer versions of stored pages to “every visit to the page”.

o From your Camera’s Web Server

  • Select Setup
  • Under General Authentication – select Permit Access from Guest Users (Menu’s may vary from one camera to the next)
  • Then Press Save

o From your Camera’s Web Server

  • Select Setup
  • Select Static from the Connection Mode Menu
  • Check the Enable Box under Network Configuration from Setup Program
  • Under Internet Connection, make sure you have the Port No. set to 80
  • Note the IP Address you have assigned and use this same IP Address within the MLIPCamera Camera Info Tab
  • Press Save.

Setting the Panasonic’s Image Quality to Favor Motion and the Refresh Interval through their web server seemed to provide the best results within MainLobby.

NOTE:

There is currently no support for user accounts for any camera so if your camera supports multiple users make sure that any type of user restrictions are turned off otherwise you may not be able to control or view your camera.

Bugs

New Feature Requests