BRLMPrinterStatus

A class for printer status.

Overview

You use this object to know your printer status.

Properties

rawData

A raw data of your printer status.

Declaration

@property (nonatomic, readonly) BRLMPrinterStatusRawDataStructure rawData;

Return Value

See BRLMPrinterStatusRawDataStructure.

model

A printer model indicated in the rawData.

Declaration

@property (nonatomic, readonly) BRLMPrinterModel model;

Return Value

See BRLMPrinterModel

errorCode

A printer error state indicated in the rawData.

Declaration

@property (nonatomic, readonly) BRLMPrinterStatusErrorCode errorCode;

Return Value

See BRLMPrinterStatusErrorCode

batteryStatus

A printer battery state indicated in rawData. If the model has no battery status, it is nil.

Declaration

@property (nonatomic, readonly, nullable) BRLMPrinterBatteryStatus* batteryStatus;

Return Value

See BRLMPrinterBatteryStatus.

mediaInfo

A media information in the printer indicated in rawData. If the model has no media information, it is nil.

Declaration

@property (nonatomic, readonly, nullable) BRLMMediaInfo* mediaInfo;

Return Value

See BRLMMediaInfo.

Types

BRLMPrinterStatusRawDataStructure

A raw data of your printer status. To know what this shows by yourself, see a command reference of your printer.

Declaration

typedef struct {
    Byte    byHead;                // Head mark
    Byte    bySize;                // Size
    Byte    byBrotherCode;         // Brother code
    Byte    bySeriesCode;          // Serial code
    Byte    byModelCode;           // Model code
    Byte    byNationCode;          // Nation code
    Byte    byFiller;              // information about cover
    Byte    byFiller2;             // Not used
    Byte    byErrorInf;            // Error information 1
    Byte    byErrorInf2;           // Error information 2
    Byte    byMediaWidth;          // Media width
    Byte    byMediaType;           // Media type
    Byte    byColorNum;            // The number of colors
    Byte    byFont;                // Font
    Byte    byJapanesFont;         // Japanese font
    Byte    byMode;                // Mode
    Byte    byDensity;             // Density
    Byte    byMediaLength;         // Media Length
    Byte    byStatusType;          // Status Type
    Byte    byPhaseType;           // Phase type
    Byte    byPhaseNoHi;           // Upper bytes of phase number
    Byte    byPhaseNoLow;          // Lower bytes of phase number
    Byte    byNoticeNo;            // Notice number
    Byte    byExtByteNum;          // Total bytes of extended part
    Byte    byLabelColor;          // Color of label
    Byte    byFontColor;           // Color of font
    Byte    byHardWareSetting[4];  // Settings of hardware
    Byte    byNoUse[2];            // Not Use
} BRLMPrinterStatusRawDataStructure;

Info

byMediaWidth and byMediaLength are rounded to the nearest 1 mm. Some models cannot be obtained, in which case 0 is assigned.

BRLMPrinterStatusErrorCode

Declaration

typedef NS_ENUM(NSInteger, BRLMPrinterStatusErrorCode) {
    BRLMPrinterStatusErrorCodeNoError,
    BRLMPrinterStatusErrorCodeNoPaper,
    BRLMPrinterStatusErrorCodeCoverOpen,
    BRLMPrinterStatusErrorCodeBusy,
    BRLMPrinterStatusErrorCodePaperJam,
    BRLMPrinterStatusErrorCodeHighVoltageAdapter,
    BRLMPrinterStatusErrorCodeBatteryEmpty,
    BRLMPrinterStatusErrorCodeBatteryTrouble,
    BRLMPrinterStatusErrorCodeTubeNotDetected,
    BRLMPrinterStatusErrorCodeUnsupportedCharger,
    BRLMPrinterStatusErrorCodeIncompatibleOptionalEquipment,
    BRLMPrinterStatusErrorCodeSystemError,
    BRLMPrinterStatusErrorCodeAnotherError,
};

Deprecates

Deprecated

ptStatus

Please use rawData instead.