BRLMChannel
Channel information to your printer.
Overview
You use this object to specify your printer. To send data to your printer, you initialize this class and pass it to BRLMPrinterDriverGenerator.
If you change your channel, you initialize this class again.
Instance methods
initWithWifiIPAddress:
Initialize this class with an IP address of your printer to connect through a network.
Declaration
- (instancetype)initWithWifiIPAddress:(NSString *)ipAddress;
Parameters
| Name | Type | Description |
|---|---|---|
| ipAddress | NSString * | IP Address of your printer. |
initWithBluetoothSerialNumber:
Initialize this class with a serial number of your printer to connect through Bluetooth.
Declaration
- (instancetype)initWithBluetoothSerialNumber:(BRLMExternalAccessorySerialNumber *)serialNumber;
Parameters
| Name | Type | Description |
|---|---|---|
| serialNumber | BRLMExternalAccessorySerialNumber * | A Bluetooth serial number of your printer. |
initWithBLELocalName:
Initialize this class with a local name of your printer to connect through Bluetooth Low Energy.
Declaration
- (instancetype)initWithBLELocalName:(NSString *)localName;
Parameters
| Name | Type | Description |
|---|---|---|
| localName | NSString * | A local name for Bluetooth Low Energy of your printer. |
Properties
channelType
A channel type which is set in initializing you called.
For allowed values, see BRLMChannelType.
Declaration
@property (nonatomic, readonly) BRLMChannelType channelType;
channelInfo
Channel information such as an IP Address and filepath you passed in initializing.
Declaration
@property (nonatomic, readonly) NSString *channelInfo;
extraInfo
Printer information such as model name and serial number. This only has a value when the BRLMChannel is generated by BRLMPrinterSearcher.
You can get the following values using BRLMChannelExtraInfoKey.
Declaration
@property (nonatomic, readonly, nullable) NSMutableDictionary<BRLMChannelExtraInfoKey*, NSString*> *extraInfo;
| Value | Key | Description | Network | Bluetooth | BLE |
|---|---|---|---|---|---|
| Model name | BRLMChannelExtraInfoKeyModelName | The printer's model name (e.g., QL-1110NWB)(*1) | ✔ | ✔ | ✔ |
| Serial number | BRLMChannelExtraInfoKeySerialNumber | The printer's serial number. | ✔ | ✔ | |
| IP Address | BRLMChannelExtraInfoKeyIpAddress | The printer's IP address. | ✔ | ||
| MAC address | BRLMChannelExtraInfoKeyMacAddress | The printer's MAC address. | ✔ | ||
| Node name | BRLMChannelExtraInfoKeyNodeName | The printer's node name. | ✔ | ||
| Location | BRLMChannelExtraInfoKeyLocation | The printer's location string (empty if not set). | ✔ | ||
| Advertise Local Name | BRLMChannelExtraInfoKeyAdvertiseLocalName | The printer's local name advertised. | ✔ |
Info
nil is stored for entries without a check.
Info
(*1) For TD-23XX series, Model name does not identify the model.
For example, if Model name is "TD-2350D".
The model is either TD-2350D_203 or TD-2350D_300.
Use getPrinterStatus to identify the model.
Types
BRLMExternalAccessorySerialNumber
Declaration
typedef NSString BRLMExternalAccessorySerialNumber;
BRLMChannelExtraInfoKey
Declaration
typedef NSString BRLMChannelExtraInfoKey;