Zebra Scanner SDK for Windows Scanner Windows Management Instrumentation Driver Developer's Guide
SCANNER WINDOWS
MANAGEMENT
INSTRUMENTATION DRIVER
DEVELOPER’S GUIDE
SCANNER WMI DRIVER
DEVELOPER’S GUIDE
72E-149785-04
Revision A
April 2019
ii WMI DRIVER DEVELOPER’S GUIDE
No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means,
without permission in writing from Zebra. This includes electronic or mechanical means, such as photocopying,
recording, or information storage and retrieval systems. The material in this manual is subject to change
without notice.
The software is provided strictly on an “as is” basis. All software, including firmware, furnished to the user is on
a licensed basis. Zebra grants to the user a non-transferable and non-exclusive license to use each software
or firmware program delivered hereunder (licensed program). Except as noted below, such license may not be
assigned, sublicensed, or otherwise transferred by the user without prior written consent of Zebra. No right to
copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall
not modify, merge, or incorporate any form or portion of a licensed program with other program material, create
a derivative work from a licensed program, or use a licensed program in a network without written permission
from Zebra. The user agrees to maintain Zebra’s copyright notice on the licensed programs delivered
hereunder, and to include the same on any authorized copies it makes, in whole or in part. The user agrees not
to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any
portion thereof.
Zebra reserves the right to make changes to any software or product to improve reliability, function, or design.
Zebra does not assume any product liability arising out of, or in connection with, the application or use of any
product, circuit, or application described herein.
No license is granted, either expressly or by implication, estoppel, or otherwise under any Zebra Technologies
Corporation, intellectual property rights. An implied license only exists for equipment, circuits, and subsystems
contained in Zebra products.
Revision History
Changes to the original guide are listed below:
Change Date Description
-01 Rev A 5/2011 Initial Release.
-02 Rev A 3/2012 Updates for 64-bit.
-03 Rev A 4/2015 Zebra Rebranding.
-04 Rev A 4/2019 Updated:
iii
- File directory on pg 3-1, 3-8, 4-2 and 4-5
- Copyright statement on the last page.
iv WMI DRIVER DEVELOPER’S GUIDE
TABLE OF CONTENTS
Revision History .............................................................................................................................. iii
Introduction ..................................................................................................................................... vii
Chapter Descriptions ...................................................................................................................... vii
Notational Conventions................................................................................................................... viii
Service Information ......................................................................................................................... viii
Chapter 1: INTRODUCTION TO THE ZEBRA SCANNER WMI DRIVER
Overview ........................................................................................................................................ 1-1
Zebra Scanner WMI Driver Architecture .................................................................................. 1-2
Managed Objects and Providers ........................................................................................ 1-2
WMI Infrastructure .............................................................................................................. 1-3
WMI Management Applications and Scripts ...................................................................... 1-3
Zebra WMI Provider Plug-in ............................................................................................... 1-3
Supported Devices ............................................................................................................. 1-3
System Requirements ........................................................................................................ 1-3
Chapter 2: INSTALLATION INSTRUCTIONS
Overview ........................................................................................................................................ 2-1
Basic Installation Verification ......................................................................................................... 2-2
Configuration .................................................................................................................................. 2-3
Scanner Configuration Bar Codes ........................................................................................... 2-3
USB Communication Protocol ............................................................................................ 2-3
Chapter 3: ZEBRA WMI PROVIDER SCHEMA IN COMMON INFORMATION MODEL (CIM)
Zebra Scanner WMI MOF File ....................................................................................................... 3-1
Properties, Methods and Events .................................................................................................... 3-1
Properties ................................................................................................................................. 3-1
Methods ................................................................................................................................... 3-6
Events ...................................................................................................................................... 3-8
Zebra Driver WMI MOF File ..................................................................................................... 3-8
Table of Contents vi
Chapter 4: TEST UTILITIES AND SOURCE CODE
Overview ........................................................................................................................................ 4-1
Test Utilities Provided in the SDK .................................................................................................. 4-2
Scanner WMI C# Sample Application ...................................................................................... 4-2
Driver WMI C# Sample Application .......................................................................................... 4-5
Appendix A: XML SCHEMAS
Overview ........................................................................................................................................ A-1
GetAllAttributes .............................................................................................................................. A-2
GetAttributes .................................................................................................................................. A-3
Schema for AttNumberList ....................................................................................................... A-3
Schema for AttValueList .......................................................................................................... A-3
SetAttributes and StoreAttributes ................................................................................................... A-4
GetDeviceTopology ....................................................................................................................... A-5
SymbScnrFirmwareUpdateEvent ................................................................................................... A-6
Session Start ............................................................................................................................ A-6
Download Start ........................................................................................................................ A-6
Download Progress .................................................................................................................. A-6
Session End ............................................................................................................................. A-7
Download End .......................................................................................................................... A-7
Error ......................................................................................................................................... A-7
SymbScnrDiscoveryEvent ............................................................................................................. A-8
Corded Scanner ....................................................................................................................... A-8
Cordless Scanner .................................................................................................................... A-9
Index
Glossary
ABOUT THIS GUIDE
Introduction
This guide provides information about Windows Management Instrumentation (WMI), a free component of the
Microsoft Windows® operating system, that provides a scalable system management infrastructure.
Chapter Descriptions
Topics covered in this guide are as follows:
•
Chapter 1, INTRODUCTION TO THE ZEBRA SCANNER WMI DRIVER provides an overview of Windows
Management Instrumentation (WMI) and the Zebra Scanner Driver Architecture.
•
Chapter 2, INSTALLATION INSTRUCTIONS describes how to verify successful installation of the Zebra WMI
provider and provides configuration bar codes.
•
Chapter 3, ZEBRA WMI PROVIDER SCHEMA IN COMMON INFORMATION MODEL (CIM) provides
information about the Zebra scanner WMI schema, Managed Object Format (symbscnr.mof) file, and the
properties, methods, and events exposed by the instance/method provider.
•
Chapter 4, TEST UTILITIES AND SOURCE CODE provides information about the sample applications which
demonstrate subscription for scanner discovery events and firmware update events.
•
Appendix A, XML SCHEMAS provides the XML schemas to communicate with an RSM-ready scanner.
viii WMI DRIVER DEVELOPER’S GUIDE
Notational Conventions
The following conventions are used in this document:
•
Courier New font is used for code segments.
•
Italics are used to highlight:
• Chapters and sections in this and related documents
• Dialog box, window and screen names
• Drop-down list and list box names
• Screen field names
• Check box and radio button names
• File names
• Directory names.
•
Bold text is used to highlight:
• Parameter and option names
• Icons on a screen
• Key names on a keypad
• Button names on a screen.
•
bullets (•) indicate:
• Action items
• Lists of alternatives
• Lists of required steps that are not necessarily sequential.
•
Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
•
Notes, caution and warning statements appear as follows:
NOTE This symbol indicates something of special interest or importance to the reader. Failure to read the note
will not result in physical harm to the reader, equipment or data.
CAUTION This symbol indicates that if this information is ignored, the possibility of data or material damage may
occur.
WARN IN G! This symbol indicates that if this information is ignored the possibility that serious personal
Service Information
injury may occur.
If you have a problem using the equipment, contact your facility’s technical or systems support. If there is a
problem with the equipment, they will contact the Global Customer Support Center at:
www.zebra.com/support
.
CHAPTER 1 INTRODUCTION TO THE ZEBRA
SCANNER WMI DRIVER
Overview
Windows Management Instrumentation (WMI) is a free component of the Microsoft Windows® operating
system that provides a scalable system management infrastructure. Using a free provider plug-in from Zebra,
WMI enables local and network remote management of a scanner. System administrators can leverage WMI to
query and set information on desktop systems, applications, networks, components, and accessories, such as
a scanner. Developers can use the underlying WMI Application Programmers Interfaces (APIs) to create
system management applications/tools that organize system information for the purposes of asset
management or other enterprise level activities. The WMI API supports the use of several high level languages
such as C++, C#, VB, VBScript, and Jscript.
For more information, search for WMI on http://msdn.microsoft.com
.
1 - 2 WMI DRIVER DEVELOPER’S GUIDE
Zebra Scanner WMI Driver Architecture
Figure 1-1
Zebra Scanner WMI Driver Architecture
Managed Objects and Providers
A provider is a COM object that monitors one or more managed objects for WMI. Similar to a driver, a provider
supplies WMI with data from a managed object. A provider also handles messages from WMI to the managed
object.
A managed object is a logical or physical enterprise component, such as a hard drive, network adapter,
database system, operating system, process, or service. A managed object communicates with WMI through a
WMI provider that calls methods in the COM API for WMI.
For example, the Platform SDK ships with the Registry provider, which accesses data in the system registry.
WMI passes information from the providers to the WMI infrastructure when client applications and scripts
request registry data. The Registry provider has one WMI class, StdRegProv, with many methods but no
properties. Other providers, such as the Win32 provider, usually have classes with many properties but few
methods, such as Win32_Process or Win32_LogicalDisk.
INTRODUCTION TO THE ZEBRA SCANNER WMI DRIVER 1 - 3
WMI Infrastructure
The WMI infrastructure is a Microsoft Windows operating system component comprised of two components:
the Windows Management service, including the WMI Core, and the WMI repository. The Windows
Management service acts as an intermediary between the providers, management applications, and the WMI
repository. The repository contains only static data about objects, such as the classes defined by providers.
WMI obtains most data dynamically from the provider when a client requests it.
Most provider classes, such as Win32_LogicalDisk, are defined in Managed Object Format (MOF) files, are
then compiled into the WMI repository by mofcomp.exe. A provider also has a DLL file which contains the code
that implements the classes.
WMI Management Applications and Scripts
A management application or script is an application that interacts with the WMI infrastructure. A management
application can query or enumerate management data by calling either the COM API for WMI or the Scripting
API for WMI. Management applications can call methods in either API to send instructions or reconfigure a
managed object. The only data or actions available for a managed object such as a disk drive or a service are
those that a provider supplies.
Zebra WMI Provider Plug-in
Zebra's driver provides a WMI interface with a mechanism to view and program scanner settings. It also
enables an administrator to perform actions such as firmware updates, event reporting on the progress of a
firmware update and the discovery of scanners, as defined in the Symbol Scanner Managed Object Format
(MOF) file. By leveraging the WMI infrastructure built into the Windows Operating System, an application
developer can write a management application to perform the following enterprise level activities:
•
Discovery (asset management)
•
Configuration deployment
•
In system firmware update.
Supported Devices
•
Any RSM-ready Zebra scanner
•
Supported Scanner Communication Modes
•
IBM Hand-held USB.
System Requirements
For system requirements, refer to the Scanner SDK Developer’s Guide.
1 - 4 WMI DRIVER DEVELOPER’S GUIDE
CHAPTER 2 INSTALLATION
INSTRUCTIONS
Overview
The Zebra WMI providers are installed as part of the Zebra Scanner SDK Installshield® package. There are
two WMI providers: Scanner WMI provider; and, Driver WMI provider. Two Windows services (Symbol Scanner
Management and RSM Driver Provider Service) are installed and start automatically. These two services are
called Zebra's WMI provider, also called the WMI plug-in.
For general installation instructions to install the Zebra Scanner SDK, refer to the installation instructions in the
Zebra Scanner SDK Programmer's Guide.
NOTE The Zebra CoreScanner Driver is a prerequisite for the Zebra WMI provider. The Zebra Scanner SDK
Installshield® package automatically installs the CoreScanner Driver if it is not already on the system. A
complete installation of the SDK installs the Zebra WMI provider. If you select the custom installation, you
must select the Scanner WMI provider and Driver WMI provider components.
2 - 2 WMI DRIVER DEVELOPER’S GUIDE
Basic Installation Verification
You can perform a basic inspection on your system process list to verify a successful installation of the Zebra
WMI provider.
To do a simple check of the Zebra WMI provider's operation:
1. Right click on the Windows Task Bar and select Task Manager.
Figure 2-1
2. Select the Processes tab.
Figure 2-2
3. In the Image Name list, find RSMDriverProviderService.exe and ScannerService.exe. The presence of
these two processes in the list indicates a successful installation.
Task Bar Menu - Task Manger
Task Manager - Processes
Loading...