Mopria Alliance Escl Scan Technical Specification
Total Page:16
File Type:pdf, Size:1020Kb
1 2 3 Technical Working Group 4 5 Mopria Alliance eSCL Scan 6 Technical Specification 7 8 Version 2.8.00 9 Final Draft approved by the Board of Directors 10 October 22, 2018 11 Mopria Alliance Confidential 12 13 Disclaimer Boiler Plate 14 This document may be used with the permission of Mopria Alliance under the terms set forth herein. 15 By your use of the document, you are agreeing to these terms. Unless this document is clearly designated as an approved 16 specification, this document is a work in process and is not an approved Mopria Alliance specification. This document is subject to 17 revision or removal at any time without notice. Information contained in this document may be used at your sole risk. Mopria Alliance 18 assumes no responsibility for errors or omissions in this document. This copyright permission does not constitute an endorsement of 19 the products or services. Mopria Alliance trademarks and certification marks may not be used unless specifically allowed by Mopria 20 Alliance. 21 22 Mopria Alliance has not conducted an independent intellectual property rights ("IPR") review of this document and the information 23 contained herein, and makes no representations or warranties regarding IPR, including without limitation patents, copyrights or trade 24 secret rights. This document may contain inventions for which you must obtain licenses from third parties before making, using or 25 selling the inventions. 26 27 Mopria Alliance owns the copyright in this document and reserves all rights therein. A user of this document may duplicate and 28 distribute copies of the document in connection with the authorized uses described herein, provided any duplication in whole or in 29 part includes the copyright notice and the disclaimer text set forth herein. Unless prior written permission has been received from 30 Mopria Alliance, any other use of this document and all other duplication and distribution of this document are prohibited. 31 Unauthorized use, duplication, or distribution is an infringement of Mopria Alliance’s copyright. 32 33 NO REPRESENTATIONS OR WARRANTIES (WHETHER EXPRESS OR IMPLIED) ARE MADE BY MOPRIA ALLIANCE AND 34 MOPRIA ALLIANCE IS NOT LIABLE FOR AND HEREBY DISCLAIMS ANY DIRECT, INDIRECT, PUNITIVE, SPECIAL, 35 INCIDENTAL, CONSEQUENTIAL, OR EXEMPLARY DAMAGES ARISING OUT OF OR IN CONNECTION WITH THE USE OF 36 THISDOCUMENT AND ANY INFORMATION CONTAINED IN THIS DOCUMENT. 37 “Notwithstanding the Copyright License Grant in Part 1 (b) of Attachment A “License to Final 38 Specification” of the Intellectual Property Rights Policy of the Mopria Alliance, Inc. Membership 39 Agreement, the copyright license grant to HP to the Final Specification based on the eSCL Contribution 40 from HP shall include the right to modify, create derivative works, distribute and sublicense the Final 41 Specification (including any Contribution of any Member to the Final Specification) to third parties. 42 By contributing the eSCL specification to the Mopria Alliance, HP allows claims in US7263524 and no 43 other HP Intellectual property is allowed or implied. See the following page for specific uses cases: 44 45 46 47 48 49 Claims in US7263524 allow for Scenarios 1 & 2 and do not allow Scenario 3. 50 51 52 Mopria Alliance Confidential Page 2 of 76 Mopria Alliance Scan Specification v2.8 1 Document History Version Date Status Comments 0.30 02/06/2014 Draft Initial draft 0.31 02/19/2014 Draft Fixed some editorials and started tightening up the Security section 2.6 06/11/2014 Draft More security related concerns addressed – making HTTPS mandatory and adding UUID to the JobURI. Added push scan support for multiple destinations. 2.6 e 11/12/2014 Draft Added uscans advertisement in Bonjour Added StoredJobRequests. Security updates for admin to mandate secure scans. Added ReferenceID to to the destination URI for the PUSH scans Added clarity to use of CertificateValidation Added more response codes for individual URIs Updated with review comments from Mopria. 2.6.f 01/12/2014 Draft Updated security section for USB requests. Added UriSchemes and PreConfiguredDestinations for PUSH scan capabilities. Removed DestinationUri and added DestinationReferenceID in ScannerStatus for PUSH scans. 2.7 08/13/2017 Draft Added support for uscans SRV record Added a new section for explaining StoredJobs Added UUID, AdminURI, IconURI, to capabilities Added FeedDirections, BlankPageDetection support Added ActualBytesPerLine, BlankPageDetected to ScanImageInfo 2.8 04/19/2018 Draft Added Manufacturer and Certifications elements to ScannerCapabilities 2.8 2018-10-22 Final Final Draft approved by the Board of Directors Mopria Alliance Confidential Page 3 of 76 Mopria Alliance Scan Specification v2.8 1 Contents 2 1 Introduction ............................................................................................................................. 6 3 1.1 Intents ...................................................................................................................... 6 4 1.2 References ............................................................................................................... 6 5 1.3 Definitions............................................................................................................... 7 6 1.4 Abbreviations and acronyms................................................................................... 7 7 2 HTTP Error Codes .................................................................................................................. 7 8 3 Discovery ................................................................................................................................ 9 9 4 eSCL Resources .................................................................................................................... 13 10 5 Intents .................................................................................................................................... 14 11 6 Data Formats ......................................................................................................................... 16 12 7 Scan Settings ......................................................................................................................... 17 13 7.1 Coordinate Conventions........................................................................................ 24 14 8 Capabilities ........................................................................................................................... 25 15 8.1 Data Formats ......................................................................................................... 25 16 8.1.1 Resolution Capabilities ......................................................................................... 25 17 8.1.2 Setting Profile ....................................................................................................... 27 18 8.1.3 InputSourceCaps ................................................................................................... 31 19 8.1.3.1 Edge Detection ....................................................................................... 32 20 8.1.3.2 Output Orientation ................................................................................. 32 21 8.1.4 Capabilities ........................................................................................................... 33 22 8.2 Interface ................................................................................................................ 35 23 8.3 Usage Flow ........................................................................................................... 35 24 9 Status ..................................................................................................................................... 39 25 9.1 Data Format .......................................................................................................... 39 26 9.2 Interface ................................................................................................................ 41 27 9.3 Usage Flow ........................................................................................................... 41 28 10 Scan Buffer Info .................................................................................................................... 43 29 10.1 Data Format .......................................................................................................... 43 30 10.2 Interface ................................................................................................................ 43 31 10.3 Usage Flow ........................................................................................................... 44 32 11 Scan Job ................................................................................................................................ 47 Mopria Alliance Confidential Page 4 of 76 Mopria Alliance Scan Specification v2.8 1 11.1 Description ............................................................................................................ 47 2 11.2 Scan Image Info .................................................................................................... 47 3 11.3 Data Format .......................................................................................................... 48 4 11.4 Interface ................................................................................................................ 48 5 11.5 Usage Flow ..........................................................................................................