Hanwha Vision MT8137 Open Platform

Copyright
2024 Hanwha Vision Co., Ltd. All rights reserved.

Restriction
Do not copy, distribute, or reproduce any part of this document without written approval from Hanwha Vision Co., Ltd.

Disclaimer
Hanwha Vision Co., Ltd. has made every effort to ensure the completeness and accuracy of this document, but makes no guarantees regarding the information contained herein. All responsibility for proper and safe use of the information in this document lies with users. Hanwha Vision Co., Ltd. may revise or update thi s document without prior notice.

Contact Information

• Hanwha Vision Co., Ltd. Hanwha Vision 6, Pangyo ro 319beon gil, Bundang gu, Seongnam si, Gyeonggi do, 13488, Korea www.hanwhavision.com
• Hanwha Vision America 500 Frank W. Burr Blvd. Suite 43 Teaneck, NJ 07666 hanwhavisionamerica.com
• Hanwha Vision Europe Heriot House, Heriot Road, Chertsey, Surrey, KT16 9DT, United Kingdom hanwhavision.eu

Revision History

The table below provides the version information and revision history of this document. Refer to 2.0x documents for checking revision history before version 3.00.

Introduction to Hanwha Vision Open Platform

Overview
The Hanwha Vision Open Platform uses a standardized API to enable you to add additional functions to an IP camera without changing the existing software.  This platform allows you to download and install third-party applications on an IP camera to integrate an IP camera with other systems and use it for various purposes. For example, the end user can install a platform for an access control system, and the IP camera can be easily integrated with the access control system. Alternatively, the end user can install an application that provides video analysis functions like people counting, which enables the use of an IP camera to control a system.

Key Features of Hanwha Vision Open Platform

The Hanwha Vision Open Platform SDK provides five key functions: real-time media streaming, video control, video analytics, recording, and video setup. In addition to these features s, the SDK APIs provide several events and network functions. Refer to the SDK API document.

• Real-time media streaming
  • Open Platform SDK supports various media formats: raw video (yuv format), encoded video (MJPEG, H.264, H.265 format), and encoded audio (G.711 format). e.g., an application provides video analytics functions by using your unique analysis algorithm.
• Video Control
  • By using video profile APIs, you can make an application that can change and control video. You can change the video source to NTSC or PAL format and add or delete a video profile according to their your own purposes. e.g., a n applicatio n connects to VMS (Video Management System) and controls the video stream provided to end users.
  • Video analytics
  • Open Platform provides basic video analysis that is used by IP cameras: motion detection, face detection, appear/disappear, tampering event, intelligent video,  enter/exit, and alarm event. e.g., an application triggers an alarm when an event has occurred.
• Recording
  • With the SDK APIs, you can store video streams on SD cards and NAS storage. End users can store the video streams on an SD card without an extra storage system and back them up easily. e.g., an application stores a video stream on an SD card when motion is detected.
• Video setup
  • You can set the video according to your preference. SDK APIs provide functions to set or get privacy masks for videos s e.g., you can store the video stream with a private mask on an SD card or in storage.

What’s N ew in Hanwha Vision Open Platform SDK

New Features in v5.00

• Add ed a MT8137 toolchain
  • Add ed a toolchain to build a Q dual light c amera

New Features in v4.02

• Command to run Docker
  • Modified the command to run Docker
  • Inserted a command for conveniently installing Debian
• Removed unsupported models
  • Removed models related to OP
• Created and registered new documents related to troubleshooting

New Features in v4.01

• Support docker
  • Added a D ocker image file to provide a development environment.
• Add a CLI command
  • Added CLI (Command line interface) to simplify project creation and setup and to disable Eclipse plugins
• No more support for Eclipse plugins
  • Replace d E clipse plugins with CLI

New Features in v4.00

• Application signature
  • Added the a pplication signature feature to prevent security risks, such as application tampering.
• SD card dedicated use
  • Added an API that enables you to dedicate the usage of their SD cards to open platform applications only.
• Raw image pointer direct access (for WN7 or later)
  • Added a feature that enables you to directly access the raw image pointer so that you can use raw images with up to 4K resolution.

New Features in v3.60

• Combine d compilation environment
  • Combine d a 32 bit based platform with a 64 bit based platform to allow operation in the same envir onment.

New Features in v3.52

• Dynamic e vent
  • The a pplication can send event s for regular templates.
  • Refer to the SDK API document
• N AND flash space
  • The application can use N AND flash space.
  • Refer to the SDKAPI document
• Bug fixes
  • Fix ed web functions
  • Fix ed Eclip se plugin bugs (Install to Camera: port, file
• Internal modification
  • Synchronized with X series camera firmware

New Features in v3.51

• Internal modification
  • Synchronized with X series camera firmware

New Features in v3.50

• SUNAPI API
  • Added an API for using SUNAPI i n the application
• RS 485 event
  • Added an event to transfer RS 485 data by using the terminal
• Proxy API
  • Added an API for setting proxy configuration
• Log event
  • Added output event s to write the event log on camera
• CPU/Memory limit
  • Modifi ed CPU/Memory usage limit
  • An e vent occurs when the system total usage is over 80% (Max 3
• Fixed defective issue s
  • Included improved performance caused by VOC and defective issues
• Upgrade d Debian
  • Added sample applications on D ebian (/opt/ opensdk/opensdk 3.50/SampleApplica tion)
  • Upgraded to the latest version of libraries

New Features in v3.00

• Raw a udio
  • Open Platform SDK supports raw audio e.g. an application provides audio analytics functions using your unique analysis algorithm.
  • Applicati on filename
    • The a pplication filename can be changed after compiling
    • OriginalAppName_v{version}.cap e.g ServerPushMJPEG.cap ServerPushMJPEG_v170414.cap
• JAVA 8
  • Updated the development environment
• Eclipse Neon2
  • Updated the development environment

Prerequisites

Open Platform Resources of WN5 Series

X series 2 m ega (XNB 6000 and so on) on), 5 mega (XNB 8000 and so on)

Open Platform Resources of S3L Series

Q  series 2 m ega QNO 6082R and so on) on), 5 mega (Q NO 8080R and so on)

Open Platform Resources of CV2x Series

P series AI camera PNO A9081R and so on)

Open Platform Resources of CV22S66 Series

LPR  camera ( TNO 7180R and so on)

Open Platform Resources of WN7 Series

X series 4K camera XNV 9082R and so on)

Open Platform Resources of CV2x 2M Series

P series AI 2M camera PNO A6081R and so on

Most SDK
Hanwha Vision cameras support Hanwha Vision Open Platform Refer to the Hanwha_opensdk_camera.pdf file on our STEP site to check the SOC information, the supported SDK version, and the firmware version by camera models.

• https://step.hanwhavision.com

Open Platform Resources of MT8137 Series
Q dual light series (QNE C9013RL and so on)

Most SDK Hanwha Vision cameras support Hanwha Vision Open Platform . Refer to the Hanwha_opensdk_camera.pdf file on our STEP site to check the SOC  information, the supported SDK version, and the firmware version by camera models.

Developing an Application

Prerequisites

To develop a Hanwha Vision Open Platform application, prepare the following:

• Operating system: Linux or Windows
• Docker
• Code development editor

Note
Hanwha Vision Open Platform version 4.01 or higher supports application development using Docker. For information on versions earlier than version 4.01, visit our STEP site at https://step.hanwhavision.com

Installing the Open Platform SDK

Running Docker Images (Linux, Mac)

Note
To run Docker images, install Docker first. For installing Docker, visit the site at https://docs.docker.com

Follow the steps below:

Step 1. Access the Linux server with the sudo privilege (administrator privilege).

Running Docker Images (Windows)

Note
To run Docker images, install Docker Desktop first.

Follow the steps below:

• Step 1. Run Docker Desktop Installer.exe to install Docker Desktop.
• Step 2. Make sure you don’t select [ Use the WSL 2 based engine in order not to use WSL2.
• Step 3. After running Docker Desktop, run Windows PowerShell as an administrator.
• Step 4. Follow steps 2 to 5 of Run ning Docker Images (Linux , Mac).

Installing the Debian Package (Linux)

Follow the steps below:

• Step 1. Get the SDK package “wi senet_opensdk 5.00 .

• Step 2. Install third party packages as required by “wisenet_opensdk 5.00 . Go to the directory where the SDK package resides.
• Step 3. Install the SDK package by running the command below:
• Step 4. Log out and log in again.

CLI Guide

Folder and File Structure

The folder and file structures of the application are as follows:

Includes
Contains the paths to header files and toolchains required to build a project.

bin
Contains bin files generated when building a project.

html
Contains images, css, fonts, styles, and index.html files to configure the web pages.

inc
Contains header files.

res
Contains image files used in applications.

src
[App_name].cpp defines application operations, receives data and events, and sends responses accordingly.

IpCameraManifest.xml

• Application overview
  • Application details: Overall information of the application ( application n same, application location, v ersion , v endor, description, target SDK, m in SDK required, and m ax SDK)
  • Supported platforms: SOC information of cameras to be installed in the application you can make changes)
  • Application configuration: Key and Value information ( you can make changes)
• Application settings
  • Input events: Determines whether to receive information such as encoded video, raw video, raw audio, and VA events.
  • Permission Determines whether to allow PTZ , Device, and SD card

libs
Contains library files.

Makefile
Builds codes to create binary files.

App_name.cap
The executable file to be installed on the camera created via the opensdk_packager command.

• https://<cameraIP>/stw-cgi/system.cgi?msubmenu=deviceinfo&action=view

Follow the steps below:

Step 1. Run the CGI command to check the Hanwha Vision Open Platform version supported by the XNV 9082R camera model.

Caution
For a platform that requires a certificate, if it is not located under “/opt/opensdk/signature,” the application won’t be installed on the camera correctly.

Issuing a certificate

• Download a test key and a test certificate valid for 3 months from our STEP site during the application development phase.
• After registering an application you’ve developed on our STEP site, request a signature key and a certificate for it.
  • A. Request a signature key and certificate on our STEP site. You will receive them via email.
  • B. Save the signature key and certificate received from Hanwha Vision under the following directory on your development PC: “/opt/opensdk/
  • C. Execute opensdk_packager, and then an electronically signed package file will be created.
  • D. When installing an open platform application on a camera, the camera software checks the signature and certificate of the application and only installs applications free of forgery.

Step 6. Install the Wisenet application on the camera with the IP address 192.168.1.100, provided that the camera access ID and password are admin and test123456 respectively. For how to install an application from the camera web viewer, refer to 4.2 Installing an Application to the IP Camera.

Debugging

A Remote debug viewer is a command line application used to view logs from a third-party application. Execute t his application, included in the SDK package from the Linux command prompt. Remote Debug Viewer is located in /opt/opened/opened –<version>/common/ Or, you can find it easily by running the command below.

Usage of Remote Debug Viewer

Use the following API in a third-party application to get logs from the R emote Debug viewer:

Input arguments for
the Remote Debug viewer:

• i IP address of IP camera
• p H TTP port number on IP camera
• u User name o f IP camera
• w Password o f IP camera
• d Viewer port number
• a Application name

Example

Managing an Application in Web Viewer

Upgrading Camera Software

To properly manage the application on the camera, use the latest firmware.

Follow the steps below:

• Step 1. Download the latest firmware file from Hanwha Vision
• Step 2. Log in to the IP camera.
• Step 3. Go to Setup ] System ] Upgrade/ Restart
• Step 4. Click the button and select the firmware file . Click Upgrade
• Step 5. The camera will shut down while upgrading and then it will reboot.

Installing an Application to the IP Camera

Follow the steps below

• Step 1. Get a .cap file of the application to
• Step 2. Log in to the camera.

Go to Setup] Open platform]]. You can check the current o pen platform version that the camera supports. ( For example, you can see the version, 5.00 _2 2 0216, in the image below.)

• Step 3. Click the [ button on the top and locate the installation package (.cap file).
• Step 4. Click Install ]. The n application will be uploaded, and a window will pop up asking if you want to grant permission to the application
• Step 5. Click OK to grant permissions and install the application. The application will be installed and a message box will be shown.
• Step 6. If the cap file is not appropriate, it will not be installed, and an error message will appear.
• Step 7. It will appear in the list of installed applications. The status will be changed to Installed.

Executing an Application

Follow the steps below:

• Step 1. Under [Status] c lick Start ]]. The application will start and the status will be changed to Running.
• Step 2. To view the running application click Go App ].

Checking Application Health

Check the health of any running application.

Follow the steps below:

• Step 1. Under [Status] c lick [Health]].
• Step 2. A window pops up , showing the CPU usage, memory usage, thread count, and duration of the application. Click OK to close the window.

Application Settings
Set the priority of an application and set the auto start option.

Follow the steps below:

• Step 1. In Priority ]], you can set the priority among running applications. If the resource usage of the whole camera (including the main task of the camera and applications) becomes too high, the application set as “low priority” will close first.
• Step 2. In [Auto start] select Enable to execute the application automatically when the camera is powered on and the main task is executed.
• Step 3. Click Apply to apply the changes. A success message window pops up.

Application Manager

• Step 1. Click Application Manager
• Step 2. A window pops up, showing CPU usage, memory usage, thread count, and duration of all running applications.
• Step 3. To close the application, click [Kill App].

Stopping an Application

To stop around the application, click [ Then the status will thereafter be changed to Stopped.

Uninstalling an Application

Follow the steps below:

• Step 1. To uninstall an application, click Uninstall
• Step 2. Click OK to confirm the uninstallation
• Step 3. The application will be removed from the list of installed applications.

Sample Application

Various sample application files are available from the Hanwha Vision Open Platform SDK. You may find sample application files under the following path:

Technical Support

The company operates a membership program for partners who use Hanwha products. Visit our STEP site at:

• https://step.hanwhavision.com

For those who signed up as an a pplication or t echnology p artner at the initial subscription on out STEP site, the followi ng services are available for the Open Platform SDK.

• Download the SDK versions.
• SDK version and platform information are supported by camera models.
• AppTest.key and AppTest.crt are available to be downloaded for the application signing test.
• Personal keys and certificates are issued in order to install the developed apps on cameras.

If you have any inquiries about the development of the Hanwha Vision Open Platfo rm application, visit our STEP site and select Help Desk > Q&A

Documents / Resources

Hanwha Vision MT8137 Open Platform [pdf] User Guide MT8137, XF8000, T4000, MT8137 Open Platform, MT8137, Open Platform, Platform

References

• User Manual