Zebra Scanner WMI MOF File
The Zebra scanner WMI schema is defined using Managed Object Format (MOF) in symbscnr.mof. This file is located in the directory \Zebra Technologies\Barcode Scanners\Common. The symbscnr.mof describes and lists the properties, methods, and events exposed by the instance/method provider. If a specific device or class of device does not support a property, its property value is defined as null.
Properties, Methods and Events
Properties
Table 1: Properties Descriptions
| Name | Type | Access Allowed | Description | Valid Values |
|---|---|---|---|---|
| PartNumber | String | R (key) | Part number (model number) on the label (P/N) attached to the device. This is an 18 digit number but comes from the COM API trimmed. | Matches exactly against the label on the tag. |
| SerialNumber | String | R (Key) | Serial Number (S/N) on the label attached to the device. This is a 16 digit number but comes from the COM API trimmed. | Matches exactly against the label on the tag. |
| DateOfManufacture | String | R | Manufacturing date of the device. Format DDMMMYY. | |
| DateOfService | String | R | Date of last repair within a Zebra Authorized repair facility. Format DDMMMYY. | |
| DeviceClass | String | R | Description of the device's hardware. |
"1D Laser" "2D Laser" "Imager" "Cordless 1D Laser" "Cordless 2D Laser" "Cordless Imager" "Cordless Base Station" |
| Caption | String | R | This property is identical to PartNumber. | |
| Description | String | R | This property is identical to PartNumber. | |
| FirmwareVersion | String | R | Version of firmware in the scanner. | |
| FirmwareUpdateStatus | String | R | Status of the last firmware update operation. | |
| FirmwareUpdateBlockCount | Integer | R | Count of firmware blocks downloaded to scanner in the current firmware update operation. | |
| FirmwareUpdateTotalBlocks | Integer | R | Total number of blocks the firmware file used in current update operation. | |
| FirmwareUpdateStatusCode | Integer | R | Status code of the last completed stage of the firmware update operation. | 0 - Success 106 - Invalid file path 107 - Management failure 108 - Firmware update failure 109 - Invalid DAT file 118 - Firmware update underway |
| FirmwareUpdateStatusCodeEx | Integer | R | Download status of software component contained in the firmware file. Zero indicates at least one component successfully downloaded. Non-zero value indicates no software component was downloaded, and the reason why. | 0 - Success 110 - Firmware resident |
| MiddlewareDriverVersion | String | R | Indicates the version of the Management Suite. | |
| LastDecodeData | String | R | Identifies the last successfully decoded bar code information. The scanner can scan the bar code if it supports its symbology and the symbology is enabled. | |
| TotalDecodes | Integer | R | Total bar codes the scanner decoded. The values reset to 0 when the WMI service stops. | |
| TotalGoodDecodes | Integer | R | Total successful bar codes the scanner decoded. The values reset to 0 when the WMI service stops. | |
| LowPowerMode | Boolean | R/W | Determines whether power remains on after a decode attempt. In low power mode, the scanner enters into a reduced power consumption mode to preserve battery life after each decode attempt. | TRUE, FALSE |
| RasterMode | Byte | R/W | Sets the raster mode of the scanner. | 0, 1, 2 |
| InCradle | Boolean | R | Reports if the cordless scanner is in a charging cradle (applies to cordless only). | TRUE, FALSE |
| OperationMode | Byte | R | Reports if the scanner is being used in Hand-held Mode or Hands-Free Mode. | 0, 1 |
| UPCA | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| UPCE | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| UPCE1 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| EAN8 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| EAN13 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| ConvertUPCEtoA | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| ConvertUPCE1toA | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| UCCCouponExtendedCode | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| Code 128 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| UCCEAN128 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| Code39 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| TriopticCode39 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| Code93 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| Code11 | Boolean | R/W | Enable/Disable this symbology. | TRUE, FALSE |
| RedundancyLevel | Integer | R/W | Sets the scanner's decode redundancy level. There are four levels. Select higher levels for decreasing levels of bar code quality. As redundancy levels increase, the scanner's aggressiveness decreases. Refer to the scanner Product Reference Guide. | 0, 1, 2, 3 |
| Code11Length1 | Byte | R/W | Defines the allowable lengths for the symbology. Range: L1 < L2;Two Lengths: L2 > L1; One Length: L1 = len; L2=0; Any Length: L1=0; L2=0 | |
| Code11Length2 | Byte | R/W | Defines the allowable lengths for the symbology. Range: L1 < L2Two Lengths:L2 > L1One Length:L1 = len; L2=0Any Length:L1=0; L2=0 | |
| Code39Length1 | Byte | R/W | Defines the allowable lengths for the symbology. Range:L1 < L2Two Lengths:L2 > L1One Length:L1 = len; L2=0Any Length:L1=0; L2=0 | |
| Code39Length2 | Byte | R/W | Defines the allowable lengths for the symbology. Range: L1 < L2Two Lengths:L2 > L1One Length:L1 = len; L2=0Any Length:L1=0; L2=0 | |
| Code93Length1 | Byte | R/W | Defines the allowable lengths for the symbology. Range: L1 < L2Two Lengths:L2 > L1One Length:L1 = len; L2=0Any Length:L1=0; L2=0 | |
| Code93Length2 | Byte | R/W | Defines the allowable lengths for the symbology. Range:L1 < L2Two Lengths:L2 > L1One Length:L1 = len; L2=0Any Length:L1=0; L2=0 | |
| LaserOnTime | Byte | R/W | Defines the maximum time decode processing continues during a scan attempt. | "99" = 9.9 seconds" |
| SecurityLevel | Byte | R/W | Sets decode security for delta bar codes, which include the Code 128 family, UPC/EAN, and Code 93. There are four levels. Select increasing levels of security for decreasing levels of bar code quality. As security levels increase, the scanner's aggressiveness decreases. Refer to the scanner Product Reference Guide. | 0, 1, 2, 3 |
| BeeperFreq | Byte | R/W | Gets/sets the Beeper Tone (Low = 2, Med = 1, High = 0) Valid values range from 0 to 2 for LS4208. May vary for other scanners. | Supports values from 0 to 127; which values within this range depend on the scanner. |
| BeeperVolume | Byte | R/W | Gets/sets the Beeper Volume (Low = 2, Med = 1, High = 0) Valid values range from 0 to 2 for LS4208. May vary for other scanners. | Supports values from 0 to 127; which values within this range depend on the scanner. |
Methods
The methods in Table 2 are counterparts of the functions defined in the Scanner SDK driver COM API. See Appendix A, XML SCHEMAS for the XML schema, which is shared with the Scanner SDK driver COM API.
Table 2: Method Descriptions
| Name | Parameters | Return Values | Description |
|---|---|---|---|
| GetAllAttributes | [OUT] string |
Integer 0 - Success Non-zero - Failure |
Returns all supported attributes of the selected scanner as an xml through the Attributes parameter. The attributes returned as an out value in the Attributes parameter must match the schema on GetAllAttributes. This function is an exact mapping of the ATTR_GET method in the Scanner SDK. |
| GetAttributes |
[IN] string attNumberList [OUT] string attValueList |
Integer 0 - Success Non-zero - Failure |
Retrieves values of specific attribute numbers. Use this to query values of one or more attributes numbers. attrNumberList [in]: The attribute numbers whose values must be queried. These attribute numbers should be comma separated. See GetAttributes for the schema for the attribute numbers. attrValueList [out]: The attribute values returned as output. See GetAttributes for the schema for the numbers. This function is an exact mapping of the ATTR_GET method in the Scanner SDK. |
| SetAttributes | [OUT] string attributeSettings |
Integer 0 - Success Non-zero - Failure |
Changes the value of writable attributes in the scanner. See SetAttributes for the schema for attributeSettings. This function is an exact mapping of the ATTR_GET method in the Scanner SDK. |
| StoreAttributes | [OUT] string attributeSettings |
Integer 0 - Success Non-zero - Failure |
Changes the value of writable attributes in the scanner. See StoreAttributes for the schema for attributeSettings. This function is an exact mapping of the ATTR_GET method in the Scanner SDK. |
| UpdateFirmware | [OUT] string filePath |
Integer 0 - Success Non-zero - Failure |
Update firmware on scanner devices. The firmware file must reside on the computer to which the scanner is connected, and the file path must be fully qualified. This function supports concurrent firmware update of multiple scanner devices. A return value of 0 indicates the successful start of the firmware update, but does not guarantee firmware update success. |
| StartNewFirmware |
Integer 0 - Success Non-zero - Failure |
Reboots the scanner with the updated firmware activated. | |
| UpdateAttribMetaFile | [OUT] string filePath |
Integer 0 - Success Non-zero - Failure |
Updates the metafile that defines the names of the attributes. File path:Fully qualified path to the new meta-file. |
| ScanDisable |
Integer 0 - Success Non-zero - Failure |
Disables the scanner. | |
| ScanEnable |
Integer 0 - Success Non-zero - Failure |
Enables the scanner. |
Table 3: Return Values for WMI Methods Invocations
| Return Value | Description |
|---|---|
| 0 | Method succeeded. |
| 104 | Connection already opened |
| 106 | File path invalid (file not found). |
| 108 | Firmware update failure. |
| 109 | Invalid DAT file. |
| 110 | Resident firmware. |
| 112 | Invalid scanner. |
| 114 | Input parameter invalid. |
| 118 | Another firmware update already in progress on the scanner. |
| 122 | Driver response empty. |
| 123 | Request failed in the driver. |
| 124 | Request failed in the scanner. |
Events
The Zebra scanner WMI provider implements the events in Table 4. The events are defined in the scanner MOF file.
Table 4: Events Descriptions
| Name | Description |
|---|---|
| SymbScnrFirmwareUpdateEvent |
Occurs at different stages of firmware update activity. The following values define the Type of event. 1 - Session start 2 - Download start 3 - Download progress 11 - Session end 12 - Download end 100 - Error |
| SymbScnrDiscoveryEvent |
Occurs when a scanner is connected or disconnected from the host and are indicated using the following Status values in the event. 0 - Device lost 1 - Device found |
Zebra Driver WMI MOF File
The Zebra Driver WMI schema is defined using Managed Object Format (MOF) in the file RSMDriverProvider.mof located in the directory \Zebra Technologies\Barcode Scanners\Common. The RSMDriverProvider.mof describes and lists the properties, methods, and events exposed by the instance/method provider. If a specific device or class of device does not support a property, its property value is defined as null.
Table 5: Properties Exposed by the Instance/Method Provider
| Name | Type | Access Allowed | Description | Valid Values |
|---|---|---|---|---|
| HostAutoSwitchingEnabled | Boolean | R/W | If enabled, driver temporarily switches Non-RSM mode scanners to RSM mode, every time the scanner is attached or re-booted | TRUE, FALSE |
Table 6: Methods Exposed by the Instance/Method Provider
| Name | Parameters | Return Values | Description |
|---|---|---|---|
| GetDeviceTopology | [OUT] string DeviceTopology |
Integer 0 - Success Non-zero - Failure |
Get the Device Topology. |
| SwitchHostMode |
[IN] string ScannerIdentity, [IN] string TargetHostMode, [IN] boolean IsSilentSwitch, [IN] boolean IsPermanentChange |
Integer 0 - Success Non-zero - Failure |
|
| RebootScanner | [IN] string ScannerIdentity |
Integer 0 - Success Non-zero - Failure |
Reboot the given scanner. |
| UpdateAttributeMetaFile | [IN] string AttributeMetaFilePath |
Integer 0 - Success Non-zero - Failure |
Update Attribute MetaFile. |
Table 7: Events Exposed by the Instance/Method Provider
| Name | Description |
|---|---|
| ScannerPNPEvent |
This event occurs when a Zebra scanner is attached or detached on the host computer. Attach - 0 Detach - 1 |