Object hierarchy to support device configuration in physical access control systems
Example implementations include a method, apparatus, and computer-readable medium for configuring a device in a physical security system via an open architecture. The device receives a command from an application via a publish-and-subscribe broker. The command includes: a type field indicating the command, a source field indicating the application, a timestamp, and a payload including a list of objects, each object including one or more parameters defined by a field name, a datatype, one or more possible values, and a mandatory status. The device transmits an event message to the application via the publish-and-subscribe broker, the event message includes a type field identifying the event message, a source field identifying the device, a timestamp, and a payload including a type field identifying a type of event.
1 . A method comprising:
receiving, at a device, a command from an application via a publish-and-subscribe broker, the command including:
a type field indicating the command, a source field indicating the application, a timestamp, and a payload including a list of objects, each object including one or more parameters defined by a field name, a datatype, one or more possible values, and a mandatory status; and
transmitting, from the device, an event message to the application via the publish-and-subscribe broker, the event message including:
a type field identifying the event message, a source field identifying the device, a timestamp, and a payload including a type field identifying a type of event.
2 . The method of claim 1 , wherein the one or more parameters of a first object in the list of objects include a parameter that references a second object defined in the command or in another message.
3 . The method of claim 1 , wherein the list of objects includes an object corresponding to the device, the one or more parameters for the object include a method performed by the device, and the value associated with the parameter indicates which method to perform.
4 . The method of claim 3 , wherein the object corresponding to the device includes additional parameters defining parameters of the method.
5 . The method of claim 1 , wherein the list of objects includes an object corresponding to a configuration of permissions, schedules, or an interface of the device.
6 . The method of claim 1 , wherein the list of objects includes an input configuration or an output configuration that indicates a method to be performed at an input of the device or an output of the device.
7 . The method of claim 1 , wherein the type of event of the event message is an object status event including a code indicating whether an action corresponding to the command was performed on an object.
8 . The method of claim 1 , wherein the type of event of the event message is an object information event including information for an object stored at the device.
9 . The method of claim 1 , wherein the type of event of the event message is an activity report event identifying a change in the device and including an identifier of the device, a type of activity, a timestamp and one or more additional parameters specific to the type of activity.
10 . The method of claim 1 , wherein the event message indicates a periodic heartbeat signal to maintain a session between the device and the application.
11 . A configurable security device, comprising:
one or more non-transitory memories storing computer executable instructions; and
one or more processors coupled to the one or more memories and, individually or in combination, configured to cause the device to:
receive, at the device, a command from an application via a publish-and-subscribe broker, the command including:
a type field indicating the command, a source field indicating the application, a timestamp, and a payload including a list of objects, each object including one or more parameters defined by a field name, a datatype, one or more possible values, and a mandatory status; and
transmit, from the device, an event message to the application via the publish-and-subscribe broker, the event message including:
a type field identifying the event message, a source field identifying the device, a timestamp, and a payload including a type field identifying a type of event.
12 . The configurable security device of claim 11 , wherein the one or more parameters of a first object in the list of objects include a parameter that references a second object defined in the command or in another message.
13 . The configurable security device of claim 11 , wherein the list of objects includes an object corresponding to the device, the one or more parameters for the object include a method performed by the device, and the value associated with the parameter indicates which method to perform.
14 . The configurable security device of claim 13 , wherein the object corresponding to the device includes additional parameters defining parameters of the method.
15 . The configurable security device of claim 11 , wherein the list of objects includes an object corresponding to a configuration of permissions, schedules, or an interface of the device.
16 . A method comprising:
transmitting a command from an application to a device via a publish-and-subscribe broker, the command including:
a type field indicating the command, a source field indicating the application, a timestamp, and a payload including a list of objects, each object including one or more parameters defined by a field name, a datatype, one or more possible values, and a mandatory status; and
receiving an event message from the device at the application via the publish-and-subscribe broker, the event message including:
a type field identifying the event message, a source field identifying the device, a timestamp, and a payload including a type field identifying a type of event.
17 . The method of claim 16 , wherein the one or more parameters of a first object in the list of objects include a parameter that references a second object defined in the command or in another message.
18 . The method of claim 16 , wherein the list of objects includes an object corresponding to the device, the one or more parameters for the object include a method performed by the device, and the value associated with the parameter indicates which method to perform.
19 . The method of claim 16 , wherein the object corresponding to the device includes additional parameters defining parameters of the method.
20 . The method of claim 16 , wherein the list of objects includes an object corresponding to a configuration of permissions, schedules, or an interface of the device.