axis camera with vaxalpr on camera software: developer’s guide on... · vaxalpr on camara:...
TRANSCRIPT
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 1 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis Camera with VaxALPR On Camera
software Developerrsquos guide
Version 20
VAXTOR EUROPE Ronda de Poniente 15 1st 28760 Tres Cantos Spain
E-mail infoeuvaxtorcom
VAXTOR USA 23201 Lake Center Drv Suite 211 Lake Forest CA 92630-6821 USA
E-mail infousvaxtorcom
VAXTOR ASIA 18 Howard Road 07-011 1
Novelty Bizcentre 369585 Singapore E-mail infoasiavaxtorcom
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 2 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
INDEX
1 Introduction 3
2 VaxALPR On Camera Reporting Options 3
21 Send VAPIX ONVIF events 6
211 Event declaration 7
22 Insert Overlay 10
23 Write results to SD 15
24 Write results to Network share 20
25 Send HTTP or HTTPS POST XML events 24
251 Well-formed XML 26
252 Configure Milestone 27
26 Send HTTP or HTTPS POST JSON events 33
27 Send proprietary events 34
271 Proprietary notification data package 36
28 TCP Connector 38
29 Dorlet integration 40
3 VaxALPR On Camera HTTP API 41
31 List management 41
32 Configuration file 42
33 Database 44
34 Images 45
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 3 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Introduction
This guide has been designed for those responsible of obtaining or integrating the results
provided by VaxALPR On Camera software with other third-party software
The VaxALPR On Camera software is a real-time solution for Automatic License Plate
Recognition (ALPR) that runs entirely within the Axis camera
2 VaxALPR On Camera Reporting Options
Once the Axis camera is installed and setup and the basic configuration of the VaxALPR On
Camera software is done we need to configure the reporting options of the VaxALPR On
Camera software
To configure the reporting options access the Axis camerarsquos setup and click on the
Applications menu Then click on the VaxALPR On Camera gt Settings option Finally click on
the Main page link This opens a window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 4 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
On the menu click ldquoReportingrdquo to open the reporting configuration window
VaxALPR Reporting configuration screen
VaxALPR On Camera 20 has 10 different ways to communicate the results to third parties
- VAPIX ONVIF events
- Axis Overlay in the camera
- Write LPR result to SD card or Network Share
- HTTP or HTTPS POST messages in XML format
- HTTP or HTTPS POST messages in JSON format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 5 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
- Vaxtor proprietary protocol
- Simple TCP connector
- Integration with Dorlet AS3 Controller
- Integration with Axis A1001 Network Door Controller Detailed in the document
ldquoVaxALPR On Camera Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
- Integration with Axis Camera Station Detailed in the document ldquoVaxALPR On Camera
Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
IMPORTANT Since version 20 there is a new option on the Settings menu (Check VaxALPR On
Camera Configuration EN_3_0pdf) to enable a local database in the camera This option
requires a SD mounted in the system It is not recommended to unmount or mount the SD
card with the software running
When the database is active VaxALPR can retry the notifications in case that one of the
reporting options fails The retried events will have as timestamp the original moment when
the plate was captured To enable or disable this option check the configuration manual
IMPORTANT Since version 20 it is possible to simulate a read This simulation can be used to
test that the reporting options are well configured
To simulate a read
1 Open the reporting option menu
2 At the bottom of the page insert a plate number on the ldquoPlate to testrdquo textbox
3 Click ldquoTest reportingrdquo
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 2 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
INDEX
1 Introduction 3
2 VaxALPR On Camera Reporting Options 3
21 Send VAPIX ONVIF events 6
211 Event declaration 7
22 Insert Overlay 10
23 Write results to SD 15
24 Write results to Network share 20
25 Send HTTP or HTTPS POST XML events 24
251 Well-formed XML 26
252 Configure Milestone 27
26 Send HTTP or HTTPS POST JSON events 33
27 Send proprietary events 34
271 Proprietary notification data package 36
28 TCP Connector 38
29 Dorlet integration 40
3 VaxALPR On Camera HTTP API 41
31 List management 41
32 Configuration file 42
33 Database 44
34 Images 45
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 3 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Introduction
This guide has been designed for those responsible of obtaining or integrating the results
provided by VaxALPR On Camera software with other third-party software
The VaxALPR On Camera software is a real-time solution for Automatic License Plate
Recognition (ALPR) that runs entirely within the Axis camera
2 VaxALPR On Camera Reporting Options
Once the Axis camera is installed and setup and the basic configuration of the VaxALPR On
Camera software is done we need to configure the reporting options of the VaxALPR On
Camera software
To configure the reporting options access the Axis camerarsquos setup and click on the
Applications menu Then click on the VaxALPR On Camera gt Settings option Finally click on
the Main page link This opens a window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 4 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
On the menu click ldquoReportingrdquo to open the reporting configuration window
VaxALPR Reporting configuration screen
VaxALPR On Camera 20 has 10 different ways to communicate the results to third parties
- VAPIX ONVIF events
- Axis Overlay in the camera
- Write LPR result to SD card or Network Share
- HTTP or HTTPS POST messages in XML format
- HTTP or HTTPS POST messages in JSON format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 5 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
- Vaxtor proprietary protocol
- Simple TCP connector
- Integration with Dorlet AS3 Controller
- Integration with Axis A1001 Network Door Controller Detailed in the document
ldquoVaxALPR On Camera Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
- Integration with Axis Camera Station Detailed in the document ldquoVaxALPR On Camera
Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
IMPORTANT Since version 20 there is a new option on the Settings menu (Check VaxALPR On
Camera Configuration EN_3_0pdf) to enable a local database in the camera This option
requires a SD mounted in the system It is not recommended to unmount or mount the SD
card with the software running
When the database is active VaxALPR can retry the notifications in case that one of the
reporting options fails The retried events will have as timestamp the original moment when
the plate was captured To enable or disable this option check the configuration manual
IMPORTANT Since version 20 it is possible to simulate a read This simulation can be used to
test that the reporting options are well configured
To simulate a read
1 Open the reporting option menu
2 At the bottom of the page insert a plate number on the ldquoPlate to testrdquo textbox
3 Click ldquoTest reportingrdquo
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 3 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Introduction
This guide has been designed for those responsible of obtaining or integrating the results
provided by VaxALPR On Camera software with other third-party software
The VaxALPR On Camera software is a real-time solution for Automatic License Plate
Recognition (ALPR) that runs entirely within the Axis camera
2 VaxALPR On Camera Reporting Options
Once the Axis camera is installed and setup and the basic configuration of the VaxALPR On
Camera software is done we need to configure the reporting options of the VaxALPR On
Camera software
To configure the reporting options access the Axis camerarsquos setup and click on the
Applications menu Then click on the VaxALPR On Camera gt Settings option Finally click on
the Main page link This opens a window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 4 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
On the menu click ldquoReportingrdquo to open the reporting configuration window
VaxALPR Reporting configuration screen
VaxALPR On Camera 20 has 10 different ways to communicate the results to third parties
- VAPIX ONVIF events
- Axis Overlay in the camera
- Write LPR result to SD card or Network Share
- HTTP or HTTPS POST messages in XML format
- HTTP or HTTPS POST messages in JSON format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 5 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
- Vaxtor proprietary protocol
- Simple TCP connector
- Integration with Dorlet AS3 Controller
- Integration with Axis A1001 Network Door Controller Detailed in the document
ldquoVaxALPR On Camera Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
- Integration with Axis Camera Station Detailed in the document ldquoVaxALPR On Camera
Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
IMPORTANT Since version 20 there is a new option on the Settings menu (Check VaxALPR On
Camera Configuration EN_3_0pdf) to enable a local database in the camera This option
requires a SD mounted in the system It is not recommended to unmount or mount the SD
card with the software running
When the database is active VaxALPR can retry the notifications in case that one of the
reporting options fails The retried events will have as timestamp the original moment when
the plate was captured To enable or disable this option check the configuration manual
IMPORTANT Since version 20 it is possible to simulate a read This simulation can be used to
test that the reporting options are well configured
To simulate a read
1 Open the reporting option menu
2 At the bottom of the page insert a plate number on the ldquoPlate to testrdquo textbox
3 Click ldquoTest reportingrdquo
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 4 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
On the menu click ldquoReportingrdquo to open the reporting configuration window
VaxALPR Reporting configuration screen
VaxALPR On Camera 20 has 10 different ways to communicate the results to third parties
- VAPIX ONVIF events
- Axis Overlay in the camera
- Write LPR result to SD card or Network Share
- HTTP or HTTPS POST messages in XML format
- HTTP or HTTPS POST messages in JSON format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 5 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
- Vaxtor proprietary protocol
- Simple TCP connector
- Integration with Dorlet AS3 Controller
- Integration with Axis A1001 Network Door Controller Detailed in the document
ldquoVaxALPR On Camera Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
- Integration with Axis Camera Station Detailed in the document ldquoVaxALPR On Camera
Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
IMPORTANT Since version 20 there is a new option on the Settings menu (Check VaxALPR On
Camera Configuration EN_3_0pdf) to enable a local database in the camera This option
requires a SD mounted in the system It is not recommended to unmount or mount the SD
card with the software running
When the database is active VaxALPR can retry the notifications in case that one of the
reporting options fails The retried events will have as timestamp the original moment when
the plate was captured To enable or disable this option check the configuration manual
IMPORTANT Since version 20 it is possible to simulate a read This simulation can be used to
test that the reporting options are well configured
To simulate a read
1 Open the reporting option menu
2 At the bottom of the page insert a plate number on the ldquoPlate to testrdquo textbox
3 Click ldquoTest reportingrdquo
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 5 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
- Vaxtor proprietary protocol
- Simple TCP connector
- Integration with Dorlet AS3 Controller
- Integration with Axis A1001 Network Door Controller Detailed in the document
ldquoVaxALPR On Camera Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
- Integration with Axis Camera Station Detailed in the document ldquoVaxALPR On Camera
Integration EN_2_0pdfrdquo available at httpwwwvaxtoreswp-
contentDownloadsVaxALPR_On_Camera_Integration_EN_2_0pdf
IMPORTANT Since version 20 there is a new option on the Settings menu (Check VaxALPR On
Camera Configuration EN_3_0pdf) to enable a local database in the camera This option
requires a SD mounted in the system It is not recommended to unmount or mount the SD
card with the software running
When the database is active VaxALPR can retry the notifications in case that one of the
reporting options fails The retried events will have as timestamp the original moment when
the plate was captured To enable or disable this option check the configuration manual
IMPORTANT Since version 20 it is possible to simulate a read This simulation can be used to
test that the reporting options are well configured
To simulate a read
1 Open the reporting option menu
2 At the bottom of the page insert a plate number on the ldquoPlate to testrdquo textbox
3 Click ldquoTest reportingrdquo
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 6 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Test reporting option
4 A confirmation message will be displayed when the simulation is sent
Confirmation message
21 Send VAPIX ONVIF events
IMPORTANT This reporting option has been modified since version 20 and above
Choose this reporting option if you want VaxALPR On Camera to send a VAPIX ONVIF event
on each plate recognition VaxALPR On Camera can send four different types of events
- ALPR This event is sent each time a license plate is recognized
- Blacklist This event is sent each time a license plate on the blacklist is recognized
- Whitelist This event is sent each time a license plate on the whitelist is recognized
- NoList This event is sent each time a license plate is recognized and the plate is not in
the whitelist or in the blacklist
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 7 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
To activate this option do the following
1 Click on the Vapix header to expand the Vapix integration menu
2 Select the Active checkbox
3 Write the Camera Id (unique identifier for each camera)
4 Click on the Submit reporting button to store the information in the camera
NOTE The Submit button is located at the bottom part of the VaxALPR Reporting
Configuration screen
VaxALPR Configuration Reporting options gt Send VAPIX ONIF events
The format of the message sent with each VAPIX ONVIF event are detailed below All the
events have the same fields only the topic2 item will change (ALPRv2 Blacklistv2 Whitelistv2
or No_listv2)
211 Event declaration
lt-- Vaxtor ALPR Event --gt
ltDeclarationgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic0ltKeygt
ltStringgtCameraApplicationPlatformltStringgt
ltItemgt
ltItemgt
ltKey NameSpace=tnsaxisgttopic1ltKeygt
ltStringgtAnalysisltStringgt
ltItemgt
ltItemgt
ltmdashValid values are ALPRv2Blacklistv2Whitelistv2 or NoListv2 --gt
ltKey NameSpace=tnsaxisgttopic2ltKeygt
ltStringgtALPRv2ltStringgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 8 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltItemgt
ltKeygtidltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- The plate read --gt
ltKeygtplateltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Video timestamp --gt
ltKeygttimestampltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Country State --gt
ltKeygtcountryltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Global confidence --gt
ltKeygtconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Characters confidence --gt
ltKeygtcharconfidenceltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 9 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
lt-- Average Char Height --gt
ltKeygtcharheightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Process Time --gt
ltKeygtprocesstimeltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtleftltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygttopltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtrightltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt-- Plate location --gt
ltKeygtbottomltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 10 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltItemgt
ltmdashRegion of Interest ID --gt
ltKeygtroiltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
lt- Description (Only for blacklist and whitelist events) --gt
ltKeygtdescriptionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltItemgt
ltmdashDirection of movement --gt
ltKeygtdirectionltKeygt
ltStringgt
ltTaggtonvif-dataltTaggt
ltItemgt
ltDeclarationgt
22 Insert Overlay
VaxALPR On Camera can modify the dynamic overlay shown in the Axis camera on each plate
recognition
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 11 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 12 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
2 Click over Overplay panel header to show details
3 Inside Overlay panel select Active checkbox to activate Overlay reporting
4 Write the Message
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 13 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
5 Specify the View (Axis camera view stream identifier by default set to 0)
6 Write the User (username of the Axis camera)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 14 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 Write the Password (password of the user of the Axis Camera)
8 Click on the button to store the configuration in the camera
9 Next access the Axis cameraacutes setup and click on the Video menu Then click on the
Video Stream option In the Overlay Settings section select the checkbox Include text
and in the input field write D
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 15 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Video gt Video Stream
23 Write results to SD
VaxALPR On Camera can save a JPEG image to an SD card (inserted in the Axis camera) on each
plate recognition
IMPORTANT All the images will be stored in the SD Card in the folder ldquoareasVaxreaderYYYY-
MM-DDrdquo If the plate is in a whitelist andor blacklist the images will be stored in
ldquoareasVaxreaderYYYY-MM-DDWHITELISTrdquo or ldquoareasVaxreaderYYYY-MM-
DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 16 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR Configuration screen
2 Click over Reporting menu option
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 17 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Rerporting screen
3 Click over Write Result panel header to show details
4 Select SD checkbox to activate Write result reporting
5 Click on the button to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 18 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
6 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Check that the Status of the SD Card is ready
NOTE When a memory card is inserted it is mounted automatically
Axis camera setup System Options gt Storage Overview
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 19 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
7 For more information about what you can do with the SD Card click on the
button that appears on the upper right corner of the Storage Management screen
Axis camera setup System Options gt Storage Overview gt Storage Management
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 20 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
24 Write results to Network share
VaxALPR On Camera can save a JPEG image to a network share (a folder created in the local
network) on each plate recognition
IMPORTANT All the images will be stored in the network share in the folder ldquoaxis-
ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDrdquo If the plate is in a whitelist andor
blacklist the images will be stored in ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-
DDWHITELISTrdquo or ldquoaxis-ltDeviceSerialNumbergtareasVaxreaderYYYY-MM-DDBLACKLISTrdquo
NOTE Each image saved will be labeled as HHMMSS-PLATEjpg with the timestamp in
UTCGMT
To configure this option do the following
1 Access the Axis camerarsquos setup and click on the Applications menu Then click on the
VaxALPR On Camera gt Settings option Finally click on the Main page link This opens a
window with the VaxALPR Configuration Screen
Axis camera setup Applications gt VaxALPR On Camera gt Settings
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 21 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration screen
1 Click over Reporting menu option
VaxALPR Reporting screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 22 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
1 Click over Write Result panel header to show details
2 Select Network share checkbox to share local file through local network
3 Click on the button to store the configuration in the camera
4 Next access the Axis cameraacutes setup and click on the System Options menu Then click
on the Storage gt Overview option Finally click on the Network Share link
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 23 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview
2 Set up the Network Share
Write a Host (IP address of the host server)
Write the Share (name of the share on the host server)
Select The share requires a login checkbox if the network share requires login
credentials and write the User name and Password
Click on the Connect button
NOTE For more information about what you can do with the Network Share click on
the button that appears on the upper right corner of the Storage Management
screen
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 24 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Axis camera setup System Options gt Storage Overview gt Storage Management
25 Send HTTP or HTTPS POST XML events
Choose this reporting option if you want VaxALPR On Camera to send the event in a XML over
a HTTP POST This method is also valid to send an Analytic Event to Milestone
To activate this option do the following
1 Click on the XML header to expand the HTTP Post XML integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp For Milestone the URL should
be httpmilestoneserver9090
Both domain names or IP address can be used
4 Modify the message if needed By default the message is a valid Analytic Event for
Milestone The message can use Dynamic text like the Overlay reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 25 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 26 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR On Camera HTTP Post XML configuration
You can find the XML Schema file (xsd) for the Milestone Analytic Event at Vaxtorrsquos website in
the developerrsquos zone httpwwwvaxtoresdevelopers-zone
Vaxtorrsquos website gt Developerrsquos zone
251 Well-formed XML
Below is an example of the default well-formed XML sent in an HTTP POST on the recognition
of plate number M8016LS
NOTE The bounding box information refers to the snapshot (image of the license plate
recognition encoded in base64 format) sent in the message
ltxml version=10 encoding=utf-8gt ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance xmlns=urnmilestone-systemsgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 27 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltEventHeadergt ltIDgt00000000-0000-0000-0000-000000000000ltIDgt ltTimestampgt2016-05-23T083936135998ZltTimestampgt ltTypegtLicense Plate RecognitionltTypegt ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggtM8016LSltCustomTaggt ltSourcegt ltNamegt1921680100ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongtM8016LSltDescriptiongt ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt0972857ltConfidencegt ltValuegtM8016LSltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt46ltSizegt ltBoundingBoxgt ltTopgt042ltTopgt ltLeftgt023ltLeftgt ltBottomgt054ltBottomgt ltRightgt055ltRightgt ltBoundingBoxgt ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt ltWidthgt1280ltWidthgt ltHeightgt960ltHeightgt ltSizeInBytesgt193656ltSizeInBytesgt ltImagegtBASE64ENCODEDJPEGltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt ltVendorgt
ltAnalyticsEventgt
Well-formed XML sent in an HTTP POST
252 Configure Milestone
Once the reporting option HTTP POST is configured we need to set up Milestone to receive
and handle our events To do this we recommend the following steps
1 Enable Milestone to receive our events
Access the Milestone Management Application and click on the Options menu Then
click on the Settings option This opens a new window Click on the Analytic Events
option and select the Enabled checkbox Finally click on the Ok button to save the
changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 28 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Milestone Management Application gt Options menu gt Settings option
Milestone Management Application gt Options menu gt Settings option gt Analytic Events option Enabled
2 Create the VaxALPR On Camera Event in Milestone
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Events and Output drop down menu Click
on the Analytics Events option and on the right-side button of your mouse to access
the Create New button Click on the Create New button to set up the event
Write a Name of the Analytics Event (VaxALPR On Camera Event)
Finally click on the Ok button to save the changes
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 29 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 30 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Events and Output gtAnalytic Events VaxALPR On
Camera Event
3 Create the alarm that will trigger when Milestone receives the VaxALPR On Camera
Event
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Click on the
Alarm Definitions option and on the right-side button of your mouse to access the
Create New button Click on the Create New button to set up the alarm
Select the Enable checkbox to activate the alarm
Write a Name of the alarm (Plate Detected)
Select a Triggering event from the drop-down list The Triggering event should be
the Analytics Event A second drop-down list will appear
Select the VaxALPR On Camera Event from the second drop-down list
Select a Source (the camera with the installed VaxALPR On Camera software)
Finally click on the Ok button to save the changes
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions option Create New
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 31 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Definitions Plate Detected
4 Modify the Alarm Data Settings
Click on the Surveillance Server drop down menu Next click on the Advanced
Configuration drop down menu and on the Alarms drop down menu Next click on the
Alarm Data Settings option Click on the Alarm List Configuration tab and move the
Object column from the Available columns to the Selected columns This column will
indicate the plate number in Milestone
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 32 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Surveillance Server gt Advanced Configuration gt Alarms gtAlarm Data Settings Alarm List Configuration
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 33 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
26 Send HTTP or HTTPS POST JSON events
Choose this reporting option if you want VaxALPR On Camera to send the event in a JSON
object over a HTTP POST
To activate this option do the following
1 Click on the JSON header to expand the HTTP Post JSON integration menu
2 Enable the Active checkbox
3 Write the URL The URL needs to be a well-formed URI like httpmyservercom or
httpsmyservercomportdestinationmypagephp Both domain names or IP
address can be used
4 Modify the message if needed The message can use Dynamic text like the Overlay
reporting option
NOTE You can use dynamic text replacement to match the current plate information
$date$ Date in ISO8601 format
$plate$ License plate number
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 34 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
5 Click Submit reporting to store the configuration in the camera
VaxALPR On Camera HTTP Post JSON configuration
27 Send proprietary events
Choose this reporting option if you want VaxALPR On Camera to send a predefined data
stream to a server on each plate recognition
To activate this option do the following
1 Click on the Vaxtor protocol header to expand the Proprietary events integration
menu
2 Enable the Active checkbox
3 Write the Host address Domain names or IP address can be used
4 Write the Port (destination port)
5 Write the Camera Id (unique identifier for each camera)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 35 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtor protocol reporting option
You can download a full example at Vaxtorrsquos website in the developerrsquos zone
httpwwwvaxtoresdevelopers-zone This sample code allows you to capture parse and
display the results obtained from the camera in your computer It is programmed in NET and
contains two projects
- VaxAlprRemotePlateParserdll Library used to capture and parse incoming data
packages from the VaxALPR On Camera software
- VaxAlprOnCameraViewer Application that displays the license plate readings on your
computer
If you wish to use the source code do the following
1 Listen in a socket and capture the data package sent by the VaxALPR On Camera
software (see description of the data package below)
2 Send the data package to the DLL parser and get the license plate information
NOTE Some of the functions that appear in the parser are ldquoGetPlateNumber()rdquo
ldquoGetOCRImage()rdquo ldquoGetCountry()rdquo etc
3 Display the license plate reading on your computer
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 36 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
Vaxtorrsquos website gt Developerrsquos zone
271 Proprietary notification data package
Each time a license plate is recognized VaxALPR On Camera opens a TCPIP communication
sends a predefined data stream and closes the communication The format of the message
sent is detailed below
Message length
Message type
Fixed message
Description
4 bytes int32 0xCAFEBABE Header message
4 bytes int32 0xBABE10 Result message
4 bytes int32 - VaxALPR ID (Instance ID in VaxALPR configuration file)
8 bytes int64 - Time Stamp (date in milliseconds)
4 bytes int32 - NC1 Number of ASCII characters in the plate
NC1 bytes byte - ASCII bytes array
4 bytes int32 - NC2 Number of ASCII characters of the plate origin
NC2 bytes byte - ASCII bytes array
Not used 4 bytes int32 - ROI ID containing the license plate (1hellipn)
If 0 license plate is situated out of ROI
8 bytes double - Global Confidence of the plate (0 ndash 100)
8 bytes double - Plate charactersrsquo height (pixels)
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 37 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
NC1 bytes float - Character confidence of the plate (0hellip100)
8 bytes double - Time the OCR takes to process the reading (milliseconds)
4 bytes int32 - x0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - y0 coordinate of the plate (pixel coordinates of the top left corner of the license plate image)
4 bytes int32 - x1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
4 bytes int32 - y1 coordinate of the plate (pixel coordinates of the bottom right corner of the license plate image)
8 bytes int64 - OCR image timestamp (milliseconds)
4 bytes int32 - SF Size of the OCR image (bytes)
SF bytes byte - OCR image data (JPG format)
4 bytes int32 - R1 Size of image reserved data (bytes)
R1 bytes byte - Reserved data (R1 bytes)
Not used 8 bytes int64 - Environment image timestamp (milliseconds)
Not used 4 bytes int32 - SF Size of the environment image (bytes)
Not used SF bytes byte - Environment image data (JPG format)
Not used 4 bytes int32 - R2 Size of image reserved data (bytes)
Not used R2 bytes byte - Reserved data (R2 bytes)
Not used 4 bytes int32 - Vehicle direction (0=gtunknown 1=gtgetting closer 2=gtgetting farther)
Not used 4 bytes int32 - ALPR multi-plate rate
4 bytes int32 - OCR mode (1 Triggered mode 0 Free-flow mode)
4 bytes int32 0x42F83988 Header of optional data
Optional 4 bytes int32 0x50000001 Plate number in wide string format section
4 bytes int32 - Number of characters in the plate
4 bytes int32 - NC3 Number of bytes the full plate string occupies
NC3 bytes byte - Array of bytes representing the string in UTF8 or UNICODE format
Optional 4 bytes int32 0x50000002 Hot-List section
NOTE This section can appear twice once per list
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 38 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
4 bytes int32 - List type (1white list 2 black list)
4 bytes int32 - NC4 Number of ASCII characters in the message
NC4 bytes byte - ASCII bytes array containing the message
Optional 4 bytes int32 0x50000003 String code section ()
NOTE This section can appear more than once but only once per string code
4 bytes int32 - String code (1plate country region 2 vehicle color 3 vehicle brand 4 vehicle model)
4 bytes int32 - NC5 Number of ASCII characters of the string
NC5 bytes byte - ASCII bytes array containing the characters
Optional 4 bytes int32 0x50000004 GPS section
8 bytes double - Latitude (decimal format)
4 bytes int32 - Latitude direction (1North 2South)
8 bytes double - Longitude (decimal format)
4 bytes int32 - Longitude direction (1West 2East)
4 bytes int32 0x42F87D89 End message
Proprietary event format
28 TCP Connector
Choose this reporting option if you want VaxALPR On Camera to send a string data type to a
server on each plate recognition
To activate this option do the following
1 Click on the TCP header to expand the TCP Connector integration menu
2 Enable the Active checkbox
3 Write the Host (IP address or hostname of the destination server)
4 Write the Port (destination port)
5 Write the Text You can use dynamic text replacement to match the current plate
information
$date$ Date in ISO8601 format
$plate$ License plate number
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 39 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
$country$ Country of the vehicle
$blacklist$ Description of the plate on the blacklist
$whitelist$ Description of the plate on the whitelist
$ifblacklist$ $ifblacklist$ If the plate is on the blacklist the text in the if clause
will be displayed
$ifwhitelist$ $ifwhitelist$ If the plate is on the whitelist the text in the if
clause will be displayed
$ifnolist$$ifnolist$ If the plate in not on a list the test in the if clause will be
displayed
$confidence$ Global confidence of the plate (0 ndash 100)
$processingtime$ Milliseconds the OCR takes to process the reading
$left$$top$$right$$bottom$ Pixel coordinates of the top left corner and the
bottom right corner of the license plate image
$absoluteleft$$absolutetop$$absoluteright$$absolutebottom$ Coordinates of
the top left corner and the bottom right corner of the license plate image in
absolute format (0hellip 1)
$width$ Width of the image in pixels
$height$ Height of the image in pixels
$ip$ IP address of the camera
$roiid$ ROI Id that detected the plate
$id$ Unique ID for the detected plate The database option needs to be enable in
the camera
$direction$ Direction of movement
$image$ The jpeg image encoded in base64
$jpegsize$ Size in bytes of the JPEG image after the base64 decoding
Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 40 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt TCP Connector
29 Dorlet integration
Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet
AS3 controller on each plate recognition
To activate this option do the following
1 Click on the Dorlet header to expand the Dorlet integration menu
2 Write the AS3 Host (IP address or hostname of the destination server)
3 Write the AS3 Port (destination port)
4 Write the AS3 LAM (LAM identifier)
5 Write the AS3 Vial Id (Vial identifier)
6 Click on the Submit reporting button to store the information in the camera
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 41 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
VaxALPR Configuration Reporting options gt Dorlet integration
3 VaxALPR On Camera HTTP API
Since version 20 VaxALPR On Camera implements an HTTP API that allow third parties to
- Modify the whitelist and blacklists on the camera
- Upload and download the configuration file
- Query information from the local plate database (if the database is enabled)
- Recover the image associated to a record in the database (if the database and the
image recording is enabled)
31 List management 1 Add a vehicle to the blacklist
httpcameraiplocalVaxreaderblacklistcgiaction=addampplate=1234ABCampdescription=My_description Response ltresult status=okgt
2 Add a vehicle to the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=addampplate=1234ABCampdescription=Mi_description Response ltresult status=okgt
3 Delete a vehicle from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=delampplate=1234ABC Response
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 42 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltresult status=okgt 4 Delete a vehicle from the whitelist
httpcameraiplocalVaxreaderwhitelistcgiaction=delampplate=1234ABC Response ltresult status=okgt
5 Get all the plates on the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=get-allampformat=xml ltblacklist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
6 Get all the plates on the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=get-allampformat=xml ltwhitelist clean=truegt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
7 Get a single plate from the blacklist httpcameraiplocalVaxreaderblacklistcgiaction=getampplate=1234ABC ltblacklistgt ltplate plate=1234ABC description=My_descriptiongt ltblacklistgt
8 Get a single plate from the whitelist httpcameraiplocalVaxreaderwhitelistcgiaction=getampplate=1234ABC ltwhitelistgt ltplate plate=1234ABC description=My_descriptiongt ltwhitelistgt
32 Configuration file
1 Download the current configuration file
httpmycameraiplocalVaxreaderalprcgi
Response (example content may vary depending on the camera model) ltconfigurationgt
ltresolutionsgt
ltresolution id=0 width=1280 height=720gt
ltresolution id=1 width=1024 height=768gt
ltresolution id=2 width=1024 height=640gt
ltresolution id=3 width=640 height=480 selected=1gt
ltresolution id=4 width=640 height=400gt
ltresolution id=5 width=320 height=240gt
ltresolution id=6 width=176 height=144gt
ltresolutionsgt
ltviewsgt
ltview id=0 description=View Area 1gt
ltview id=1 description=Aacuterea de visualizacioacuten 2 selected=1gt
ltview id=2 description=View area 3gt
ltviewsgt
ltmode working_mode=0 is_virtual_port=true virtual_port=1 generate_database=
true store_database_images=true retry_notifications=false check_whitelist=false
check_blacklist=falsegt
ltocr same_plate_delay=60 same_plate_max_chars_distance=2 min_char_height=17 max_ch
ar_height=40 min_global_confidence=70 min_character_confidence=50 grammar_strict=
true report_times=falsemin_num_plate_characters=5 max_num_plate_characters=9 max_
slop_angle=20 background_mode=1 read_double_line_plates=true algorithm_complexity=
2 plate_depth=1 reserved=1002 state=0gt
ltcountriesgt
ltcountry id=1195gt
ltcountriesgt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 43 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
ltroisgt
ltroi id=1 width=629 height=482 type=2gt
ltpointsgt
ltpoint x=96 y=470gt
ltpoint x=64 y=379gt
ltpoint x=73 y=303gt
ltpoint x=98 y=258gt
ltpoint x=121 y=237gt
ltpoint x=413 y=182gt
ltpoint x=496 y=125gt
ltpoint x=623 y=67gt
ltpoint x=602 y=0gt
ltpoint x=0 y=2gt
ltpoint x=1 y=471gt
ltpointsgt
ltroigt
ltroi id=4 width=454 height=351 type=2gt
ltpointsgt
ltpoint x=449 y=238gt
ltpoint x=401 y=280gt
ltpoint x=394 y=328gt
ltpoint x=404 y=346gt
ltpoint x=451 y=347gt
ltpointsgt
ltroigt
ltroisgt
ltocrgt
ltanalytic recognition_timeout=500 min_num_occurrences=1 max_num_occurrences=5 plat
e_report=3gt
ltreportinggt
lta1001 active=false host=a1001ip user=user password=password controller_t
oken=ControllerAxis-accc8888888 AccessController idpoint_token=ReaderAxis-
accc88888881453299458759360000gt
ltvaxtor_protocol active=true host=192168088 port=9100 id=1gt
ltoverlay active=true user=root password=pass message=$date$ - $plate$
($country$) $blacklist$ view=0gt
ltdorlet active=false host= port=9090 vial_id=1 LAM=0gt
ltwrite_result sd=false network_share=falsegt
ltvapix active=true id=1gt
lttcp active=false host= port=20000 message=$date$$plate$$country$$black
list$$whitelist$gt
ltjson active=false url=http192168022130000 message=
plate$plate$ date$date$ country$country$ confidence$confidence$
left$left$ top$top$ right$right$ bottom$bottom$
charheight$charheight$ processingtime$processingtime$ gt
ltxml active=false url= message=ltxml version=10 encoding=utf-8gt
ltAnalyticsEvent xmlnsi=httpwwww3org2001XMLSchema-instance
xmlns=urnmilestone-systemsgt ltEventHeadergt ltIDgt00000000-0000-0000-0000-
000000000000ltIDgt ltTimestampgt$date$ltTimestampgt ltTypegtLicense Plate RecognitionltTypegt
ltMessagegtVaxALPR On Camera EventltMessagegt ltCustomTaggt$plate$ltCustomTaggt ltSourcegt
ltNamegt$ip$ltNamegt ltSourcegt ltEventHeadergt ltDescriptiongt$plate$ltDescriptiongt
ltObjectListgt ltObjectgt ltNamegtPlateltNamegt ltConfidencegt$confidence$ltConfidencegt
ltValuegt$plate$ltValuegt ltAlarmTriggergttrueltAlarmTriggergt ltSizegt$charheight$ltSizegt
ltBoundingBoxgt ltTopgt$absolutetop$ltTopgt ltLeftgt$absoluteleft$ltLeftgt
ltBottomgt$absolutebottom$ltBottomgt ltRightgt$absoluteright$ltRightgt ltBoundingBoxgt
ltObjectgt ltObjectListgt ltSnapshotListgt ltSnapshotgt ltTimeOffsetgt0ltTimeOffsetgt
ltWidthgt$width$ltWidthgt ltHeightgt$height$ltHeightgt ltSizeInBytesgt$jpegsize$ltSizeInBytesgt
ltImagegt$image$ltImagegt ltSnapshotgt ltSnapshotListgt ltVendorgt ltNamegtVaxtor SystemsltNamegt
ltVendorgt ltAnalyticsEventgtgt
ltacs active=true host=acshost port=50333 username=user password=password
SSL=false bookmark_name=$plate$ -
$country$ bookmark_description=$ifblacklist$Blacklist
$blacklist$$ifblacklist$$ifwhitelist$Whitelist $whitelist$$ifwhitelist$gt
ltreportinggt
ltconfigurationgt
2 Upload a new configuration file To upload a configuration file create an HTTP POST
call to the URL httpcameraiplocalVaxreaderalprcgi where the body of the
message is the configuration file
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 44 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
The configuration file should have the same format of the configuration file
downloaded from the camera
Response
If the configuration file is correct the response will be current camera
configuration
If the configuration file is incorrect an error XML with the wrong parameters will
be returned The HTTP result code will be 500
lterror message=rdquoError setting configurationrdquo reason=rdquoltreasongtrdquogt
33 Database
It is possible to query the local database (if enabled) on the camera The database queries
can return an empty response if the database is locked in that case wait a few
milliseconds and retry the query
All the queries are automatically paged (100 results per query) To request a different
page add the parameter ldquopage=ltpagegtrdquo to the URL
The total count of records for the query is returned as the count attribute of the resultset
The record count in this page is returned as the results attribute in the resultset
1 Query all the plates in the database (ordered from newer to older)
httpcameraiplocalVaxreaderplatescgi
Response (example) ltresultset results=100 limit=100 count=28642gt
ltplate id=28642 plate_number=1234ABC plate_origin=UNK confidence
=100 taken_on=2017-11-
23T181125264Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=21 character
_confidence=10000100001000010000100001000010000 process
ing_time=100 multiplate_rate=1 signaled=false roi_id=0 left=1
top=1 right=5 bottom=5error=false state= num_rows=1 dire
ction=1gt
ltresultsetgt
2 Query all the plates since a given ID (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiid=ltidgt
Response (example) ltresultset results=100 limit=100 count=27956gt
ltplate id=687 plate_number=1234ABC plate_origin=Spain confidence
=100 taken_on=2017-10-
25T133541506Z is_blacklist=false blacklist_description= is_whi
telist=false whitelist_description=character_height=29 character
_confidence=10000100001000010000100001000010000 process
ing_time=6904709005355835 multiplate_rate=3 signaled=false roi_
id=-
1 left=240 top=411right=405 bottom=475 error=false state=U
NKNOWN num_rows=1 direction=1gt
ltplate id=688 plate_number=1234ABC plate_origin=Spain confidence
=78857142857142861 taken_on=2017-10-
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt
VaxALPR On Camara Developerrsquos guide
Version 20
VAXTOR Ronda de Poniente 15 First floor Tres Cantos Madrid Spain 45 Tel +34 91 757 22 11 ndash Email infoeuvaxtorcom ndash web httpwwwvaxtorcom
25T133550733Z is_blacklist=false blacklist_description= is_whi
telist=falsewhitelist_description= character_height=27 character
_confidence=0001000010000100001000094005800 processing_
time=66248625099658966 multiplate_rate=1 signaled=false roi_id=
-
1left=498 top=259 right=639 bottom=319 error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
3 Query by plate number from the (ordered from older to newer)
httpcameraiplocalVaxreaderplatescgiplate=ltplate_number_urlscapedgt
The query accepts wildcards For example to query all the plates that ends in 89 the
plate value will be 89
IMPORTANT The lsquorsquo character will need to be escaped in the URL (25) so the URL
that you will need to use in a navigator will be
httpcameraiplocalVaxreaderplatescgiplate=2589
Response (example) ltresultset results=1 limit=100 count=1gt
ltplate id=14219 plate_number=AAA89 plate_origin=UNKNOWN confiden
ce=100 taken_on=2017-11-
08T163259Z is_blacklist=false blacklist_description= is_whiteli
st=false whitelist_description=character_height=25 character_con
fidence=1000010000100001000010000 processing_time=4145051
121711731 multiplate_rate=1 signaled=false roi_id=-
1 left=477 top=275 right=631 bottom=355error=false state=U
NKNOWN num_rows=1 direction=0gt
ltresultsetgt
34 Images
1 Recover the image linked to a record in the database httpcameraiplocalVaxreaderimagecgiid=ltidgt Response If the image is available a JPEG will be returned If the image is not available a XML will be returned with the information about the
error The HTTP result code will be 500 lterror message=Error reading file reason=Failed to open
file
varspoolstorageareasSD_DISKVaxreaderdbimages1jpg
No such file or directorygt