Example of the server configuration for a basic project

Owned by BAS-IP (Unlicensed)
Last updated: Jun 03, 2024
18 min read

Here you can find an example of a complete server (with SIP) configuration for 1 house project: 

1. Configure basic server settings for the correct functioning:

2. Add user profiles for various users and configure their permissions. 

In general, 3 profiles are enough for the basic project, and they are created by default:  

  • administrator controls the whole system and has all possible permissions to perform system installation, configuration, and support.

  • concierge interacts with residents and visitors, manages access conditions, and sends announcements and messages: announces (can create/edit/delete/send announces, can view particular announces); calls (can receive call like concierge, can call to intercom); conversations (can create conversation/conversation message, can accept messages from descendant users); devices (can view devices, can view device events); elevators (can view elevators); emergency alerts (can view emergency alerts, can playback emergency alerts); group types (can view group type); markers (can view marker). 

  • user is a profile for residents with the following permissions: access restrictions (can view/create/delete access rules); announces (can particular announces); calls (can call to intercom); conversations (can create conversation/conversation message); devices (can view devices/all devices); group types (can view group type); identifiers (can view particular identifiers; can create/delete identifiers; can create guest identifiers, can export identifiers); profiles (can view available roles only). 

If necessary, you can edit these profiles in the corresponding tab and add other permissions or create new profiles:  

  1. Go to the Profiles tab of the User management section.

  2. Click the plus icon (in the low left corner).

  3. Enter a profile name and add a description (if required).

  4. Select the required permissions.

  5. Save data by clicking the corresponding button in the low left corner.

Also, it is possible to use one server for several small projects, e.g., for some separate areas with few devices. You can read about this configuration by following the link.

3. Add a group for the house/s. 

For example, there is 1 house with 2 units, 20 floors, and 4 apartments on each floor. So, manual group creation for example looks like this: 

  1. Go to the Groups tab in the User management section.

  2. Click Add group and select Add root group.

  3. Enter a group name, e.g. Heathfield House1.

  4. Select сustom for type.  

  5. Add a description, if necessary.

  6. Click the Save button in the low left corner when all required data is entered.

When the root (basic) group is created, you are required to add subgroups for each unit, floor, and apartment. To do this: 

  1. Find previously created root group in the list. 

  2. Click 3 dots near the group name.

  3. Select a new group. A menu for adding a group will open.  

  4. Enter all data that you've entered for the root group, but pay attention that this group stands for unit:   

    • enter a group name, e.g. Unit 1.

    • Select unit for type.

    • Enter a logical address: Unit No., e.g. 1. 

    • Add a description, if necessary.

  5. Click the Save button in the low left corner when all required data is entered.

  6. Repeat steps 1-5 to add a group for the 2nd unit. Pay attention, logical address must differ for the 2nd unit. 

  7. Repeat steps 1-5 to add subgroups for 20 floors in every unit and 4 apartments on each floor. Select the corresponding group type. Pay attention, that subgroups for floors must be added to a unit group, and subgroups for apartments must be added to a floor group.       

As a result, you will receive the following hierarchy: 

Also, you can enter data about groups you are required to create and they can be generated automatically. Detailed steps you can read here or watch the video.    

Further, you must add users and devices to the required subgroup (unit/floor/apartment) and set access restrictions for them.  

4. Add users to the system.   

All residents and service staff must be added to the Link: 

  1. Open the User tab of the User management section.

  2. Click the plus icon in the low left corner.

  3. Enter a user name.

  4. Add a user photo if necessary.

  5. Select the user profile (from created in the previous steps).

  6. Enter the user email to send the registration link.

  7. Enter user phone number if necessary.   

  8. If necessary, enter user address.

  9. Add a user to a corresponding group. For example, Mr. Clark lives on the 2nd floor of the 1st unit in Heathfield House1. So, you must add Mr. Clark exactly to this group. 

     

  10. Set available for user licenses that they purchased (this section is available if you have the can edit user licenses permission assigned to your profile).

  11. Click the Save button in the low left corner when all necessary data is entered.

Further, you must add identifiers and set access restrictions for users. 

Applying licenses to users

You can manage user licenses only if the Can edit user licenses permission assigned to your profile. By default, 1 license for an apartment includes 1 mobile app, i.e., only 1 user can use the Link app if 1 mobile app license is applied. So, if there is more than 1 resident in the apartment, you as the administrator must do the following configurations so all users can use the Link app:

  1. Add a user to the Link server as described in the previous section.

  2. Be sure that you are adding the user to the correct group.

  3. Enable and set the number of licenses for mobile application according to the number of apartment residents. 

  4.  Usually, users invite other apartment residents via the mobile app. Wait for the user to add their family members which be displayed in the corresponding section of the user entity. A user added the an administrator is considered as the main. Family members added by the main user are considered sub-users. Family members are automatically added to the main user group. Also, they get the same rights as the one who invited them but cannot invite/remove other users, configure a forwarding queue for an apartment, or subscribe to family members actions. Only the main user has rights to all these features. 

  5. Create identifier(s) for added family member(s) as described here.

  6. If required, create or apply access restrictions to added family member(s). But, we recommend applying access restrictions to an apartment group instead of each user.

As a result, all users have licenses for mobile app and all other required data. 

 

The other possible way of applying licenses is adding users without the mobile app. So, you as the administrator:  

  1. Add all apartment residents to the Link server as described in the previous section.

  2. Be sure that you are adding users to the correct group.

  3. Enable and set 1 mobile application license for each user.

  4. Create identifier(s) for all apartment residents as described here if you skipped it in the 1st step.

  5. If required, or if you skipped it in the 1st step, create or apply access restrictions to all apartment residents. But, we recommend applying access restrictions to an apartment group instead of each user.

As a result, all users have licenses for mobile app and all the necessary data. However, links main and sub-user are lost, and all users added by the administrator are now considered as main. Consequently, they all can invite/remove other users and configure a forwarding queue for an apartment. This may lead to misunderstandings and some features malfunctions. Additionally, subscription to family members actions will not work as no one is considered a family member.  

Also, you must add users for cleaners and security guards completing the previously described steps. Depending on what access they must have, you can add them to the root (house) group, e.g. Heathfield House1, or to the exact unit/floor group. If you add a user to the root group, they can pass only devices added to this root group, so they can only enter the house territory. This variant is appropriate for security guards. If you add user to unit group/s (e.g. a cleaner), they can use devices added to the root and unit group, so they can enter the house territory and unit/s. 

5. Add devices to the system.

All devices (panels, controllers, monitors) must be added to the Link server to associate physical devices with data on the server. To do it:

  1. Go to the Devices tab of the Device management section.

  2. Click plus icon in the low left corner.

  3. Enter the device name.

  4. Select its type: panel, monitor, access controller.

  5. Select the device model.

  6. Indicate the device Serial number (check the Dashboard tab of the device web interface or device box).

  7. Select a group/subgroup where the device is installed.

  8. Set panels location geodata. This data is required for the Link app, when a visitor with a pass (added to Apple Wallet) approaches the available panel (with location), the pass will be automatically shown.

  9. Add a description, if necessary.

  10. Enable using a camera to identify license plates, if necessary. 

  11. Allow remote lock opening (from the device web interface, via API), if necessary. 

  12. Enter network settings for server and panel interaction:

    • select the MQTT communication protocol.

    • enter the device IP address and port (for HTTP only).

    • enter login and password that are used to enter the device web interface.

    • indicate server interaction password (is created in the Management system section (Network tab) of the device web interface).

Also, the same network settings as for the server must be entered in the device web interface. The management system must be enabled for the device:

  1. Log in to the device web interface. By default, the username is admin, and the password is 123456.

  2. Go to the Network tab > Management system section.

  3. Select the MQTT protocol.

  4. Enter all required data. 

  5. Submit settings.

 Detailed instructions are here.

As an example, there is 1 entrance panel in the Heathfield House1 to access its territory, 1 panel is near the entrance for each unit and each floor, and 1 monitor is in each apartment. So, repeat all previous steps to add each device for the corresponding group. 

Also, you can remotely enter SIP, Network, and Address settings and send them on the device to prepare the device for functioning. More details you can read here. 

6. Add access restrictions for created groups/users.

Access restrictions link devices, users, and schedules (if required) and you can quickly configure giving access or not to these or those devices for concrete users. Access restrictions must be applied to groups with added devices and users.

To create access restrictions, e.g. for users who live in the 1st unit and 1st floor to have access to the Heathfield territory, their unit, and floor: 

  1. Go to the Access restriction tab of the Access management section. 

  2. Click plus icon in the low left corner.

  3. Enter the restriction name.

  4. Enable the possibility to use this restriction for guest identifiers. 

  5. Add description, if required. 

  6. Select devices from the list to allow their use. So, to access the Heathfield territory, 1st unit, and floor, you must select devices added to these areas. 

  7. Select the number of locks (if 2 locks are connected) that are allowed to open by users: the first, the second, or all.

  8. Click the Save button in the low left corner after entering all required data.

  9. Go to the Groups tab and find the corresponding group for which the rule is created. In our case, it is for users who live in the 1st unit and 1st floor, so 1st floor group must be selected. 

  10. Click 3 dots near the group name and select edit.

  11. Select previously created access restriction.

  12. Save changes. 

If you want to apply access restriction to an exact user (e.g. cleaner or security guard), you must: 

  1. Go to the Access restriction tab of the Access management section. 

  2. Click plus icon in the low left corner.

  3. Enter the restriction name.

  4. Add description, if required. 

  5. Select devices from the list to allow their use, e.g workers must have access to all areas. So, you must select all devices located on the object.

  6. Create a schedule to limit active time for users and their identifiers, e.g., workers are required to have access to the areas at the exact time. More details about schedules you can read here. 

    • enter the schedule name.

    • add a description, if required.

    • disable the All day option and specify the date (day/month/year) this schedule is active and set the start and end time of this schedule functioning, e.g. from 9 a.m. till 19 p.m. 

    • select daily repetition of the schedule and workers will have access to the areas every day from 9 a.m. to 19 p.m.

    • save schedule;

  7. Save access restriction. 

  8. Go to the User tab and find the user you want to apply created access restriction. 

  9. Click edit the user. 

  10. In the Access restriction section, select created for the user restriction. 

  11. Save changes.

 

7. Add identifiers for users. 

To provide an identifier for a user, you must: 

  1. Go to the Identifiers tab in the Access management section.

  2. Click the plus icon in the low left corner.

  3. Enter the identifier name.

  4. Select the user of this ID. 

  5. Select the identifier type (pay attention to a device characteristics) and enter its value:

    • card: EM-Marin or Mifare card. In the Identifier field, you must enter a card number in decimal format, without commas. Usually, the number is printed on the card in decimal or hexadecimal format. You can use this link to convert a value from one to another system.

    • UKEY allows using smartphones as identifiers (BAS-IP UKEY app is required). You must enter the identifier number in the Identifier field. 

    • access code that must be entered on the panel keypad to open lock/s. In the Identifier field, you must indicate a numeric code that will be used to open a lock.

    • face ID allows opening the lock by scanning visitors faces. When adding this identifier type, you must upload a user photo with a well-lit face and real face proportions in .jpeg format.

    • the automatically generated QR code. Enable the Download QR code option and after saving the identifier, it will be saved to the computer. Then it must be uploaded to a mobile device for further use.

    • license plates can be added and used to open lock/s. In the Identifier field, you enter the plate number. For this identifier to work, you need either an Axis camera with an ALPR together with a license, Hikvision, or AxxonOne cameras both with ALPR.

For details about the usage of license plates as identifiers, see How to configure license plate recognition.

  1. If necessary, enable and set restriction period restrictions for identifier validity.

  2. If necessary, enable and set the maximum number of passes in the passes restrictions field. 

  3. Select access restrictions from already added, e.g. Entrance panel.

  1. Click the Save button in the low left corner when all required data will be entered. The identifier will automatically be sent to all devices indicated in access restrictions. You can check where ID is added in the Synchronization section.

8. Add and configure an elevator functioning.

If you have a connected EVRC-IP controller, first of all, you must add it in the Devices tab (see step 5 above or check the video with subtitles).

After adding a device, you must configure the controller work: 

  1. Open the Elevators tab of the Elevator management section.

  2. Click plus icon in the left low corner.

  3. Enter the elevator name.

  4. Select a group where it is placed, e.g. Heathfield House1

  5. Tick send elevator controller settings on the device so that the settings data is transmitted to the controller.

  6. Select available mode: Up (an elevator moves only in the upward direction), Down (movement is only in the downward direction), Up and down (both directions are available), Access by identifier (movement only to those floors that are available for the used identifier).

  7. Select relay type: COM-NO/COM-NC.

  8. Set the time during which the relay will be switched.

  9. Set lift release time (during which relay will be closed/opened) for identifier and for API call.

  10. If necessary, enable the switching relay when turning on the device.

  11. You can see the number of available and used relays. For Up and down mode only 8 relays are available, for other modes 16 can be used.

  12. Create a list of floors and corresponding relays for a unit.

  13. To add a floor click plus icon.

  14. Enter Floor No. and Relay No. that connected to this floor at the controller.

  15. Indicate whether the floor is public or not (e.g., ground floor). Users will always have access to the public floor despite their identifier settings.

  16. Select necessary apartments located on the floor (data is automatically taken from the Groups tab).

  17. Click Confirm to add the floor to the list.

  18. Click Confirm to add the controller when you enter all necessary data.

  19. Click the Save button in the left low corner.

  1. Open the Device settings tab of the Device management tab and find the controller.

  2. Check the correctness of settings (if they are the same as entered in the Elevators tab).

  3. Enable send on device feature to transmit entered settings to the controller.

  4. Save changes.

As result, an elevator will be added to the group.

In addition, you can add access restrictions for users and elevators: 

  1. Go to the Access restriction tab of the Elevator management section. 

  2. Click plus icon in the low left corner.

  3. Enter the restriction name.

  4. Add description, if required. 

  5. Select user(s) from the list to whom this restriction will be applied.

  6. Select the elevator that the selected users can use. 

  7. Specify floor(s) to which user/s will have access. Users will always have access to the floor marked as public. 

  8. Click the Save button in the low left corner after entering all required data.

9. Create virtual numbers for users. 

To make a call between devices, users and devices must have virtual numbers. For a user registered in the Link app, a virtual number is created and applied automatically. You can check the number in the user profile. For other devices, you must create a virtual number: 

  1. Go to the Virtual numbers tab of the Telephony settings section.

  2. Click plus icon in the low left corner.

  3. The system will automatically generate a SIP number. Enter a name for the number.

  4. Create the password for the number.

  5. Tick the Active box to turn on the number operating. 

  1. Select the user (from previously added in the User tab) of the number.

  2. Select the device on which the number must be used. If a user will use the number on a mobile device, leave the field blank.

  3. Click the Save button in the low left corner when all required data will be entered.

When you apply a number for a device, the ability to call this device () will appear in the Link app. 

10. Guest access providing.

Temporary identifiers for guests, couriers, taxi drivers, etc can be provided by a concierge in the Link or by a user in the Link app. It's possible to configure areas visitors will have access to, the time and date when the ID will work, and the number of available passes. 

To create a guest pass in the Link (by concierge, for example), the concierge must: 

  1. Go to the Guest access tab in the Access management section.

  2. Click plus icon in the low left corner.

  3. Select ID type: QR code (available for panels with camera), Access code (available for panels with keypad), URL (available for all devices), or a License plate (available for panels and installed Axis camera with Axis License Plate Verifier software).

  4. Select guest type: Courier or Guest.

  5. Select the access restrictions you want to apply for the ID. Selected access restrictions must coincide with restrictions applied to the user is creates the ID.

  6. Tick the restriction period field if it is necessary to limit the ID validity period.  

  7. Indicate the beginning and the ending of the ID active period. By default, the pass works for 1 day.

  8. If necessary, tick the limit the number of passes field.

  9. Enter the available number of passes for this ID. By default, 1 pass is available.

  1. Enter a guest message if required. 

  2. Click confirm when all data is entered.

  3. Copy the link/access code or download a QR code (or pkpass file for adding the QR code to Apple Wallet) and sent it to the guest for further use. 

When you select a QR-code pass, you can share it as an image of the code and all the main information. Visitor can check all the necessary information (validity period, the number of available passes) and has to open it and show for entrance panel scanning.

In addition to the image, the QR code can be shared in a format for adding it to Apple Wallet if you/your visitor use IOS. When receiving a pass, a visitor must open it and press Add button. As a result, the visitor will get access to the pass by opening Apple Wallet.

Also, if some changes about the pass are done on the Link server, the visitor will be notified about it and they will be automatically applied. So, there is no need to send another pass.  

To create a guest pass in the Link app, a user must:

  1. Press Add pass in the Passes tab.

2. Enter the owner name of this pass. If you skip a name, the app will generate it. You also may leave comments if necessary.

3. Select pass type: QR-code (available for panels with camera), Access code (available for panels with keypad), or URL (available for all devices).

4. Select guest type: Courier or Guest.

5. Indicate the beginning and the ending of the pass active period. By default, the pass works for 1 day. 

6. If necessary, set the available number of passes for the identifier. By default, 1 pass is available. 

7. Select the devices to which you want to grant access. For example, the pass can open the door only to the unit only, or also to your apartment. By default, all devices are selected for pass opening. 

8. Press Send to share the pass via any messenger when all data will be entered.

You can send a pass via any messenger or e-mail after pressing Send button when creating a pass. When you select an access code, it will be generated in text with all the necessary information (validity period, the number of available passes) to open the lock.

When you select a link, it will be generated in the URL. A visitor must open it to get information about the validity period, the number of available passes, and the ability to open the lock.

The process of sharing QR codes is described above (how to create a guest pass in the Link). 

The other way to share the pass is to swipe it left anf press share button. Also you can delete the pass. 

For QR-code pass you can edit guest type, pass active period, number of available passes and devices.   

BAS-IP Link app is a perfect addition to the Link software. Detailed information about all features you can read here. Here are the basic ones:

  • a user has a list of available for them places (property objects) with devices. They can watch a stream from entrance panels and/or monitors to check the situation at home or the office. Also, they can open the lock via Bluetooth, and call an elevator to the required floor. 
    Place/s displayed in the menu is a group/s to which the user is added on the Link server. All available devices are also added to the group together with the user. Also, access rules must be applied to the group for its display in the app; 

  • a user can call a device from the list available or get a call from the other device; 

  • a user can provide temporary identifiers for visitors;

  • a user can open the lock via Bluetooth;

  • a user can invite up to 5 family members to share the features of the app;

  • a user can use the app for an Apple watch;