Paxton Net2 API

Events (SignalR)

As we use Angular here at Paxton, this is what we know best. Therefore, we will explain how to get started with SignalR using Angular/Typescript. If you need help setting up Angular, please refer to the official documentation at angular.io.

The Net2 Local Web API uses SignalR 2 for ASP.NET to provide live event reporting. This library has a dependency on JQuery when used in Javascript/Typescript.

The first step is to install these dependencies. You can install the dependencies via NPM using the following command:

npm install jquery signalr

After installing the dependencies, the scripts need to be added to your angular.json file within the scripts parameter. The scripts should be located here:

"node_modules/jquery/dist/jquery.min.js"
"node_modules/signalr/jquery.signalR.min.js"

Now we have the dependencies installed, we can create the service to hold the SignalR logic. This can be done using the Angular CLI with this command:

ng generate service signalr

In the service just above @Injectable, add this line to gain access to the JQuery methods:

declare let $: any;

NOTE: We are not using the strongly typed JQuery character as this prevents the use of the SignalR methods. It is possible to install the JQuery and SignalR types but this is a personal preference and not necessary.

Next we need to create the SignalR Hub Connection and Proxy. The SignalR Hub name is eventHubLocal.

private _connection: any;
private _proxy: any;
this._connection = $.hubConnection('http://108.28.63.84:8080');
this._proxy = this._connection.createHubProxy('eventHubLocal');

To authenticate, you need to attach the access token to the query string for the connection:

this._connection.qs = {token: 'eyJhbGci...obLvVU8A'};

Once created, you can start hooking up the event listeners. There are three end points which can be listen to:

• liveEvents - A live stream of all monitorable events in Net2. This does not include System Events.
• rollCallEvents - A live stream of users being marked safe or unsafe in roll call.
• doorEvents - A live stream of door open/closed status events.
• doorStatusEvents - A live stream of door status updates.

You can hook up the listener like this:

this._proxy.on('[EVENT_NAME]', event => {
  // Do stuff here
}

Event Models:

• liveEvent
• rollCallEvent
• doorEvent
• doorStatusEvent

{
  eventTime: string,
  eventType: number,
  eventSubType: number,
  tokenType: TokenCategory, // (enum - Token = 0, PIN, VehicleReg, Code)
  tokenNumber: number,
  userId: number,
  userName: string,
  deviceId: number,
  areaName: string,
  details: string,
  notificationType: "EventsReportEvent"
}

By default, you will not receive any events from these. You must first prompt the server to push to these endpoints. You can do this by invoking the following methods:

• subscribeToLiveEvents - subscribes to all live events generated by all ACUs.
• subscribeToRollCallEvents - subscribes to the safe/unsafe events in a particular roll call. You must supply the roll call ID as a parameter.
• subscribeToDoorEvents - subscribes to the open/close events of a particular door. You must supply the door address (serial number) as a parameter.
• subscribeToDoorStatusEvents - subscribes to the status updates of a particular door. You must supply the door address (serial number) as a parameter.

You can also unsubscribe from these by prefixing "un" to the method.

You can invoke these methods like this:

this._proxy.invoke('[METHOD_NAME]', '[PARAM_AS_STRING]')