Merit LILIN Ent. Co., Ltd.
Edge IP Camera LPR SDK
July 2, 2018
Chapter 1. INTRODUCTION
Chapter 1-1. Overview
This document, LILIN IP camera automatic number plate recognition (LPR) protocol SDK, specifies the
integrations of using number plate database of LILIN IP camera.
Chapter 1.2. Firmware version
LILIN S series IP camera firmware 2.7.94 or above can support LPR protocol.
Chapter 2. GET LPR EVENT LIST
Chapter 2.1 Get All LPR log list
Get all detected number plates including denial, allowed, and visitor lists.
Syntax:
[Link]
Syntax:
[Link]
Example:
/get_search_info?select=log&limit=10
/get_search_info?select=white&limit=1
/get_search_info?select=white&limit=1
/get_search_info?select=white&limit=2
/get_search_info?select=white&limit=10
Parameter Values Description
<list> String Log, white, black list
<count> Integer Count limit
Return:
{"LPR_COUNT": 47,"INFORMATION":
[{"INDEX":1,"TS":"1523329437899288","MOD_TS":"2018-04-10 03:03:57
GMT","CAR_ID":"44","LPR":"30U9874","RTIME":"1038.0","ACTION":"0","ACT_PARAM":"denial","
THRESHOLD":"0.795461475849152","ROI_X":"96","ROI_Y":"54","ROI_W":"1728","ROI_H":"972",
"LP_X":"1167","LP_Y":"120","LP_W":"612","LP_H":"108",
"LP_BMP":"LPR_IMAGE/20180410030357_899297lp_30U9874_1685.png","ROI_BMP":"","COU
NTRY":"TUR","LPR_USER":"","LPR_PHONE":"","LPR_ADDRESS":"","LPR_PAYSTATUS":"","LPR
_EXIST":"","LPR_SCHEDULE_S":"","LPR_SCHEDULE_E":"","LPR_OTHER":"","LPR_DETECT_E
NDTIME":""},
{"INDEX":2,"TS":"1523329162878730","MOD_TS":"2018-04-10 02:59:22
GMT","CAR_ID":"43","LPR":"7336GN","RTIME":"1035.0","ACTION":"0","ACT_PARAM":"allowed","
THRESHOLD":"0.74889463186264","ROI_X":"96","ROI_Y":"54","ROI_W":"1728","ROI_H":"972","
LP_X":"693","LP_Y":"303","LP_W":"264","LP_H":"51",
"LP_BMP":"LPR_IMAGE/20180410025922_878744lp_7336GN_1238.png","ROI_BMP":"","COUN
TRY":"KGZ","LPR_USER":"","LPR_PHONE":"","LPR_ADDRESS":"","LPR_PAYSTATUS":"","LPR_
EXIST":"","LPR_SCHEDULE_S":"","LPR_SCHEDULE_E":"","LPR_OTHER":"","LPR_DETECT_E
NDTIME":""},
Parameter Values Description
LPR_COUNT 1~1000 Log list: max.1000
Denial list: max.100
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 2
LTD
Allowed list: max.1000
Visitor list: max. 1000
INDEX Number Index of the detected plates
TS Number 偵測到車牌的時間值 (TS/1000=MOD_TS)
MOD_TS YYYY-MM-DD The time stamp of the detected plate
hh:mm:ss
CAR_ID Number The detected plate ID of a sense
LPR Text & number The detected number plate
RTIME N/A Undefined
ACTION N/A Undefined
ACT_PARAM denial, allowed, The list of the detected plate
visitor
THRESHOLD Number The threshold of the detected plate
ROI_X: Number The coordinates of the detecting window
ROI_Y:
ROI_W:
ROI_H:
LP_X: Number The coordinates of the detected plates
LP_Y:
LP_W:
LP_H:
LP_BMP NumberThe BMP snapshot path of the detected plate
ROI_BMP N/A Reserved
COUNTRY Text Reserved
LPR_USER Text The username of denial & allowed list
LPR_PHONE N/A Reserved
LPR_ADDRESS N/A Reserved
LPR_PAYSTATUS 0~3 Detect level for Denial & Allowed list (fuzzy
detection)
0: Very Weak
1: Weak
2: Normal
3: Strong
LPR_EXIST N/A Reserved
LPR_SCHEDULE_S 00:00~23:59 Schedule allowed start time of denial & allowed list
LPR_SCHEDULE_E 00:00~23:59 Schedule allowed end time of denial & allowed list
LPR_OTHER Text Other info of denial & allowed list
LPR_DETECT_ENDTIME YYYY-MM-DD_h The end time of the denial & allowed list
h:mm
LIST_TYPE black, white, Number plate list type
customer
Chapter 2.2 Get LPR denial list
Get all detected number plates including denial list.
Syntax:
[Link]
Return:
{"LPR_COUNT": 2,"INFORMATION":
[{"INDEX":1,"TS":"1523329437899288","MOD_TS":"2018-04-10 03:03:57
GMT","CAR_ID":"44","LPR":"30U9874","RTIME":"1038.0","ACTION":"0","ACT_PARAM":"denial","
THRESHOLD":"0.795461475849152","ROI_X":"96","ROI_Y":"54","ROI_W":"1728","ROI_H":"972",
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 3
LTD
"LP_X":"1167","LP_Y":"120","LP_W":"612","LP_H":"108","LP_BMP":"LPR_IMAGE/201804100303
57_899297lp_30U9874_1685.png","ROI_BMP":"","COUNTRY":"TUR","LPR_USER":"AAA","LPR_
PHONE":"","LPR_ADDRESS":"","LPR_PAYSTATUS":"2","LPR_EXIST":"","LPR_SCHEDULE_S":"
00:00","LPR_SCHEDULE_E":"23:59","LPR_OTHER":"","LPR_DETECT_ENDTIME":"2018-12-31_
23:59"},
{"INDEX":2,"TS":"","MOD_TS":"","CAR_ID":"","LPR":"YP8549","RTIME":"","ACTION":"","ACT_PA
RAM":"black","THRESHOLD":"","ROI_X":"","ROI_Y":"","ROI_W":"","ROI_H":"","LP_X":"","LP_Y":"",
"LP_W":"","LP_H":"",
"LP_BMP":"","ROI_BMP":"","COUNTRY":"","LPR_USER":"CCC","LPR_PHONE":"","LPR_ADDRE
SS":"","LPR_PAYSTATUS":"2","LPR_EXIST":"","LPR_SCHEDULE_S":"00:00","LPR_SCHEDULE
_E":"23:59","LPR_OTHER":"","LPR_DETECT_ENDTIME":"2018-12-31_23:59"}],"LIST_TYPE":
"black"}
Chapter 2.3 Get LPR allowed list
Syntax:
[Link]
Return:
{"LPR_COUNT": 1,"INFORMATION":
[{"INDEX":1,"TS":"1523329162878730","MOD_TS":"2018-04-10 02:59:22
GMT","CAR_ID":"43","LPR":"7336GN","RTIME":"1035.0","ACTION":"0","ACT_PARAM":"allowed","
THRESHOLD":"0.74889463186264","ROI_X":"96","ROI_Y":"54","ROI_W":"1728","ROI_H":"972","
LP_X":"693","LP_Y":"303","LP_W":"264","LP_H":"51",
"LP_BMP":"LPR_IMAGE/20180410025922_878744lp_7336GN_1238.png","ROI_BMP":"","COUN
TRY":"KGZ","LPR_USER":"BBB","LPR_PHONE":"","LPR_ADDRESS":"","LPR_PAYSTATUS":"2","
LPR_EXIST":"","LPR_SCHEDULE_S":"00:00","LPR_SCHEDULE_E":"23:59","LPR_OTHER":"","L
PR_DETECT_ENDTIME":"2019-12-31_23:59"}],"LIST_TYPE": "white"}
Chapter 2.4 Get LPR visitor list
Syntax:
[Link]
Return:
{"LPR_COUNT": 1,"INFORMATION":
[{"INDEX":1,"TS":"1523337311508978","MOD_TS":"2018-04-10 13:15:11
GMT","CAR_ID":"45","LPR":"B0692","RTIME":"1035.0","ACTION":"0","ACT_PARAM":"visitor","TH
RESHOLD":"0.722453415393829","ROI_X":"96","ROI_Y":"54","ROI_W":"1728","ROI_H":"972","L
P_X":"918","LP_Y":"423","LP_W":"372","LP_H":"84",
"LP_BMP":"LPR_IMAGE/20180410131511_508987lp_B0692_3153.png","ROI_BMP":"","COUNT
RY":"ROU","LPR_USER":"","LPR_PHONE":"","LPR_ADDRESS":"","LPR_PAYSTATUS":"","LPR_
EXIST":"","LPR_SCHEDULE_S":"","LPR_SCHEDULE_E":"","LPR_OTHER":"","LPR_DETECT_E
NDTIME":""}],"LIST_TYPE": "customer"}
Chapter 2.5 Delete LPR event lists
Delete all LPR log lists.
Syntax:
[Link]
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 4
LTD
Return: clean ok
Delete the LPR denial list.
Syntax:
[Link]
Return: clean ok
Delete the LPR allowed list.
Syntax:
[Link]
Return: clean ok
Delete the LPR visitor list.
Syntax:
[Link]
Return: clean ok
Chapter 3. GET RUN-TIME LPR EVENT LIST
Syntax:
[Link]
Return:
--myboundary
Content-Type: text/plain
CamTime:2018-04-10 14:24:08
MotionDetect=0
AlarmInputDetect=0
AlarmInput2Detect=0
AlarmInput3Detect=0
AlarmInput4Detect=0
AlarmInput5Detect=0
AlarmInput6Detect=0
AudioDetect=0
TemperDetect=0
FaceDetectNumber=0
AlarmOutputStatus=0
AlarmOutput2Status=0
PIRDetect=0
DoorBell=0
LUX=0
Day=0
LPR0=7336GN,ACT_PARAM0=allowed,ROI_X0=96,ROI_Y0=54,ROI_W0=1728,ROI_H0=972,LP
_X0=810,LP_Y0=546,LP_W0=384,LP_H0=72,LPR_TIME0=2018-04-10 14:24:07 GMT
LPR1=,ACT_PARAM1=,ROI_X1=,ROI_Y1=,ROI_W1=,ROI_H1=,LP_X1=,LP_Y1=,LP_W1=,LP_H
1=,LPR_TIME1=
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 5
LTD
LPR2=,ACT_PARAM2=,ROI_X2=,ROI_Y2=,ROI_W2=,ROI_H2=,LP_X2=,LP_Y2=,LP_W2=,LP_H
2=,LPR_TIME2=
LPR3=,ACT_PARAM3=,ROI_X3=,ROI_Y3=,ROI_W3=,ROI_H3=,LP_X3=,LP_Y3=,LP_W3=,LP_H
3=,LPR_TIME3=
Parameters:
Parameter Values Description
LPR<number> 0~3 Number plates of the 4 detected plates (max 4).
LPR Text & number The number plate text
ACT_PARAM denial, allowed, The group list of the number plate
visitor
ROI_X Number Detection ROI of the camera
ROI_Y
ROI_W
ROI_H
LP_X Number The position of the detected plate
LP_Y
LP_W
LP_H
LPR_TIME YYYY-MM-DD The time of the detected plate
hh:mm:ss GMT
Chapter 4. HTTP POST NOTIFICATION
Syntax:
For JPEG
[Link]
port=<port>&account=<username>&password=<password>&am_http_jpeg=<sendjpeg>&st
reaminx=<encoder>&filemode=<filenameformat>&filename=<filename>urlinfo=%2F<url>
For text
[Link]
port=<port>&account=<username>&password=<password>&am_http_jpeg=<sendjpeg>&js
oninfo=<json>&urlinfo=%2F<url>
Example:
For JPEG:
/eventhttppost?channel=1&servername=httpservername&server=[Link]&port=8080&account
=1&password=1&am_http_jpeg=1&streaminx=3&filemode=0&filename=snap&urlinfo=%2FTEST
For text:
eventhttppost?channel=1&servername=httpservername&server=[Link]&port=8080&account
=1&password=1&am_http_jpeg=0&jsoninfo=CAMERA%25CAM_NAME%25&urlinfo=%2FTEST
Parameters:
Parameter Values Description
ch 1~3 HTTP post channel
servename String Description usage for IP camera UI
server IP, DNS
dns String DNS of the HTTP server
port Number Port number of the HTTP server
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 6
LTD
username String Username of the HTTP server
password String Password of the HTTP server
am_http_jpeg 0~1 0: text, 1: JPEG
streaminx 0~3 Encoder num. (It needs to be JPEG)
filemode 0~1 JPEG file name format:
0: Date
1: Fixed
file name String JPEG file name
jasoninfo String
url String The url of the HTTP server
Chapter 5. DELETE LPR EVENT LIST
Chapter 5.1 Delete all LPR list
Get all detected number plates including denial, allowed, and visitor lists..
Syntax:
[Link]
Examples:
/set_search_info?clean=log
/set_search_info?clean=black
/set_search_info?clean=white
/set_search_info?clean=customer
Chapter 5.2 Delete items of an LPR list
Get all detected number plates including denial, allowed, and visitor lists.
Syntax:
[Link]
Examples:
/set_search_info?delete=black&lprcount=1&lpr_oplate=ABC123
/set_search_info?delete=white&lprcount=1&lpr_oplate=ABC123
/set_search_info?delete=customer&lprcount=1&lpr_oplate=ABC123
Return:
<?xml version="1.0" encoding="UTF-8"?>
-<lprinfo>
<lpr_res>0</lpr_res>
</lprinfo>
Chapter 6. SET LPR DB LIST
Set number plates into a database
Syntax:
For adding:
[Link]
&lpr_user=<user>&lpr_paystatus=<paystatus>&lpr_schedule_s=<schedule_s>&lpr_schedu
le_e=<schedule_e>&lpr_other=<other>&lpr_detect_endtime=<endtime>
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 7
LTD
For updating;
[Link]
&lpr_oplate=<platenum>&lpr_user=<user>&lpr_paystatus=<paystatus>&lpr_schedule_s=<
schedule_s>&lpr_schedule_e=<schedule_e>&lpr_other=<other>&lpr_detect_endtime=<end
time>
Parameters:
Parameter Values Description
add: add number plate to a db
act Text
update: update number plate to a db
type Text black, white
count Number Number of items
platenum Text The number plate
User Text User name
Detect level
0: Very Weak
paystatus 0~3 1: Weak
2: Normal
3: Strong
schedule_s HH:mm HH: hour, mm: minute, ex 07:00
schedule_e HH:mm HH: hour, mm: minute, ex 17:00
endtime YYYY-MM-DD HH:mm 2018-02-12_10:25
Examples of adding a number plate to a db:
/set_search_info?add=black&lprcount=1&lpr_plate=ABC123&lpr_user=TEST123&lpr_paystatus=0&l
pr_schedule_s=01:00&lpr_schedule_e=07:00&lpr_other=other123&lpr_detect_endtime=2018-02-12_
10:25
/set_search_info?add=white&lprcount=1&lpr_plate=ABC123&lpr_user=TEST123&lpr_paystatus=0&l
pr_schedule_s=01:00&lpr_schedule_e=07:00&lpr_other=other123&lpr_detect_endtime=2018-02-12_
10:25
Return:
<?xml version="1.0" encoding="UTF-8"?>
-<lprinfo>
<lpr_res>0</lpr_res>
</lprinfo>
Examples of updating a number plate into a db:
/set_search_info?update=black&lprcount=1&lpr_plate=ABC123&lpr_oplate=ABC123&lpr_user=test1
23&lpr_paystatus=0&lpr_schedule_s=05:03&lpr_schedule_e=06:12&lpr_other=other567&lpr_detect_
endtime=2018-02-12_10:25
/set_search_info?update=white&lprcount=1&lpr_plate=ABC123&lpr_oplate=ABC123&lpr_user=test1
23&lpr_paystatus=0&lpr_schedule_s=05:03&lpr_schedule_e=06:12&lpr_other=other567&lpr_detect_
endtime=2018-02-12_10:25
Return:
<?xml version="1.0" encoding="UTF-8"?>
-<lprinfo>
<lpr_res>0</lpr_res>
</lprinfo>
Chapter 7. IMPORT & EXPORT
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 8
LTD
Import a CSV file into LPR DB.
Syntax:
[Link]
Export a CSV file from LPR DB.
Syntax:
[Link]
[Link] data format
Note: The file should be utf8 format.
Note: The file name needs to be [Link].
Chapter 8. GET THE NUMBER PLATE SNAPSHOT
Syntax:
[Link]
[Link]
Example:
[Link]
Note: The path and file name of images, please refer to LP_BMP token of Chapter 2.1 Get All LPR log list.
Chapter 9. RESTART RECOGNITION
To restart recognition, send the CGI for enabling recognition.
Syntax:
[Link]
Chapter 9-1 Enable LPR or disable LPR feature
Disable LPR function
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 9
LTD
Syntax:
[Link] IP/lpr_info?set=status&LPR_FLAG=0
Enable LPR function
Syntax:
[Link] IP/lpr_info?set=status&LPR_FLAG=1
Chapter 10. ENABLE or DISABLE LPR DENIAL & ALLOWED DETECTION
To active LPR denial and allowed detections, send the CGI for enabling or disabling.
Syntax:
[Link]
Example:
/lpr_info?set=status&LPR_BLACK_FLAG=0
/lpr_info?set=status&LPR_WHITE_FLAG=0
Parameters:
Parameter Values Description
BLACK: Denial list
type BLACK, WHITE
WHITE: Allowed list
0: Disable
act 0~1
1: Enable
Chapter 11. DEFINE DETECTION AREA of LPR
To define detection area of ANPR, send the CGI for enabling or disabling.
Syntax:
[Link]
i_right=<roi_right>&roi_bottom=<roi_bottom>&plate_percent=<plateminsizepercent
>&plate_threshold=<plate_threshold>&ttl=<ttl>
Example:
/set_search_info?update=config&roi_left=171&roi_top=589&roi_right=532&roi_bottom=886&plate
_percent=10&plate_threshold=0.700000&ttl=0
Parameters:
Parameter Values Description
roi_left Number Define the ROI of the recognition window
roi_top
roi_right
roi_bottom
plateminsizepercent 6~50 Percentage of the number plate over the camera
plate_threshold N/A The threshold value of detecting a car
ttl N/A Detection delay time
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 10
LTD
MERIT LILIN
MERIT CO.,CO.,
LILIN LTD 11
LTD