Sigur ACS#
The service is designed to interact with the Sigur ACS. The ACS synchronizes employees with the list in the Biometric System and listens to events, based on which it decides whether to open or not to open the turnstile. These events are generated in the VL Access pipeline SendToSigur. The protocol used is HTTP.
- Supports the Sigur ACS version: 1.6.3.18.s.
Supported integration options for Sigur ACS#
Software integrations with Sigur ACS software are implemented for interaction:
- with LP5/CBS for passage of recognized persons through a turnstile/door with a magnetic lock.
- with LUNA CARS for ensuring access control of vehicles when passing through barriers.
The face recognition device generates an event, Access transmits the event to LP5, LP5 processes the event and returns the result to Access for further processing.
User data is transferred from ACS to LP5 using two mechanisms:
- replication - the mechanism for the initial transfer of user data;
- synchronization - the mechanism for periodic transfer of user data when the composition/data of users changes.
For synchronization/replication settings, see the service settings.
If the terminal has no means of outputting data (such as a screen), the SendToDevice pipeline is not required.
LP5 Integration Options#
Each LP5 integration (Table 59) uses the Luna service. Each LP5 integration (Table 60) uses the Luna service.
Table 59. LP5 Integration Options
Integration options with KBS#
Each integration with KBS (Table 61) uses the KBS service. Each integration with KBS (Table 62) uses the KBS service.
Table 60. Integration options with KBS
Integration options with LUNA CARS#
Each integration with the vehicle access control system (Table 63) uses the LunaCars service. Each integration with the vehicle access control system (Table 64) uses the LunaCars service.
TC ACS - Access control system for the vehicle territory using a barrier.
LUNA CARS transmits vehicle detection events to Access for further processing.
Cameras are connected via LUNA CARS.
Table 61. Vehicle access control system integration options
| Additional service | Pipeline |
|---|---|
| Sigur | SendCarsToSigur |
| Sigur + LaurentController | SendCarsToLaurent |
Standard integrations using Sigur#
1․ Sigur integration diagram for passage of recognized persons through a turnstile/door with a magnetic lock. Standard Access components (Figure 94) and (Table 65) are used for integration with Sigur. 1․ Sigur integration diagram for passage of recognized persons through a turnstile/door with a magnetic lock. Standard Access components (Figure 95) and (Table 66) are used for integration with Sigur.
Table 62. Integration Description
| Component | Description |
|---|---|
| 1ф | |
| Person | A person wishing to pass through a passage point. |
| Passage point | A set of components used to control human access. More than one passage point can be connected, limited by the ACS license. A passage point can be used for both entry and exit. Each direction uses its own reader and video data source. |
| Reader | A device for receiving access card data. |
| Controller | A passage point control board. |
| Turnstile | A barrier device for access control |
| Sigur ACS | Central software for working with Sigur. Stores employee data and makes a decision on granting access. |
| Sigur Service | An Access component for processing information from an ACS. |
| Add-on for 2f | |
| Video source | A device for extracting a frame of a person's face. It can be either a biometric terminal (LUNA FAST 4A1 and others) or a camera connected via FaceStream. |
| Device ... | An Access component for receiving data from a video data source. Selected based on the device used. |
| Working with LP5 and CBS | |
| MatchByPhoto pipeline | Access component for interacting with BS |
| SendToController pipeline | Access component for interacting with CBS |
| SendToDevice pipeline | Access component for sending a signal to open a relay to a device and displaying text on the screen |
2․ Sigur integration scheme for providing access control for vehicles when passing through barriers. Standard Access components (Figure 96) and (Table 67) are used for integration with Sigur.
Table 63. Integration description
| Component | Description |
|---|---|
| Vehicle (V) | A car wishing to pass through a point of passage. |
| Point of passage | A set of components used to control vehicle access. More than one point of passage can be connected, limited by the ACS license. A point of passage can be used for both entry and exit. A separate video data source is used for each direction. |
| Controller | Passage point control board. |
| Barrier | A barrier device for access control |
| Sigur ACS | Central software for working with Sigur. Stores vehicle data and makes a decision on granting access. |
| Sigur Service | Access component for processing information from ACS. |
| Video data source | A device for extracting a frame of the vehicle's state registration plate. |
| Device ... | Access component for receiving data from a video data source. Selected based on the device used. |
| Working with LUNA CARS | |
| SendCarsToSigur Pipeline | Access Component for sending events from LUNA CARS to Sigur. Access connects to LUNA CARS Analytics backend using websocket |
| LunaCars Service | Access Component for hardware and software integration, required for communication between LUNA CARS and blocking devices |
Setting up Sigur ACS software#
To launch and set up Sigur ACS software, you must do the following:
1․ Make sure that you are using Sigur ACS software version 1.6.3.18.s or later:
- In the Sigur control program menu, select the menu item "Help" → "About the program".
- Compare the software version with the one indicated on the website www.sigur.com.
- If necessary, update the software to the latest version.
2․ Set up interaction between the integration module and the Sigur ACS software server:
- In the Sigur control program menu, select the menu item "File" → "Settings".
- In the "Edit settings" dialog, go to the "Video surveillance" item (Figure 97).
- Add a video surveillance server (Figure 98).
- Specify an arbitrary server name.
- Server type — «Custom system».
- Click «OK»;
3․ Configure the server parameters (Figure 99):
- "Server address" and "Server port (HTTP)" - used when accessing the server from the ACS via HTTP;
- "Server address" corresponds to the IP address of the machine on which Access is running;
- "Server port (HTTP)" - the port for the integration module (the default value is "9091", if the port is already in use - change);
- "Path to service" specifies the common prefix of paths on the server for all requests from the ACS. This value should be taken from the information block of the Sigur component in Access, the value of the webhook-url field (Figure 100).
- Enable the "Upload photos to servers" flag when using the Sigur service, disable when using the SigurThroughDatabase service.
- Enable the "Receive events from the server" flag.
4․ Enable the face recognition function:
- In the "Edit settings" dialog, go to the "Face recognition" item.
- Check the "Enable face recognition" item (Figure 101).
Setting up access points in Sigur#
If errors occur, restart the Sigur ACS software server so that it can connect to the integration module.
To set up access points in Sigur, you must do the following:
1․ In the side menu of the Sigur management program, select the "Hardware" item (Figure 102).
2․ Select the required access point and set up video surveillance parameters for it (Figure 103):
- "System" - select the name of the created user system;
- "Camera" - select a camera. When you click on the drop-down list, it should display the names of all devices created in Access, this indicates that the integration is working properly and Sigur was able to connect to Access. Select the device that is used to identify the desired access point;
- Activate the flags "Allow face verification" and "Enable face identification";
- Click the "Apply" button.
After this, replication of employees from Sigur should begin. For a description of the replication algorithm, see the section [Diagram of interaction between Sigur ACS and LUNA Access] (#sigur-interaction).
Setting up access modes in the Sigur ACS software#
The ACS has two identification modes in the selected direction:
- 1f mode - based on recognition of the access object's face
- 2f mode - based on the main identification feature (card) and on the access object's face
To set up the software, follow these steps:
1․ In the Sigur control program, in the "Equipment" side menu, select the required access point and go to the video surveillance settings (Figure 104):
To enable 1f mode: activate the "Enable face identification" flag.
To enable 2f mode: activate the "Allow face verification" flag.
2․ Go to the "Modes" tab and, having created a new one or selected the required one from the existing ones, go to the "Special rules" tab (Figure 105):
For operation in 1-phase mode: If access in any of the directions should be provided only by the fact of face recognition, then for the parameters "Face identification at the entrance/exit" set the value "Enabled".
For operation in 2-phase mode: If access in any of the directions should be provided by the fact of presenting the employee's primary ID and the fact of recognition of his face, then for the parameters "Face verification at the entrance/exit" set one of the following values:
- Soft — let in anyway. After identification by the main feature (presenting the card), the system grants access if it is possible according to other criteria, even if the person never appears in the frame. Such access permission will be accompanied by the event "Face not recognized".
- Hard — let in only if there is a match. After identification by the main feature (presenting the card), the system checks whether the person's face was recognized in the frame during the time specified in the settings before the event, and if not, waits for the person to appear in the frame within 5 seconds. If the person still does not appear in the frame, access is not granted. The "Surveillance" tab in the software displays the event: "Access denied. Face not identified."
- Strict group - skip only if matched with a face from the department. After identification by the main feature (presenting the card), the system checks whether the person's face was recognized in the frame during the time specified in the settings before the event, and if not, waits for the person to appear in the frame within 5 seconds. The detected face is checked for compliance with any of the faces located in the same department as the identified object. If the person still does not appear in the frame, access is not granted. The "Surveillance" tab in the software displays the event: "Access denied. Face not identified."
- Soft group — skip if there is no match with the person from the department. After identification by the main attribute, the system grants access if it is possible by other criteria, even if the person of the identified person or any other subject of the same department has not appeared. Such access permission will be accompanied by the event "Person not identified".
Methods of interaction with Sigur#
An API is used тo exchange data with the ACS (Table 68).
Table 64. Sigur methods
| Method | Description |
|---|---|
| GET /event | Receiving detection events. One-way stream connection in which Access broadcasts detection events to the ACS. |
| GET /getpersons | Get a list of employees from Access. Based on the response of this request, the ACS makes a decision on further adding/updating/deleting employees in Access |
| POST /updateprson | Update employee data in Access |
| GET /removeperson | Delete employee data in Access |
| GET /getchannels | Get a list of event sources in Access, used to configure access directions |
Diagram of interaction between Sigur ACS and Access#
Access acts as a server, and Sigur acts as a client. After configuring the client, Sigur ACS independently executes all requests to Luna Access (Figure 106).
Face detection events
1․ Sigur ACS initiates a GET request: /event to receive face detection events from Access, the connection always remains open. 2․ Access returns events to the connection as they occur. Even if there are no events, Access sends an artificial "Keep alive" event every 5 seconds so that both sides of the connection are sure that the connection is still OK. Access returns a json event object with the fields:
- type - Event type;
- channelId - Channel ID in Access;
- persons - Array with recognition results;
- id - Person ID;
- score - Similarity level as a real number from 0 to 1.
Vehicle detection events
3․ Sigur ACS initiates a GET request: /event to receive vehicle detection events from Access, the connection always remains open (Access sends new events to the ACS as they occur). 4․ Access returns events to the connection as they occur. Even if there are no events, Access sends an artificial "Keep alive" event every 5 seconds so that both sides of the connection are sure that the connection is still OK. Access returns a json event object with the fields:
- type - Event type;
- channelId - Channel ID in Access;
- number - String of the recognized vehicle registration plate;
- direction - Direction of vertical movement of the car in the frame. An optional field, may be absent. If present, it can take the values "up" or "down".
Getting a list of employees
5․ Sigur ACS initiates a GET request: /getpersons to synchronize data with Access. The request is executed when the ACS server starts and when any synchronized data on the ACS side changes. If the request or subsequent requests fail, the ACS will try to repeat the request every 5 seconds until synchronization is completed without errors. 6․ Access returns a json object with the fields:
- id - employee ID;
- photoVersion - Current "photo version" of the employee in Access, the field value is the time the photo was updated in the ACS in timestamp format (unix format);
- name - Employee name.
Employee modification
7․ Sigur ACS initiates a POST request: /updateperson to add or update employee data in Access. The request body contains a json object with the following fields:
- id - employee ID in ACS, an integer from 1 to 2^31-1;
- name - employee name;
- photoVersion - employee's current "photo version" in Access, the field value is the time the photo was updated in ACS in timestamp format (unix format);
- photo - JPEG photo, encoded in base64.
8․ Access searches its database for an employee with the specified id. If such an id exists, then his data must be updated to match the transferred data. If such an id does not exist, then it must be created. If successful, Access returns HTTP status 200. OK. If unsuccessful, the ACS will prematurely terminate data synchronization, i.e. will stop executing updateperson and removeperson requests, the ACS will make a new attempt in 5 seconds. 9․ Sigur ACS initiates a GET request: /removeperson to delete employee data in Access. The request body contains a json object with the field:
- id - ID of the employee to be deleted.
Configuration of the passage direction
10․ Access searches its database for an employee with the specified id and deletes their data. If successful, Access returns HTTP status 200. OK. If unsuccessful, the ACS will prematurely terminate data synchronization; the ACS will make a new attempt in 5 seconds. 11․ The Sigur ACS initiates a GET request: /getchannels to identify channels of video surveillance devices created in Access. The request is executed when the user performs actions in the ACS interface to configure the connection of channels and passage points. 12․ Access returns the json object "channels" with the fields:
- id - channel ID;
- name - Channel name.
The connection of channels and passage points occurs in the ACS user interface.
Sigur FAQ#
1․ Why is the drop-down list in the bio_system_id field empty when configuring the Sigur service connection parameters?
- It is necessary to check the presence of the added biometric system service, it must be of a supported type. Supported types: Luna, CbsMts.
2․ Why is the drop-down list in the luna_cars_id field empty when configuring the Sigur service connection parameters?
- It is necessary to check the presence of the added LunaCars service.
3․ Why did employee synchronization not start after configuring Sigur?
- The following points must be met in order for the data to synchronize:
- Recognition is enabled in the ACS software settings;
- Recognition is enabled in the equipment. The access point settings must have a camera linked and the required mode (identification or verification) checked;
- The employee must have access to this access point;
- The employee must have an access mode in which the required identification mode is enabled;
- Any edit of any employee can be the trigger for starting employee synchronization.