Table of Contents   MOBOTIX Online Help

Using Variables

Variables can be used in various dialogs and are replaced at runtime by the actual values:

Notes:

Variable Description

The variable's syntax is as follows:
$(GROUP.VARIABLE[,formatting options[,..]])

Variable Description Note
LEV / LASTEVENT: Last Event
$(LEV.DATE) Date and time of the last event YYYY-MM-DD hh:mm:ss
$(LEV.TIME) Time of the last event hh:mm:ss
$(LEV.SECONDS) Seconds since the last event Seconds
$(LEV.RELATIV) Time since the last event hh:mm:ss
EVT / EVENT: Event
$(EVT.AST)
$(EVENT.AST)
Displays all activated Action Groups See also: Abbreviations Used in the MOBOTIX Camera
$(EVT.EST.SELECTED)
$(EVENT.EST.SELECTED)
Displays all active events See also: Abbreviations Used in the MOBOTIX Camera
$(EVT.EST.ACTIVATED)
$(EVENT.EST.ACTIVATED)
Displays the event that has triggered an alarm. See also: Abbreviations Used in the MOBOTIX Camera
$(EVT.SYA)
$(EVENT.ANTE)
Displays the number of the pre-alarm images currently set Pre-Alarm Images
$(EVT.SYP)
$(EVENT.POST)
Displays the number of the post-alarm images currently set Post-Alarm Images
$(EVT.SIA)
$(EVENT.ANTEINTERVAL)
Displays the interval between the pre-alarm images. Milliseconds
$(EVT.SIP)
$(EVENT.POSTINTERVAL)
Displays the interval between the post-alarm images. Milliseconds
$(EVT.VATIMESTAMP) Shows the time stamp of the last time a visual alert (VA) was acknowledged YYYY-MM-DD hh:mm:ss
$(EVT.VAD) Shows the date of the last time a visual alert (VA) was acknowledged YYYY-MM-DD
$(EVT.VAT) Shows the time of the last time a visual alert (VA) was acknowledged hh:mm:ss
$(EVT.VAS) Shows the status of the visual alert (VA) in this images HIDE (hidden) or DRAW (shown)
FPR / FINGERPRINT: Fingerprint Information
$(FPR.VER)
$(FINGERPRINT.VERSION)
Version number of the JPEG comment  
$(FPR.PRD)
$(FINGERPRINT.PRODUCER)
Manufacturer name (MOBOTIX).  
$(FPR.FRM)
$(FINGERPRINT.FRAME)
Unique image number of every digitized image since the camera has been rebooted.  
$(FPR.ENO)
$(FINGERPRINT.EVENT)
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.
$(FPR.IMT)
$(FPR.IMAGETYPE)
Image type  
$(FPR.TIMESTAMP) Date and time as $(TMS) YYYY-MM-DD hh:mm:ss.msec
$(FPR.DAT) Date as $(TMS.DAT) YYYY-MM-DD
$(FPR.TIM) Time as $(TMS.TIME) hh:mm:ss.msec
$(FPR.TIT) Seconds and milliseconds as $(TMS.TIMET) ss.msec
$(FPR.TZN) Abbreviation of the current time zone as in ($TMS.ZONE) ZZZ
IMG / IMAGE: Image Variables
$(IMG.CTY) Shows information on the camera model. If this variable shows MONO, all parameters will parameters will only display the value for the right lens. DUAL, MONO
$(IMG.ICC) Video codec used for converting this image to JPEG MxPEG, JPEG
$(IMG.FRJ) Frame rate of JPEG/MxPEG conversion Hz
$(IMG.FRB) Digitizer rate of the camera sensor (Bayer frame rate) Hz
$(IMG.XTO)
$(IMG.XRES)
Image size of the X dimension in pixels X pixels
$(IMG.YTO)
$(IMG.YRES)
Image size of the Y dimension in pixels Y pixels
$(IMG.QLT)
$(IMG.QUALITY)
Quality level of JPEG/MxPEG conversion in percent Percent
$(IMG.CAM) Image type or selected image sensors when this image was recorded RIGHT, LEFT, BOTH, PIP
$(IMG.ZOM) Zoom level (x1000) of this image. 1000=1x Zoom 1000..8000
$(IMG.PAX) Center of the zoomed image section in X direction.
-1000=left, 0=center, 1000=right
-1000..0..1000
$(IMG.PAY) Center of the zoomed image section in Y direction.
-1000=bottom, 0=center, 1000=top
-1000..0..1000
$(IMG.MIR) Mirroring of the image NONE, VERTICAL, HORIZONTAL, BOTH
$(IMG.ROT) Rotation of the image in degrees 0..359
$(IMG.SRP[.RIGHT|LEFT]) Sharpness setting of the right or left image -2..0..10
$(IMG.ACT[.RIGHT|LEFT]) Setting of the auto contrast OFF, AUTO
$(IMG.BRT[.RIGHT|LEFT]) Brightness setting for both lenses -10..0..10
$(IMG.BLT[.RIGHT|LEFT]) Backlight correction for both lenses -10..0..10
$(IMG.CSA[.RIGHT|LEFT]) Color saturation. -10 = B/W -10..0..10
$(IMG.BBL[.RIGHT|LEFT]) Blue balance -10..0..10
$(IMG.RBL[.RIGHT|LEFT]) Color Balance for Red -10..0..10
$(IMG.DKL[.RIGHT|LEFT]) Setting of the noise reduction OFF, LOW, MEDIUM, MORE, HIGH, EXTREM
$(IMG.EXB[.RIGHT|LEFT]) Black pixel correction ON, OFF
$(IMG.EXW[.RIGHT|LEFT]) Exposure window weighting. TOTAL: Ignore exposure windows, use full image to determine exposure. 0..100, TOTAL
$(IMG.WBW[.RIGHT|LEFT]) White balance weighting. TOTAL: Ignore exposure windows, use full image to determine white balance. 0..100, TOTAL
$(IMG.AVB[.RIGHT|BOTH|LEFT]) Mean brightness of the image in percent. BOTH is the mean value of both the right and the left lens. 0..100
$(IMG.AMB[.RIGHT|BOTH|LEFT]) Minimum mean image brightness. This value is important for night improvement. 0..100
$(IMG.AMP[.RIGHT|BOTH|LEFT]) Software amplification (1024=1.0x, 8192=8.0x) 1024..8192
$(IMG.AMP[.RIGHT|BOTH|LEFT].FACTOR) Software amplification as a factor with two decimals 1.00..8.00
$(IMG.GNG[.RIGHT|LEFT]) Green amplification of the camera sensor. The value range depends on the sensor. 128..1024..16384
$(IMG.GNR[.RIGHT|LEFT]) Red amplification of the camera sensor. The value range depends on the sensor. 128..1024..16384
$(IMG.GNB[.RIGHT|LEFT]) Blue amplification of the camera sensor. The value range depends on the sensor. 128..1024..16384
$(IMG.CNG[.RIGHT|LEFT]) Green color correction value. 1024=1. 0=No correction required. 128..1024..16384
$(IMG.CNR[.RIGHT|LEFT]) Red color correction value. 128..1024..16384
$(IMG.CNB[.RIGHT|LEFT]) Blue color correction value. 128..1024..16384
$(IMG.LFQ) Power supply frequency in Hz 50, 60
$(IMG.EXI[.RIGHT|LEFT]) Minimum exposure time in microseconds Microseconds
$(IMG.EXI[.RIGHT|LEFT].SECOND) Minimum exposure time in seconds Example: 1/90 seconds 1/x
$(IMG.EXA[.RIGHT|LEFT]) Maximum exposure time in microseconds Microseconds
$(IMG.EXA[.RIGHT|LEFT].SECOND) Maximum exposure time in seconds Example: 1/90 seconds 1/x
$(IMG.EXP[.RIGHT|LEFT]) Current exposure time in microseconds Microseconds
$(IMG.EXP[.RIGHT|LEFT].SECOND) Current exposure time in seconds. Example: 1/90 seconds 1/x
TMS / TIMESTAMP: Timestamp Information
$(TMS) Timestamp & milliseconds YYYY-MM-DD hh:mm:ss.msec
$(TMS.DATE) Date according to ISO 8601 YYYY-MM-DD
$(TMS.TIME) 24h date & milliseconds hh:mm:ss.msec
$(TMS.TIMET) Number of seconds since 1970-01-01 00:00:00 UTC & milliseconds Seconds.msec
$(TMS.YEAR) Year, four digits YYYY
$(TMS.SYEAR) Year, two digits YY
$(TMS.MON) Month from 01 to 12 MM
$(TMS.MON.NAME) Abbreviation of the month Jan, Feb, etc. MMM
$(TMS.MON.FULL) Full name of the month. January, February, etc. Month
$(TMS.DAY) Day from 01 to 31 TT
$(TMS.YDAY) Day of the year (001 ... 366) DDD
$(TMS.WEEK) 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
$(TMS.WDAY) Day of the week from 1 to 7. 1=Monday, 2=Tuesday, etc. W
$(TMS.WDAY.NAME) Abbreviation of the weekday. Mon, Tue, etc. WWW
$(TMS.WDAY.FULL) Full name of the weekday. Monday, Tuesday, etc. Day
$(TMS.HOUR) Two-digit number of the current hour (24h representation) from 00 to 23 hh
$(TMS.HOUR12) Two-digit number of the current hour (12h representation) from 01 to 12 hh
$(TMS.AMPM) AM and PM abbreviations
12 o'clock noon is 'PM' and 12 o'clock midnight is 'AM'
AM or PM
$(TMS.MIN) Two-digit minutes mm
$(TMS.SEC) Two-digit seconds ss
$(TMS.MSEC) Three-digit milliseconds msec
$(TMS.ZONE) Abbreviation of the current time zone ZZZ
$(TMS.RFC822) Date and time as deviation from GMT (UTC) according to RFC822 Day, DD MMM YYYY hh:mm:ss +zzzz
ID: Identification Information
$(ID.MAC) MAC address of the network interface 00:03:C5:xx:yy:zz, where 00:03:C5: MOBOTIX identifier, xx:yy:zz: factory IP address in hexadecimal notation
$(ID.FIP) Factory default IP address of the camera 10.x.x.x
$(ID.NAM)
$(ID.HOSTNAME)
Host name of the camera <host name>
$(ID.ET0)
$(ID.ETHERNET)
Current IP address of the camera E.g. 128.243.66.90
$(ID.SWV)
$(ID.PATCH)
Software version of the camera E.g. MX-V4.1.6.27
$(ID.UPT)
$(ID.UPTIME)
Operating time of the camera since the last reboot in seconds ss
$(ID.TSI) IP addresses of the time servers separated by space characters. e.g. 10.1.1.1 10.1.1.2
$(ID.TSP) Time Server Protocol NONE: Automatic Adjustment is not activated. NTP, RFC868, NONE
$(ID.TST) 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
$(ID.TSO) Time server offset in milliseconds (NTP only) e.g. 0.073
$(ID.PTS) 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
$(ID.NTS) Like $(ID.PTS), but counting changes to the past. 0..4294967295
$(ID.CTX[.ALL|.<n>]) Returns text lines from IP Receive and the serial interface. .ALL returns all available lines, .<n> up to n lines (maximum of 64 lines possible). Corresponds to $(ID.CTX.1) when called without parameters. Several strings
$(ID.CTX.LIP[.DAT|.TIM|.SRC|.MSG]) Returns the last text line from IP Receive, if available. .DAT limits the output to a certain date, .TIM to a certain time, .SRC to an IP address and port of the sender and .MSG to the message itself. Corresponds to $(ID.CTX) and returns all lines when called without parameters. YYYY-MM-DD hh:mm:ss IP:port string
$(ID.CTX.LRS[.DAT|.TIM|.SRC|.MSG]) Returns the last text line from the serial interface, if available. .DAT limits the output to a certain date, .TIM to a certain time and .MSG to the message itself. Corresponds to $(ID.CTX) and returns all lines when called without parameters. YYYY-MM-DD hh:mm:ss "RS232" string
SEN / SENSOR: Sensor Information
$(SEN.INA) to $(SEN.INP) Status of the signal inputs: If an ExtIO is attached, these variables show their statuses. 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). Only if no MX-232-IO-Box is not present, the variables will show the statuses of the on-board inputs. 0, 1
$(SEN.BTR) State of the right camera key 0, 1
$(SEN.BTL) State of the left camera key 0, 1
$(SEN.PIR) PIR level in percent 0..100
$(SEN.MIC)

Microphone level in percent

This value will only be displayed if the Microphone event or the level meter has been activated.

0..100
$(SEN.ILR) Illumination level of the right lens, where 0: dark, 1000: direct sun at the equator at noon 0..1000
$(SEN.ILL) Illumination level of the left lens, where 0: dark, 1000: direct sun at the equator at noon 0..1000
$(SEN.LXR) Lux value of the right lens 0..100000
$(SEN.LXL) Lux value of the left lens 0..100000
$(SEN.LXE) Lux value of the sensor in the MX-GPS-Box 0..100000
$(SEN.VM1) Number of the triggered motion window for VM1 (Comma-separated list with window numbers)
$(SEN.VM2) Number of the triggered motion window for VM2 (Comma-separated list with window numbers)
$(SEN.TIN.CELSIUS) Internal camera temperature in degrees Celsius °C
$(SEN.TIN.FAHRENHEIT) Internal camera temperature in degrees Fahrenheit °F
$(SEN.TEX.CELSIUS) Only with ExtIO! Temperature of the ExtIO in degrees Celsius °C
$(SEN.TEX.FAHRENHEIT) Only with ExtIO! Temperature of the ExtIO in degrees Fahrenheit °F
$(SEN.TGP.CELSIUS) Only with MX-GPS-Box! Temperature of the MX-GPS-Box in degrees Celsius °C
$(SEN.TGP.FAHRENHEIT) Only with MX-GPS-Box! Temperature of the MX-GPS-Box in degrees Fahrenheit °F
$(SEN.GST) Only with MX-GPS-Box! Shows the number of satellites used to obtain the fix and the total number of reachable satellites.  
$(SEN.GPS) Only with MX-GPS-Box! Shows the position in degrees of longitude and 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. ° & m
$(SEN.GAL) 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
$(SEN.GVE) 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
$(SEN.GDI) 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
$(TEXT.FTPDIR) Default path for FTP image storage <hostname>/YYYY/MM/DD/hh/
$(TEXT.FTPFILE) Default filename for FTP image storage (without file name extension) mYYMMDDhhmmssmsc
$(TEXT.EVENTFILE) 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
$(STORAGE.BUFFERFILL.CURRENT)
$(STORAGE.BUFFERFILL.AVERAGE)
$(STORAGE.BUFFERFILL.MAXIMUM)
Buffer load indicator in percent 0..100
$(STORAGE.TRANSFERDELAY.CURRENT)
$(STORAGE.TRANSFERDELAY.AVERAGE)
$(STORAGE.TRANSFERDELAY.MAXIMUM)
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.

Formatting Options

Using the formatting options allows formatting the Text Display of the MOBOTIX camera's live image.

Examples:

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#

Formatting Commands

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 LENGTH, the output width is enlarged automatically, if the Formatting Switch TRUNCATE has not been set.

Default value: 0

Reasonable maximum values and image sizes:

Image Size Maximum Value
PDA: 160x120 20
CIF: 320x240 40
VGA: 640x480 80
MEGA: 1280x960 160

If higher than the maximum values in this table are used, the characters are wrapped to the next line.

0..512
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: [Space]

Any character
ALI
ALIGN

This parameter sets the alignment of the text output within the specified length.

Default value: LEFT

RIGHT, CENTER, LEFT

Formatting Switches

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.

Note: Combining DEFAULT and GLOBAL will reset the values to the camera's default settings.

 
TRU
TRUNCATE
Cuts off any text longer than specified by LENGTH.  
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: $("admin:meinsm", BASE64).

cn, de, en, es, fr, it, jp, ru

© 2001-2017 MOBOTIX AG, Germany · http://www.mobotix.com/