Prerequisites
There are no prerequisites for this module.
Installation
There are two approaches for installing the desired module components in the OSGi environment: automated and manual installation.
Automated Installation
The installation of the Cameras module can be performed through execution of a Kit Manager installation script. In the bin/pscripts folder of the Cameras module there are three scripts:
To install the Cameras module using one of the scripts above execute the console command from the kitman command group kitman.install "<script name>", where <script name> is the name of the script to be installed.
The kitman command group is exported by the Kit Manager Bundle.
You may also write your own install scripts for easier installation (and start) of a certain set of bundles. The required bundles for the Cameras module are listed in the Manual Installation section.
Manual Installation
If you want to install the Cameras module without using one of the provided Kit Manager installation scripts follow the steps below:
To install and start the Cameras module's core functionalities:
set mbs.bundles.base=../../../bundles/
kitman.i "Web Console"
kitman.i "Peripheral Web Admin"
fw.i -s -l -f fw.jaxp13.jar
fw.i -s -l -f fw.osgiutil.jar
fw.i -s com.prosyst.mbs.cameras.driver.api.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.recorder.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.core.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.rtsp.jar
fw.i -f com.prosyst.mbs.cameras.driver.transcoder.vlc.jar
fw.i -s -f com.prosyst.mbs.cameras.driver.transcoder.ffmpeg.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.commands.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.inventory.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.axis.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.mobotix.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.panasonic.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.generic.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.ipcam.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.onvif.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.sercom.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.zyxel.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.udp.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.udp.ipx.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.compro.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.dlink.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.dlink.cas3xx.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.edimax.jar
fw.i -s -l -f com.prosyst.mbs.cameras.driver.motionguide.jar
To take advantage of the Cameras module along with additional bundles providing integration with the Device Access module:
set mbs.bundles.base=../../../bundles/
kitman.i "Device Access"
kitman.i "Cameras"
fw.i -f com.prosyst.mbs.cameras.da.hdm.api.jar
fw.i -f com.prosyst.mbs.cameras.da.items.api.jar
fw.i -s -l -f com.prosyst.mbs.cameras.da.hdm.adapter.jar
fw.i -s -l -f com.prosyst.mbs.cameras.da.items.provider.jar
To use the Cameras module along with additional bundles providing integration with the HDM mode of the Device Access:
set mbs.bundles.base=../../../bundles/
kitman.i "Device Access HDM"
kitman.i "Cameras"
fw.i -f com.prosyst.mbs.cameras.da.hdm.api.jar
fw.i -s -l -f com.prosyst.mbs.cameras.da.hdm.adapter.jar
System Properties
Property |
Type |
Default Value |
Description |
|---|---|---|---|
com.prosyst.mbs.cameras.mobotix.logLevel |
integer |
3 |
Determines the least severe level of log messages created by the Camera Mobotix Driver Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.mobotix.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Camera Mobotix Driver Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.mobotix.logLevel system property. |
mbs.cameras.motion.target_dir |
String |
/tmp/motion |
Determines the target base directory where the motion application stores camera records read by the Camera MotionGuide Driver Bundle. Also, holds the pipe file responsible for the bundle and the motion application's communication. |
mbs.cameras.motion.pipe |
String |
events_pipe |
Sets the pipe file's name, which is relative to the mbs.cameras.motion.target_dir's value. |
mbs.cameras.motion.video.convertTo3gp |
boolean |
true |
Tells the Camera MotionGuide Driver Bundle to convert the video files created by the motion application into 3gp format. |
com.prosyst.mbs.cameras.motionguide.logLevel |
integer |
3 |
Determines the least severe level of log messages created by the Camera MotionGuide Driver Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.motionguide.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Camera MotionGuide Driver Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.motionguide.logLevel system property. |
com.prosyst.mbs.cameras.panasonic.logLevel |
integer |
3 |
Determines the least severe level of log messages created by Camera Panasonic Driver Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.panasonic.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Camera Panasonic Driver Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.panasonic.logLevel system property. |
com.prosyst.mbs.cameras.udp.logLevel |
integer |
3 |
Determines the least severe level of log messages created by the Camera UDP Driver Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.udp.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Camera UDP Driver Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.udp.logLevel system property. |
com.prosyst.mbs.services.cameras.hdmadapter.logLevel |
integer |
3 |
Determines the least severe level of log messages created by Cameras HDM Adapter Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.services.cameras.hdmadapter.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Cameras HDM Adapter Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.services.cameras.hdmadapter.logLevel system property. |
com.prosyst.mbs.cameras.manager.logLevel |
integer |
3 |
Determines the least severe level of log messages created by the Cameras Manager Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.manager.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Cameras Manager Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.manager.logLevel system property. |
com.prosyst.mbs.cameras.rtsp.logLevel |
integer |
3 |
Determines the least severe level of log messages created by the Cameras RTSP Proxy Bundle. The property can be set to one of the following values:
|
com.prosyst.mbs.cameras.rtsp.logPrintLevel |
integer |
0 |
Determines the least severe level of the log messages from the Cameras RTSP Proxy Bundle to be printed in the runtime console. The property can be set to one of the values, similar to those of the com.prosyst.mbs.cameras.rtsp.logLevel system property. |
For information on how to set them refer to Changing Settings
Configuration Properties
Name |
PID/FPID |
Property |
Type |
Default Value |
Description |
|---|---|---|---|---|---|
Bundle Storage Usage |
com.prosyst.mbs.services.cameras.storage.local |
internal.storage |
boolean |
true |
If "true", the records are stored in the bundle's internal storage location: osgi\bin\vms\<vm>\storage\data\<Cameras_Recorder_Bundle_ID> |
Default Record Location |
com.prosyst.mbs.services.cameras.storage.local |
default.location |
String |
- |
The name of the directory to be created in osgi\bin\vms\<vm> to store the records. Used when internal.storage is set to false. |
IP Address |
com.prosyst.mbs.services.cameras.config |
ip |
String |
- |
IP address of the Camera. |
Controller ID |
com.prosyst.mbs.services.cameras.config |
controller.id |
String |
- |
Controller ID of the peripheral. |
Driver |
com.prosyst.mbs.services.cameras.config |
driver |
String |
- |
The driver to be used. |
User Name |
com.prosyst.mbs.services.cameras.config |
user |
String |
- |
User name of the camera. |
Password |
com.prosyst.mbs.services.cameras.config |
password |
String |
- |
Password of the camera. |
Type |
com.prosyst.mbs.services.cameras.config |
type |
String |
- |
Type of the camera - IP or USB. |
Model |
com.prosyst.mbs.services.cameras.config |
model |
String |
- |
The model of the camera. |
HTTP Proxy Host |
mbs.cameras.proxy.pid |
proxy.host |
String |
- |
The IP address of the proxy host. If such is not set, an appropriate one is searched among the available IP addresses of the local machine's network interfaces. |
HTTP Proxy Host Ignore Prefix |
mbs.cameras.proxy.pid |
proxyHostIgnorePrefix |
String |
192.168 |
The prefix for an IP address. It must be ignored while searching for proxy host IP among the available IP addresses of the local machine's network interfaces. |
HTTP Proxy Host Ignore IPv6 |
mbs.cameras.proxy.pid |
proxyHostIgnoreIPv6 |
boolean |
true |
The IPv6 network address. It should be ignored while searching for proxy host IP among the available IP addresses of the local machine's network interfaces. |
HTTP Proxy Alias |
mbs.cameras.proxy.pid |
proxy.alias |
String |
camerasManager |
The proxy alias that will be used to generate the proxy URLs. |
HTTP Proxy Protocol |
mbs.cameras.proxy.pid |
proxy.protocol |
String |
HTTP |
The protocol used to generate the proxy URLs. If not set to "HTTP" nor "HTTPS", then the values of the HTTP Service's properties openPort and openSecurePort are used. |
HTTP Proxy Port |
mbs.cameras.proxy.pid |
proxy.port |
integer |
- |
The port used to generate the proxy URLs. If not set, the values of service registration properties openPort and secureOpenPort of the HTTP Service are used. |
HTTP Proxy Video Buffer |
mbs.cameras.proxy.pid |
proxyVideoBuffer |
integer |
4 |
The video buffer size (in kB). |
Ping interval |
mbs.cameras.manager.pid |
ping.interval |
integer |
60 |
Defines the minimum interval for checking whether the camera is connected (in seconds). |
RTSP Proxy Port |
mbs.rtsp.pid |
port |
integer |
554 |
The primary port allocated for accepted requests. It must be a number between 1 and 65535. |
Secondary RTSP Proxy Port |
mbs.rtsp.pid |
secondaryport |
integer |
8554 |
Optional. When the primary port is not available (used by an application, or because of OS restrictions), the secondary one is used to carry the incoming and outgoing traffic. This property is available only for plain connection type. It must be a number between 1 and 65535. |
Min Proxy UDP Port |
mbs.rtsp.pid |
min.udp.port |
integer |
12000 |
Minimum proxy UDP port. Value must by an even number and lower than the value of max.udp.port |
Max Proxy UDP Port |
mbs.rtsp.pid |
max.udp.port |
integer |
12200 |
Maximum proxy UDP port. Value must by an even number and higher than the value of min.udp.port |
FFMPEG Executable Path |
mbs.cameras.transcoder.ffmpeg |
path |
String |
ffmpeg |
Defines the path to the FFMPEG executable. If you do not have it installed, the transcoder will not function correctly. You can download a binary for your operating system from here. |
FFMPEG Demuxltiplexer |
mbs.cameras.transcoder.ffmpeg |
demux_enabled |
boolean |
false |
If set to true, then the FFMPEG demuxltiplexer is enabled. |
FFMPEG Demuxltiplexer Buffer |
mbs.cameras.transcoder.ffmpeg |
demux_buffer |
integer |
8 |
The size of the FFMPEG demuxltiplexer buffer (in kB). |
FFMPEG Demuxltiplexer Pipe Buffer |
mbs.cameras.transcoder.ffmpeg |
demux_pipe_buffer |
integer |
8 |
The size of the FFMPEG demuxltiplexer pipe buffer (in kB). |
VLC Executable Path |
mbs.cameras.transcoder.vlc |
path |
String |
vlc |
Defines the path to the VLC executable. If you do not have it installed, the transcoder will not function correctly. You can download a binary for your operating system from here. |
VLC Demuxltiplexer |
mbs.cameras.transcoder.vlc |
demux_enabled |
boolean |
false |
If set to true, then the VLC demuxltiplexer is enabled. |
VLC Demuxltiplexer Buffer |
mbs.cameras.transcoder.vlc |
demux_buffer |
integer |
8 |
The size of the VLC demuxltiplexer buffer (in kB). |
VLC Demuxltiplexer Pipe Buffer |
mbs.cameras.transcoder.vlc |
demux_pipe_buffer |
integer |
8 |
The size of the VLC demuxltiplexer pipe buffer (in kB). |
For more information on how to change System Properties or Configuration Properties, please consult "System Properties & Configurations".
Troubleshooting
No troubleshooting information is available for this module.