Embed Size (px)
Citation preview
Page 1
Koala Face Recognition Access Platform
Instructions for Use
Contact Information for After-sales Services
Tel: 400-6060-004
Email Address: [email protected]
Website: techsupport.megvii.com
Document Version V3.1.0
Date of Release July 25, 2019
Page 2
All rights reserved.
Without written permission of this company, no organization or individual is allowed to transcribe, reproduce, or distribute in any way, in whole or in part, the contents of this document.
Note:
Any product, service or feature you purchase from Beijing Megvii Co., Ltd. is subject to the company's commercial contracts and terms, and all or part of the products, services, or features described in this document may not be included in the scope of your purchase or use. Unless otherwise agreed in the contract, Beijing Megvii Co., Ltd. makes no statement or warranty, express or implied, regarding the contents of this document.
The content of this document may be updated from time to time due to product version upgrades or other reasons. Unless otherwise agreed, this document is provided as guidance for use only, and no statements, information, and recommendations in this document constitute express or implied warranties of any kind.
Page 3
Contents
1. Product Description ............................................................................................. 6
1.1. Overview .................................................................................................... 6
1.2. Product Architecture .................................................................................. 6
1.3. Hardware Composition .............................................................................. 7
1.4. Software Composition ................................................................................ 8
1.4.1. Koala Customer Management System (Admin) ............................... 8
1.4.2. Koala User Management System (Online) ...................................... 9
1.4.3. Koala Host Configuration (8866) .................................................... 10
1.4.4. TV App ........................................................................................... 11
1.4.5. Access Control Device App ........................................................... 11
2. Frequently Used Functions ............................................................................... 12
2.1. Login Management System ..................................................................... 12
2.2. Create New Company.............................................................................. 13
2.3. Add Device .............................................................................................. 14
2.3.1. Bind Host ....................................................................................... 14
2.3.2. Bind Video Streaming Camera or Face Capture Camera .............. 15
2.3.3. Bind M5/M5E ................................................................................. 15
2.4. Enter Data into Library ............................................................................. 17
2.4.1. Individual Data Entry ...................................................................... 17
2.4.2. Batch Import .................................................................................. 19
2.5. Permission Settings ................................................................................. 20
2.5.1. Access Control Rules .................................................................... 20
2.5.2. Personnel Grouping ....................................................................... 22
2.5.3. Access Control Grouping ............................................................... 23
2.5.4. Period Settings .............................................................................. 24
2.5.5. Holiday Settings ............................................................................. 25
2.6. Attendance Settings ................................................................................. 26
2.7. Face Recognition Access ........................................................................ 27
2.8. View Record ............................................................................................ 28
2.9. Welcome Settings .................................................................................... 29
2.9.1. TV Box Configuration ..................................................................... 29
2.9.2. Change the “Koala User Management System” Theme ................ 32
2.10. Create New Sub-account ......................................................................... 33
2.11. Koala Download Center - Download Official App/Upgrade Package ....... 33
Page 4
2.12. OTA Upgrade ........................................................................................... 34
2.12.1. Upload Upgrade Package ............................................................ 34
2.12.2. Upgrade Device ........................................................................... 35
2.12.3. Upgrade Configuration ................................................................. 36
2.12.4. Upgrade Record .......................................................................... 36
2.13. Import and Switch Language Packages (International Version Only) ...... 37
2.14. Modify IP (8866) ...................................................................................... 39
2.15. Configure Cascade .................................................................................. 40
2.16. Using APIs ............................................................................................... 41
2.17. Customer Directory .................................................................................. 41
2.18. Organization Directory ............................................................................. 43
2.19. Host Directory .......................................................................................... 44
2.20. Host Firmware Version ............................................................................ 46
2.21. Upgrade Management ............................................................................. 47
2.22. Tasks ....................................................................................................... 47
3. Koala User Management System (Online) ....................................................... 48
3.1. Homepage ............................................................................................... 48
3.2. User Management ................................................................................... 48
3.2.1. Employee Management ................................................................. 48
3.2.2. Visitor Management ....................................................................... 51
3.2.3. Yellow List Management ................................................................ 51
3.3. Attendance Management ......................................................................... 51
3.4. History ...................................................................................................... 52
3.4.1. User Records ................................................................................. 52
3.4.2. Non-liveness Attack ....................................................................... 53
3.5. Access Control Management ................................................................... 54
3.5.1. Access Control Device ................................................................... 54
3.5.2. Permissions Management ............................................................. 54
3.6. Welcome Management ............................................................................ 56
3.7. Account Management .............................................................................. 57
4. Koala Host Configuration (8866) ...................................................................... 57
4.1. Host Restart ............................................................................................. 57
4.2. Host NTP Synchronization ....................................................................... 58
4.2.1. Sync Method 1: .............................................................................. 58
4.2.2. Sync Method 2: .............................................................................. 58
4.2.3. POST Callback .............................................................................. 58
Page 5
5. FAQ & Solutions ................................................................................................ 59
5.1. Customer Management ........................................................................... 59
5.1.1. Solution for No Firmware in Host Firmware Version ...................... 59
5.2. User Management ................................................................................... 59
5.2.1. Batch Import Image Quantity Problems ......................................... 59
5.2.2. Insufficient Storage Space for Koala .............................................. 59
5.3. Host Management ................................................................................... 60
5.3.1. API Cross-domain Problems.......................................................... 60
5.3.2. SDK Error in ID Card Quality Detection: LICENSE_NOT_FOUND ....... 60
5.3.3. TX1 Error: Dog Authorization Not Found ....................................... 60
5.4. Hardware ................................................................................................. 61
5.4.1. Limitation on C2\M3002 Routes ..................................................... 61
5.4.2. Param Error Message in Remix Box .............................................. 61
5.4.3. Video Stream Interruption in HiMedia Box ..................................... 61
5.4.4. Capture Setting Options Not Updated After Firmware Upgrade of C3S-123 ................................................................ 61
5.4.5. Method for Exporting System Logs From an Access Control Device ............................................................................. 62
Page 6
1. Product Description
1.1. Overview
The Koala Face Recognition Access Platform is a smart face recognition product designed to provide the best access experience. The platform supports both new deployment and installation based on any existing all-purpose card, and allows you to upgrade from an all-purpose card to access based on facial recognition.
Compared with traditional products, Koala adopts computer vision algorithms such as face detection, quality judgment, liveness detection, attribute analysis, and face recognition based on deep learning methods. This provides the advantages of high efficiency and precision in various application scenarios, such as 1:N face recognition gates and 1:N face recognition access control and welcome systems.The dynamic and non-cooperative face verification method is more convenient than the traditional card-swipe access method. In addition, thanks to the uniqueness of facial features, this method also solves problems such as forgetting to carry ID and fraudulent use of another person's ID.
The Koala Face Recognition Access Platform can be used in commercial buildings, factories, enterprises and institutions, college dormitories, and residential areas for a wide range of scenarios, such as access control, attendance, and meeting sign-in.When used in combination with the backstage management system, the platform can perform functions such as personnel identification, VIP welcome service, staff attendance, visitor registration, stranger alert, daily data statistics, and inquiry.
1.2. Product Architecture
Page 7
Koala is composed of the cloud and terminals. The cloud has management and computation functions and is referred to as the "host". There are multiple host configurations available for different scenarios. The WEB Server of a host can perform business management functions, including library management, access control, attendance check, and welcome. The host can also manage network switches, TV boxes, and other accessories to open doors via network relays and display welcomes in pop-up windows.
Terminals can be divided into three types, video stream, capture, and recognition, and are provided in different forms. Terminals can be combined with the host to implement all face recognition access features. Koala is a face recognition access platform that provides APIs to customers. Customers may integrate Koala into third-party systems, such as any existing all-purpose card management systems, attendance check systems, or mobile apps.
Each host has a clear load capacity. When a host cannot meet a customer's needs, multiple hosts can be cascaded, so that one host serves as the cascade master and other hosts serve as cascade slaves.
1.3. Hardware Composition
No. Type Abbreviation Product Model
1 Standard Box Camera C2 MegEye C2
2 Backlight Box Camera C3 MegEye-C3V-120-P-X16
3 Standard Dome Camera M3002 MegEye-C2V-320
4 Backlight Dome Camera M3006 MegEye-C3V-32J-X05
5 High-density Face Capture Camera C3S-123 MegEye-C3S-123
6 Indoor Access Control Device M5 MegID-W2K
Page 8
7 Outdoor Access Control Device M5E MegID-W2K-E
8 Mini-host NUC MegBox-B1D-122
9 Standard Host Industrial Personal
Computer MegServer-S1C
10 N3 Host TX1 MegBox-B1R-112/212
11 High-performance Host Server DR1000-H4/H5
1.4. Software Composition
1.4.1. Koala Customer Management System (Admin)
Website: http://server IP/admin2
Ex-factory IP: 192.168.1.50
Ex-factory Account: [email protected]
Ex-factory Password: 123456
This system is used by the technical support team or IT O&M team to provide admin backend management for Koala customers. The website provides information such as the customer directory, directory of hosts bound by customers, host firmware versions, and upgrade management information. When a new customer is connected to the customer management system, the technical support team will add the customer information and its bound host and firmware version to the system.
Page 9
1.4.2. Koala User Management System (Online)
Website: http://server IP
Ex-factory IP: 192.168.1.50
The account name and password must be created in the customer management system.
This system can be used by Koala users for access-related management, including user management, attendance management, historical record viewing, access control and permissions management, welcome management, and account management.
Page 10
1.4.3. Koala Host Configuration (8866)
Website: http://host IP:8866
Ex-factory IP: 192.168.1.50
Ex-factory Account: admin
Ex-factory Password: Koala
Koala host configuration is used to view host-related configuration and information and provides the following major functions:
1. Display the host status: IP, parameters, free storage space, log, binding status, access control information, identification callback settings, NTP settings, etc.
2. View recognition result and check whether the recognition function of the host is normal through commissioning
3. Display information about various devices such as cameras and switches bound to the host
4. Restart the host remotely
Page 11
1.4.4. TV App
The TV App is mounted on the TV box to display the recognition interface. It has the following major functions:
1. Display the welcome interface (time/weather/video stream)
2. Display pop-up windows for recognition results
3. Change the interface theme
4. Link host(s) and camera(s)
1.4.5. Access Control Device App
The Access Control Device App contains a standby interface, a recognition interface, and an engineering interface.
Page 12
2. Frequently Used Functions
2.1. Login Management System
You can log into the Koala Customer Management System and Koala User Management System via the website "http://Server IP". If you try to log in with your account [email protected], you will be redirected to Koala Customer Management System. If you try to log in with your company account, you will be automatically redirected to the Koala User Management System.
You will be asked to change your password upon your first login.
Page 13
2.2. Create New Company
① Log into the Koala Customer Management System.
② Go to the "Customer Directory" interface and click Create New Company.
① Enter [Customer Name, Deliverer, and System Account and User Password] into the corresponding fields. The system account and user password refer to the account name and password used for customer login. After you click “Confirm”, your customer information will be displayed in the customer column (multiple items may be entered), and your customer can log into the specified server to perform backend operations. Click "Go to Koala" to access the backstage management page for the customer.
② Change the password for the company account:
③ Users with admin permissions can enter a new password directly on the Customer Directory -> Edit page.
Page 14
2.3. Add Device
2.3.1. Bind Host
Log into the Koala host configuration interface of the host to be bound, click "Bind", and enter the account and password of the created customer to bind the host. The list of hosts that have been bound to the company can be viewed in the Koala Customer Management System.
Similarly, click "Unbind" and then enter the company account and password to unbind the host.
Page 15
2.3.2. Bind Video Streaming Camera or Face Capture Camera
Log into the Koala User Management System, go to Access Control -> Access Control Device -> New -> Enter Information, and click OK.
Shooting location: User-defined name of the location. For example: The East Gate Passage.
Camera video stream address: Enter the RTSP video stream address of the corresponding camera. For the video stream addresses of different camera models, visit the technical support website (http://techsupport.megvii.com/hc/kb/article/202280/).
Network switch type: Network relay should be selected for linked access control. For details, visit:
http://techsupport.megvii.com/hc/kb/article/1078756/.
Recognition Host: The video stream camera and face capture camera must be linked to the host for 1:N face recognition. Select the planned host for linkage (no additional camera can be bound to a host when the limit on the number of routes is reached).
Access Control Grouping: The camera can be assigned to a certain access control group (which can be created in "Permissions Management"), which facilitates group permissions management.
2.3.3. Bind M5/M5E
M5/M5E has two modes of operation: Online mode and offline mode.
Page 16
Online Mode: Front-end face capture and back-end recognition, suitable for application scenarios with a library with over 20,000 entries.
Offline Mode: Front-end recognition, suitable for application scenarios with a library with less than 20,000 entries.
You will be directed to the login page when the system is powered on for the first time, or when you log out or restore factory settings.
Select a working mode and enter the server IP address, company account, and password.
You can complete the binding procedure by clicking on and following the instructions to set the location and other information. You may check the newly bound device by going to the Koala User Management System -> Access Control Management -> Access Control Device.
In online mode, the system will assign a recognition host automatically (you may also manually specify a recognition host by going to the Koala User Management System -> Access Control Management -> Access Control Device -> Edit).
Page 17
2.4. Enter Data into Library
2.4.1. Individual Data Entry
When only a small volume of data needs to be entered, log into the Koala User Management System, go to User Management -> Employee Management -> Create New Employee -> Enter Information, and click OK.
The employee "name" is required.
Photo recognition: You can upload up to three photos. Refer to "Photo Demonstration" for uploading instructions.
Page 18
Display head portrait: The head portrait will be displayed in scenarios such as welcome pop-up. You may choose any personalized photo.
After entering the onboarding time and employee birthday, the system issues reminders on the onboarding date, onboarding anniversaries, and birthdays via pop-up windows.
Staff groups: Multiple staff groups can be selected to facilitate group permissions management (for details, see Access Control Management -> Permissions Management).
Page 19
(Visitor Management -> Create New Visitor -> Enter Information -> OK)
Visitor types include VIPs and ordinary visitors, and different welcome pop-up windows are displayed, which can be classified and filtered via record inquiry.
2.4.2. Batch Import
(Batch Import -> Select Import Method -> Select Files -> OK)
Import Tables:
To import tables, it is necessary to download the specified template. Please do not upload tables in any other format.
Import Photos (In case of a great number of personnel, you may collect their photos and upload in batch)
Page 20
Generally, photos should be imported after the import of personnel information,
so that a photo can be automatically matched with a person.
1. Select a match type, and the system will match and automatically link the file name of the photo with the specified content. If there is no match, a new library entry will be created with the file name as the person's name. (Here is a name matching example: If the photo is named “Zhao San”, the photo can be automatically matched with “San Zhao” it is uploaded.)
2. Photos to be uploaded must be in folder format, and nested folders are supported (attention should be paid to "Photo Demonstration").
2.5. Permission Settings
Starting from V3.1.0, the system supports group-based and time-based permissions management, which is more flexible and convenient for management.
2.5.1. Access Control Rules
Example: Setting Access Control Rules for Ordinary Employees
Set the access control rule “punch in on work days, but not on weekends or statutory holidays” for ordinary employees.
(Example: Office building access control for ordinary employees)
Page 21
① Create an “ordinary employees” group and add all ordinary employees to the
group.
② Create an access control device group, “Office Building Access Control Group”,
and move all access control devices of the office building to the group.
③ Set the opening period of access control as 9:00 am to 9:00 pm, Monday to
Saturday, which should be named “Ordinary Employees Period”.
④ Settings for Holidays - For statutory holidays, add a rule for all statutory holidays
in the current year and name it “Statutory Holidays.”(Opposite rules should be set, which means that all permissions become invalid during these periods. For example, May 1 is a statutory holiday, and although May 1 falls on Friday, ordinary employees cannot enter the office building on this day according to the access control rules.)
⑤ For personnel, select “ordinary employees”; for access control, select“Office
Building Access Control Group”; for period options, select “Ordinary Employees Period”; and for holidays, select “Statutory Holidays”.
Page 22
Multiple access control rules are set based on the “OR” relationship, which means that access is permitted so long as an employee meets the condition of one of the access rules.
The system can create a full access rule automatically, which can be edited and deleted.
We recommend that personnel be grouped based on different applications, such as the finance group, warehouse group, VIP group, or part-time employee group. Then appropriate access control rules can be created for different personnel groups.
The system automatically creates three groups (All Employees: all employees), (All Visitors: all visitors) and (All Access Controls: people with full access). These three groups are not visible, but can be selected for access control rules.
Note: When a person in a certain library has no permissions, a pop-up window will be displayed: No open access. This means that access by the person is prohibited, but the person is recorded in the history for subsequent inquiries.
2.5.2. Personnel Grouping
(Access Control Management -> Permissions Management -> Personnel Grouping)
Example: Create a group of ordinary employees
① Enter the group name: “Ordinary Employees Group”.
② The names of all ordinary employees can be added to the group via the “Add”
column on the right. Batches of employees can also be quickly added through “Add Department”.
Page 23
When there is a large number of employees, you can "Search for Staff" to find the personnel to add.
One person can be bound to multiple personnel groups.
2.5.3. Access Control Grouping
(Access Control Management -> Permissions Management -> Access Control Grouping)
Example: The devices in an office building can be divided into various groups.
① Name the group “Office Building”.
② Add all devices in the office building to the group.
A single access control device can only exist in one access control group. The “Ungrouped Devices” group lists all access control devices that have not been bound to any access control group in order to facilitate group selection.
In case of any error in grouping, you may select an access control device directly from “All” to move it from another group to this group.
Page 24
2.5.4. Period Settings
(Access Control Management -> Permissions Management -> Period Settings)
Example: Create a “996” (working 12 hours a day, 6 days a week) access control period for ordinary employees with a time limit of one year.
① Name the time period “Ordinary Employees Period”.
② Fill in period for Monday: 9:00-21:00.
③ Click “Same as Above” on the right for Tuesday, Wednesday, Thursday, Friday,
and Saturday
If you do not modify the period of each day when creating a new period, the default option is no period.
There are three default time interval options, which are determined based on the principle of union sets (for example, if Time Interval I is set to 9:00-19:00 and Time Interval II is set to 18:00-20:00, then the time period of the day should be 9:00-20:00).
“Same as Above” means that the setting for this item is the same as the previous one (for example, when you check Same as Above in determining a plan for Wednesday, and no plan is set for Tuesday, the empty plan for Tuesday will be copied rather than that for Monday).
Page 25
2.5.5. Holiday Settings
(Access Control Management -> Permissions Management -> Holiday Settings)
Example: Set a statutory holiday and exclude this time period from the access control permissions.
① Create a holiday and name it “Statutory Holiday”.
② Select “Repeat Annually” by default.
③ Add the date of the statutory holiday for the year.
Holiday settings include [Repeat Annually], [Repeat Monthly], and [Do Not Repeat].
“Repeat Annually” means that the date is a holiday every year, such as May 1 of each year.
“Repeat Monthly” means that this day is a holiday every month, such as holidays falling on the 29th day and the 30th day of each month.
“Do Not Repeat” means that a specific date needs to be specified and it will never be repeated.
Holidays have the highest priority, and no time period judgments will be made during a holiday, which means that no access rights are granted during holidays.
Page 26
2.6. Attendance Settings
(Attendance Settings) Attendance Management -> Attendance Settings
Example: Set the time interval 9:00 am to 6:00 pm from Monday to Friday as the attendance check period. If an employee arrives at the office late or leaves the office early by 20 minutes or more, the situation will be recorded (except for holidays).
① Fill in the time in and time out: 9:00 am and 6:00 pm respectively
② Fill in the time of late arrival and that of early leave: 20 minutes or more after 9:00
am or before 6:00 pm.
③ Select special holidays (such as May Day) and cancel attendance check during
the holidays.
Note: Attendance statistics are compiled according to recognition records and access permissions are not checked. So long as there is relevant data in the library, there will be a recognition result and attendance check will be conducted.
In case of more complicated attendance needs check, we recommend that all historical records be obtained through the API before attendance analysis and statistics are performed.
Page 27
2.7. Face Recognition Access
Form: Dome Camera
Face recognition can be performed when a person passes through the gate in an upright posture. If face recognition is not successful, the person must look at the dome camera for face recognition.
Form: Box Camera/Face Capture Camera
Enter the access control area, walk toward the door, and look straight ahead. After successful face recognition, the back door will open. If there is a welcome display screen, it will be displayed in a pop-up window.
Page 28
Form: Access Control Device
Go to the Access Control Device, look straight ahead, and make sure that your face is included in the designated area. When a pop-up window is displayed, it indicates successful face recognition. In some systems, a sound can be set to indicate successful face recognition.
2.8. View Record
User records are categorized into Employee, Visitor, VIP, Yellow List, Unidentified, and Password Entry. Users can be filtered by category.
VIP settings can be defined in user management settings under frequently used functions.
Unidentified refers to the users continuously scoring between the recognition threshold and the stranger threshold during recognition by the back-end host.
Password Entry refers to the users who have their photos taken when they unlock the door with a password.
The system checks the disk space every hour and deletes the oldest face capture images automatically when 80% of the disk space is occupied. Records are not deleted. The deletion continues until the occupied disk space is no more than 80% (images taken within the last 7 days will not be deleted). When the free disk space is less than 5GB
Page 29
during the daily check at 2:30, recognition records in the Koala User Management System will be automatically deleted, starting with records from 6 months ago, until the free disk space reaches 5GB.
2.9. Welcome Settings
2.9.1. TV Box Configuration
If you use the new version of the Megvii Remix TV box, you will enter the TV App interface after turning it on. Press the “Settings” button on the TV box to enter the System Settings page of the TV App. For specific settings, refer to
http://techsupport.megvii.com/hc/kb/article/1146617/.
Firstly, enter the network server address http://Local server IP
Select host:
Page 30
Bind camera: Select one or more cameras for pop-up windows after recognition. This indicates that photos of all people captured by the selected cameras will be displayed in the pop-up windows on this screen.
Bind the video stream to be displayed: Select the video stream displayed on the screen. Only one video stream can be selected.
Go to Theme Settings: Press the "Settings" button to select a theme
Page 31
Various themes are available.
If you select a local video theme, you first need to go to the System Settings interface to select the video stream to be played and copy it to the box or play it with a USB flash drive.
Page 32
2.9.2. Change the “Koala User Management System” Theme
Access Control Management -> Welcome Management -> Edit
Edit by clicking on the icon above.
Layouts can be made by companies based on their own standards, or the default theme may be selected. The logo above can be replaced. For example, it can be replaced by your company's logo.
Page 33
2.10. Create New Sub-account
Account Management - New
Example: Create a sub-account for Jack, an HR Department employee, with the permission to add employees and visitors.
① Create a sub-account, [email protected] (in email address format).
② Select “Add employee” and “Add visitor”.
③ Log into the sub-account to change the password.
2.11. Koala Download Center - Download Official App/Upgrade Package
http://techsupport.megvii.com/hc/kb/article/196904/
Including:
① Download a ROM upgrade package for an access control device.
② Download the access control device app installer.
③ Download the TV box App
Page 34
④ Download the management/employee app.
⑤ Download the Megvii Visitor/ID Comparison app.
⑥ Download the offline deployment/upgrade package for the Koala host.
⑦ Download the latest camera firmware.
The download the necessary content through the links above based on system version and software requirements.
2.12. OTA Upgrade
2.12.1. Upload Upgrade Package
Go to the Koala Customer Management System -> Upgrade Management -> Access Control Device -> Current Version -> Upload Upgrade Package
The MD5 value must correspond to the upgrade package. After each release, relevant information will be published on Megvii's technical support website (http://techsupport.megvii.com). If verification fails, it cannot be uploaded.
If the version of the upgrade package to be uploaded is earlier than or the same as the existing version, you have to delete the existing version before uploading.
Page 35
When a device is being upgraded, you cannot delete the upgrade package or upload a new upgrade package.
2.12.2. Upgrade Device
Step 1: Select the company account and find the access control device under the account.
Step 2: Select the device to be upgraded and click “Upgrade the selected items”.
Only online and “upgradeable” devices can be selected. So long as the device version is different from the upgrade package version, it can be upgraded.
If you click “Select all”, all devices that meet the conditions will be selected. Filtering only affects the information display, not the items selected.
You can continue to select devices during an ongoing upgrade and click “Upgrade the selected item” to perform another upgrade.
When both the ROM and app are being upgraded at the same time, the ROM will be upgraded and you must re-select the app to upgrade.
Page 36
Step 3: Check the upgrade result.
After you click "Upgrade the selected items", the status of the selected devices will change from "Waiting for download", "Downloading", "Upgrading", to "Latest already", which indicates that the selected devices have been upgraded and are ready for use.
2.12.3. Upgrade Configuration
Downloading for up to five devices can be conducted concurrently. Additional devices are in the "Waiting for download" status. The number of concurrent devices can be increased when the network bandwidth allows, up to 20.
2.12.4. Upgrade Record
Click “Previous versions” to view the records of deleted upgrade packages.
Page 37
Click "Upgrade status" to view the historical upgrade status of the device for problem tracing. Click "Networking status" to view the online/offline status record of your device.
2.13. Import and Switch Language Packages (International Version Only)
By default, the international version supports English, Traditional Chinese, Portuguese, Russian, Thai, Spanish, and Arabic.
In the Koala Customer Management System, select the designated company and click on the Operations navigation bar.
Page 38
Edit -> Language settings -> Select file
-
Scenario 1: Update the English language package. You can select the latest file to upload by clicking "Select file". (The updated language package needs to be exported via an online translation system.)
Scenario 2: Add new language. For new regions without a language package, if translation is needed, you can switch to the language in the management console by uploading the translation file for the region. (You must translate the language for the region yourself.)
1. Switch language on the online homepage.
2. You can switch the language in Admin -> Edit customer -> Language settings
Page 39
2.14. Modify IP (8866)
Log into the 8866 interface and add "8866" after the name of your server.
(Host IP Modification) Configuration -> Host
Click "Save" after modification.
Modify Camera IP
The camera IP can be modified only when the camera is bound to the host.
① Log into the 8866 interface and enter the account of the host to which the camera
is bound.
② Modify the specified device.
③ Enter the camera video stream IP.
Page 40
On this page, you can also enter the name of the bound camera, the "Shooting location", "Camera video stream address" and "Network switch address".
2.15. Configure Cascade
The feature is mainly used for cascading multiple hosts in order to share a library. For details, please refer to documents in the knowledge base, http://techsupport.megvii.com/hc/kb/article/1106593/. In principle, only devices of the same version can be cascaded.
Page 41
2.16. Using APIs
APIs include online-permission interface, system management, recognition records, employee management, attendance management, comprehensive management, access control groups, staff groups, access control permissions, access control period & holiday management, host-system management, host-recognition. For help using APIs, visit: http://techsupport.megvii.com/hc/kb/article/208625/.
2.17. Customer Directory
The customer directory is used for company management. In the directory, you can create, edit, and delete companies, or jump to a company's user management system (Koala).
The current system is no longer divided into the online version and the offline version, and is always referred to as the online version.
For how to create a new company, refer to Section 2.2 (See above).
The detailed description of a company includes customers, purpose, deployment plan, deliverer, time of creation, remarks, number of people, hardware status, and software status. You can jump directly to the hardware and software sections by clicking on them on this page.
Page 42
Model settings:
On this page, you can adjust the library quality. Generally, the default value can be used. You can also make slight adjustments to the angle, fuzziness, and other qualities as needed.
Page 43
2.18. Organization Directory
The organization directory is used for the management of multiple companies. Each company can only exist in one organization.
Example: A large company has multiple subsidiaries in Beijing, Zhejiang, Shenzhen, and other cities. All personnel of the company can be managed and viewed in a unified manner when these subsidiaries are added to the organization through organization creation.
① Enter the organization name: XXX Company.
② Enter the login account (in email address format)and password.
Page 44
③ Add affiliated companies.
④ Go to Koala to manage multiple companies by switching among them.
2.19. Host Directory
You can view the encryption dog's validity period, customer, host address, and status, and addresses of any bound camera in the host directory.
Page 45
Example: You want to adjust the face capture recognition parameters for a specified host. You can find the host at address B, and change the face capture quality and recognition settings for the host by clicking “View”.
Firmware version
Face capture quality
You can select Standard, Precise, or Custom for face capture quality and set the quality according to your needs.
Recognition settings
Page 46
2.20. Host Firmware Version
Page 47
2.21. Upgrade Management
Currently, remote upgrades only apply to ROMs and apps for M5\M5E.
For detailed instructions on upgrade, refer to Section 2.12 (See above).
2.22. Tasks
Page 48
3. Koala User Management System (Online)
3.1. Homepage
“Comprehensive statistics” is displayed at the top of the homepage. It shows the number of employee recognition records, visitor recognition records, and stranger recognition records for the day and the system date and time.
The newly added parts are the number of people and features of the library and bound cameras.
The "Screen status" below shows camera video stream information, the host server status, network switch IP, access permissions, and other information in the system.
3.2. User Management
3.2.1. Employee Management
Data export
You can perform data backup by exporting data and filter the data to be exported.
Operation icons
Page 49
The first icon is “Reset password”, which can be used to reset your login password for the app.
The second icon is “Edit employee”, which can be used to edit the entered employee information.
“Photo demonstration”
Page 50
Query employee
You can query an employee by entering “Registration start time”, “Registration end time”, “Department”, and “Employee name”.
Delete data
You can delete a specific employee or delete all the employees.
Page 51
3.2.2. Visitor Management
Same as user management.
The main difference between an employee and a visitor lies in the setting of visiting times, as the door will no longer open for visitors once the period expires.
3.2.3. Yellow List Management
Same as user management.
Personnel on the yellow list can be recognized, but are not allowed to pass
3.3. Attendance Management
Click the “View” button to view a user's attendance.
Page 52
Attendance information can be viewed by month, including employee names and number of days of normal attendance, late, early leave, missing clock-in/out, and absent.
You can also view the overall attendance through external attendance by year or month.
3.4. History
3.4.1. User Records
You can view the information about the captured user, the location of capture, the identification, and the capture time.
Page 53
Recognition results can also be used to categorize the captured users into Visitor, VIP, Yellow List, Unidentified, and Password Entry in addition to Employee.
3.4.2. Non-liveness Attack
Non-liveness attack records need to be enabled in system settings to detect records of malicious non-liveness attacks.
Press F12 in the user management interface, enter localStorage["debug_score"] = true in the console, press Enter, and refresh. You will then find an additional “Score” column in the history.
The “C” in the scoring options represents similarity, which can be used to
Page 54
determine the similarity of each recognition to serve as the adjustment criterion for the recognition threshold in case of false recognition. “F” represents the score of a liveness attack.
3.5. Access Control Management
3.5.1. Access Control Device
You can select between “Failure” and “Normal” for the device status.
3.5.2. Permissions Management
Help
Page 55
In “Help”, the rule logic for each part of permissions management is described in detail.
Historical record query
You can click “History” to view the rules created. Factors related to the rules include the Personnel, Access Control, Period, and Holiday settings. You can also view the time of deletion and the operator in case of malicious deletion, accidental deletion, and other issues.
When there are too many records, you can click “Delete all”.
Permissions query
Permissions query corresponds to historical records, so you can view the rules corresponding to an employee. A query can be performed by entering the “Employee
Page 56
name” or selecting from the “Access control group”.
Rule switch
Rules can be “enabled” or “disabled”.
You can arrange rules in “ascending” order or in “descending” order by clicking the arrow.
3.6. Welcome Management
The welcome settings interface includes the screen number, welcome theme, pop-up time, city, and bound camera.
Page 57
3.7. Account Management
The encryption dog status is displayed in the lower part of the page, including the ID status and time of expiration. Be sure to pay attention to the validity period of the encryption dog in order to prevent a sudden stop of the system.
4. Koala Host Configuration (8866)
4.1. Host Restart
You can restart the host remotely by entering the host admin password. In some abnormal situations, the host can be restarted remotely without on-site operation.
Page 58
4.2. Host NTP Synchronization
4.2.1. Sync Method 1:
The user provides the NTP server. All hosts and access control devices are used as NTP clients, where the time is consistent with that in the customer's NTP server. We recommend keeping the time consistent with that in other systems of the user.
4.2.2. Sync Method 2:
If the user doesn't provide the NTP server, the cascaded host acts as the NTP server, and other cascaded slaves and access control devices are used as NTP clients, whose time should be consistent with that in the cascaded host. In this way, you can ensure time consistency in the face recognition access control system.
4.2.3. POST Callback
Recognition results conducted by this host can be output to a third party through POST callback.
Page 59
Recognition results contain face capture images by default. You can choose not to include the images in specific scenarios to improve real-time performance.
5. FAQ & Solutions
5.1. Customer Management
5.1.1. Solution for No Firmware in Host Firmware Version
Problem description: There is no firmware in the host firmware version on the admin2 interface.
Host version: All versions
Solution:
1. Go to “repo” to check whether there is box_version.sql.
2. Go to “mysql” to check whether there is box_version.sql. Steps: ① mysql -uroot
-proot ② Use Koala_online ③ Show tables; check if there is box_version. If
there is, go to Step 3.
3. Exit mysql. Go to “mysql -uroot -proot Koala_online < /home/Koala/repo/box_version.sql” in repo.
4. Refresh the admin2 interface and the firmware appears.
5.2. User Management
5.2.1. Batch Import Image Quantity Problems
Koala's “Employee management” function can be used to batch import images for the employee library. Generally, we do not recommend uploading more than 3,000 images at one time, and the total size should not exceed 2GB.
However, the number of imported images should be far less than 3,000 when you batch import images in Windows due to the defects of the Windows system.
In a Windows system, the number of characters in the names of the files selected may not exceed 32K (32767B). Otherwise, browser operations will result in undetectable exceptions which will not trigger an alert.
5.2.2. Insufficient Storage Space for Koala
The problem of insufficient storage space will occur after you use a version prior to 2.9.1 for a period of time and you will not be able to use Koala. In this case, you need to enter the Koala system to delete historical records and logs. Specific procedure:
1. Go to /data/bak and delete the file named “.sql.gz”. Only keep the files from the last three days or so.
2. Go to /data/Koala_online/upload/event and delete photos in historical records.
After deleting these two items, there will be a large amount of storage space available for use.
Page 60
5.3. Host Management
5.3.1. API Cross-domain Problems
For example, the following errors may occur:
"Failed to load https://api-cn.faceplusplus.com/facepp/v3/detect: Response to preflight request doesn’t pass access control check: No ’Access-Control-Allow-Origin’ header is present on the requested resource."
Such errors may occur when a user calls our APIs with a browser. In case of a cross-domain problem, avoid calling APIs with a browser to solve the problem.
5.3.2. SDK Error in ID Card Quality Detection: LICENSE_NOT_FOUND
This error is caused by the entry of an incorrect authorization duration. The following changes can be made to solve this problem:
If you are using a trial key, open the file “MGLicenseHandle.m”, go to the “licenseForNetWokrFinish:finish” method, and change the authorization duration (apiDuration) to 1 because the duration for the trial key can only be 1 day.
If you are using an official key, open the file “MGLicenseHandle.m”, modify the authorization duration (apiDuration) to the duration purchased by the user (30 or 365 days). If the purchased duration is 30 days, change apiDuration to 30; and change it to 365 in case of a purchase of 365 days.
5.3.3. TX1 Error: Dog Authorization Not Found
Problem Scenario 1:
- Recognition cannot be performed after the host has been working for a period of time, and foliage exits due to an exception.
- There is a similar error in the updater:
Current PID: 25285
file1WOZkE: Start Error:One of the following licenses is required:
* CodeMeter 102507:101
Failure reason: CmStick Entry not found, Error 200
Problem Scenario 2:
The time of the encryption dog system is incorrect, so foliage cannot start. The problem cannot be fixed by restarting the host.
For the solution, visit: http://techsupport.megvii.com/hc/kb/article/1219915/.
Page 61
5.4. Hardware
5.4.1. Limitation on C2\M3002 Routes
For example, if an industrial personal computer can take only three routes for C2, and allow 5 persons to pass per second, it means that the system can perform recognition for a maximum of 5 persons from three routes per second. If more than 5 persons pass together, one or more persons may not be recognized.
5.4.2. Param Error Message in Remix Box
You need to restore Remix to the factory settings, re-access the external network, and reset the IP address.
5.4.3. Video Stream Interruption in HiMedia Box
Problem description: When the HiMedia Box is used to play a video, the video stream is interrupted repeatedly. After a period of normal playing, an interruption may occur for more than 10s, during which obvious frame loss can be observed.
Troubleshooting: Connect the camera directly to a PC and check whether there is any interruption of the video watched with VLC. An interruption may indicate a fault in the camera. You can try to reset the version, restore the factory settings, or perform other operations to solve the problem.
Connect the camera directly to a PC and check whether there is any interruption of the video watched with VLC. If there is no interruption, the problem is caused by the network and has nothing to do with the camera hardware.
Test result: After troubleshooting, if there is any interruption of the video watched with VLC, it is highly likely that the problem lies in the camera. In this case, we recommend you replace the camera.
Note: Interruption here means the pause of a video instead of mosaic and other problems (mosaic is generally caused by the network).
5.4.4. Capture Setting Options Not Updated After Firmware Upgrade of C3S-123
After upgrading the C3S-123 firmware to the latest version (General_HangZhouHuaMu_IPC_HI3516D_83H20_FACE_RT3070_V4.03.R12.Nat.OnvifS....bin), the capture setting options stay unchanged when IE is reopened. The number of images still cannot be changed to 50.
Version: C3S-123, R12 (3 and 1 firmware)
Solution: After deleting the CMS under the netSurveillance folder, you can re-open IE as an administrator to view the options.
Page 62
5.4.5. Method for Exporting System Logs From an Access Control Device
For the solution, visit: http://techsupport.megvii.com/hc/kb/article/1229943/.
