Variables can be used in various dialogs and are replaced at runtime by the actual values:
File or directory name in the FTP Profiles dialog.
Subject or body text in the Email Profiles dialog
Network messages in the Messaging dialog
Comments in the Text & Display Settings dialog
Apart from the variables listed above, you can also use Placeholders for Dynamic Image Text.
When retrieving data from one of the supported weather stations connected to the serial interface, weather variables will allow displaying the weather data in the image.
Note that variables are not case-sensitive.
Information on formatting variables is contained in the Formatting Options section in this help page.
Optional parts of variables are written in angular brackets and do not have to be used.
Note that a maximum of 25 variables can be used at the same time.
The variable's syntax is as follows:
$(GROUP.VARIABLE[,formatting options[,..]])
Variable |
Description |
Note |
---|---|---|
LEV / LASTEVENT: Last Event |
||
|
Date and time of the last event |
YYYY-MM-DD hh:mm:ss |
|
Time of the last event |
hh:mm:ss |
|
Seconds since the last event |
Seconds |
|
Time since the last event |
hh:mm:ss |
EVT / EVENT: Event |
||
|
Displays all activated Action Groups. |
|
|
Displays all active events. |
|
|
Displays the event that triggered an alarm. |
|
|
Displays the number of the pre-alarm images currently set. |
Pre-Alarm Images |
|
Displays the number of the post-alarm images currently set. |
Post-Alarm Images |
|
Displays the interval between the pre-alarm images. |
Milliseconds |
|
Displays the interval between the post-alarm images. |
Milliseconds |
|
Shows the time stamp of the last time a visual alert (VA) was acknowledged. |
YYYY-MM-DD hh:mm:ss |
|
Shows the date of the last time a visual alert (VA) was acknowledged. |
YYYY-MM-DD |
|
Shows the time of the last time a visual alert (VA) was acknowledged. |
hh:mm:ss |
|
Shows the status of the visual alert (VA) in this image. |
|
FPR / FINGERPRINT: Fingerprint Information |
||
|
Version number of the JPEG comment |
|
|
Manufacturer name (MOBOTIX) |
|
|
Unique image number of every digitized image since the camera has been rebooted. |
|
|
Currently valid event number; for an event images, the number of the event. |
This variable is only available with active recording and outside of image profiles. |
|
Image type |
|
|
Date and time as $(TMS) |
YYYY-MM-DD hh:mm:ss.msec |
|
Date as $(TMS.DAT) |
YYYY-MM-DD |
|
Time as $(TMS.TIME) |
hh:mm:ss.msec |
|
Seconds and milliseconds as $(TMS.TIMET) |
ss.msec |
|
Abbreviation of the current time zone as in ($TMS.ZONE) |
ZZZ |
IMG / IMAGE: Image Variables |
||
|
Shows information on the camera model. If this variable shows |
|
|
Video codec used for converting this image to JPEG |
|
|
Frame rate of JPEG/MxPEG conversion |
Hz |
|
Digitizer rate of the camera sensor (Bayer frame rate) |
Hz |
|
Image size of the X dimension in pixels |
X pixels |
|
Image size of the Y dimension in pixels |
Y pixels |
|
Quality level of JPEG/MxPEG conversion in percent |
Percent |
|
Image type or selected image sensors when this image was recorded |
|
|
Selected Zoom level (x1000) of this image. 1000=1x Zoom |
|
|
Center of the zoomed image section in X direction.
|
|
|
Center of the zoomed image section in Y direction.
|
|
|
Mirroring of the image |
|
|
Rotation of the image in degrees |
|
|
Sharpness setting of the right or left image |
|
|
Setting of the auto contrast |
|
|
Brightness setting for both lenses |
|
|
Backlight correction for both lenses |
|
|
Color saturation. |
|
|
|
|
|
|
|
|
Setting of the noise filter |
|
|
Black pixel correction |
|
|
Weighting of the measurement windows for exposure. |
|
|
White balance weighting. |
|
|
Mean brightness of the image in percent. |
|
|
Minimum mean image brightness. This value is important for night improvement. |
|
|
Green amplification of the camera sensor. The value range depends on the sensor. |
|
|
Red amplification of the camera sensor. The value range depends on the sensor. |
|
|
Blue amplification of the camera sensor. The value range depends on the sensor. |
|
|
Green color correction value. |
|
|
Red color correction value. |
|
|
Blue color correction value. |
|
|
Power supply frequency in Hz |
|
|
Minimum exposure time in microseconds |
Microseconds |
|
Minimum exposure time in seconds Example: |
seconds 1/x |
|
Maximum exposure time in microseconds |
Microseconds |
|
Maximum exposure time in seconds Example: |
seconds 1/x |
|
Current exposure time in microseconds |
Microseconds |
|
Current exposure time in seconds. Example: 1/90 |
seconds 1/x |
TMS / TIMESTAMP: Timestamp Information |
||
|
Timestamp & milliseconds |
YYYY-MM-DD hh:mm:ss.msec |
|
Date according to ISO 8601 |
YYYY-MM-DD |
|
24h date & milliseconds |
hh:mm:ss.msec |
|
Number of seconds since 1970-01-01 00:00:00 UTC & milliseconds |
Seconds.msec |
|
Year, four digits |
YYYY |
|
Year, two digits |
YY |
|
Month from 01 to 12 |
MM |
|
Abbreviation of the month |
MMM |
|
Full name of the month. |
Month |
|
Day from 01 to 31 |
TT |
|
Day of the year (001 ... 366) |
DDD |
|
Number of the week according to ISO 8601:1988 from 01 to 53. The first week has at least four days in the current year. The week starts on Monday. |
WW |
|
Day of the week from 1 to 7. |
W |
|
Abbreviation of the weekday. |
WWW |
|
Full name of the weekday. |
Day |
|
Two-digit number of the current hour (24h representation) from 00 to 23 |
hh |
|
Two-digit number of the current hour (12h representation) from 01 to 12 |
hh |
|
AM and PM abbreviations 12 o'clock noon is 'PM' and 12 o'clock midnight is 'AM' |
|
|
Two-digit minutes |
mm |
|
Two-digit seconds |
ss |
|
Three-digit milliseconds |
msec |
|
Abbreviation of the current time zone |
ZZZ |
|
Date and time as deviation from GMT (UTC) according to RFC822 |
Day, DD MMM YYYY hh:mm:ss +zzzz |
ID: Identification Information |
||
|
MAC address of the network interface |
00:03:C5:xx:yy:zz, where |
|
Factory default IP address of the camera |
10.x.x.x |
|
Host name of the camera |
<host name> |
|
Current IP address of the camera |
E.g. 192.168.1.221 |
|
Software version of the camera |
E.g. MX-V4.4.2.51-r1 |
|
Operating time of the camera since the last reboot in seconds |
ss |
|
IP addresses of the time servers separated by space characters. |
e.g. 10.1.1.1 10.1.1.2 |
|
Time Server Protocol |
|
|
Time stamp of the last time server check (this is not the time of the last contact to the server): A check is run every 30 minutes with NTP, every 6 hours with RFC868. |
YYYY-MM-DD hh:mm:ss |
|
Time server offset in milliseconds (NTP only) |
e.g. 0.073 |
|
If the camera time is set to a point in the future, this counter is increased by the time difference in seconds. It serves the detection of camera time changes to prevent manipulation of recordings. |
0..4294967295 |
|
Like |
0..4294967295 |
|
Returns text lines from IP Receive and the serial interface. |
Several strings |
|
Returns the last text line from IP Receive, if available. |
YYYY-MM-DD hh:mm:ss IP:port string |
|
Returns the last text line from the serial interface, if available. |
YYYY-MM-DD hh:mm:ss "RS232" string |
SEN / SENSOR: Sensor Information |
||
|
Status of the signal inputs: If an ExtIO is attached, these variables show the corresponding status. Otherwise, the variables show the status of the inputs of the MX-232-IO-Box (INA to IND: 7.1 to 7.4, INE to INH: PIR to Bpc, INI to INP: ERT mode of the inputs, also in the order of 7.1 to Bpc). The on-board inputs will be available only if there is no MX-232-IO-Box present. |
0, 1 |
|
State of the right camera key |
0, 1 |
|
State of the left camera key |
0, 1 |
|
PIR level in percent |
0..100 |
|
Microphone level in percent This value will only be displayed if the Microphone event or the level meter has been activated. |
0..100 |
|
Illumination level of the right lens, where |
0..1000 |
|
Illumination level of the left lens, where |
0..1000 |
|
Lux value of the right lens |
0..100000 |
|
Lux value of the left lens |
0..100000 |
|
Lux value of the sensor in the MX-GPS-Box |
0..100000 |
|
Number of the triggered motion window for VM1 |
(Comma-separated list with window numbers) |
|
Number of the triggered motion window for VM2 |
(Comma-separated list with window numbers) |
|
Internal camera temperature in degrees Celsius or degrees Fahrenheit |
°C °F |
|
Only cameras with ambient temperature sensor! Ambient camera temperature in degrees Celsius or degrees Fahrenheit. |
°C °F |
|
Only with ExtIO! Temperature of the ExtIO in degrees Celsius or degrees Fahrenheit |
°C °F |
|
Only with MX-GPS-Box! Temperature of the MX-GPS-Box in degrees Celsius or degrees Fahrenheit |
°C °F |
|
Only with thermal image sensor! Temperature of the sensor center in degrees Celsius or degrees Fahrenheit (right sensor) |
°C °F |
|
Only with thermal image sensor! Temperature of the sensor center in degrees Celsius or degrees Fahrenheit (left sensor) |
°C °F |
|
Only with image sensor for thermal radiometry! A list of measured temperatures of all configured radiometry events. The displayed values are determined for every event according to the following method:
In this context, the minimum range specifies the number of pixels in which the temperature values exceeds or drops below the trigger value in order to trigger an event. |
°C °F |
|
Only with MX-GPS-Box! Shows the number of satellites used to obtain the fix and the total number of reachable satellites. |
|
|
Only with MX-GPS-Box! Shows the position in degrees longitude and degrees latitude. In addition, the box also shows the precision of this value in meters. Note that the availability of this value depends on the reception status of the MX-GPS-Box. By default, longitude and latitude are shown as a decimal fraction (this corresponds to using |
° & m |
|
Only with MX-GPS-Box! Shows the current longitude. Note that the availability of this value depends on the reception status of the MX-GPS-Box. By default, the longitude is shown as a decimal fraction (this corresponds to using |
° |
|
Only with MX-GPS-Box! Shows the current latitude. Note that the availability of this value depends on the reception status of the MX-GPS-Box. By default, the latitude is shown as a decimal fraction (this corresponds to using |
° |
|
Only with MX-GPS-Box! Shows the elevation above Mean Sea Level and the precision of this value. Note that the availability of this value depends on the reception status of the MX-GPS-Box. Note that $(SEN.GPS) may already deliver a position, but the elevation cannot be determined yet. |
m |
|
Only with MX-GPS-Box! Shows the current speed and the precision of this value. Note that the availability of this value depends on the reception status of the MX-GPS-Box. Note that $(SEN.GPS) may already deliver a position, but the speed cannot be determined yet. |
m/s |
|
Only with MX-GPS-Box! Shows the direction of movement and the precision of this value. Note that the availability of this value depends on the reception status of the MX-GPS-Box. Note that $(SEN.GPS) may already deliver a position, but the direction of movement cannot be determined, although the box is measuring significant movement. |
° |
TEXT: Text Variables |
||
|
Default path for FTP image storage |
<hostname>/YYYY/MM/DD/hh/ |
|
Default filename for FTP image storage (without file name extension) |
mYYMMDDhhmmssmsc |
|
File name (without file name extension) that contains a timestamp and where event images are identified by a E+<event number> suffix. |
fYYMMDDhhssmsc[_Eeeeeee] |
STO / STORAGE: Storage |
||
|
Buffer load indicator in percent |
0..100 |
|
Transfer delay when storing in seconds |
Seconds |
Special Variables |
||
$("any text" [, Formatting option])
|
Use double quotes to write any text. This text can then be formatted using the Formatting Options. In order to output the "$" character itself, make sure that you enter "$$". |
If any text is entered as the second parameter, this text is seen as the result of the variable. |
The formatting options allow formatting the Text Display of the MOBOTIX camera's live image.
$(fpr.eno, fill=0, len=6, align=right)
: Sequence number 6 digits and leading zeros.
$("sampletext",len=80,fill=-,align=center)
: One full row of minus signs ("-") with the center-aligned word "sampletext".
In order to output the "$" character itself, make sure that you enter "$$".
Syntax errors are displayed behind the formatting instructions and are enclosed in leading/trailing "#" signs:
#"sampletext",Test,len=80,fill=-,align=center:format parameter unknown#
The formatting commands take a value and are separated by commas (",") one after another.
FORMATTINGOPTION1=VALUE, FORMATTINGOPTION2=VALUE
Option |
Description |
Note |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
LEN, LENGTH |
This parameter sets the width of the text output. The remaining space is filled using the fill character. "0" is variable
width. If the text is larger than defined in Default value: Reasonable maximum values and image sizes:
If higher than the maximum values in this table are used, the characters are wrapped to the next line. |
|
||||||||||
FIL, FILL |
Sets the fill character to be used to format the output. This command takes one character. Superfluous characters will be ignored. Default value: |
Any character |
||||||||||
ALI, ALIGN |
This parameter sets the alignment of the text output within the specified length. Default value: |
|
The formatting switches do not take a value and are separated by commas (",") one after another.
Switch |
Description |
Note |
---|---|---|
DEF, DEFAULT |
Uses the default settings for this variable |
|
GLO, GLOBAL |
Sets the values of this variable as global default for all following variables. NoteCombining |
|
TRU, TRUNCATE |
Cuts off any text longer than specified by |
|
B64, BASE64 |
Switches text output to Base64 encoding (this is required by some email servers, for example) |
Use this switch to supply user information, for example: |