Events - Linux API

From VentureResearchWiki
Jump to navigation Jump to search

Events are generated asynchronously by the devices on the bus and controller and result in immediate notification of the event to the application. There is not a system prompt (“>”) at the end of an Event Packet. Events will not interrupt a command in progress, such as one reporting to ALL devices. However, events can come in before the response starts with the ACK.

Message Structure[edit | edit source]

Events are structured as follows: [EventPriority][EventSource],[EventSpecifier],[EventMessage]<CRLF>

EventPriority[edit | edit source]

Code Meaning
@ RFID Tag Events
! Fatal Events
* Warning Events
- Info Events
= Debug Events

EventSource[edit | edit source]

Possible sources may include: SYS, RFID, ETH, WIFI, IO, or others depending on the device and controller used.

EventSpecifier[edit | edit source]

The specifier is a numeric code to assist the application in determining how to parse the event message.

EventMessage[edit | edit source]

The event message is a human-readable and machine-parseable representation of the event data.


Coding[edit | edit source]

To formalize documentation of coding please use the following guidelines when creating/editing code:


Item Code Usage
Event *e= Name of Event
Category *t= Category of Event
Description *d= Description of Event
Priority *pi Event Priority
Source *sc Source of Event
Specifier *sp Specifier of Event
Message *m Expected Message
See Also *sa= Related Events

Possible Categories[edit | edit source]

Categories
I/O
Info
RFID
RFID (HF) Reader Module
RFID (UHF) Reader Module
Session
System
Trigger Mode

Example[edit | edit source]

The following code:

*e=EXAMPLEEVENT
*t=Example
*d=This is a detailed description of the event.
*pi=!
*sc=SYS
*sp=01
*m=An EXAMPLE has occured.
*sa=EXAMPLEREBOOT

would populate this Example Event page.