Class SerialPortPrinter

It represents a printer which is connected through a serial port (RS232) in the client machine.

Hierarchy

SerialPortPrinter

Implements

IClientPrinter

Index

Constructors

constructor

Properties

Id

Accessors

Methods

serialize

Constructors

constructor

new SerialPortPrinter(portName: string, baudRate: number, parity: Parity, stopBits: StopBits, dataBits: DataBits, flowControl: Handshake): SerialPortPrinter

- Defined in ClientPrinter.ts:280
Creates an instance of the SerialPortPrinter class wiht the specified information.

Parameters
- portName: string
  
  The serial port name, for example COM1.
- baudRate: number
  
  The serial port baud rate in bits per second.
- parity: Parity
  
  The serial port parity-checking protocol.
- stopBits: StopBits
  
  The serial port standard number of stopbits per byte.
- dataBits: DataBits
  
  The serial port standard length of data bits per byte.
- flowControl: Handshake
  
  The handshaking protocol for serial port transmission of data.
Returns SerialPortPrinter

Properties

Id

Id: number = 3

The Client Printer ID

Accessors

baudRate

get baudRate(): number
set baudRate(value: number): void

- Defined in ClientPrinter.ts:223
Gets or sets the serial port baud rate in bits per second. Default value is 9600

Returns number
- Defined in ClientPrinter.ts:226
Gets or sets the serial port baud rate in bits per second. Default value is 9600

Parameters
- value: number
Returns void

dataBits

get dataBits(): DataBits
set dataBits(value: DataBits): void

- Defined in ClientPrinter.ts:254
Gets or sets the serial port standard length of data bits per byte. Default value is Serial.DataBits.Eight

Returns DataBits
- Defined in ClientPrinter.ts:257
Gets or sets the serial port standard length of data bits per byte. Default value is Serial.DataBits.Eight

Parameters
- value: DataBits
Returns void

flowControl

get flowControl(): Handshake
set flowControl(value: Handshake): void

- Defined in ClientPrinter.ts:264
Gets or sets the handshaking protocol for serial port transmission of data. Default value is Serial.Handshake.XOnXOff

Returns Handshake
- Defined in ClientPrinter.ts:267
Gets or sets the handshaking protocol for serial port transmission of data. Default value is Serial.Handshake.XOnXOff

Parameters
- value: Handshake
Returns void

parity

get parity(): Parity
set parity(value: Parity): void

- Defined in ClientPrinter.ts:233
Gets or sets the serial port parity-checking protocol. Default value is Serial.Parity.None

Returns Parity
- Defined in ClientPrinter.ts:236
Gets or sets the serial port parity-checking protocol. Default value is Serial.Parity.None

Parameters
- value: Parity
Returns void

portName

get portName(): string
set portName(value: string): void

- Defined in ClientPrinter.ts:213
Gets or sets the serial port name, for example COM1. Default value is "COM1"

Returns string
- Defined in ClientPrinter.ts:216
Gets or sets the serial port name, for example COM1. Default value is "COM1"

Parameters
- value: string
Returns void

stopBits

get stopBits(): StopBits
set stopBits(value: StopBits): void

- Defined in ClientPrinter.ts:244
Gets or sets the serial port standard number of stopbits per byte. Default value is Serial.StopBits.One

Returns StopBits
- Defined in ClientPrinter.ts:247
Gets or sets the serial port standard number of stopbits per byte. Default value is Serial.StopBits.One

Parameters
- value: StopBits
Returns void

Methods

serialize

serialize(): string

Implementation of IClientPrinter.serialize
- Defined in ClientPrinter.ts:293
The Client Printer serialization.

Returns string