*Plugin – Sense Export

Owned by Tom Polman
Last updated: Sept 21, 2022
3 min read

Configuration Article | CA-20200930-TP-24

VDG Sense | Setup | Plugins | Sense Export

The Sense Export plugin is a plugin that allows automatic upload of jpeg images to an FTP server in case of an event. For instance, if a VCA signal is triggered or motion is detected on a device. The Export plugin can only be triggered using a viewer or server macro action. This article explains the necessary steps to configure this function.

Configuration

  1. Enable the ‘Sense Export plugin’ in the ‘Plugins’ tab

2. In the plugin configuration screen, click images, and set the desired values.

Preimages
The amount of images that should be included before the Export action has been triggered

Postimages
The amount of images that should be included after the Export action has been triggered

Framespacing
Amount of time in millisecondes that should be between each image

JpegQuality
Quality of the image in percentage. Higher is better quality, but larger filesize.

ImageWidth & Image Height
The dimensions of the image in pixels

3. Configure primary FTP

Host
Address of the FTP server

Port
Port of the FTP server. Default: 21

Username
Username credentials for the FTP server

Password
Password credentials for the FTP server

Path
The path where the exported images should be placed. If left empty, images will be uploaded to the root folder

UseSSL
Enable if FTP uses SSL certificates (FTPS)

Certificatefile
The path to the certificate file required for the FTPS. Enter the full path + filename + extension

Timeout
Time in milliseconds before a timeout will be given

UseTempFile
Check if images should use a temporary filename during upload. This type of behavior is often required in projects that utilize multiple levels of process automation or need extra fault tolerance because an interrupted upload can leave a partial file on the remote server

 

4. (Optional) Configure backup FTP

In case no connection can be made to the primary FTP, the Export plugin will attempt to upload to the backup FTP.

Executing Export Plugin

To trigger the Export Plugin, create a ‘Server macro’ or ‘Viewer macro’ with the following action: 

Action: Plugin -> export -> startexport

An example macro should look like this:

Configure the plugin action:

Serverid
The unique ID of the server where the device is located

DeviceID
The unique ID of the device from which the images should be exported

 

Click save to save your macro.