Variables can be used in various dialogs and are replaced at runtime by the actual values:
Notes:
The variables follow this syntax:
$(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 actions | 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.EDT) $(EVENT.EVENTDEADTIME) |
Displays the event deadtime currently set | Seconds |
$(EVT.ADY) $(EVENT.ACTIONDELAY) |
Displays the action deadtime currently set | Seconds |
$(EVT.MDT) $(EVENT.MESSAGEDEADTIME) |
Displays the messaging deadtime currently set | Seconds |
$(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) |
$(EVT.JPC) | Shows the number of generated JPEG images since the camera or the program has been restarted. | Images |
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. | |
$(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) | Date as $(TMS.ZONE) | YYYY-MM-DD |
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.FRJ.DEZI) | Frame rate of JPEG/MxPEG conversion as a number | Example: 110 instead of 11.0 |
$(IMG.FRB) | Digitizer rate of the camera sensor (Bayer frame rate) | Hz |
$(IMG.FRB.DEZI) | Digitizer rate of the camera sensor (Bayer frame rate) as a number | Example: 110 instead of 11.0 |
$(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 , 2000 , 4000 |
$(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, 180 |
$(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]) | Red Balance | -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.SEN[.RIGHT|LEFT]) | Image sensor sensitivity | 0, 1, 2 |
$(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 week day. Mon , Tue , etc. |
WWW |
$(TMS.WDAY.FULL) | Day of the week. 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. 192.168.50.33 |
$(ID.SWV) $(ID.PATCH) |
Software version of the camera | E.g. M10-V2.0.3.9 |
$(ID.UPT) $(ID.UPTIME) |
Operating time of the camera since the last reboot in seconds | ss |
$(ID.CONFIG) | Time stamp of the configuration file | YYYY-MM-DD hh:mm:ss |
$(ID.CDA) | Time stamp of the configuration file (date only) | YYYY-MM-DD |
$(ID.CTI) | Time stamp of the configuration file (time only) | hh:mm:ss |
SEN / SENSOR: Sensor Information | ||
$(SEN.HFQ) | Frequency of the sensor data | Hz |
$(SEN.SIN) | Status of the signal input | 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.VIM) | Number of the triggered motion window | (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 |
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] |
Special Variables | ||
$("any text" [, Formatting Option]) |
Use double quotes to write any text. This text can then be formatted using the Formatting Options. The "$" character itself is written as "$$", if you would like to use it in the text that is to be formatted. |
If any text is entered as the second parameter, this text is seen as the result of the variable. |
Using the formatting options allows formatting the Text Display of the MOBOTIX camera's live image.
Examples:
$(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".The "$" character itself is written as "$$", if you would like to use it in the text that is to be formatted.
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. |
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: |
Any character | ||||||||||||
ALI ALIGN |
This parameter sets the alignment of the text output within the specified length. Default value: |
RIGHT , CENTER , LEFT |
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.
|
|||
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) . |