Axis Camera with VaxALPR On Camera software: Developer s guide

Transcription

1 Axis Camera with VaxALPR On Camera software: Developer s guide Version 1.0 VAXTOR TECHNOLOGIES Ronda de Poniente 15, First floor Tres Cantos, Madrid, Spain info.eu@vaxtor.com VAXTOR CORPORATION Lake Center Drive, Suite 211 Lake Forest, CA , USA info.us@vaxtor.com

2 INDEX 1. Introduction VaxALPR On Camera: Reporting Options Send VAPIX / ONVIF events ALPR event declaration Blacklist event declaration Whitelist event declaration Insert Overlay Write results to SD Write results to Network share Send Milestone or POST events Well-formed XML Send proprietary events Proprietary notification TCP Connector Send JSON Dorlet integration VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 2

3 1. Introduction This guide has been designed for those responsible of obtaining or integrating the results provided by the 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 camera s setup and click on the Applications menu. Then click on the VaxALPR On Camera > Settings option. Finally, click on the Main page link. This opens a window with the VaxALPR Configuration Screen. Axis camera setup: Applications > VaxALPR On Camera > Settings VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 3

4 VaxALPR Configuration screen Scroll down to the Reporting options and configure the option that best suits your needs. 2.1 Send VAPIX / ONVIF events 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 three 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. To activate this option, do the following: VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 4

5 1. Select the Send VAPIX / ONVIF events checkbox. 2. Write the Camera Id (unique identifier for each camera). 3. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VaxALPR Configuration: Reporting options > Send VAPIX /ONIF events VaxALPR Configuration: Buttons The format of the messages sent with each VAPIX / ONVIF event, are detailed below: ALPR event declaration <! Vaxtor ALPR Event --> <Declaration> <Key NameSpace="tnsaxis">topic0</Key> VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 5

6 <String>CameraApplicationPlatform</String> <Key NameSpace="tnsaxis">topic1</Key> <String>Analysis</String> <Key NameSpace="tnsaxis">topic2</Key> <String>ALPR</String> <Key>id</Key> <Tag>onvif-source</Tag> <!-- The plate string --> <Key>plate</Key> <!-- Video timestamp --> <Key>timestamp</Key> <!-- Country --> <Key>country</Key> <!-- Global confidence --> <Key>confidence</Key> <!-- Characters confidence --> <Key>charconfidence</Key> <!-- Average Char Height --> VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 6

7 <Key>charheight</Key> <!-- Process Time --> <Key>processtime</Key> <!-- Plate location --> <Key>left</Key> <!-- Plate location --> <Key>top</Key> <!-- Plate location --> <Key>right</Key> <!-- Plate location --> <Key>bottom</Key> <!-- ROI ID (unused) --> <Key>roi</Key> </Declaration> ALPR event declaration Blacklist event declaration <!-- Vaxtor ALPR Blacklist Event --> <Declaration> VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 7

8 <Key NameSpace="tnsaxis">topic0</Key> <String>CameraApplicationPlatform</String> <Key NameSpace="tnsaxis">topic1</Key> <String>Analysis</String> <Key NameSpace="tnsaxis">topic2</Key> <String>Blacklist</String> <Key>id</Key> <!-- The plate read --> <Key>plate</Key> <!-- Video timestamp --> <Key>timestamp</Key> <!-- Description --> <Key>description</Key> </Declaration> Blacklist event declaration Whitelist event declaration <!-- Vaxtor ALPR Whitelist Event --> <Declaration> <Key NameSpace="tnsaxis">topic0</Key> <String>CameraApplicationPlatform</String> <Key NameSpace="tnsaxis">topic1</Key> <String>Analysis</String> VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 8

9 <Key NameSpace="tnsaxis">topic2</Key> <String>Whitelist</String> <Key>id</Key> <!-- The plate read --> <Key>plate</Key> <!-- Video timestamp --> <Key>timestamp</Key> <!-- Description --> <Key>description</Key> </Declaration> Whitelist event declaration 2.2 Insert Overlay Choose this reporting option if you want VaxALPR On Camera to modify the dynamic overlay shown in the Axis camera on each plate recognition. To activate this option, do the following: 1. Select the Insert Overlay checkbox. 2. Write the Text Overlay. 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 VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 9

10 $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. $confidence$: Global confidence of the plate (0 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 3. Specify the Overlay Camera (Axis camera stream identifier; by default, set to 0). 4. Specify the Overlay Port (destination port). 5. Write the Axis User (username of the Axis camera). 6. Write the Axis Password (password of the user of the Axis Camera). 7. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VaxALPR Configuration: Reporting options > Insert Overlay VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 10

11 VaxALPR Configuration: Buttons 8. Next, access the Axis camera s 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. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 11

12 Axis camera setup: Video > Video Stream 2.3 Write results to SD Choose this reporting option if you want VaxALPR On Camera to 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 /areas/vaxreader/<date>/. If the plate is in a whitelist and/or blacklist, the images will be stored in /areas/vaxreader/<date>/whitelist/ or /areas/vaxreader/<date>/blacklist/. NOTE: Each image saved will be labeled as HHMMSS-PLATE.jpg. To activate this option, do the following: 1. Select the Write results to SD checkbox. 2. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 12

13 VaxALPR Configuration: Reporting options > Write results to SD VaxALPR Configuration: Buttons 3. Next, access the Axis camera s setup and click on the System Options menu. Then click on the Storage > Overview option. Check that the Status of the SD Card is ready. NOTE: When a memory card is inserted, it is mounted automatically. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 13

14 Axis camera setup: System Options > Storage Overview 4. 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. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 14

15 Axis camera setup: System Options > Storage Overview > Storage Management 2.4 Write results to Network share Choose this reporting option if you want VaxALPR On Camera to 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 axis- <DeviceSerialNumber>/areas/Vaxreader/<date>/. If the plate is in a whitelist and/or blacklist, the images will be stored in axis- <DeviceSerialNumber>/areas/Vaxreader/<date>/WHITELIST/ or axis- <DeviceSerialNumber>/areas/Vaxreader/<date>/BLACKLIST/. NOTE: Each image saved will be labeled as HHMMSS-PLATE.jpg. To activate this option, do the following: 1. Select the Write results to Network Share checkbox. 2. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 15

16 VaxALPR Configuration: Reporting options > Write results to Network Share VaxALPR Configuration: Buttons 3. Next, access the Axis camera s setup and click on the System Options menu. Then click on the Storage > Overview option. Finally click on the Network Share link. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 16

17 Axis camera setup: System Options > Storage Overview 4. 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 screen. button that appears on the upper right corner of the Storage Management VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 17

18 Axis camera setup: System Options > Storage Overview > Storage Management 2.5 Send Milestone or POST events Choose this reporting option if you want VaxALPR On Camera to send an HTTP POST or a Milestone event with a well-formed XML on each plate recognition. To activate this option, do the following: 1. Select the Send Milestone or POST events checkbox. 2. Write the Host (IP address or hostname of the destination server). 3. Write the Port (destination port). 4. Write the Camera IP (IP address of the Axis camera). 5. Write the Route (URL where the notification will be sent). If you are sending a Milestone event, the route should be /. 6. Select the HTTPS checkbox if you want a secure http communication. Do not select this option if you are sending a Milestone event. 7. Select the checkbox Send Image if you want to send the image of the license plate recognition. The JPG image will be encoded in base64 format. 8. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 18

19 VaxALPR Configuration: Reporting options > Send Milestone or POST events VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 19

20 VaxALPR Configuration: Buttons You can find the XML Schema file (.xsd) at Vaxtor s website in the developer s zone Vaxtor s website > Developer s zone VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 20

21 2.5.1 Well-formed XML Below is an example of a well-formed XML sent in an HTTP POST on the recognition of plate number M8016LS. NOTE: If the license plate recognized is on a blacklist or whitelist, another HTTP POST will be sent with an XML file where the <Type> is Blacklist License Plate Recognition or Whitelist License Plate Recognition. NOTE: The bounding box information refers to the snapshot (image of the license plate recognition encoded in base64 format) sent in the message. <?xml version="1.0" encoding="utf-8"?> <AnalyticsEvent xmlns:i=" xmlns="urn:milestone-systems"> <EventHeader> <ID> </ID> <Timestamp> T08:39: Z</Timestamp> <Type>License Plate Recognition</Type> <Message>VaxALPR On Camera Event</Message> <CustomTag>M8016LS</CustomTag> <Source> <Name> </Name> </Source> </EventHeader> <Description>M8016LS</Description> <ObjectList> <Object> <Name>Plate</Name> <Confidence> </Confidence> <Value>M8016LS</Value> <AlarmTrigger>true</AlarmTrigger> <Size>46</Size> <BoundingBox> <Top>0.42</Top> <Left>0.23</Left> <Bottom>0.54</Bottom> <Right>0.55</Right> </BoundingBox> </Object> </ObjectList> <SnapshotList> <Snapshot> <TimeOffset>0</TimeOffset> <Width>1280</Width> <Height>960</Height> <SizeInBytes>193656</SizeInBytes> <Image>BASE64ENCODEDJPEG</Image> </Snapshot> </SnapshotList> <Vendor> <Name>Vaxtor Systems</Name> </Vendor> </AnalyticsEvent> Well-formed XML sent in an HTTP POST VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 21

22 2.6 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. Select the Send proprietary events checkbox. 2. Write the Host (IP address or hostname of the destination server). 3. Write the Port (destination port). 4. Write the Camera Id (unique identifier for each camera). 5. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VaxALPR Configuration: Reporting options > Send proprietary events VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 22

23 VaxALPR Configuration: Buttons You can download a full solution at Vaxtor s website in the developer s zone This solution allows you to capture, parse, and display the results obtained from the camera in your computer. The source code is programmed in.net and contains two projects: - VaxAlprRemotePlateParser.dll: 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 GetPlateNumber(), GetOCRImage(), GetCountry(), etc. 3. Display the license plate reading on your computer. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 23

24 Vaxtor s website > Developer s zone Proprietary notification Each time a license plate is recognized, VaxALPR On Camera opens a TCP/IP 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 4 bytes int32 0xCAFEBABE Header message 4 bytes int32 0xBABE10 Result message Description 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 (1 n) If 0, license plate is situated out of ROI. 8 bytes double - Global Confidence of the plate (0 100) 8 bytes double - Plate characters height (pixels) VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 24

25 NC1 bytes float - Character confidence of the plate (0 100) 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=>unknown, 1=>getting closer, 2=>getting 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 0x 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 0x Hot-List section NOTE: This section can appear twice, once per list. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 25

26 4 bytes int32 - List type (1:white 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 0x String code section (**) NOTE: This section can appear more than once, but only once per string code. 4 bytes int32 - String code (1:plate 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 0x GPS section 8 bytes double - Latitude (decimal format) 4 bytes int32 - Latitude direction (1:North, 2:South) 8 bytes double - Longitude (decimal format) 4 bytes int32 - Longitude direction (1:West, 2:East) 4 bytes int32 0x42F87D89 End message Proprietary event format 2.7 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. Select the TCP Connector checkbox. 2. Write the Host (IP address or hostname of the destination server). 3. Write the Port (destination port). 4. Write the Text. 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 VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 26

27 $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. $confidence$: Global confidence of the plate (0 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 5. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 27

28 VaxALPR Configuration: Reporting options > TCP Connector VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 28

29 VaxALPR Configuration: Buttons 2.8 Send JSON Choose this reporting option if you want VaxALPR On Camera to send an HTTP POST with a JSON object on each plate recognition. To activate this option, do the following: 1. Select the Send JSON checkbox. 2. Write the Host (IP address or hostname of the destination server). 3. Write the Port (destination port). 4. Write the Route (URL where the notification will be sent). 5. Select the HTTPS checkbox if you want a secure http communication. 6. Write the JSON Object. You can use dynamic text replacement to match the current plate information: { : Start with a bracket $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. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 29

30 $ifwhitelist$... $ifwhitelist$: If the plate is on the whitelist, the text in the if clause will be displayed. $confidence$: Global confidence of the plate (0 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 $image$: JPG image of the license plate recognition encoded in base64 format. } : End with a bracket 7. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 30

31 VaxALPR Configuration: Reporting options > Send JSON VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 31

32 VaxALPR Configuration: Buttons 2.9 Dorlet integration Choose this reporting option if you want VaxALPR On Camera to send a notification to a Dorlet AS/3 controller on each plate recognition. To activate this option, do the following: 1. Select the Dorlet integration checkbox. 2. Write the AS/3 Host (IP address or hostname of the destination server). 3. Write the AS/3 Port (destination port). 4. Write the AS/3 LAM (LAM identifier). 5. Write the AS/3 Vial Id (Vial identifier). 6. Click on the Submit button to store the information in the camera. NOTE: The Submit button is located at the bottom part of the VaxALPR Configuration screen. VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 32

33 VaxALPR Configuration: Reporting options > Dorlet integration VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 33

34 VaxALPR Configuration: Buttons VAXTOR. Ronda de Poniente 15, First floor, Tres Cantos, Madrid, Spain 34