Transcript
AND9263/D MatrixCamt Video Development Kit Software Developer's Guide Introduction
www.onsemi.com
MatrixCam Video Development Kit provides a rich set of APIs to create and customize User Interfaces and Experiences on a large variety of Platforms and browsers. MatrixCamt VDK has an embedded web server & an embedded streaming server that enable these APIs. Additionally, an Open Source Automated Test Suite is available that provides validation of these APIs. There are 3 Main Functions of the MatrixCam VDK.
APPLICATION NOTE
Figure 1. MatrixCam VDK Camera
Figure 2. 3 Main Functions of the MatrixCam VDK
This document covers: 1. Web (HTTP Endpoint) APIs 2. Streaming Server (RTSP) APIs 3. Open Source Test Validation Suite
© Semiconductor Components Industries, LLC, 2015
September, 2015 − Rev. 1
1
Publication Order Number: AND9263/D
AND9263/D Application Programming Interface Architecture
BOA Web Server
http
Ethernet or Wi-Fi® rtsp Streaming Server
MatrixCam Video Development Kit
Figure 3. Application Programming Interface Architecture Web (HTTP Endpoint) APIs
Embedded Streaming Server
The MatrixCam VDK has an embedded Streaming Server that provides a live preview of the Camera stream over rtsp protocol. The RTSP url can be queried from the System using the API: IP_ADDR/vb.htm?paratest=rtsp_url
Configuration and Control API Http Endpoints enable Configuration and Control of the Camera. Basic GET/SET functionality: • Clients can be built in any platform (MacOS®, Windows®, iOS® or Androidt) in any programming language that supports making http calls • This can be done on a local area network using the ip address of the camera, or remotely over the Internet if the Camera has a publicly addressable IP address
This stream can be consumed by any media player that can process an rtsp stream. One of the more popular clients is VLC. It can be downloaded as native clients for most popular desktop and mobile platforms including Windows, Linux®, MacOS, Android, iOS. There is also a VLC plug-in available for Firefox®.
Example - Video Resolution API HTTP request for GET API
Automated Test Suite
IP_ADDR/vb.htm?paratest=video_resolution_pri_1
Open Source Test Suites are available to test the Application Programming Interfaces of the MatrixCam VDK 1. An open source Test Suite under Apache 2.0 license is available to validate the Camera Configuration and control a. https://github.com/ONSemiconductor/Matrix APITests. Executes from PC (O/S – Linux, Windows, Mac OS) b. Additional harness to test from Android is found at https://github.com/ONSemiconductor/ MatrixAndroidAPITests 2. An open source Test Suite under GPL license is available to validate the rtsp stream a. https://github.com/ONSemiconductor/Matrix RTSPTests b. This executes from Android Devices supporting Android 4.x and up
• Description of GET API To get the current Resolution. Response will be 0/1/2/3. 0 means 1080p, 1 means 720p, 2 means 360p, 3 means 180p. Default value is 0.
• HTTP request for SET API IP_ADDR/vb.htm?video_resolution_pri_1=0/1/2/3
• Description of SET API To set the resolution. Resolution = 0/1/2/3. Complete List of APIS The complete list of HTTP Endpoints is available in the API.zip file. This file is part of the software download package and can be found here: https://www.dropbox.com/ sh/7sjtjf7zdge6z8x/AACnE_7Ov458tXaliu8juEpua?dl=0
www.onsemi.com 2
AND9263/D
Firefox is a registered trademark of Mozilla Foundation. iOS and MacOS are registered trademarks of Apple Inc. Linux is a registered trademark of Linus Torvalds. Windows is a registered trademark of Microsoft Corporation. Wi-Fi is a registered trademark of the Wi-Fi Alliance. Android is a trademark of Google Inc. MatrixCam is a trademark of Semiconductor Components Industries, LLC (SCILLC) or its subsidiaries in the United States and/or other countries. All other brand names and product names appearing in this document are registered trademarks or trademarks of their respective holders. ON Semiconductor and the are registered trademarks of Semiconductor Components Industries, LLC (SCILLC) or its subsidiaries in the United States and/or other countries. SCILLC owns the rights to a number of patents, trademarks, copyrights, trade secrets, and other intellectual property. A listing of SCILLC’s product/patent coverage may be accessed at www.onsemi.com/site/pdf/Patent−Marking.pdf. SCILLC reserves the right to make changes without further notice to any products herein. SCILLC makes no warranty, representation or guarantee regarding the suitability of its products for any particular purpose, nor does SCILLC assume any liability arising out of the application or use of any product or circuit, and specifically disclaims any and all liability, including without limitation special, consequential or incidental damages. “Typical” parameters which may be provided in SCILLC data sheets and/or specifications can and do vary in different applications and actual performance may vary over time. All operating parameters, including “Typicals” must be validated for each customer application by customer’s technical experts. SCILLC does not convey any license under its patent rights nor the rights of others. SCILLC products are not designed, intended, or authorized for use as components in systems intended for surgical implant into the body, or other applications intended to support or sustain life, or for any other application in which the failure of the SCILLC product could create a situation where personal injury or death may occur. Should Buyer purchase or use SCILLC products for any such unintended or unauthorized application, Buyer shall indemnify and hold SCILLC and its officers, employees, subsidiaries, affiliates, and distributors harmless against all claims, costs, damages, and expenses, and reasonable attorney fees arising out of, directly or indirectly, any claim of personal injury or death associated with such unintended or unauthorized use, even if such claim alleges that SCILLC was negligent regarding the design or manufacture of the part. SCILLC is an Equal Opportunity/Affirmative Action Employer. This literature is subject to all applicable copyright laws and is not for resale in any manner.
PUBLICATION ORDERING INFORMATION LITERATURE FULFILLMENT: Literature Distribution Center for ON Semiconductor 19521 E. 32nd Pkwy, Aurora, Colorado 80011 USA Phone: 303−675−2175 or 800−344−3860 Toll Free USA/Canada Fax: 303−675−2176 or 800−344−3867 Toll Free USA/Canada Email:
[email protected]
N. American Technical Support: 800−282−9855 Toll Free USA/Canada Europe, Middle East and Africa Technical Support: Phone: 421 33 790 2910 Japan Customer Focus Center Phone: 81−3−5817−1050
www.onsemi.com 3
ON Semiconductor Website: www.onsemi.com Order Literature: http://www.onsemi.com/orderlit For additional information, please contact your local Sales Representative
AND9263/D
