NumberOk event package specification. Delivered over TCP

NumberOk event package specification. Delivered over TCP

In the TCP packet data pairs PARAM=VALUE are divided with ascii 0x05.

Not every pair may appear in a package.

Order of pairs may vary.

Text is UTF-8 encoded.

Pair "SystemId=N" ( N - integer value) is added to all events. Value - is primary key from table NumberOkS.

Event screenshots are sent along with event data only if relevant box ticked in NumberOk UI (send Screenshots).


Event class

Event type

Event fields

Field type

Field description

Executive devices (IO Modules) block


AlarmBoard

InputState



Inputs state




ChannelIndex=All

String

All inputs state




State

String

For all inputs: 0 - opened, 1 - closed. Note: State is not inverted, as is.




DeviceId

unsigned long long

Device address

Recognition block results


Status

IAService.LPR



Note: these events generated by analytic




State

string (Detected | Updated | Lost)

Plate detection




RuntimeID

int64

Internal object's index




MovementType

string (TryIn | In | TryOut | Out | Undetermined)

Type of movement




uMovementType

int (1, 2, 4, 8, 0)

Integer type of movement (correspond with MovementType)




FrameTimeStampMs

uint64

UTC time of frame, milliseconds since 01.01.1970




ProcessTimeMs

int

Frame processing time, milliseconds




TestMode

string (Enabled)

Test mode flag




Text

string

REMOVED !




Plate

string

Car number.(Deprecated. Changed to parameter PlateNumber)




PlateNumber

string

Car number




RawPlateNumber

string

Car number not processed by rules




UnicodePlateNumber

string, hex encoded

Car number, unicode. Example: "BÜ 1234" === 0x0042 0x00DC 0x0020 0x0031 0x0032 0x0033 0x0034 => "004200DC00200031003200330034"




ZoneIndex

int: 0..3

Zone number




ChannelIndex

int: 0...

Channel number




KPP

int: 0...

Checkpoint number. (Deprecated. Changed to parameter ChkPoint)




Checkpoint

int: 0...

Checkpoint number




PlateTTL

int

Time of plate lost




SymbolsCount

int

REMOVED !




SymbolThreshols

float: 0.0..1.0

REMOVED !




PlateConfidence

float: 0.0..1.0

Confidence of plate recognition




SymbolConfidence_%1

int: 0..SymbolsCount-1, float: 0.0..1.0

REMOVED !




PlateConfidenceAverage

float: 0.0..1.0

REMOVED !




CoordsX

int

Plate's X - coord relative to frame. (0;0) - top left corner




CoordsY

int

Plate's Y - coord relative to frame. (0;0) - top left corner




CoordsWidth

int

Plate's width (pixels)




CoordsHeight

int

Plate's height (pixels)




EtalonId

unsigned long long

Primary key from CARS table




Owner

String

Description




PassMode

int

Pass type ( 0 - Deny, 1 - Allow )




PassBits

unsigned short

Calculated pass value, bits




PassIntervalStart

uint64

REMOVED !




PassIntervalEnd

uint64

REMOVED !




MovementTypePrevious

string

Type of previous movement




uMovementTypePrevious

int

Integer type of movement (correspond with MovementTypePrevious)




LastMovementDetector

int

Integer type of movement detector (correspond with LastMovementDetectorText)




LastMovementDetectorText

string

Type of movement detector




DetectedTimestampMS

uint64

UTC Date/Time of plate detection, milliseconds (in range Detected-Updated-Lost)




LastTimestampMS

uint64

UTC Date/Time of last detection of plate (in range Detected-Updated-Lost)




Country

text

Country




ISO3166

uint16_t

ISO 3661 Country Code




District

string, hex encoded

District code, unicode. Example: BÜ === 0x0042 0x00DC => "004200DC"




FirstTimeStampMs

uint64

UTC Date/Time of the first detection of the plate (in range Detected-Updated-Lost)




PlateStandartTxt

text

Plate model ( like LLL-NN-LLL, where L - letter, N - digit )




Latitude

float

GEO Latitude of camera




Longitude

float

GEO Longitude of camera




CarBrandLocalIdx

uint

Internal brand index. Look at table MMR_BRANDS in the database.




CarBrand

string

Brand text




CarModel

string

Car model




CarType

uint16_t

Car type integer




CarTypeText

string

Car type string




CarColor

uint16_t

Car Color integer RGB




CarColorText

string

Car Color string

Channel status


Status

VideoSignal



Channel status




Channel

int

Channel number ( 0, 1, ...)




State

string (Lost | Present)

Status




IntState

int (0 | 1)

Integer status: 0 == Lost, 1 == Present

Barier control


Barier

Command

Checkpoint

int (0...)

Checkpoint number




Command

string (Open | Close)

What to do with checkpoint: Open or Close

Alarm event


AlarmEvent

Reaction



Reaction event




TimestampMS

int64

UTC time stamp of event, milliseconds since 01.01.1970




AlarmDbID

int64

Primary key for table EXECUTED_EVENTS




AlarmTypeInt

int(1-Recognition, 2-CheckPoint, 3-Parking, 4-Frequency, 5-TrafficRules,6-AvgSpeed)

Integer event type




AlarmTypeStr

string (Recognition | CheckPoint | Parking | Frequency|TrafficRules|AvgSpeed)

String event type




AlarmShortParams

string

Short event's parameters




AlarmText

string

Text of alarm event




RuntimeID

int64

Internal object's index




LprEventID

int64

ID from table LPREVENTS




EtalonId

int64

ID from table CARS




GroupID

int64

ID from table GROUPS




GroupName

string

Group name




Plate

string

Plate number




PlateU

string

Unicode plate number




PlateCountry

string

Country/-ies




iso3661Id

int

ISO 3661 Country Code




ChannelIndex

int(0...)

Channel number




ZoneIndex

int(0..3)

Zone number




ChannelDesc

string

Channel description




Chkpoint

int(0...)

Checkpoint number




MovementInt

int

Movement int value




MovementStr

string

Movement string value (Undetermined - 0, Attempt to enter - 1, Entry - 2, Attempt to exit - 4, Exit - 8)




ParkingID

int64

ID from table PARKINGS




ParkingNum

int

Parking number




Latitude

float

GEO Latitude of camera




Longitude

float

GEO Longitude of camera




ChannelIndex2

int(0...)

Channel number ( point 2 for Average speed )




ZoneIndex2

int(0..3)

Zone number ( point 2 for Average speed )




ChannelDesc2

string

Channel description (for second point)




Latitude2

float

GEO Latitude of camera of the 2-nd point for Average speed




Longitude2

float

GEO Longitude of camera of camera of the 2-nd point for Average speed




TimestampMS2

int64

UTC time stamp of event point2 for Average speed, milliseconds since 01.01.1970




AvgSpeed

float

Average speed value




RuntimeID2

int64

Internal object's index ( for second point )




LprEventID2

int64

ID from table LPREVENTS ( for second point )

Parking control


Parking

PlacesTotalUsed







ParkingName

string

Parking human name




ParkingID

int64

Parking database ID




Total

int:int:

Total places on parking: total:used:




Violators

int

Violators count




NotInDB

int:int:

Not in database places: total:used:




Name_of_Group

int64:int:int:

Places for group: GroupID:total:used:





    • Related Articles

    • TCP Integration

      Preparations Set up NumberOk to recognize license plates. You will notice LP overlay accompanying vehicles under View tab when recognition is tuned up properly. TCP Integration settinga Basic settings Go to Settings > Analytic. Check Analytics: ...
    • LPR Cameras Connection (NumberOk META)

      1. Adding LPR camera in NumberOk Meta Navigate to Settings > Integration > LPR Cameras Click Add Camera button. Add LPR camera dialog will open. Complete the dialog with the following: Camera type - FF group protocol Describe your camera Specify ...
    • Managing NumberOk via DataBase

      Intro Managing NumberOk via FireBird database is considered an unsupported non-documented method. The database is accessible from outside NumberOk and access to the database should be restricted on OS and file system levels. NumberOk vendor doesn’t ...
    • Running NumberOk as an operating system service

      There is a possibility to run NumberOk as a service to better integrate it into distributed computation systems running on server platforms. As a service, NumberOk is better integrated to a multi-threaded environment, optimized to work with TCP/IP ...
    • German Special Characters Transfer via TCP/IP Integration

      Specific German characters (e.g., ü, ö) are transferred via TCP/IP in a particular format. To correctly process these characters, check two fields: RawPlateNumber and UnicodePlateNumber. License plates containing special German characters should be ...