FelenaSoft Home | Contacts | Site Map
FelenaSoft Company

Modules settings

Modules settings

Sources settings

Click on camera icon to configure it

Universal camera

This module allows you to select as source of the image - a camera (IP, USB, including wireless cameras) or world Internet camera ('Random IP Camera'). Name of the camera can be specified in Preview module settings (or Preview and Archive module).

For USB-cameras: choose your camera from the list. Select the required combination of image refresh rate (fps) and image resolution (set by the camera's drivers). Below are the regular settings for image settings like brightness, contrast, sharpness, etc. that you can change with the slider. 'Back to defaults' will set the settings back to the camera's initail settings.

For Internet cameras: you can specify the image refresh rate in the advanced settings menu.

For IP cameras:
  1. select your camera from the list of available (auto detected) cameras;
  2. if your camera is not on the list, choose the camera's manufacturer and specify its IP, if needed along with access data (username and password);
  3. if your camera still doesn't display image, check if it's connected, then choose 'Manual Setup' and fill in the 'Full URL' field, and if needed access data (username and password) fields;
  4. you can also specify a URL for direct storing to the archive without re-encoding (for RTSP cameras);
  5. you can expand/minimize advanced settings by clicking on the text button below.

Advanced settings for IP cameras:

  • Sound settings

  1. Sound URL field
  2. Sound quality (sampling frequency) settings

  • Settings for PTZ cameras:

  1. HTTP port to control PTZ functions of the camera (if the port differs from a standard port)
  2. Turning on/off horizontal or vertical inversion of PTZ
  3. Available PTZ options - if the automatically detected PTZ API doesn't work for you, try selecting other PTZ presets from this combobox.

For analogue cameras:

Xeoma supports video capture cards that use DirectShow/WDM drivers and have 1 chip per channel. Such capture cards are seen in Windows as a number of separate devices (Device #1, Device #2, etc.) Xeoma will detect them as a number of USB webcams. Xeoma works with default settings, so if something is not working the way you wanted, you need to change the defaults on your card/analogue camera.

Xeoma also works with DVRs that have direct URLs for JPEG, MJPEG, H.264 or MPEG-4 streams for each channel and stream video over http or rtsp protocols. Xeoma "sees" such DVRs as a number of separate IP cameras. Sometimes these cameras are found automatically with simple search or search by IP/password (both launched in '+' menu in the panel below). Sometimes, however, in order to connect DVR to Xeoma, you need to know the exact URLs for video streams of this DVR (http/rtsp for MJPEG/H264). It can be found in the device documentation, or its web admin interface, or you can contact the manufacturer of this DVR and ask them directly.

Click on Microphone icon to enter its settings and choose your device from the list

Microphone

This module allows you to select the sound source - microphone. Select the microphone from the list of available audio devices. Whether you need this module in your chain, or not, depends on the type of camera - usually USB cameras require the Microphone module to work with sound, while IP cameras usually have the sound stream embedded and don't need a Microphone module. Note: microphone is not a video source and doesn't require additional licenses.

Xeoma file reading module

File reading

This module allows you to select JPEG or MJPEG files as image source. Name of the camera can be specified in Preview module settings (or Preview and Archive module). Specify the full path to JPEG or MJPEG file you want to use as a source.

Xeoma screen capture module

Screen capture

This module allows you to record your screen(s) (only on Windows). As usual, you can give name to this source's preview box in Preview module settings (or Preview and Archive module). In this module's settings you can specify the frequency of shots and size relative to the original image size.

Used with motion detector, it can help you start recording as soon as there's activity on the computer.

Another Xeoma module, usually used in pair with the Web server module

Another Xeoma

The module allows you to receive audio / video stream that is transmitted by other copies of Xeoma over the network. To do this, specify the URL of the audio / video stream and access parameters, in 'Another Xeoma' settings. Name of the camera can be specified in Preview module settings (or Preview and Archive module). You can set image resolution and frame rate in the advanced settings.

More about Another Xeoma and Web Server connection

FTP receiver module helps you get image from camera in most challenging environment, even if has no IP address

FTP receiver

The module allows you to use an FTP server as a source or, simply put, stream your camera image to Xeoma via FTP. It's convenient when you don't want or cannot perform port-forwarding on your router at the place where camera is located, or when there's no IP address that can be assigned to the camera (like when the camera is connected via the mobile Internet) thus no program can find it. Configure your camera so that it passes the image (JPEG) on to the FTP server via the IP address of your computer using the specified port, user name and password. You can assign this module a preview name in Preview module settings (or Preview and Archive module).

Detailed photo instruction on how to set this module up can be found here.

Destination settings

Alarm sound module will play a sound on the server

Alarm sound

This module allows the server to play the specified sound at image received. If you want the signal to be triggered when motion is detected, plug it after a motion detector. You can select a wav sound file from the list or specify the path to the file manually, specify the file playback interval (sound will be played with each incoming frame, but not more than the specified interval) and duration of play. Click 'Test' for verification of the settings.

With this module, you can automatically launch a third-party application or script

Application runner

This module allows you to run the specified application. If you want the application runner to be triggered by detected motion, connect it after motion detector module. Specify the path to the program to run with the use of macros and interval (program will be run with each incoming frame, but not more than the specified interval). Click 'Test' for verification of the settings.

Upon receiving the signal, this module will automatically maximize Xeoma Client window if it was minimized (only on the Client side)

Pop-up window (in Client)

This module allows you to automatically restore Xeoma from the minimized state at received incoming frames.

With this module, you can send automated SMS (text messages) with help of a GSM modem or service providers

Sms Sending

This module allows to set up the automated sending of text messages (SMS) to a cell phone. You can set the interval between messages sending, and use macros to specify which camera and at what time detected motion. Select one of the options to send messages: with use of clickatell.com or bulksms.com sites, or using a GSM modem.

If you choose clickatell.com, you will need to specify your login, password and API ID (or just API ID) received after registration on the site. In modem option, you only need to connect the modem. After that, enter phone number(s) to send messages to, message text and select sending frequency.

API ID (Api key) - This key is available on the site that you use.
In clickatell.com you need to go to the tab 'Manage my product', click 'My Connections' and select 'XML' in the drop down box 'Add connection', then click 'Submit and Get API ID' - your API ID will appear in the window.


In bulksms.com you will need only login and password you got during the registration. You can also get 5 free text messages for testing with this service.

Sender's number or name: you can use any name, but you must be registered on the site, with which you are sending text messages. If you get an error after the test that warns you about the wrong sender, the name you specified is incorrect, or not consistent with the administration of the site. If you leave the sender field empty, number that you specified during registration will be used.

Recipients' numbers: SMS can be sent to multiple numbers at the same time, just separate numbers by ';' ',' or space.

For more information, go to the site you are registered with.

After the module is set up, click 'Test' to test its work.

With this module, you can send automated Emails with attached pictures or videos

Sending Email

This module allows you to set up automated e-mailing at event detection. You can set the interval between emails, and attach incoming video and images (specify maximum count of attached images, time between pictures captures, videos' fps and duration, and maximum size of messages). Pictures that can be attached - up to is how many pictures you can have attached to each email message according to Max message size set up with the slider below.

For example, you don't want each message to be bigger than 2 Mb. It means that each message can have up to 26 pictures (this number can vary depending on camera's resolution & picture size - which in most cases can be configured in web admin of your camera).

Select your mail server from the list or specify your own. If your mail server is not listed, you can specify the settings manually. Enter SMTP-server address and port as well as the method for encrypting data. Enter username and password of your email. In 'Recipient' line specify recipient's email (or emails separating them with space, comma or semicolon). You can send email to multiple addresses. Enter subject and message text (optional). Click 'Test' for verification of the settings.

Please note that if you connect email sending module after motion detector, it will certainly affect the result. For example, if you have a 1 minute interval between messages and set up the email sending module to attach 2 pictures to each message. This means that every 30 seconds the program will check motion detector if there is motion at THAT moment. If there is, the picture gets stored in temporary memory waiting for being sent. If not - it doesn't. In the next 30 seconds the program checks again, to get another picture if there is motion this time. And at that instant it sends an email with all pictures that it stored during that time interval (during 1 minute in our example). If there are no pictures, no message is sent.

If you want to be able to view the attached videos on your mobile device, MP4 format of videos should probably be your choice for it is supported by most mobile devices.

This module allows you to save incoming frames in specified file using Xeoma video surveillance software

Save to file

This module allows you to save incoming frames in specified file. You can specify the path to store videos and images, name to be assigned to stored files and use macros therefor. For example, you want JPEG images to be saved on the C drive in the Public folder and subfolder Pictures with a core name img and added current date and time. Specify the full path to the file C:\Users\Public\Pictures\img_% ym-d_h-is%. jpg. You can specify the interval between frames saving.

This module allows you to upload an image or video file to a specified FTP-server using Xeoma video surveillance software

FTP upload

This module allows you to upload an image or video file to a specified FTP (SFTP)-server. Specify server address, port, username and password and check the box for secure connection. Specify the path to the saved file using the offered macros. You can specify the interval and type of stored data. Click 'Test' for verification of the settings.

This module allows to generate and send HTTP requests using Xeoma video surveillance software

HTTP request sender

This module allows to generate and send HTTP requests. If you want to send motion-triggered requests, connect the module after the motion detector module. Check the box 'Show all parameters' to set request parameters. Use the {ID} macro while setting up parameters for module's unique identificator. The resulting URL will be shown in 'Resulting URL' field.

Multi-functional module, that can be used in Xeoma video surveillance software to reach different goals

Web server

More about web server here

This module allows you to store the incoming image to the archive for a later view and displays the image on the screen in Xeoma video surveillance software.

Archive

More about archive here

Filters

Using this module in Xeoma video surveillance software you can filter frames in low (insufficient) light

Day Detector

This module automatically filters frames in low (insufficient) light. To disable the module, uncheck box in upper right corner. In this case all following modules will not receive image. If you want to disable the filter without disabling the whole chain, check 'Hidden' - the icon will have different color of the filter circuit then. To enable the module back, check the box.

Using this module in Xeoma video surveillance software you can set motion detection in a given area

Motion detector

More about motion detector here

Using this module in Xeoma video surveillance software you can set the days and time when connected to scheduler modules will work

Scheduler

This module allows you to set the days and time when connected to scheduler modules will work. You can specify days and time of work, for example from 5 pm to 11:59 pm on weekdays (that is till 11:59:59 because the minute gets recorded to the end). You can also specify time for work days and set round-the-clock work on weekends. To disable the module, uncheck box in upper right corner. In this case all following modules will not receive image. If you want to disable the filter without disabling the whole chain, check 'Hidden' - the icon will have different color of the filter circuit then. To enable the module back, check the box.

Using this filter in Xeoma video surveillance software you will be notified whenever emergency situations arise

Problems Detector

This filter module notifies you whenever emergency situations arise: no image from camera, no sound, camera was turned, image is too dark, image is too bright, no free disk space left, RAM is running out or server is restarted.

This module helps combine output from two video sources into one in Xeoma video surveillance software

Unitor

The Unitor module helps combine output from two video sources into one. Connect two cameras or other video sources to the Unitor and you will have a merged image as the result. Additionally, you can use 1 audio source.

You can select cameras' position in relation to each other (horizontal or vertical combination), as well as change their order.

Please note that Unitor will give you only 1 audio stream in the result.

For more information on this module, please read the Unitor article.

This module allows to reduce the size of incoming image using Xeoma video surveillance software

Image Resize

The Image Resize module allows to reduce the size of the incoming image.

Adjust the size of the result image in % of original's size in the settings of the module.

This module allows to rotate and flip camera image in Xeoma video surveillance software

Image Rotate

The Image Rotate module allows to rotate and flip camera image.

Use slider to set the rotation angle. Untick the "90-degree pitch (rounded down)" option to use arbitrary rotation angle. Otherwise, when ticked, it will round down the value to 0, 90 or 180.

Switch streams with this module using Xeoma video surveillance software

Relay switch

This module is a streams switcher. When it receives a signal from a managing module, it closes the circuit and lets through the stream from the managed (secondary) chain.

For example, connect two Universal cameras to the Relay Switch module. Put a Motion Detector after the first Universal camera but before the Relay Switch. This way, when motion is detected, the second camera will be turned on and start passing its video stream to the modules you connect after the Relay.

Depending on the selected mode of operation, the Relay Switch offers various types of behavior after the motion from the first camera is over.
"On as long as there's signal" - the secondary chain will be turned on and working as long as the managing module keeps sending the signal, and turned off when it stops.
"On with the 1st signal, off with the 2nd" - the secondary chain will be turned on when the first signal comes, and turned off when the next signal comes.
"On just once, during the time selected below:" - the secondary chain will be turned on just one time when the signal comes, and turn off automatically after the time you specify below with the slider.

You can embed waterstamp of time and date, GPS coordinates or custom text into image from the camera using Marking module in Xeoma video surveillance software

Marking

This module helps embed waterstamp of time and date, GPS coordinates or custom text into image from the camera or other video source. You can choose marking position, date/time format and set up desired font size.

Using this module in Xeoma video surveillance software you can switch on/off all following modules (the whole chain connected after the HTTP marking) and save meta information upon receiving an http-request

HTTP marking

This module is a combination of "HTTP switcher" and "Marking" modules. This module allows to switch on/off all following modules (the whole chain connected after the HTTP marking) and save meta information upon receiving an http-request. It works like a circuit breaker/closer and can receive commands to either break the circuit (with the URL for switching off) or close it (with the URL for switching on). It saves meta information about the command and the identifier (ID). With this ID, you can find an entry in the archive and view it. Upon receiving a command to continue, the module keeps the circuit closed. If a command to continue or switch off has not been received in a long time, the circuit will be broken automatically.

For example, you can connect HTTP marking in a chain before the Archive module, and send the switching off URL with the identifier (example: "id=123"). To continue recording, send the command to continue. To resume recording, send the switching on URL request.

Requests can be sent through home automation systems or simply via a web browser.

This module allows to switch on/off all following modules (the whole chain connected after the HTTP switcher) upon receiving an http-request in Xeoma video surveillance software

HTTP switcher

This module allows to switch on/off all following modules (the whole chain connected after the HTTP switcher) upon receiving an http-request. It works like a circuit breaker/closer and can receive commands to either break the circuit (with the URL for switching off) or close it (with the URL for switching on).

URL-path for switching off: send this http request to make HTTP switcher block video stream for the set period of time (or permanently, until the switching on URL is sent).
URL-path for switching on: send this URL to make HTTP switcher stop blocking the video stream (close the circuit). If there is a timeout specified, when it's finished, the module will resume blocking the video stream.

For example, you can connect this module in a chain before the Archive module, and send the switching off URL when you need to stop recording. To resume recording, send the switching on URL request. Requests can be sent through home automation systems or simply via a web browser.

Use {ID} macro to get a unique name for this module. If macro is not used and the path is the same for all HTTP senders, upon receiving a request all modules of this kind will be switched on/off.

Use "timeout_seconds" parameter to set or change time of work (for example: http://10.1.10.10:10090/http_sender_on?module=HttpSwitcher.7&timeout_seconds=5).

Use "show_status" parameter to get the module's current state information (for example: http://10.1.10.10:10090/http_sender_on?module=HttpSwitcher.7&show_status).

Using this module in Xeoma video surveillance software allows to filter out image if the sound threshold is not exceeded

Sound detector

This module filter out image if the sound threshold is not exceeded. The scale of current sound level lets you know what intensity of sound is needed to make your system react. Post-record option allows to save to archive frames after sound ended. If you use IP cameras, please set up audio URL in the "Universal Camera" module. If you use sound sources, please add a "Microphone" module to the chain before the Audio detector.

To disable any module, uncheck box in upper right corner. To enable the module back, check the box back. To remove the module, click on Trash bin in its settings or drag the module back to top panel. To close the Settings window of the module and save changes, click on «OK», press Esc key on your keyboard or on any place of the window. To close the Information window, click on the module image or on «OK».

Other help pages