BluetoothTerminalManager

public class BluetoothTerminalManager : NSObject

extension BluetoothTerminalManager: CBCentralManagerDelegate

The BluetoothTerminalManager class manages card terminals.

Author

Godfrey Chung

Version

1.0

Date

17 Nov 2017

TerminalType
The terminal type
See more
Declaration
Swift

public enum TerminalType
ioctlEscape
This control code is to send escape command.
Declaration
Swift

public static let ioctlEscape: Int
BatteryStatus
Battery status

Since
0.4
See more
Declaration
Swift

public enum BatteryStatus
DeviceInfoType
The device information type

Since
0.5
See more
Declaration
Swift

public enum DeviceInfoType : Int
delegate
The delegate object you want to receive Bluetooth terminal manager events.
Declaration
Swift

public var delegate: BluetoothTerminalManagerDelegate?


                    
                    
                    centralManager

The central manager

Declaration

Swift

public private(set) var centralManager: CBCentralManager! { get }


                    
                    
                    startScan(terminalType:)

Starts the scanning for available card terminals.

Declaration

Swift

public func startScan(terminalType: TerminalType)

Parameters


                                terminalType

the terminal type. It can be TerminalType.acr3901us1, TerminalType.acr1255uj1, TerminalType.amr220c or TerminalType.acr1555u.

stopScan()
Stops the scanning for available card terminals.
Declaration
Swift

public func stopScan()


                    
                    
                    timeouts(terminal:)

Gets the timeouts from the card terminal.

Declaration

Swift

public func timeouts(terminal: CardTerminal) throws -> TerminalTimeouts

Parameters


                                terminal

the card terminal

Return Value

the timeouts


                    
                    
                    setMasterKey(terminal:masterKey:)

Sets the master key from the card terminal.

Since

0.3

Declaration

Swift

public func setMasterKey(terminal: CardTerminal,
                         masterKey: [UInt8]?) throws

Parameters

`terminal`	the card terminal
`masterKey`	the master key


                    
                    
                    terminalType(terminal:)

Gets the terminal type from the card terminal.

Since

0.3

Declaration

Swift

public func terminalType(terminal: CardTerminal) throws -> TerminalType

Parameters


                                terminal

the card terminal

Return Value

the terminal type


                    
                    
                    batteryStatus(terminal:timeout:)

Gets the battery status from the card terminal.

Since

0.4

Throws

CardError.operationFailed if the card operation failed

Declaration

Swift

public func batteryStatus(terminal: CardTerminal,
                          timeout: Int) throws -> BatteryStatus

Parameters

`terminal`	the card terminal
`timeout`	the maximum time to wait in milliseconds

Return Value

the battery status


                    
                    
                    batteryLevel(terminal:timeout:)

Gets the battery level from the card terminal.

Since

0.4

Throws

CardError.operationFailed if the card operation failed

Declaration

Swift

public func batteryLevel(terminal: CardTerminal,
                         timeout: Int) throws -> Int

Parameters

`terminal`	the card terminal
`timeout`	the maximum time to wait in milliseconds

Return Value

the battery level. -1 if the card terminal does not support it.


                    
                    
                    deviceInfo(terminal:type:timeout:)

Gets the device information.

Since

0.5

Throws

CardError.operationFailed if the card operation failed

Declaration

Swift

public func deviceInfo(terminal: CardTerminal,
                       type: BluetoothTerminalManager.DeviceInfoType,
                       timeout: Int) throws -> String?

Parameters

`terminal`	the card terminal
`type`	the device information type
`timeout`	the maximum time to wait in milliseconds

Return Value

the device information. nil if the card terminal does not support it.


                    
                    
                    disconnect(terminal:)

Disconnects the card terminal.

Declaration

Swift

public func disconnect(terminal: CardTerminal) throws

Parameters


                                terminal

the card terminal

CBCentralManagerDelegate


                    
                    
                    centralManagerDidUpdateState(_:)

Undocumented

Declaration

Swift

public func centralManagerDidUpdateState(_ central: CBCentralManager)


                    
                    
                    centralManager(_:didDiscover:advertisementData:rssi:)

Undocumented

Declaration

Swift

public func centralManager(_ central: CBCentralManager,
                           didDiscover peripheral: CBPeripheral,
                           advertisementData: [String : Any],
                           rssi RSSI: NSNumber)


                    
                    
                    centralManager(_:didConnect:)

Undocumented

Declaration

Swift

public func centralManager(_ central: CBCentralManager,
                           didConnect peripheral: CBPeripheral)


                    
                    
                    centralManager(_:didFailToConnect:error:)

Undocumented

Declaration

Swift

public func centralManager(_ central: CBCentralManager,
                           didFailToConnect peripheral: CBPeripheral,
                           error: Error?)


                    
                    
                    centralManager(_:didDisconnectPeripheral:error:)

Undocumented

Declaration

Swift

public func centralManager(_ central: CBCentralManager,
                           didDisconnectPeripheral peripheral: CBPeripheral,
                           error: Error?)