CsUserDefs.h

Go to the documentation of this file.

/*
 * ©2015 Symbol Technologies LLC. All rights reserved.
 */

#ifndef USERDEFS_H
#define USERDEFS_H

#ifndef CMD_OPCODE
#define CMD_OPCODE
enum CmdOpcode
{   
    CMD_GET_VERSION                     = 0x3E8, 
    CMD_REGISTER_FOR_EVENTS                 = 0x3E9,
    CMD_CLAIM_DEVICE                        = 0x5DC, 
    CMD_RELEASE_DEVICE                      = 0x5DD, 
    CMD_DEVICE_ABORT_UPDATE_FIRMWARE                            = 0x7D1, 
    CMD_DEVICE_AIM_OFF                      = 0x7D2, 
    CMD_DEVICE_AIM_ON                       = 0x7D3, 
    CMD_DEVICE_LED_OFF                      = 0x7D9, 
    CMD_DEVICE_LED_ON                       = 0x7DA, 
    CMD_DEVICE_PULL_TRIGGER                 = 0x7DB, 
    CMD_DEVICE_RELEASE_TRIGGER                                  = 0x7DC, 
    CMD_DEVICE_SCAN_DISABLE                 = 0x7DD, 
    CMD_DEVICE_SCAN_ENABLE                  = 0x7DE, 
    CMD_DEVICE_BEEP_CONTROL                 = 0x7E2, 
    CMD_REBOOT_SCANNER                      = 0x7E3, 
    CMD_DEVICE_CAPTURE_IMAGE                                    = 0xBB8, 
    CMD_DEVICE_CAPTURE_BARCODE                                  = 0xDAC, 
    CMD_DEVICE_CAPTURE_VIDEO                                    = 0xFA0, 
    CMD_RSM_ATTR_GETALL                     = 0x1388, 
    CMD_RSM_ATTR_GET                        = 0x1389, 
    CMD_RSM_ATTR_GETNEXT                    = 0x138A, 
    CMD_RSM_ATTR_SET                        = 0x138C, 
    CMD_RSM_ATTR_STORE                      = 0x138D, 
    CMD_GET_DEVICE_TOPOLOGY                 = 0x138E, 
    CMD_REFRESH_TOPOLOGY                    = 0x138F, 
    CMD_START_NEW_FIRMWARE                  = 0x1396, 
    CMD_DEVICE_UPDATE_FIRMWARE                                  = 0x1398, 
    CMD_DEVICE_UPDATE_FIRMWARE_FROM_PLUGIN                      = 0x1399, 
    CMD_LOAD_CONFIGURATION                                      = 0x139C,
    CMD_DEVICE_SWITCH_HOST_MODE                                 = 0x1838, 
    CMD_SWITCH_CDC_DEVICES                                      = 0x1839  

};
#endif // CMD_OPCODE


#ifndef STATUS_ID
#define STATUS_ID
enum StatusID
{
    STATUS_OK                                   = 0, 
    STATUS_ERROR                                = 1, 
    STATUS_ERROR_PARTIAL_SUCCESS                = 8, 
    STATUS_ERROR_DEVICE_NOT_AVAILABLE           = 4, 
    STATUS_ERROR_COMMAND_RESPONSE_TIMED_OUT     = 7, 
    STATUS_ERROR_COMMLIB_UNAVAILABLE            = 101, 
    STATUS_ERROR_INCORRECT_BUFFER_SIZE          = 104, 
    STATUS_ERROR_INVALID_ARG                    = 107, 
    STATUS_ERROR_INVALID_SCANNERID              = 108, 
    STATUS_ERROR_INCORRECT_NUMBER_OF_EVENTS     = 109, 
    STATUS_ERROR_DUPLICATE_EVENTID              = 110, 
    STATUS_ERROR_INVALID_EVENTID                = 111, 
    STATUS_ERROR_DEVICE_UNAVAILABLE             = 112, 
    STATUS_ERROR_INVALID_OPCODE                 = 113, 
    STATUS_ERROR_INVALID_TYPE                   = 114, 
    STATUS_ERROR_ASYNC_NOT_SUPPORTED            = 115, 
    STATUS_ERROR_OPCODE_NOT_SUPPORTED           = 116, 
    STATUS_ERROR_OPERATION_FAILED               = 117, 
    STATUS_ERROR_REQUEST_FAILED                 = 118, 
    STATUS_ERROR_OPERATION_NOT_SUPPORTED_FOR_AUXILIARY_SCANNERS = 119,

    STATUS_ERROR_DEVICE_BUSY                    = 120, 
    STATUS_ERROR_CDC_SCANNERS_NOT_FOUND         = 150, 
    STATUS_ERROR_UNABLE_TO_OPEN_CDC_COM_PORT    = 151, 
    STATUS_ERROR_ALREADY_OPENED                 = 200, 
    STATUS_ERROR_ALREADY_CLOSED                 = 201, 
    STATUS_ERROR_CLOSED                         = 202, 
    STATUS_ERROR_INVALID_INXML                  = 300, 
    ERROR_FW_INVALID_DATFILE                    = 500, 
    ERROR_FW_UPDATE_FAILED_IN_SCN               = 501, 
    ERROR_FW_READ_FAILED_DATFILE                = 502, 
    ERROR_FW_UPDATE_INPROGRESS                  = 503, 
    ERROR_FW_UPDATE_ALREADY_ABORTED             = 504, 
    ERROR_FW_UPDATE_ABORTED                     = 505, 
    ERROR_FW_SCN_DETTACHED                      = 506, 
    STATUS_FW_SWCOMP_RESIDENT                   = 600, 
    STATUS_ERROR_INVALID_CONFIG_FILE            = 601,  
    STATUS_ERROR_INCOMPATIBLE_CONFIG_FILE       = 602,  
    STATUS_ERROR_CONFIG_FILE_SYNTAX_VALIDATION_FAILED = 603   
};
#endif // STATUS_ID

#ifndef SUBSCRIPTION_FLAG
#define SUBSCRIPTION_FLAG
enum EventSubscriptionFlags
{
    SUBSCRIBE_NONE              = 0,
    SUBSCRIBE_BARCODE           = 1,
    SUBSCRIBE_IMAGE             = 2,
    SUBSCRIBE_VIDEO             = 4,
    SUBSCRIBE_RMD               = 8,
    SUBSCRIBE_PNP               = 16,
    SUBSCRIBE_CMD_REPONSE       = 32,
    SUBSCRIBE_DIO               = 64,
    SUBSCRIBE_NOTIFICATION      = 128
};
#endif // SUBSCRIPTION_FLAG



#ifndef UF_EVENT_ID
#define UF_EVENT_ID
enum UpdateFirmwareEventID
{
    SCANNER_UF_SESS_START          = 11, 
    SCANNER_UF_DL_START            = 12, 
    SCANNER_UF_DL_PROGRESS         = 13, 
    SCANNER_UF_DL_END              = 14, 
    SCANNER_UF_SESS_END            = 15, 
    SCANNER_UF_STATUS              = 16, 
    SCANNER_UC_SESS_START          = 17, 
    SCANNER_UC_PROGRESS            = 18, 
    SCANNER_UC_SESS_END            = 19  
};
#endif

enum PnpEventType
{
    SCANNER_ATTACHED = 0, 
    SCANNER_DETACHED = 1  
};

enum ImageEventType{
    IMAGE_COMPLETE = 1, 
    IMAGE_TRAN_STATUS = 2 
};

enum VideoEventType{
    VIDEO_FRAME_COMPLETE = 1 
};


enum ImageType{
    BMP_FILE_SECTION = 3, 
    TIFF_FILE_SECTION = 4,
    JPEG_FILE_SECTION = 1,
    ISO_IEC_15434_TYPE = 5
};

#ifndef SCANNER_TYPES
#define SCANNER_TYPES
enum ScannerType
{
    SCANNER_TYPE_ALL        = 0xffff,
    SCANNER_TYPE_SNAPI      = 1,
    SCANNER_TYPE_IBMHID     = 2,
    SCANNER_TYPE_IBMTT      = 4,
    SCANNER_TYPE_HIDKB      = 8,
    SCANNER_TYPE_INVALID    = 0
};
#endif // SCANNER_TYPES


enum ScannerNotificationType{
    SCANNER_NOTIFICATION_UKNOWN =0,
    SCANNER_NOTIFICATION_DECODE_MODE, 
    SCANNER_NOTIFICATION_SNAPSHOT_MODE, 
    SCANNER_NOTIFICATION_VIDEO_MODE, 
    SCANNER_NOTIFICATION_NO_DECODE_EVENT = 1001 
};


#endif // USERDEFS_H