PyramidNETRS232 Namespace Reference

Classes
class	CreditArgs
	Properties of a credit event More...
class	DebugBufferEntry
	Helper entry for describing serial communication transactions More...
class	DebugEntryArgs
	Properties of a debug entry event More...
class	ErrorArgs
	Properties of an error event More...
class	EscrowArgs
	Properties of an escrow event See also RS232Config.IsEscrowMode More...
class	EventChangedArgs
	Properties of an event change event More...
class	Extensions
	Add-ons for what is missing from 3.5 .NET
class	MasterCodex
class	PyramidAcceptor
	The main class that does the actual "talking" the acceptor. In the context of documentation, this object what is referred to as the master and the acceptor is the slave device. More...
struct	Request
	Base message from which all packets are derived
class	RS232Config
	Define the operating parameters of your bill acceptor More...
class	SlaveCodex
	Used internally to quickly translate between bytes and the string meaning
class	StateChangedArgs
	Properties of a state change event More...

Enumerations
enum	States : byte {   States.Offline, States.Idling, States.Accepting, States.Escrowed,   States.Stacking, States.Returning, States.BillJammed, States.StackerFull,   States.AcceptorFailure }
	The bill acceptor will pass through a series of "States" during bill processing. The acceptor will always be in one single "State". If the acceptor is waiting for a bill insertion, it will report an "Idle" state to the master. If the acceptor is reading a bill, it will report an "Accepting" state to the master. The change from one state to another is called a transition. More...
enum	Events : byte {   Events.None = 0, Events.Stacked = 1 << 0, Events.Returned = 1 << 1, Events.Cheated = 1 << 2,   Events.BillRejected = 1 << 3, Events.PowerUp = 1 << 4, Events.InvalidCommand = 1 << 5 }
	Slave acceptor may report a single-shot "Event" taking place. Multiple events may be reported in a single message. Events are only reported one time and will always accompany a state. If a message is retransmitted, the event will be reported a second time but only becuase it was for a retransmission, not because the event occured twice. If the slave has just stacked a bill in the cashbox, the slave will report a "Stacked" event and since it is now waiting for another bill insertion, it will also report an "Idle" state within the same message. More...
enum	Errors : byte {   Errors.None = 0, Errors.Timeout = 1 << 0, Errors.WriteError = 1 << 1, Errors.PortError = 1 << 2,   Errors.CashboxMissing = 1 << 3, Errors.ChecksumError = 1 << 4, Errors.InvalidCommand = 1 << 5, Errors.FailedToOpenPort = 1 << 6 }
	Errors reported by this library More...
enum	Flows { Flows.Master, Flows.Slave }
	The origin of this debug entry More...

Enumeration Type Documentation

Errors

enum PyramidNETRS232.Errors : byte

strong

Errors reported by this library

Enumerator
None	Default error type - nothing is wrong
Timeout	Timed out reading from slave
WriteError	Error occured while writing to slave. Possible break in serial connection.
PortError	Unable to open, close, or write to port. May occur if USB VCP is suddenly removed.
CashboxMissing	Cashbox is not detected by slave
ChecksumError	Message from slave has an incorrect checksum. If you see this along with InvalidCommands, it is likely that the serial connection is damaged.
InvalidCommand	The last message received from the slave contains 1 or more invalid messages. If you see this along with ChecksumErrors, it is likely that the serial connection is damaged.
FailedToOpenPort	Usually occurs when the target port is already open. May also occur on some virtual null modems.

Definition at line 126 of file DataContracts.cs.

Events

enum PyramidNETRS232.Events : byte

strong

Slave acceptor may report a single-shot "Event" taking place. Multiple events may be reported in a single message. Events are only reported one time and will always accompany a state. If a message is retransmitted, the event will be reported a second time but only becuase it was for a retransmission, not because the event occured twice. If the slave has just stacked a bill in the cashbox, the slave will report a "Stacked" event and since it is now waiting for another bill insertion, it will also report an "Idle" state within the same message.

Enumerator
None	No events to report
Stacked	Note has successfully been added to the cashbox
Returned	Note has successfully been returned to the patron
Cheated	Cheat attempt suspected. The Apex 7000 will return a note to the patron if a cheat is suspected.
BillRejected	Note was not recognized as valid OR was recognized as valid but disabled note.
PowerUp	The slave is powering up while this event is being reported. No commands sent by the master to the slave will be acted upon until the power up event is over.
InvalidCommand	Slave reports that the last message received from the master was invalid.

Definition at line 80 of file DataContracts.cs.

Flows

enum PyramidNETRS232.Flows

strong

The origin of this debug entry

Enumerator
Master	Sent by master
Slave	Sent by slave

Definition at line 113 of file DebugBuffer.cs.

States

enum PyramidNETRS232.States : byte

strong

The bill acceptor will pass through a series of "States" during bill processing. The acceptor will always be in one single "State". If the acceptor is waiting for a bill insertion, it will report an "Idle" state to the master. If the acceptor is reading a bill, it will report an "Accepting" state to the master. The change from one state to another is called a transition.

Enumerator
Offline	No slave is currently attached to the master.
Idling	Slave reports normal, idle activity. Ready to accept notes.
Accepting	Slave reports that it is currently pulling in a note.
Escrowed	Slave reports that a note is in the escrow position. This position is a physical location inside the acceptor that is too far for the customer to pull back but not far enough to that it can't be returned if necessary. This state is only report in Escrow Mode. See also RS232Config.IsEscrowMode
Stacking	Slave reports that the note is in the process of being stacked.
Returning	Slave reports that the note is in the process of being returned.
BillJammed	Slave reports that there is a note jam in the feed path that is was not able to clear after a reasonable amount of time. This jam may be located in the cashbox or the main bottom plate.
StackerFull	Slave reports that the cashbox is full and unable to stack anymore notes. When this state is reported, the acceptor is considered out of service. The front LEDs will be off and no notes can be inserted until the cashbox is emptied $$$.
AcceptorFailure	Slave reports a failure that is not a jam or cashbox related issue. This could include motor failure or EEPROM/Flash memory failure.

Definition at line 11 of file DataContracts.cs.