i-PRO WV-XAE203W Extension Software Owner’s Manual
- June 10, 2024
- i-PRO
Table of Contents
i-PRO WV-XAE203W Extension Software
Product Information
The Extension Software WV-XAE203W is designed to be installed on a network
camera, allowing for easier and more convenient use. The software includes the
AI Non-Mask detection function which can automatically recognize non-mask
wearers and notify external systems such as WV-ASM300 / WV-ASM300W (option)
and WJ-NX series network recorders (option). This software uses deep learning
technology and proprietary image processing technology to recognize colored
masks, pattern (geometric) masks, fashion masks, and various mask shapes such
as flat type, pleated type, and
three-dimensional type. The maximum number of simultaneous detection is 8
people, and the software is recommended for indoor use only.
Please refer to the manual for recommended minimum face size information.
Features
- Recognizes colored masks, pattern (geometric) masks, fashion masks, and various mask shapes
- Maximum number of simultaneous detection: 8 people
- Uses deep learning technology and proprietary image processing technology
- Easy installation on a camera without any settings required
System Requirements for a PC
For the requirements of PC which are used for settings refers to the Operating Instructions of a camera.
Trademark and Registered Trademarks
On open-source software used:
Name of Software | Name of License | Copyright |
---|---|---|
cwebsocket | The MIT License | – |
Product Usage Instructions
- Install the Extension Software WV-XAE203W on your network camera.
- Register the release key.
- The AI Non-Mask detection function will automatically recognize non-mask wearers and notify external systems such as WV-ASM300 / WV-ASM300W (option) and WJ-NX series network recorders (option).
Note:
Distributing, copying, disassembling, reverse compiling, and reverse
engineering of the software provided with this product are all expressly
prohibited. In addition, exporting any software provided with this product
violating export laws is prohibited.
Disclaimer of Warranty:
IN NO EVENT SHALL i-PRO Co., Ltd. BE LIABLE TO ANY PARTY OR ANY PERSON, EXCEPT
FOR REPLACEMENT OR REASONABLE MAINTENANCE OF THE PRODUCT, FOR THE CASES
INCLUDING BUT NOT LIMITED TO BELOW: (1) ANY LOSS OR DAMAGE, INCLUDING WITHOUT
LIMITATION, DIRECT OR INDIRECT, SPECIAL, CONSEQUENTIAL.
Before attempting to connect or operate this software,please read these
instructions carefully and save this manual for future use.
The model number is abbreviated in some descriptions in this manual.
Introduction
Preface
The Extension Software WV-XAE203W (hereafter referred to as this product) is
software for more conveniently using the network camera (option, hereafter
referred to as the camera). By installing this product on the camera and
registering the release key, the “AI Non-Mask detection function” which
automatically recognizes non-mask wearers, can notify Information on non-mask
wearers to external systems such as WV-ASM300 / WV-ASM300W (option) and WJ-NX
series network recorders (option).
Important
- This product is necessary for each camera.
- See the URL below for information such as the models supported by this product, the software version, etc. https://i-pro.com/global/en/surveillance/training-support/support/technical-information
Features
- This product notifies the specified notification destination of the detected non-mask wearer information.
- This product has the following features.
- The deep learning technology and our proprietary image processing technology can recognize colored masks, pattern (geometric) masks, fashion masks and various mask shapes.
- You can use it immediately by installing this product on the camera without any settings.
Specifications
Recognized masks Color masks, pattern (geometric) masks, fashion masks and
various
mask shapes (flat type, pleated type, three-dimensional type) Maximum number
of simultaneous detection 8 people
Maximum face orientation 45° left and right 30° up and down
Installation location Indoors
- See the URL below for “Recommended minimum face size” information.
https://i-pro.com/global/en/surveillance/training-support/support/technical-
information
About the Operating Instructions
This manual explains the method of installing this product in a camera,
settings that need to be made before starting to operate this product, and the
method of operation for using this product. Since this product is used after
being installed on a camera, before using this product always be sure to also
read the Operating Instructions of the camera with which this product is to be
used.
Based on the specific model of a camera which is used, its screen may be
different from the screen shown in this manual.
In this manual, a personal computer is referred to as a PC.
In this manual, WV-ASM300 and WV-ASM300W are referred to as WV-ASM300.
System requirements for a PC
For the requirements of PC which are used for settings refers to the Operating
Instructions of a camera.
Trademarks and registered trademarks
- Internet Explorer, and Microsoft Edge are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
- Microsoft product screen shot(s) reprinted with permission from Microsoft Corporation.
- Google Chrome are trademarks of Google LLC.
- Firefox is a trademark of the Mozilla Foundation in the US and other countries.
On open source software used
This product uses the open source software below.
Name of software | Name of license |
---|---|
cwebsocket | The MIT License |
• For the corresponding license statement, see “Open Source Software” on page 11.
Copyright
Distributing, copying, disassembling, reverse compiling and reverse
engineering of the software provided with this product are all expressly
prohibited. In addition, exporting any software provided with this product
violating export laws is prohibited.
Disclaimer of warranty
IN NO EVENT SHALL i-PRO Co., Ltd. BE LIABLE TO ANY PARTY OR ANY PERSON, EXCEPT FOR REPLACEMENT OR REASONABLE MAINTENANCE OF THE PRODUCT, FOR THE CASES INCLUDING BUT NOT LIMITED TO BELOW:
- ANY LOSS OR DAMAGE, INCLUDING WITHOUT LIMITATION, DIRECT OR INDIRECT, SPECIAL, CONSEQUENTIAL OR EXEMPLARY, ARISING OUT OF OR RELATING TO THE PRODUCT;
- INCONVENIENCE OR ANY LOSS ARISING WHEN IMAGES ARE NOT DISPLAYED, DUE TO ANY REASON OR CAUSE INCLUDING ANY FAILURE OR PROBLEM OF THE PRODUCT;
- ANY PROBLEM, CONSEQUENTIAL INCONVENIENCE, OR LOSS OR DAMAGE, ARISING OUT OF THE SYSTEM COMBINED WITH THIRD PARTY DEVICES;
- ANY CLAIM OR ACTION FOR DAMAGES BROUGHT BY ANY PERSON OR ORGANIZATION AS A PHOTOGRAPHED SUBJECT DUE TO VIOLATION OF PRIVACY CONCERNING A SURVEILLANCE CAMERA’S PICTURE OR SAVED DATA, FOR SOME REASON (INCLUDING USE WHEN USER AUTHENTICATION ON THE AUTHENTICATION SETTING SCREEN IS SET TO OFF), BECOMING PUBLIC OR BEING USED FOR ANY PURPOSE;
- LOSS OF REGISTERED DATA CAUSED BY ANY FAILURE (INCLUDING INITIALIZATION OF THE PRODUCT DUE TO FORGOTTEN UTHENTICATION INFORMATION SUCH AS A USER NAME AND PASSWORD).
Limitation of liability
THIS PUBLICATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR MPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT OF
THE THIRD PARTY’S RIGHT.
THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS.
CHANGES ARE ADDED TO THE INFORMATION HEREIN, AT ANY TIME, FOR THE IMPROVEMENTS
OF THIS PUBLICATION AND/OR THE CORRESPONDING PRODUCT(S).
Before using this product
The following situations may be difficult for Non-Mask Detection, or may return a false positive.
- Not supported under IR-LED light.
- Mask may not be detected depending on how it is worn and its type.
- Fashion masks (specific objects, specific characters, specific hieroglyphs, etc.) may not be detected.
- When worn such as “Mask on the chin” or “Nose sticking out of the mask”, it may not be detected.
- Non-detection or reduced accuracy may occur due to uneven light, changes in light conditions, face orientation, jewelry, fast movement of the subject, strong external light, etc.
- If it does not appear for more than 2 seconds, it may not be detected.
- The face is out of focus.
- The face is shaking.
- The face is overexposed or washed out.
- Only a part of the face is shown.
- The face is not looking up.
- The face is too close to the camera.
- The face is too small (size less than the specified face width).
- It may react to dolls and posters.
Other cautions are explained below.
- AI Non-Mask Detection Application supports “0° (Off)” and “180° (vertical rotation)” under “Image rotation” settings.
- For 4K network cameras, AI Non-Mask Detection Application limits the delivery frame rate from a maximum of 30 fps to 15 fps.
- When AI Non-Mask Detection Application is running, if you change the camera’s imaging mode or stream settings, the application will restart. If the demo screen of AI Non-Mask Detection Application is open, please reboot it.
- If you have set a privacy zone, you cannot detect Non-Mask within the privacy zone.
- If 10 or more persons appear in the image, it may not be possible to detect the one not wearing the mask.
- The message ID of TCP alarm notification is ‘69’.
- When using TCP alarm notification, set “Additional alarm data” under “TCP alarm notification” of the camera to “On”.
- When using multiple TCP alarm notification simultaneously, if one TCP alarm notification is received after setting the “Alarm mask time” of the WJ-NX series network recorder, no other TCP alarm notification will be received during the “Alarm mask time”.
- For TCP alarm notification settings, refer to ‘TCP alarm notification’ in the Operating Instructions of the camera.
- Depending on various installation conditions and usage environment such as the brightness of the location and the movement of the subject, movement may be difficult to detect, or it may not be detected, or it may malfunction. Please evaluate the installation location before installing.
- We shall not be liable for any inconvenience, damage or loss caused by setting the Non-Mask Detection function or as a result thereof.
Operation flow
Install the Software
Follow the steps below to download this product and install it on your camera.
-
Access the following URL to download “AI Non-Mask Detection” and save it onto the PC. https://i-pro.com/global/en/surveillance/training-support/documentation-database-list
Important:
A space cannot be used in the name of the saving directory. -
Select the [Setup] – [Ext. software] – [Software mng.] tab of the camera.
Important:
Check “Remaining ROM” and “Remaining RAM” of the camera. If disk space is
insufficient, uninstall any other extension software already installed. For
how to uninstall, refer to the “Operation settings” section in the Operating
Instructions of the camera.
- Click the [Browse…] button and designate the downloaded “AI Non-Mask Detection”.
- Make sure that “Install new Ext. software” is selected and click the [Execute] button.
Then the software installation will begin.
When the installation is completed, “AI Non-Mask Detection” will be added to the list of extended software and the “Software mng.” screen. (The names may be partially omitted.)
Important:
• Do not turn off the power of the camera when installing the software.
• Do not perform any operations until the installation is completed.
How to obtain and register the Registration Key
This product DOES NOT need to be activated by “Registration Key” issued by Key
Management System before you start using.
Follow the steps below to obtain the Registration Key.
-
**< If you do not have your User ID and password for the Key Management System>
*** Access the website of the Key Management System and create your User ID and password.
Then start reading from STEP 1 below. -
< If you already have your User ID and password for the Key Management System>
-
Access the website of the Key Management System and “Issue Registration Key” with the User ID and password that you have obtained.
Then start reading from STEP 2 below.
Note:
This product has a trial period, during which you can use this product without registering the Registration Key. If you keep using it after the trial period (30 days), obtain and register the Registration Key.
STEP 1 Sign up
Create your User ID and password, if this is the first time to access the Key
Management system.
-
Access the URL for PC below and sign up.
• For PC
https://kms.business.panasonic.net/ipkms/pc/home.htm -
Login as a temporary user using the User ID and password written on the web page.
-
Register required information and create your User ID and password.
Important:
• Keep your User ID and password safe. You do not need to obtain a new User ID from the next time. Use the User ID already issued.
• It is recommended to change the password periodically.
STEP 2 Obtain the Registration Key
- Check the MPR ID, Activation Key No. and Registration ID.
• For the MPR ID, refer to [MPR ID] on the [Setup] -[Ext. software] – [Software mng.] tab of the camera.
The Activation Key No. and Registration ID are shown on the Activation Key
Card.
Note:
The MPR ID can also be checked on the product package.
-
Access to the following URL “Key Management System” from your PC or Smartphone.
• For PC:
https://kms.business.panasonic.net/ipkms/pc/home.htm
• For Smartphone:
https://kms.business.panasonic.net/ipkms/m-key/ -
Login using your User ID and password.
-
Click [Issue Registration Key] button.
-
Select your product from the menu and click [Next step] button.
-
Input your “MPR ID”, “Activation Key No.” and
“Registration ID”. -
Click the [Issue] button.
-
Then “Registration Key” will be issued on the screen and sent to your e-mail address.
We recommend keeping “Registration Key” together with Activation Key Card for future support.
Important:
• Please make sure the combination between “MPR ID” and “Activation Key No.” is correct when issuing “Registration Key”. Because once you issued “Registration Key”, you cannot issue new one from the same “Activation Key No.”.
• To issue the Registration Key for another camera, go through (6) and (7) of STEP 2.
• If you register multiple Registration Keys for one camera, you can issue them at the same time by entering multiple Activation IDs and Encryption IDs in STEP 2 (6).
STEP 3 Register the Registration Key
-
Select [Setup] – [Ext. software] – [Software mng.] tab of the camera.
-
Click the [Registration >>] button to display the “Registration of application” screen.
-
Enter the Registration Key obtained in STEP 2 in the “Registration Key” field with no dashes (-) in between, and click the [Set] button. Once you register the Registration Key, the “AI Non-Mask Detection” function will be activated.
Note:
The registration of the Registration Key is only operable by users whose access level is “1. Administrator”. Refer to the Operating Instructions of the camera for how to configure the access level.
See the demo screen
Open the demo launch screen
After installing AI Non-Mask Detection Application, go to camera “Setup” menu
“Ext. software” page, where “AI Non-Mask Detection” is added to “Software mng.” tab.
Click “AI Non-Mask Detection”, or “Setup”, and then “Demo launch screen” opens. Also, in order to open the “Demo launch screen”, it is necessary to register the schedule in advance on the “Operation sched.” tab of the “Ext. software” page.
Note:
If the “Operation sched.” is outside the operating hours, the “Demo launch
screen” cannot be opened.
Open the demo screen
Click the [DEMO] button on the “Demo launch screen” to open the “Demo screen”.
A JPEG image is displayed, and the result of mask detection for each frame is
displayed in a frame.
Non-Mask Detection alarm is determined in multiple frames, the alarm is not
notified even if the red frame is displayed in one frame
- Red frame: Non-Mask Detection status
- Blue frame: Mask Detection status
Note:
- Use Firefox, GoogleTM ChromeTM and Microsoft edge to display the demo screen. Internet Explorer is not supported.
- The demo screen can be displayed on only one browser. It does not support simultaneous access by multiple browsers.
- If the data encryption is set to “On”, the demo screen image will not be displayed.
- The demo screen does not support HTTPS connection.
- When used simultaneously with other extension software functions , the position of the face may be significantly misaligned with the frame on the demo screen.
- The demo screen is for demo purposes and is not recommended for actual operation.
Open Source Software
The MIT License (MIT)
Copyright (c) 2015 Andrew Putilov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
For U.S. and Canada:
i-PRO Americas Inc.
For Europe and other countries:
i-PRO EMEA B.V.
https://www.i-pro.com/
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>