SDK driver integration

The SDK driver must be installed on the client for integration with devices that use the SDK to occur successfully. This driver monitors communication (online or offline) with all devices connected to it, sends them data and information and carries out the necessary procedures for their integration with the system.

To obtain the SDK driver:

1. Register on the login screendrivers and select the itemSDK in the fieldDriver type;
2. Then access the screenDownloads to download this driver;
3. Unzip the driver;
4. So that the driver can be started and stopped using the start-service.bat and stop-service.bat files, respectively, create this service in Windows using the create-service.bat file. Executing this .bat file must be done as a Windows administrator user.

An SDK driver may also require certain information to be registered, depending on the devices it will support. This registration must be done on theextensible properties and then selected in the drivers screen. For more information about the required properties, check the device manufacturer's documentation.

Driver configuration is done in the config.properties file, which is located in the directory where the driver was unzipped. This file can also be obtained by clicking the buttonDownload configuration file from the drivers screen. The file has the default settings already filled in, but if it is necessary to change any of its fields, use a text editor (Notepad, for example) to open it.

Links used by the Proxy SDK:

• http://sam.senior.com.br/download/driver_sdk/version.properties
• http://sam.senior.com.br/download/driver_sdk/last/SDKProxy.zip
• wss://sam-api.senior.com.br/websocket/pendency
• https://sam-api.senior.com.br/sdk/v1

• proxy.driver.port: port that detects driver connections;
• sdk.host: access address to Ronda senior X followed by the port and other parameters, which refer to driver connection plugins. This information may be changed with the creation of new plugins. The default value of this key is "https://sam-api.senior.com.br/sdk/v1" and can be changed if Ronda senior X is run on-premises or on a private cloud server;
• sdk.connection.timeout: maximum time, in milliseconds, for which the driver waits to establish a connection with the Ronda senior X;
• sdk.request.timeout: maximum time, in milliseconds, from the driver's pending query interval to Ronda senior X. The minimum value is 5000 using websocket, or 10000 without websocket;
• sdk.api_response.timeout: maximum time, in milliseconds, for which the driver waits for a response from a service requested from Ronda senior X;
• sdk.driver0.driver_key: driver token (available in driver registration). The proxy uses this token to identify the driver within the Ronda senior X. If it does not find the keysdk.driver0.driver_key, the proxy assumes that there is no driver configured.

The proxy supports management of multiple drivers, always starting with the keysdk.driver0.driver_key, incrementing the index to find a new key. For example,sdk.driver1.driver_key, sdk.driver2.driver_key , and so on, until the next index is not found.

These settings are sent to devices when the SDK driver starts and when the commandConfigure device is sent to the system.

Information about people, badges, locations and access permissions is sent to the device whenever there is an addition, change or deletion to this data. "Access permissions" correspond to all the data that defines whether a person can access a device: roles, levels, time slots and the like. Only people who have access allowed on the device and are not blocked are sent.

When sending this information and settings to devices, if communication is offline, this data will be sent the moment communication is re-established.

The procedures carried out by the SDK (Software Development Kit) driver are recorded in fileslog, which can be accessed within the folder where the driver is installed. Each message fromlog has a classification among the following:

• FATAL: messages that interrupt the operation of the application, forcing the service or executable to be restarted;
• ERROR: application malfunction messages, which must be analyzed by Senior's technical team, however, the service or executable continues running;
• WARN: messages that indicate failure in registrations or system configurations. They must be analyzed by the system administrator;
• INFO: normal system operation messages, such as event received, pending issue sent, etc., for informational purposes;
• DEBUG: messages about the internal functioning of system components (such astimer initiated, parameters read, etc.) for informational purposes to the Senior technical team. This level oflog it should only be enabled in case of problems with the environment;
• TRACE: messages about the internal functioning of system components, with details of the data being processed.

Applications generate a file in the LOG folder containing the logs oflog. When reaching 10 MB, this file is automatically compressed and placed in a folder.backup, creating a new log file in the LOG folder.

The folderbackup created has its name changed to the current date of compression of the file.log and, as it is cyclical, it holds a maximum of ten allocated files, replacing the oldest file when there is a new file that exceeds the maximum capacity.