Index (jPyramidRS-232 1.2.5 API)

A B C D E F G I M N P R S T U V

A

AcceptorModel - Class in com.pyramidacceptors.ptalk.api: Acceptor Model enumeration as reported by Pyramid products.
AcceptorModel() - Constructor for class com.pyramidacceptors.ptalk.api.AcceptorModel
addChangeListener(PTalkEventListener) - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Subscribe to events generated by this instance
.
ALL_EVENTS_MASK - Static variable in enum com.pyramidacceptors.ptalk.api.RS232Configuration
Apex52FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex52USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex54FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex54USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex56FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex56USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex72FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex72USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex74FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex74USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex76FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Apex76USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
API_REVISION - Static variable in class com.pyramidacceptors.ptalk.api.APIConstants: String response for client code
APIConstants - Class in com.pyramidacceptors.ptalk.api: Provides constant strings and enumerations used for API transactions
between client code and the ICommDevice
APIConstants() - Constructor for class com.pyramidacceptors.ptalk.api.APIConstants
APILevel - Enum in com.pyramidacceptors.ptalk.api: API Level assists in detecting how to talk to the target ICommDevice
Aqua - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
asTest() - Static method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Returns an object that does not touch any serial ports.

B

BillDirections - Enum in com.pyramidacceptors.ptalk.api: Enumerated bill directions specifically for a bill validator type.
BillNames - Enum in com.pyramidacceptors.ptalk.api: Enumerated bill enables for a bill validator ICommDevice.
Pyramid designates up to twelve(12) slots for notes.
bytesToString(byte[]) - Static method in class com.pyramidacceptors.ptalk.api.Utilities: Byte array to string including the 0X notation
bytesToString(byte[], String) - Static method in class com.pyramidacceptors.ptalk.api.Utilities: Byte array to string including the notation

C

changeEventReceived(PTalkEvent) - Method in interface com.pyramidacceptors.ptalk.api.event.PTalkEventListener: Triggered when the event origin achieves an event
changeEventReceived(PTalkEvent) - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
com.pyramidacceptors.ptalk.api - package com.pyramidacceptors.ptalk.api: Contains all helper and worker classes relevant to to communication with a
slave device.
com.pyramidacceptors.ptalk.api.event - package com.pyramidacceptors.ptalk.api.event: Contains all events that a slave device is capable of generating.
In RS-232, a slave is always in one state and events may occur at any order
Please see the documentation in Events
COMM_TIMEOUT - Static variable in class com.pyramidacceptors.ptalk.api.APIConstants: Global, default timeout unless otherwise specified
connect() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
CONNECTION_FAILURE - Static variable in class com.pyramidacceptors.ptalk.api.event.ConnectionFailureEvent
ConnectionFailureEvent - Class in com.pyramidacceptors.ptalk.api.event: Created by cory on 4/8/2016.
ConnectionFailureEvent(Object, int) - Constructor for class com.pyramidacceptors.ptalk.api.event.ConnectionFailureEvent: Creates a new failure event tracking the total serial failures prior to this event.
CreditEvent - Class in com.pyramidacceptors.ptalk.api.event: Raised when slave raises a Credit event
Events.Credit
CreditEvent(Object, String, BillNames) - Constructor for class com.pyramidacceptors.ptalk.api.event.CreditEvent: Creates a new event
Curve - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel

D

DEFAULT_EVENT_MASK - Static variable in enum com.pyramidacceptors.ptalk.api.RS232Configuration: All flags except serial data event are enabled by default
DEVICE_IS_NOT_SUPPORTED - Static variable in exception com.pyramidacceptors.ptalk.api.PyramidDeviceException: Standard message for unsupported devices detected by the API
DEVICE_REQUIRES_UPDATE_FOR_THIS_FEATURE - Static variable in exception com.pyramidacceptors.ptalk.api.PyramidDeviceException: Standard message for devices that require a firmware request to use a
given feature
disconnect() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor

E

EscrowedEvent - Class in com.pyramidacceptors.ptalk.api.event: Raised when slave enters the Escrowed state
Events.Escrowed
EscrowedEvent(Object, String, BillNames) - Constructor for class com.pyramidacceptors.ptalk.api.event.EscrowedEvent: Creates a new event
Events - Enum in com.pyramidacceptors.ptalk.api.event: The bill acceptor will pass through a series of "States" during bill processing.

F

fromByte(byte) - Static method in class com.pyramidacceptors.ptalk.api.AcceptorModel: Retrieve model name from lookup table using standard acctype code
fromByte(byte) - Static method in enum com.pyramidacceptors.ptalk.api.BillDirections: Convert a byte into an enumerated bill direction
fromByte(byte) - Static method in enum com.pyramidacceptors.ptalk.api.BillNames: Convert a byte into an enumerated bill name

G

getAcceptorModel() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Returns the model of the target acceptor in the format This may AcceptorModel.Unknown until the 1st valid slave message is received.
getBillName() - Method in class com.pyramidacceptors.ptalk.api.event.CreditEvent: Returns the BillName that has been credited
getBillName() - Method in class com.pyramidacceptors.ptalk.api.event.EscrowedEvent: Returns the BillName that is in escrow
getEnableMask() - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration
getEscrowMode() - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration
getEventId() - Method in class com.pyramidacceptors.ptalk.api.event.PTalkEvent: Deprecated.
Use getId() instead
getEventMask() - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration
getFailureCount() - Method in class com.pyramidacceptors.ptalk.api.event.ConnectionFailureEvent: Returns the total number of failed transmissions before this event was raised.
getFirmwareRevision() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Returns the firmware revision of the target acceptor in the format major.minor.
getId() - Method in class com.pyramidacceptors.ptalk.api.event.PTalkEvent: Returns the event id for this event.
getIntId() - Method in enum com.pyramidacceptors.ptalk.api.event.Events
getMessageType() - Method in class com.pyramidacceptors.ptalk.api.event.SerialDataEvent: Returns the MessageType for this event
getPacketString() - Method in class com.pyramidacceptors.ptalk.api.event.PTalkEvent: Returns the stringified packet that this event was decoded from
getPollRate() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
getPollrate() - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Returns the current poll rate is milliseconds.
getPollRetryLimit() - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Returns the number of retries the polling loop will allow before giving up and raising a connection failure events.
getPortList() - Static method in class com.pyramidacceptors.ptalk.api.PyramidPort: Retrieve a list of ports available to the host OS
getPortList(String) - Static method in class com.pyramidacceptors.ptalk.api.PyramidPort: Retrieve a list of ports available on the given path (filter).
This is ignored on Windows
For *nix style systems you may use a path such as "/dev" or "/dev/term"
getPortList(Pattern) - Static method in class com.pyramidacceptors.ptalk.api.PyramidPort: Retrieve a list of ports with names matching the given Regex pattern
getPortList(Pattern, String) - Static method in class com.pyramidacceptors.ptalk.api.PyramidPort: Retrieve a list of ports with names matching the given Regex pattern AND
ports that reside on the given path.
This is ignored on Windows
For *nix style systems you may use a path such as "/dev" or "/dev/term"
getPortName() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
getSerialNumber() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Returns the 9-digit serial number of the target acceptor.

I

InvalidDevice - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
isConnected() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
IState - Interface in com.pyramidacceptors.ptalk.api: All alternate states must implement this interface.

M

message - Variable in class com.pyramidacceptors.ptalk.api.event.SerialDataEvent
messageType - Variable in class com.pyramidacceptors.ptalk.api.event.SerialDataEvent
MessageType - Enum in com.pyramidacceptors.ptalk.api: Created by cory on 4/7/2016.

N

newRxEvent(Object, String) - Static method in class com.pyramidacceptors.ptalk.api.event.SerialDataEvent: Generates a new slave, or Rx, type serial data event
newTxEvent(Object, String) - Static method in class com.pyramidacceptors.ptalk.api.event.SerialDataEvent: Generates a new master, or Tx, type serial data event

P

pause() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
Phoenix - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Pro2 - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
PTalkEvent - Class in com.pyramidacceptors.ptalk.api.event: Created by cory on 4/7/2016.
PTalkEvent(Object, Events, String) - Constructor for class com.pyramidacceptors.ptalk.api.event.PTalkEvent: Generates a new PTalk event.
PTalkEventListener - Interface in com.pyramidacceptors.ptalk.api.event: Implementers of this interface wish to subscribe to all PTalkEvent.
PURGE_RXCLEAR - Static variable in class com.pyramidacceptors.ptalk.api.PyramidPort
PURGE_TXCLEAR - Static variable in class com.pyramidacceptors.ptalk.api.PyramidPort
PyramidAcceptor - Class in com.pyramidacceptors.ptalk.api: The Pyramid Acceptor class is the realization of an ICommDevice.
It uses a RS-232 socket by default.
PyramidDeviceException - Exception in com.pyramidacceptors.ptalk.api: A PyramidDeviceException is thrown by any method that encounters as
exceptional circumstance while interacting with device.
PyramidDeviceException(String, String, String) - Constructor for exception com.pyramidacceptors.ptalk.api.PyramidDeviceException: A PyramidDeviceException is any exceptional situation caused by an
illegal of a connected device
PyramidPort - Class in com.pyramidacceptors.ptalk.api: A PyramidPort is an abstraction of jssc.SerialPort.

R

removeChangeListener(PTalkEventListener) - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Unsubscribe to events generated by this instance
.
requestReset() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Request the slave to perform a power cycle.
requestSerialNumber() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Request the slave to report its serial number in the next message loop.
RS232Configuration - Enum in com.pyramidacceptors.ptalk.api: RS-232 states, events and errors as defined in the RS-232 Spec.
RS232Configuration.RS232State - Enum in com.pyramidacceptors.ptalk.api: The bill acceptor will pass through a series of "States" during bill
processing.

S

SerialDataEvent - Class in com.pyramidacceptors.ptalk.api.event: Created by cory on 4/7/2016.
SerialDataEvent(Object, MessageType, String) - Constructor for class com.pyramidacceptors.ptalk.api.event.SerialDataEvent: Creates a new event
setEnabled(boolean) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Enables or disables the bill acceptor.
setEnableMask(int) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Serial Protocol often allow for the enable/disable of bills or other
features via a bit mask.
setEscrowMode(boolean) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Enable or disable escrow mode on the slave device.
setEventMask(int) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Events are the foundation of the PTalk, event driven API.
setPollRate(int) - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
setPollrate(int) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Sets the pollrate in .
setPollRetryLimit(int) - Method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Sets the polling retry limit for the polling loop.
SpectraS4FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
SpectraS4USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
SpectraS6FOR - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
SpectraS6USA - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel

T

Trilogy - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel

U

UnknownDevice - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
unpause() - Method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor
UnsupportedDevice - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Unused - Static variable in class com.pyramidacceptors.ptalk.api.AcceptorModel
Utilities - Class in com.pyramidacceptors.ptalk.api: Created by cory on 4/7/2016.
Utilities() - Constructor for class com.pyramidacceptors.ptalk.api.Utilities

V

valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.APILevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.BillDirections: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.BillNames: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.event.Events: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.MessageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.RS232Configuration.RS232State: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Returns the enum constant of this type with the specified name.
valueOfRS232(String) - Static method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Instantiate a new Pyramid Acceptor with an existing port
valueOfRS232(RS232Configuration, String, int, int, int, int) - Static method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Generate a new PyramidAcceptor with a custom port configuration.
valueOfRS232() - Static method in class com.pyramidacceptors.ptalk.api.PyramidAcceptor: Attempt to autodetect the connected slave and use a default RS-232
configuration.
values() - Static method in enum com.pyramidacceptors.ptalk.api.APILevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.BillDirections: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.BillNames: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.event.Events: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.RS232Configuration.RS232State: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.pyramidacceptors.ptalk.api.RS232Configuration: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I M N P R S T U V