Modules§
Structs§
- Collect
Request - Represents a
Collectrequest message. - Currency
- Represents device currency code and denomination.
- Currency
Assign - Represents a currency-to-bit assignment for CurrencyAssignResponse messages.
- Currency
Assign List - Represents a list of [CurrencyAsssign].
- Currency
Assign Request - Represents a
Statusrequest message. - Currency
Assign Response - Represents the Response to a UID request Message.
- Denomination
- Represents the currency denomination.
- Denomination
Disable - Represents a set of denominations to disable on the device.
- Denomination
Disable List - Represents a list of DenominationDisable items.
- Denomination
Disable Request - Represents a
Denomination Disablerequest message. - Denomination
Disable Response - Represents the Response to a DenominationDisableRequest.
- Device
Status - Represents the JCM device status.
- Direction
Disable Request - Represents a
Denomination Disablerequest message. - Direction
Disable Response - Represents the Response to a DirectionDisableRequest.
- Escrow
Event - Represents an inhibit event.
- Event
- Represents an event Message sent by the device.
- Event
Code Details - Convenience struct to display details for EventCode.
- Firmware
Version - Represents the firmware version from a VersionResponse.
- Function
Status Details - Convenience wrapper for a detailed view of a FunctionStatus.
- Hold
Request - Represents a
Holdrequest message. - Hold
Timeout - Represents the timeout in seconds to hold a note in escrow.
- Idle
Request - Represents a
Idlerequest message. - Inhibit
Direction - Represents denomination direction to inhibit.
- Inhibit
Event - Represents an inhibit event.
- Inhibit
Request - Represents a
Idlerequest message. - Message
- Represents the generic message format for JCM host-device communication.
- Message
Data - Represents message data for JCM host-device communication.
- Reject
Code Details - Convenience struct to display detailed RejectCode message.
- Reject
Request - Represents a
Idlerequest message. - Rejected
Event - Represents a reject event.
- Request
- Represents an event Message sent by the device.
- Request
Code Details - Convenience struct to display details for RequestCode.
- Reset
Request - Represents a
Resetrequest message. - Response
- Represents the generic response format for JCM host-device communication.
- Stack
Request - Represents the additional data in a stack request.
- Status
Request - Represents a
Statusrequest message. - Status
Response - Represents the Response to a UID request Message.
- Ticket
- Represents a
tickethandled by the JCM device. - Ticket
Metadata - UidRequest
- Represents a
Statusrequest message. - UidResponse
- Represents the Response to a UID request Message.
- Unit
Number - Represents the unit number for a device function module.
- Unit
Status - Represents the status of a JCM device unit, e.g.
Acceptor,Stacker,Recycler, etc. - Unit
Status List - Convenience container for a list of UnitStatus items.
- Version
Request - Represents a
Versionrequest message. - Version
Response - Represents the response to a VersionRequest.
Enums§
- Bill
Acceptor State - Represents the state of the bill acceptor.
- Collect
Mode - Represents the device mode for collecting notes.
- ConfId
- Represents the JCM device configuration ID.
- Currency
Code - ISO 4217 currency codes https://en.wikipedia.org/wiki/ISO_4217
- Denomination
Disable Mode - Represents the request mode for the [DenominationDisableRequest].
- Direction
Disable Mode - Represents the request mode for the [DirectionDisableRequest].
- Direction
Inhibit - Represents variants for inhibiting a denomination direction.
- Error
- Represents error variants for the library.
- Escrow
Data - Represents the additional data of an [EscrowEvent].
- Event
Code - Represents code variants for specific request messages.
- Event
Type - Represents the sequence number of the device-to-host event status message.
- Failure
Code - Represents JCM device failure codes.
- FuncId
- Represents the function ID of the JCM device.
- Function
Errors - Represents whether the device unit is functional.
- Function
Status - Represents the function status of device unit.
- Major
Minor Status - Represents the major-minor status of the JCM device status.
- Message
Code - Message
Id - Represents the
IDfield of a message. - Message
Type - Represents the message type.
- Reject
Code - Represents note rejection codes.
- Request
Code - Represents code variants for specific request messages.
- Request
Mode - Represents the mode for a Request.
- Request
Type - Represents the type of host-to-device request message.
- Response
Code - Represents response code variants for reponse messages.
- Stack
Status Change - Represents the device status change after completing the collection operation.
- Status
Code - Represents status codes returned by JCM devices.
- Unit
Availability - Represents whether the device unit is functional.
Constants§
- CURRENCY_
ASSIGN_ LEN - CURRENCY_
LEN - Represents the length in bytes of the Currency.
- DEFAULT_
HOLD_ TIMEOUT - Default hold timeout (in seconds).
- DENOM_
LEN - Represents the byte length of the Denomination.
- INHIBIT_
DIRECTION_ MASK - Represents the bitfield mask for InhibitDirection.
- MAX_
DATA_ LEN - Maximum length of the MessageData when converted to bytes.
- MAX_LEN
- Maximum length of the Message.
- MAX_
TICKET_ LEN - Represents the maximum length of a Ticket ASCII code.
- MAX_
UNIT_ STATUS_ LEN - Maximum number of UnitStatus items in a StatusResponse.
- MIN_
ESCROW_ DATA_ LEN - Represents the minimum byte length of EscrowData.
- MIN_LEN
- Minimum length of the Message.
Type Aliases§
- Function
Mode - Convenience alias for FuncId for consistency with the specification.
- Result
- Convenience alias for the library
Result.