UniPRT SDK v1.0.0.0
 
Loading...
Searching...
No Matches
PrinterMonitor.h
1//
2// PrinterMonitor.h
3// TSCPrinters SDK
4//
5// Created by Realbuber on 2024/4/11.
6//
7
8#ifndef PrinterMonitor_h
9#define PrinterMonitor_h
10
11
12#endif /* PrinterMonitor_h */
13
14#import <Foundation/Foundation.h>
15#import <UniPRT/TcpComm.h>
16#import <UniPRT/JsonComm.h>
17#import <UniPRT/PrinterInfo.h>
18#import <UniPRT/SynchronizationContext.h>
19#import <UniPRT/JsonCommController.h>
20#import <UniPRT/JsonStringBuilder.h>
21
44@interface PrinterMonitor : NSObject
45
58@property (nonatomic, strong) NSString *engineStatus;
59
70@property (nonatomic, strong) NSArray<NSString *> *alertStatus;
71
82@property (nonatomic, strong) NSArray<NSString *> *displayStatus;
83
94@property (nonatomic, strong) NSString *DONT_CARE_ID;
95
114@property (nonatomic) BOOL engineStatusListening;
115
132@property (nonatomic) BOOL displayStatusListening;
133
150@property (nonatomic) BOOL alertStatusListening;
151
171- (instancetype)initWithTcpComm:(TcpComm *)connection;
172
192- (instancetype)initWithJsonComm:(JsonComm *)mgmtComm;
193
237- (instancetype)initWithCommDescriptor:(NSString *)commDescriptor;
238
268
303- (NSString *)getEngineStatus;
304
345- (NSArray<NSString *> *)getFaultStatus;
346
363- (void)SetEngineStatusListening:(BOOL)value;
364
381- (void)SetDisplayStatusListening:(BOOL)value;
382
399- (void)SetAlertStatusListening:(BOOL)value;
400
420typedef void (^EngineStatusCallback)(NSString *newEngineState);
421
441typedef void (^DisplayStatusCallback)(NSArray<NSString *> *panelText);
442
462typedef void (^AlertStatusCallback)(NSArray<NSString *> *alertText);
463
474@property (nonatomic, copy) EngineStatusCallback engineStatusCallback;
475
487
498@property (nonatomic, copy) AlertStatusCallback alertStatusCallback;
499
500@end
Printer information class to show printer attributes and other useful information.
Definition PrinterInfo.h:33
Module to facilitate listening/retrieval of printer unsolicited messaging or retrieval of printer sta...
Definition PrinterMonitor.h:45
BOOL displayStatusListening
Enable/disable listening/parsing unsolicited front panel display text from printer.
Definition PrinterMonitor.h:132
void(^ EngineStatusCallback)(NSString *newEngineState)
A callback type for engine status changes.
Definition PrinterMonitor.h:420
NSString * getEngineStatus()
Query the printer for the engine status.
BOOL alertStatusListening
Enable/disable listening/parsing unsolicited fault status alerts from printer.
Definition PrinterMonitor.h:150
void(^ DisplayStatusCallback)(NSArray< NSString * > *panelText)
A callback type for display status changes.
Definition PrinterMonitor.h:441
EngineStatusCallback engineStatusCallback
Holds the function to call when engine status received from printer. Function must match signature of...
Definition PrinterMonitor.h:474
AlertStatusCallback alertStatusCallback
Holds the function to call when fault/alert messages are received from printer. Function must match s...
Definition PrinterMonitor.h:498
NSArray< NSString * > * getFaultStatus()
Query the printer for fault status.
BOOL engineStatusListening
Enable/disable listening/parsing unsolicited engine status from printer.
Definition PrinterMonitor.h:114
PrinterInfo * getPrinterInfo()
Get printer information.
void(^ AlertStatusCallback)(NSArray< NSString * > *alertText)
A callback type for alert status changes.
Definition PrinterMonitor.h:462
DisplayStatusCallback displayStatusCallback
Holds the function to call when display text messages are received from printer. Function must match ...
Definition PrinterMonitor.h:486
A class for TCP communication, inheriting from AComm and conforming to the NSStreamDelegate protocol.
Definition TcpComm.h:101