CDMDataManSystem.h

Go to the documentation of this file.

//
//  CDMDataManSystem.h
//
//  Copyright (c) 2014 Cognex Corporation. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <ExternalAccessory/ExternalAccessory.h>
#import "CDMDataManSystemDelegate.h"


typedef NS_ENUM(NSInteger, CDMImageSize)
{
    kCDMImageSizeFull,
    kCDMImageSizeQuarter,
    kCDMImageSizeSixteenth,
    kCDMImageSizeSixtyFourth
};

typedef NS_ENUM(NSInteger, CDMImageQuality)
{
    kCDMImageQualityLow = 10,
    kCDMImageQualityMedium = 50,
    kCDMImageQualityHigh = 90
};

typedef NS_ENUM(NSInteger, CDMImageFormat)
{
    kCDMImageFormatBitmap = 0,
    kCDMImageFormatJpeg = 1
};

typedef NS_OPTIONS(NSInteger, CDMResultTypes)
{
    kCDMResultTypeNone = 0,
    kCDMResultTypeReadString = 1,
    kCDMResultTypeReadXml = 2,
    kCDMResultTypeXmlStatistics = 4,
    kCDMResultTypeImage = 8,
    kCDMResultTypeImageGraphics = 16,
    kCDMResultTypeTrainingResults = 32,
    kCDMResultTypeCodeQualityData = 64
};

typedef NS_ENUM(NSInteger, CDMConnectionState) {
    kCDMConnectionStateDisconnected = 0,
    kCDMConnectionStateConnecting = 1,
    kCDMConnectionStateConnected = 2,
    kCDMConnectionStateDisconnecting = 3
};

typedef enum : NSUInteger {
    DataManDeviceClass_MX,
    DataManDeviceClass_Network,
    DataManDeviceClass_PhoneCamera
} DataManDeviceClass;

@interface CDMDataManSystem : NSObject

@property (readonly) DataManDeviceClass deviceClass;

@property (readonly) CDMConnectionState connectionState;

@property (weak) id<CDMDataManSystemDelegate> delegate;

@property (nonatomic) CDMResultTypes resultTypes;

@property (readonly, getter = isHeartbeatEnabled) BOOL heartbeatEnabled;

@property (readonly, getter = isLiveImageEnabled) BOOL liveImageEnabled;

@property (nonatomic) NSTimeInterval timeout;

@property (readonly, getter = isConnected) BOOL connected;

+ (NSString *)getVersion;

+ (CDMDataManSystem *)dataManSystemWithHostname:(NSString *)hostname port:(int)port delegate:(id<CDMDataManSystemDelegate>)delegate;

+ (CDMDataManSystem *)dataManSystemWithAccessory:(EAAccessory*)accessory delegate:(id<CDMDataManSystemDelegate>)delegate;

+ (CDMDataManSystem *)dataManSystemOfExternalAccessoryWithDelegate:(id<CDMDataManSystemDelegate>)delegate;

typedef NS_ENUM(NSInteger, CDMCameraMode)
{
    kCDMCameraModeNoAimer = 0,
    kCDMCameraModePassiveAimer = 1,
    kCDMCameraModeActiveAimer = 2,
    kCDMCameraModeFrontCamera = 3
};

typedef NS_OPTIONS(NSInteger, CDMPreviewOption)
{
    kCDMPreviewOptionDefaults = 0,
    kCDMPreviewOptionNoZoomBtn = 1,
    kCDMPreviewOptionNoIllumBtn = 2,
    kCDMPreviewOptionHwTrigger = 4,
    kCDMPreviewOptionPaused = 8,
    kCDMPreviewOptionAlwaysShow = 16
};

+ (CDMDataManSystem *)dataManSystemWithCameraMode:(CDMCameraMode)cameraMode
                                   previewOptions:(CDMPreviewOption)previewOptions
                              nullablePreviewView:(UIView*)previewView
                                         delegate:(id<CDMDataManSystemDelegate>)delegate;

- (void) setPreviewContainer:(UIView*) previewContainer;


- (BOOL)connect;

- (BOOL)connectWithUsername:(NSString*)username password:(NSString*)password;

- (void)disconnect;

- (BOOL)sendCommand:(NSString *)command;

- (BOOL)sendCommand:(NSString *)command withCallback:(void(^)(CDMResponse *response))callback;

- (BOOL)sendCommand:(NSString *)command withData:(NSData *)data timeout:(NSTimeInterval)timeout expectBinaryResponse:(BOOL)expectBinaryResponse callback:(void(^)(CDMResponse *response))callback;

- (BOOL)sendBatchCommands:(NSArray *)commands completed:(void(^)())complete;

- (void)acceptIncomingConnection:(BOOL)accept;

- (void)enableHeartbeatWithInterval:(NSTimeInterval)interval;

- (void)disableHeartbeat;

- (void)enableLiveImageWithFormat:(CDMImageFormat)imageFormat imageSize:(CDMImageSize)imageSize imageQuality:(CDMImageQuality)quality callback:(void(^)(UIImage* image, CDMResponse* response))callback;

- (void)disableLiveImage;

@end