ANPR ACCESS ANPR ACCESS HD

Transcription

1 ANPR ACCESS ANPR ACCESS HD ethernet programmers guide v4.2

2 Content CONTENT 1 INTRODUCTION 3 2 COMMUNICATION PROTOCOL MESSAGE FORMAT 4 TCPClient TCPServer transmission 5 TCPServer TCPClient reception AVAILABLE SERVER FUNCTIONS GET DEVICE INFO NO OPERATION REBOOT START TRIGGER STOP TRIGGER ENABLE ENGINE DISABLE ENGINE GET DIGITAL I/O SET DIGITAL OUTPUT GET DATE / TIME SET DATE / TIME GET ERROR COUNTERS RESET ERROR COUNTERS GRAB LIVE IMAGE RELOAD CHECK LIST GET CHECK LIST 16 A TCP TAG IDENTIFIER OVERVIEW 18 B ERROR CODES 19 C DISCLAIMER 21 D DOCUMENT REVISION 22 2/22

3 Introduction 1 INTRODUCTION The NEDAP ANPR License Plate Reader offers automatic number plate reading. The NEDAP ANPR is an all in one camera including camera, analyzer and IR illuminator. The ANPR has embedded processing software onboard. The License Plate Reader is default featured with an RS485 and Ethernet communication. Wiegand is possible using the separate available Wiegand Interface Module 3/22

4 2 COMMUNICATION PROTOCOL Communication is based upon the TCP protocol. All requests sent from the TCPClient are always supposed to receive an acknowledge message from the TCPServer inside the ANPR. If the connection is unused (no data sent from client to server) for more than 60 seconds then the TCPServer automatically shuts the connection. To maintain an open connection is enough to send periodically a NOP command within the connection timeout. The TCPServer communication port is MESSAGE FORMAT TCP message format Always set to 24 (=0x ). <CMD> 4 Command code. 0xFFFFFFFF 4 Received. <ERR> 4 Error code ( 0=no error). <LEN> 4 Data length in bytes. 32-bit aligned. Header not included. <DATA> <LEN> Message data. The message data contains the tags-fields. Every tag is defined by a tag-identifier and a tag-length indicator. The packet may contain any number of tag-fields. Tagfields are arranged depending on the ANPR firmware. This may as well change when using a different firmware version. For this reason, when searching for tag-fields in a received packet, the server should scan all tag-fields regardless of their position inside the received message. This programming method allows for software compatibility with future firmware versions. Data message field format <TAG-ID> 4 Tag-identifier. <TAG-LEN> 4 Tag-length in bytes. <TAG-DATA> <TAG-LEN> Tag field contents. Data conventions The tag-data field contents are based on the following conventions: All data fields are always aligned 4 bytes. Value data fields are 4 bytes encoded in little endian. E.g. 10 -> 0x0A (len=4) String data fields should contain a terminating zero. The LEN field should include the terminating zero but not the padding bytes. E.g. 'ABCDE' -> 0x (len=6) Buffer data fields may contain generic data. The LEN field should not include the padding bytes. 4/22

5 TCPClient TCPServer transmission During the transmission ensure that the following is performed: 1 Add the message header to the message. In case there is no data to send, the message is made up by the message header only. The data length field should also be set to zero. 2 Enter the command code field. Refer to command descriptions in chapter Send the message. TCPServer TCPClient reception During reception ensure that the following is performed: 1 Wait for the first message packet and extract the message header. 2 Wait, if necessary, for next packets until the complete message is received. Waiting time for each packet is application set. 3 Create a data buffer containing the complete received message. Check whether the error field contains any error. If this is the case, the message data is contains are not valid. 2.2 AVAILABLE SERVER FUNCTIONS GET DEVICE INFO Request device information about the ANPR. Get device info Command code Command code <STRLEN> 4 Data length in bytes ID <BSN> 4 Board serial number ID <BC> 4 Board code ID 5/22

6 <HWVN> 4 Hardware version ID <TEMP> 4 Board temperature (in tenths of C) ID <FPVN> 4 FPGA version ID <STRLEN> 4 SIZ <FWVN> <STRLEN> * Firmware version string including description ID 1 4 Number of video channels always 1 (only if context camera installed 2) *STRING fields should include a terminating zero. Append padding bytes to ensure 4 byte alignment. Padding bytes are not counted in the string length NO OPERATION The TCPClient may use this message to prevent the TCP connection from being automatically shut by the TCPServer following 60 seconds of communication inactivity (no data sent). This is the only message for which no response is expected from the TCPServer. No operation Command code. Example no-operation , 3E , FF FF FF FF, FF FF FF FF, , REBOOT When sending this command, the ANPR will perform a reboot. Before the restart, an acknowledge message is sent. No operation Command code. 6/22

7 Command code START TRIGGER This command should be used when the ANPR is set to TRIGGER_ETHERNET mode. If this command is sent while the ANPR is operating a different mode, the reply will be an error message. The command message must include a trigger-string. This string requires no specific formatting and is used as a trigger identifier. For example, it may contain the current date and time of the client. Upon receiving this command, the ANPR starts grabbing and processing plates for the specified gate-time period. When the gate-time expires, a transit event is generated. In case a stop-trigger message is received before the gate-time expires, the gate-time is ignored. Start trigger Command code. 20+<STRLEN 4 Data length in bytes. > ID <GATE-TIME> 4 Gate-time in milliseconds ID <STRLEN> 4 SIZ <TRIG-STR> <STRLEN> * Trigger-string (max. 32 characters). STRING fields should include a terminating zero. Append padding bytes to ensure 4 byte alignment. Padding bytes are not counted in the string length. 7/22

8 Command code. Example start-trigger (gate-time 1000ms, trigger-string 'ABC123') , C , FF FF FF FF, FF FF FF FF, , 1C , , , E , , , , STOP TRIGGER This command should only be used when the ANPR is set to TRIGGER_ETHERNET mode. If this command is sent while the ANPR is operating a different mode, the reply will be an error message. Sending this message causes the images grabbing and processing to halt and the consequent generation of a transit event. The message must contain the same trigger-string as the previous start-trigger command. Stop trigger Command code. 8+<STRLEN> 4 Data length in bytes ID <STRLEN> 4 SIZ <TRIG-STR> <STRLEN> * Trigger-string (max. 32 characters). STRING fields should include a terminating zero. Append padding bytes to ensure 4 byte alignment. Padding bytes are not counted in the string length Command code. 8/22

9 2.2.6 ENABLE ENGINE This command enables plate number reading. It corresponds to the EnableEngine command in the General Settings page on the web server. If the plate reader engine was already enabled, this command will perform no action, while the reply message from the TCPServer will not show any error. Enable engine Command code Command code DISABLE ENGINE This command disables plate number reading. It corresponds to the EnableEngine command in the General Settings page on the web server. If the plate reader engine was already disabled, this command will perform no action, while the reply message from the TCPServer will not show any error. Disable plate reading Command code Command code. 9/22

10 2.2.8 GET DIGITAL I/O This command allows reading the state of the digital inputs and outputs. Get digital I/O Command code Command code Data length in bytes ID <NR-I> 4 Number of digital inputs ID <I-STAT> 4 Digital input status ID <NR-O> 4 Number of digital outputs ID <O-STAT> 4 Digital output status The state of the digital inputs and outputs is a 32-bit long variable. The least significant bit corresponds to input or output number 0. If the bit has value 1, the input or output is active SET DIGITAL OUTPUT This command allows setting a digital output on or off. Set digital output / Command code: 25051=Output ON, 25052=Output OFF. 10/22

11 12 4 Data length in bytes ID <DON> 4 Selected digital output number / 4 Command code GET DATE / TIME This command allows reading the ANPR current date and time with additional information about time zone and daylight saving time. Get date/time Command code Command code Data length in bytes ID <DAY> 1 Day <MON> 1 Month <YEAR> 2 Year <HOUR> 2 Hour <MIN> 2 Minutes 11/22

12 <SEC> 2 Seconds <MSEC> 2 Milliseconds ID <TIMEZONE> 4 GMT offset in minutes ID <DST> 4 0=Standard time, 1=Daylight saving time The received time is Greenwich Mean Time (GMT). Add to the received time the GMT offset to obtain the local time. If the daylight saving time value is 1, it is necessary to add 60 minutes SET DATE / TIME This command allows settings the date and time. It also enables/disables the automatic switch to daylight save time. The ANPR is featured with a real time clock with backup battery: this ensures that the date and time is even updated while the device is off. Set date/time Command code Data length in bytes ID <DAY> 1 Day <MON> 1 Month <YEAR> 2 Year <HOUR> 2 Hour <MIN> 2 Minutes <SEC> 2 Seconds <MSEC> 2 Milliseconds ID <TIMEZONE> 4 GMT offset in minutes ID <DST> 4 1=Enable automatic switch to daylight saving time / standard time. 12/22

13 Command code GET ERROR COUNTERS While operating the ANPR keeps track of errors detected as of startup. This allows keeping under control any anomalies, such as problems with the FTP server. Get error counters Command code Command code Data length in bytes ID <ERRCNT> 4 Number of errors in image transfer to FTP server ID <ERRCNT> 4 Number of errors in image transfer to data base ID <ERRCNT> 4 Number of errors in alarm sending to PNS ID <ERRCNT> 4 Number of errors in log sending to FTP server ID 13/22

14 <ERRCNT> 4 Number of errors in image grabbing ID <ERRCNT> 4 Number of errors in synchronization with time server RESET ERROR COUNTERS This command will reset the error counters. Reset error counters Command code : Command code GRAB LIVE IMAGE This command allows grabbing a live JPEG image. The images may be bright or dark due to adjustments in the electronic auto-shutter system. The specified image size must be smaller than or equal to the ANPR camera resolution. Grab live image Command code. 0 4 Receiver: 0=IMAGE_BW 28 4 Data length in bytes ID <QVAL> 4 JPEG quality in range from 1 to ID 8 4 SIZ 14/22

15 <WIDTH> 4 Image width in pixels. <HEIGHT> 4 Image Height in pixels Command code. 0 4 Sender Data length in bytes. <IMGSIZ> ID 12 4 SIZ <DAY> 1 Day <MON> 1 Month <YEAR> 2 Year <HOUR> 2 Hour <MIN> 2 Minutes <SEC> 2 Seconds <MSEC> 2 Milliseconds ID SIZ <IMGSIZ> 0 4 Unused. 0 4 Unused Image header size in bytes. <IMGSIZ> 4 Image size in bytes. <WIDTH> 4 Image width in pixels. <HEIGHT> 4 Image height in pixels. 0 4 Unused. 0 4 Unused. 0 4 Unused. 0 4 Unused. <IMG> <IMGSIZ> * JPEG image data. Padding bytes are appended to ensure 4 byte alignment. Padding bytes are not counted in the image size RELOAD CHECK LIST This command reloads the check list file into RAM memory. List management must be enabled on the web interface in order for this operation to be carried out. If list management is not enabled, the reply is an error message. 15/22

16 Reload plate list / Command code: 35000=Reload check list A, 35001=Reload check list B / 4 Command code GET CHECK LIST This command allows reading the ANPR check list. Get plate list / Command code: 35002=Get check list A, 35003=Get check list B / 4 Command code Data length in bytes. <LISTSIZ> ID <PLATES> 4 Number of plates in the list 16/22

17 ID <LISTSIZ> 4 SIZ <LIST> <LISTSIZ> String containing license plates The string with the plate check list is formatted as follows: Vehicle Number plate; Country; Comment string Example 46HVR9;NLD;Ferrari 599 GTO ZLSZ17;NLD;Fiat Cinquecento AB123HK;ITA; 17/22

18 TCP TAG IDENTIFIER OVERVIEW A TCP TAG IDENTIFIER OVERVIEW Command identifiers ID Description Set digital output on Set digital output off Get digital I/O No operation Get live image Reboot Set date / time Get date / time Reload check list A Reload check list B Get check list A Get check list B Enable engine Disable engine Get error counters Reset error counters Start trigger Stop trigger Get device info Data Identifiers ID Description 2000 JPEG image 2001 Image time JPEG quality GMT offset in minutes Daylight saving time Image size (width and height in pixels) Board serial number Firmware version string / description Board code Hardware version Board temperature (in tenths of C) FPGA version Date / time Number of video channels Number of digital inputs Number of digital outputs Digital input status Digital output status Selected digital output number Error count image transfer to FTP server Error count image transfer to data base Error count alarm sending to PNS Error count log sending to FTP server Error count image grabbing Error count time server synchronization Trigger-string Gate-time in milliseconds Number of plates in the list String containing license plates Enable automatic switch to daylight saving time / standard time 18/22

19 Error codes B ERROR CODES These error codes are only applicable for firmware revision 11.8 and newer. ID Name Description 0 OK No error. Operation successful ML_ERR_INVALID_COMMAND_CODE Command code is not valid ML_ERR_NETWORK Network error ML_ERR_INSUFFICIENT_MEMORY Memory is insufficient to complete the operation ML_ERR_FILL_BUFFER Error while preparing the reply buffer ML_ERR_MISSING_PARAMETER A parameter is missing in the VRC message ML_ERR_FILE_DELETE Error while deleting a file ML_ERR_FILE_READ Error while reading a file ML_ERR_FILE_WRITE Error while writing a file ML_ERR_PARTITION_FORMAT Error while formatting a partition ML_ERR_ALREADY_DONE The command was already executed ML_ERR_DEVICE_BUSY Device or resource busy ML_ERR_WRONG_PARAMETER A wrong parameter was passed in the VRC message ML_ERR_SYS_EXECUTE A task couldn't be executed ML_ERR_GET_IMAGE_FAILED Image grab failed ML_ERR_IMAGE_SIZE Error while resizing the image ML_ERR_IMAGE_FORMAT Error while changing image format ML_ERR_JPEG_ENCODE Error while encoding the image in JPEG format ML_ERR_NOT_ALLOWED The requested operation is not allowed ML_ERR_TOO_SOON The request was issued too soon without respecting a minimum time interval from the previous request ML_ERR_INVALID_DATA_RECEIVED Format of received data is invalid. Returned when reading or writing parameters from INI files ML_ERR_INTERNAL_ERROR Internal error ML_ERR_INVALID_STRING_KEY_VALUE The value is not valid (for keys of type STRING) ML_ERR_INVALID_LONG_KEY_VALUE The value is outside the allowed range (for keys of type LONG) ML_ERR_INI_FILE_WRITE Error while writing a INI file ML_ERR_INI_FILE_READ Error while reading a INI file ML_ERR_WRONG_PACKET_SIZE Input data size is not valid ML_ERR_SIGNATURE_INVALID Error while initializing a image signature instance ML_ERR_SIGNATURE_MISSING_FIELDS Some fields required to compute the signature are missing ML_ERR_INI_WRONG_DATA Some fields in the INI file have invalid values ML_ERR_INI_NEED_REBOOT Update of files was successful and now the device must be rebooted for the changes to take effect ML_ERR_TRIGGER_MSG_QUEUE_IS_FULL The message queue is full ML_ERR_TRIGGER_MSG_QUEUE_SEND_FAILED A internal communication error occurred ML_ERR_FTP_STORE Error while storing data on FTP server 19/22

20 Error codes ML_ERR_ENGINE_IS_STOP Engine is stopped and therefore it can't process the trigger ML_ERR_ENGINE_IS_NOT_CONFIGURED Engine is not configured ML_ERR_TRIGGER_INVALID Trigger is not valid ML_ERR_WRONG_TRIGGER_MODE Wrong trigger mode ML_ERR_FTP_STORE_DISABLED Storing to FTP server is disabled ML_ERR_IMAGE_OCR_NOT_AVAILABLE OCR image was not available ML_ERR_IMAGE_COL_NOT_AVAILABLE Color image was not available ML_ERR_IMAGE_HQ_NOT_AVAILABLE HQ image was not available ML_ERR_NO_NEW_IMAGES No new image is available ML_ERR_NO_NEW_TRANSIT No new transit is available 20/22

21 Disclaimer C DISCLAIMER This information is furnished for guidance, and with no guarantee as to its accuracy or completeness; its publication conveys no license under any patent or other right, nor does the publisher assume liability for any consequence of its use; specifications and availability of goods mentioned in it are subject to change without notice; it is not to be reproduced in any way, in whole or in part, without the written consent of the publisher. 21/22

22 Document revision D DOCUMENT REVISION Version Date Comment Added error code list Added ANPR ACCESS HD Layout adjusted to new corporate style 22/22