Devices

Default diagram

The default structure of Apollo devices begins with a master controller and requires one or more controller modules to be registered directly below. Input devices, output devices and readers must be registered under a module. These devices cannot be direct children of the master controller.

A reader may also have child devices: input and output devices related to it.

Considering the structure shown in this diagram:

• Reader 1 may reference (in activations, for example) Input Device 2 and Output Device 2, as they are its child devices;
• Reader 3 cannot reference any input or output device;
• Reader 2 also cannot reference any input or output device;
• Input Device 1 and Output Device 1 can only be referenced by their parent module (Module 1). They cannot be referenced by the readers that are on the same level.

All input and output devices can answer requests from any device which is on the same hierarchy. Input Device 2, for example, can answer requests from Reader 1, from Module 1 and from the Master Controller device.

Procedures

To add an Apollo device from scratch, follow the procedures below.

1. If you already have an Apollo driver registered, go to step 5. Otherwise, on the main menu, go to Access control > Devices > Drivers;
2. Click on the Add button;
3. Fill in the fields which are shown on the screen. On the Manufacturer field, select "Apollo";
4. Click on the Save button;
5. You must also register the physical locations where these devices will be installed. If the locations are already registered, go to the next step. Otherwise, register the physical locations before proceeding;
6. On the main menu, go to Access control > Devices > Devices and click on Add master controller;
7. Fill in the fields which are shown on the screen. In the Driver field, select a registered driver of the Apollo manufacturer;
8. Fields specific to this manufacturer will be displayed on the screen. Fill them out according to the information provided by the manufacturer;
9. Apollo master controllers must have at least one port registered. In the Port item, activate one of the options;
10. A window will show up and display the fields specific to ports. Fill them out and close this window;
11. Optionally, modify the access messages and the events monitored by this master controller;
12. Click on Save to finish the master controller registration. In the main device screen, this master controller will be displayed in the Hierarchy list.

To add a module, an input device, an output device or a reader, check the Add sublevel item.

Apollo device readers may also have input and output devices as sublevels. To register them, just click on the Add sublevel button while viewing a reader register.

Default diagram

The default structure of SDK (Software Development Kit) devices starts with a master controller and allows input devices, output devices and readers to be registered right under it. There are no modules in SDK devices.

Unlike Apollo, an SDK device reader cannot have children. The sublevel types which can be added will depend on the Master controller type defined for this device:

SDK device type	Reader	Input device	Output device
Access control	Has	Has	Has
REP* device (time control)	Has	Does not have	Does not have
Collector	Has	Has	Does not have

Considering the structure shown in this diagram:

• Reader 1 can make a reference to (in activations, for example) Input Device 1, Output Device 1 and Reader 2;
• Reader 2 can make a reference to Input Device 1, Output Device 1 and Reader 1.

Devices can reference others which are on the same level, and the same input/output device can be simultaneously referenced by more than one reader.

Procedures

To create a device SDK from scratch, follow the procedures below.

1. If you already have an SDK driver registered, go to step 5. Otherwise, on the main menu, go to Access control > Devices > Drivers;
2. Click on Add;
3. Fill in a Description and in the Driver type field, select "SDK";
4. Click on the Save button;
5. You must also register the physical locations where these devices will be installed. If the locations are already registered, go to the next step. Otherwise, register the physical location before moving on;
6. Also, if the device to be registered is for time control (REP device), its properties must be registered. If they are already registered or if the device is not an REP device, go to step 10. Otherwise, go to Access Control > Devices > REP properties;
7. Click on Add;
8. Fill in the fields which are displayed on the screen, according to the company information and click on Save;
9. Go to Access control > Devices > Devices and click on Add master controller;
10. Fill in the fields which are shown on the screen. In Driver, select a registered driver of the SDK manufacturer;
11. In Master controller type field, you will define the type of the device which is being registered: access control, REP device (time control) or collector;
12. Fields specific to the chosen type will be displayed on the screen. Fill them out according to the information provided by the manufacturer;
13. If it is an REP device, define the REP Properties previously registered and the Tax number of the company so that it is printed on the clocking event receipts;
14. Optionally, modify the events monitored by this master controller. If it is an access device, its access messages can also be modified;
15. Click on the Save button to finish the master controller registration. In the main device screen, this master controller will be displayed in the Hierarchy list.

To add an input device, output device or reader, click on Add sublevel and then on the desired item. This button can be found on the master controller registration screen and on the main device screen, where the master controller must be selected in the hierarchy list. The options shown will depend on the Master controller type, as mentioned above on the Default diagram.

Then, fill in the fields shown on the screen, which will be different according to the registered device, and click on Save. Repeat these last steps as many times as necessary, to register all the child devices of the master controller.

There are several types of devices that can be registered. Each type has different fields to be filled in, according to their operation. Furthermore, managing devices have amanufacturer driver (Apollo or SDK) which also changes how it works and how it must be registered.

1. On the senior X Platform, access Access and Security Management > Access control > Devices;
2. click inAdd manager, the main device that controls the other devices and has information such as network configuration, for example;
3. Add a Description and select a Driver. The fields that will be displayed to be filled in depend on this selection;
4. If the document requires aUser It isPassword access (for example, a camera used in theLPR), fill in these two fields;
5. Select a Physical location and a Communication port, i.e., the port of the device which is able to receive TCP-IP connections;
6. In the Network identification, enter an identification to access the server, like its name, for example;
7. Write the Display message, i.e., the default text which will appear on the device display when there's no access event or other type of situation happening;
8. Select a Master controller type. Depending on the selection, different fields will be displayed to be filled in:
   • Turnstile bypass time in seconds: set the time that must pass for a turnstile bypass event to be generated. This field is only available for access control devices (Apollo or SDK);
   • Maximum number of cards in panel: define the maximum number of ID cards that will be controlled simultaneously by the device. This field is only available for Apollo devices;
   • Type of controller: manufacturer Apollo has several device models, such as controller boards and master controllers. Select here the controller model that corresponds to the registered device. For more information, check the manufacturer documentation. This field is only available for Apollo devices;
   • Ports: the port configuration fields are displayed when one of the device ports is activated. They must be completed in accordance with specifications provided by the manufacturer for this device;
   • Access messages: Enter the text that will appear on the device display when each access event occurs. In addition to customizing each message, you can also define if it will show the date and time and/or the ID card number. These messages are only available for access control devices (Apollo or SDK);
   • REP device properties: select the REP device additional properties, which must be previously registered with the information of the company where the device will be used. The Fiscal number of the company must also be provided, as it will be printed in the clocking event receipt. These fields are only available for REP devices;
   • REP-P Properties: as in the item above, select the additional REP properties, which need to be registered previously. For REP-P, only companies with registered CNPJ will be shown. Also enter the fieldsLatitude It is Longitude, with the device's location positions, to integrate with Ponto Mobile. These fields are only available forREP-P devices
   ;
9. Select the Extensible properties, which must be previously registered according to the specifications provided by the manufacturer;
10. In the Monitored events section, indicate, for each event, whether it will generate a monitoring occurrence. You can select anytype of occurrence registered and associate it with an occurrence so that it is considered an occurrence of that type, appearing in monitoring whenever such an occurrence occurs;
11. When the manager type is access controller, the screen will display the Monitored access section. It must indicate which types of access should generate occurrences, the types of occurrences and whether they should trigger emails;
12. Click on Save.

On the senior X Platform, access Access and Security Management > Access control > Devices > Devices, Hierarchy section, click on the registered device and clickAdd sublevel. Select the desired option:Reader,Prohibited orExit. Each registration type shows different fields to be filled in.

Reader registration

The reader is responsible for identifying people, vehicles or materials by reading credentials. A reader must be a child of a manager or a module and cannot have child devices.

1. After selecting the optionReader, fill in aDescription, select theTechnology that it will use (bars, proximity, Smart Card, Biometrics, QR Code, logical device and LPR camera) and a Physical location;

2. Inform theAddress of the device this reader is connected to. This value must be unique for each reader under the same parent device;
3. Select the Extensible properties, which must be previously registered according to the specifications provided by the manufacturer;
4. Indicate the Access direction. If this direction is "Entry" or "Exit", validation will always be done for thePhysical destination location. If the access direction is set to "Both", thePhysical destination location should be the place of entry and the Physical location of origin, the exit. Validation regarding where you are going, in this situation, will consider these locations;

5. The Check vacancy field is only available for access control devices (Apollo or SDK). Both entry and exit are counted depending on whether the credential is passed. If you want to define an automatic blocking for when there is no vacancy available, create a customized access validation.
6. Define whether the system Requires vehicle validation;
7. If it is necessary to generateNotifications When someone accesses through this reader, select the optionGenerates presence notification;
8. Check the Temporary blocking option to make the person's exit be blocked when the temporary credential is read by the reader, and the person must then go to the reception to be able to leave. It is only shown for readers with the Access direction being "Exit" or "Both" and, when checked, the Automatic write-off field cannot be checked.
9. The Automatic write-off is only valid for devices with a card collection box (even in case of sensors with a card collection box). After the temporary credential is put into the card collection box, it is written off and becomes available to be used by another person. This option is only shown for readers with the Access direction being "Exit" or "Both" and, when checked, the Temporary ID card block field cannot be checked.
10. If the selected Technology is Biometrics, select the Biometrics type, that is, the format of the biometric template that will be used by this reader, and the Conference level, a percentage measured by the number of points of the fingerprint template that will be analyzed by the system;
11. The 1:N Validation allows you to set the validation method used by biometric readers in relation to the ID card readers. There are two methods:
    • 1:1: the ID card and the biometry are used together. An ID Card reading must be carried out, followed by a biometry reading;
    • 1:N: the biometry alone can be used, with an ID Card reading not being needed.

Check this field to use the 1:N validation. Otherwise, the 1:1 validation will be used. This field is only displayed for biometric readers. When using the 1:1 method, the biometrics must obligatorily be validated after the ID card (people without biometrics will be blocked). However, if this option is checked, the biometrics validation will only be required if the person has registered biometrics. People who do not have biometrics registered only need to use the ID card. This field is only displayed for non-biometric readers;

12. In the Activations section, one or more output devices may be selected to be activated when this reader grants or denies accesses, as long as there is at least one output device registered for this master controller. These activations are only available for access control devices (Apollo or SDK);
13. Indicate the Access time, that is, how much time a door or turnstile must stay open for the access, and the Time to generate open door alarm, which is the tolerance period until an open door alarm is generated, if the door does not return to the standard state. These fields are only available for Apollo devices;
14. The Works in parity field allows you to configure two readers from the same module to work in a pairing, releasing the same physical blocking. For boards of the AIM type, only the AIM4SL and AIM2SL boards execute pairing validations. This field is only available for Apollo devices;
15. Indicate the type of validation that must be performed for the operation modes (Online validation type and Offline validation type) with this master controller. These fields are only available for Apollo devices;
16. Select the Card format that will be used with the reader. This field is only available for Apollo devices;
17. Click on Save.

Note

The ID cards in the memory of the reader modules are only necessary when the module has no communication with the master controller (AAN). In this case, when performing an access, the module can make the validation based on the information of the ID card in the memory. For this to happen, the Offline validation type of the reader must be set as "ID card".

Input device registration

The input device is responsible for monitoring the state of the alarm sensors. An input device can be a child of a master controller or a module, and it cannot have any child devices.

1. After registering a device, click on Add sublevel. If the device is already registered, click on it and then on Add sublevel;
2. Click on Input device, enter a Description and select a Physical location;
3. Enter the Address of the device to which this input device is connected. This value is unique for any child device;
4. In Activation delay, indicate the tolerance time before the alarm is activated;
5. Select a Default state of the device;
6. Select the Extensible properties, which must be previously registered according to the specifications provided by the manufacturer;
7. Select oneType of occurrence registered in advance and yourPriority, which will affect how this occurrence is shown in theMonitoring;
8. In the Activations section, one or more output devices may be selected to be activated when this input device is activated, as long as there is at least one output device registered for this master controller;

Note

Masking is used in situations where it is necessary to deactivate the digital input or alarm signal for a period of time. For example, a presence sensor has no need to be active during the working hours, when people circulation in the location is expected. To do this, it is possible to define time bands in which the digital input or alarm signal will be inactive.

Select the days of the week and timeslots to be masked. The alarms that occur during this period won't generate any alarms or reactions.

9. Click on Save.

Output device registration

The output device is responsible for triggering equipments such as sirens, magnetic clasps, gates and others, according to the defined configuration, by emitting electrical pulses when triggered. An output device can be a child of a master controller or a module, and it cannot have any child devices.

1. After registering a device, click on Add sublevel. If the device is already registered, click on it and then on Add sublevel;
2. Click on Output device, fill in a Description and select a Physical location;
3. Enter the Address of the device to which this output device is connected. This value must be unique for any child device;
4. Select a Default state of the device;
5. Select the Extensible properties, which must be previously registered according to the specifications provided by the manufacturer;
6. Click on Save.

Module device registration

This device type is an extension of the master controller device and acts as an interface between said device and peripherals, such as readers. The module must be the child of an Apollo master controller (it is not available for SDK devices) and may be the parent of input devices, output devices and readers.

Fill in the Address with the information obtained from a document provided by the manufacturer, where the unit value in the document must be incremented by one.

Apollo has several device models, such as controller boards and master controllers. In Controller type, select the controller model that corresponds to the registered device. For more information, check the manufacturer documentation.

Select the Port (defined in the master controller registration) in which this module is located. Only ports configured in the master controller will appear as an option in this field. Then click on Save.

Keyboard device registration

Some manufacturers use a keyboard in the device, which is enabled via this registration.

The keyboard can be used to make configurations and register biometries directly on the device, however it cannot be used to access locations.

1. After registering a device, click on Add sublevel. If the device is already registered, click on it and then on Add sublevel;
2. Click on Keyboard, fill in a Description and select a Physical location;
3. Enter the Address of the device to which this keyboard is connected. This value must be unique for any child device;
4. To enable the keyboard, click on Active;
5. Click on Save.

Consult hierarchy of all registered devices and their sublevels, in a tree view. Initially only master controllers are shown (initial devices, which don't have a parent device). To show the child of an item, click on the arrow to the left of its name.

The Add master controller button is always available and allows you to create a new initial device. Upon selecting an item from the hierarchy, the Add sublevel and View buttons are displayed. They allow you to create a new child device for the selected item and to view or edit its information, respectively.

The search box of the Find Device item allows you to find an item without needing to look for it in the tree. When selecting a search result, the visualization screen is shown.

If the Show inactive devices option is unchecked, only active devices will be displayed on the screen. If it is checked, active devices will be displayed, as well as inactive ones.

In Device Consultation, click on the desired device and then on View. The visualization screen can also be accessed right after finishing the creation of a device. The registered information is displayed here, as well as which other devices are linked to it.

In this screen, Command sendings may be carried out by selecting a command and sending send it to the device to execute certain operations on it. For more information, check the list of commands.