PyramidNETRS232.RS232Config Class Reference

Define the operating parameters of your bill acceptor More...

Public Member Functions
	RS232Config (string commPort)
	Create a new configuration to use for the Apex7000 validator class. Defaults to non-escrow mode. More...
	RS232Config (string commPort, bool isEscrowMode)
	Create a new configuration to use for the Apex7000 validator class. More...
virtual ICommPort	GetCommPort ()
	Create a new comm port using this configuration. By default, this library uses the internal StrongPort type. If you want to use a different implementation, create a class that extends ICommPort and override this class to return your type. More...

Properties
int	PollRate [get, set]
	Gets or sets the poll rate in milliseconds. The polled system is designed for the master to request information from the slave at a periodic rate. The rate can be as slow as 5 seconds or as fast as 50 msec between each poll. The popular rate is fast since the overall system performance (bills per minute accepted) will be slower at slower polling rates. While feeding the bill into the acceptor, the acceptor will miss a few polls, because it is reading the bill and not servicing the serial interface (Typical for acceptors using this protocol). More...
string	CommPortName [get]
	String name of the comm port (What the OS calls it) More...
bool	IsEscrowMode [get, set]
	Escrow mode allows you to manually call Stack() or Reject() on each escrowed note. If false, we stack any valid note automatically. More...
int	EscrowTimeoutSeconds [get, set]
	Gets or sets the timeout for escrow mode. By default, we wait indefinately but you may configure this to a non-zero value to enable escrow timeouts. This has the effect of sending a reject message to the acceptor once timeout occurs. More...
byte	EnableMask [get, set]
	Bitwise enable disbale pattern. Each bit set to 1 corresponds to an enabled bill. e.g. 0x7E (0b01111110) is all bill except the $1 are enabled. This value is limited to 7-bits (0x7F) and any extra bits will be unset. 0xFF -> 0x7F More...

Detailed Description

Define the operating parameters of your bill acceptor

Definition at line 9 of file RS232Config.cs.

Constructor & Destructor Documentation

RS232Config() [1/2]

PyramidNETRS232.RS232Config.RS232Config

(

string

commPort

)

Create a new configuration to use for the Apex7000 validator class. Defaults to non-escrow mode.

See also

RS232Config.IsEscrowMode

Parameters

commPort

String port name e.g. COM4

Definition at line 25 of file RS232Config.cs.

RS232Config() [2/2]

PyramidNETRS232.RS232Config.RS232Config	(	string	commPort,
		bool	isEscrowMode
	)

Create a new configuration to use for the Apex7000 validator class.

See also

RS232Config.IsEscrowMode

Parameters

commPort	String port name e.g. COM4
isEscrowMode	bool true to enable escrow mode

Definition at line 35 of file RS232Config.cs.

Member Function Documentation

GetCommPort()

virtual ICommPort PyramidNETRS232.RS232Config.GetCommPort ( )

virtual

Create a new comm port using this configuration. By default, this library uses the internal StrongPort type. If you want to use a different implementation, create a class that extends ICommPort and override this class to return your type.

Returns

ICommPort

Definition at line 107 of file RS232Config.cs.

Property Documentation

CommPortName

string PyramidNETRS232.RS232Config.CommPortName

get

String name of the comm port (What the OS calls it)

Definition at line 70 of file RS232Config.cs.

EnableMask

byte PyramidNETRS232.RS232Config.EnableMask

getset

Bitwise enable disbale pattern. Each bit set to 1 corresponds to an enabled bill. e.g. 0x7E (0b01111110) is all bill except the $1 are enabled. This value is limited to 7-bits (0x7F) and any extra bits will be unset. 0xFF -> 0x7F

Default mask is 0x7F (all enabled)

Definition at line 93 of file RS232Config.cs.

EscrowTimeoutSeconds

int PyramidNETRS232.RS232Config.EscrowTimeoutSeconds

getset

Gets or sets the timeout for escrow mode. By default, we wait indefinately but you may configure this to a non-zero value to enable escrow timeouts. This has the effect of sending a reject message to the acceptor once timeout occurs.

Default value is 0 (disabled)

Definition at line 85 of file RS232Config.cs.

IsEscrowMode

bool PyramidNETRS232.RS232Config.IsEscrowMode

getset

Escrow mode allows you to manually call Stack() or Reject() on each escrowed note. If false, we stack any valid note automatically.

Default value is false

Definition at line 77 of file RS232Config.cs.

PollRate

int PyramidNETRS232.RS232Config.PollRate

getset

Gets or sets the poll rate in milliseconds. The polled system is designed for the master to request information from the slave at a periodic rate. The rate can be as slow as 5 seconds or as fast as 50 msec between each poll. The popular rate is fast since the overall system performance (bills per minute accepted) will be slower at slower polling rates. While feeding the bill into the acceptor, the acceptor will miss a few polls, because it is reading the bill and not servicing the serial interface (Typical for acceptors using this protocol).

Default value is 100 ms

Min: 50 Max: 5000

Definition at line 52 of file RS232Config.cs.

---

The documentation for this class was generated from the following file:

• Apex7000_BillValidator/RS232Config.cs