Crate jcm

Modules

• usb

Structs

• CollectRequest
  Represents a Collect request message.
• Currency
  Represents device currency code and denomination.
• CurrencyAssign
  Represents a currency-to-bit assignment for CurrencyAssignResponse messages.
• CurrencyAssignList
  Represents a list of [CurrencyAsssign].
• CurrencyAssignRequest
  Represents a Status request message.
• CurrencyAssignResponse
  Represents the Response to a UID request Message.
• Denomination
  Represents the currency denomination.
• DenominationDisable
  Represents a set of denominations to disable on the device.
• DenominationDisableList
  Represents a list of DenominationDisable items.
• DenominationDisableRequest
  Represents a Denomination Disable request message.
• DenominationDisableResponse
  Represents the Response to a DenominationDisableRequest.
• DeviceStatus
  Represents the JCM device status.
• DirectionDisableRequest
  Represents a Denomination Disable request message.
• DirectionDisableResponse
  Represents the Response to a DirectionDisableRequest.
• EscrowEvent
  Represents an inhibit event.
• Event
  Represents an event Message sent by the device.
• EventCodeDetails
  Convenience struct to display details for EventCode.
• FirmwareVersion
  Represents the firmware version from a VersionResponse.
• FunctionStatusDetails
  Convenience wrapper for a detailed view of a FunctionStatus.
• HoldRequest
  Represents a Hold request message.
• HoldTimeout
  Represents the timeout in seconds to hold a note in escrow.
• IdleRequest
  Represents a Idle request message.
• InhibitDirection
  Represents denomination direction to inhibit.
• InhibitEvent
  Represents an inhibit event.
• InhibitRequest
  Represents a Idle request message.
• Message
  Represents the generic message format for JCM host-device communication.
• MessageData
  Represents message data for JCM host-device communication.
• RejectCodeDetails
  Convenience struct to display detailed RejectCode message.
• RejectRequest
  Represents a Idle request message.
• RejectedEvent
  Represents a reject event.
• Request
  Represents an event Message sent by the device.
• RequestCodeDetails
  Convenience struct to display details for RequestCode.
• ResetRequest
  Represents a Reset request message.
• Response
  Represents the generic response format for JCM host-device communication.
• StackRequest
  Represents the additional data in a stack request.
• StatusRequest
  Represents a Status request message.
• StatusResponse
  Represents the Response to a UID request Message.
• Ticket
  Represents a ticket handled by the JCM device.
• TicketMetadata
• UidRequest
  Represents a Status request message.
• UidResponse
  Represents the Response to a UID request Message.
• UnitNumber
  Represents the unit number for a device function module.
• UnitStatus
  Represents the status of a JCM device unit, e.g. Acceptor, Stacker, Recycler, etc.
• UnitStatusList
  Convenience container for a list of UnitStatus items.
• VersionRequest
  Represents a Version request message.
• VersionResponse
  Represents the response to a VersionRequest.

Enums

• BillAcceptorState
  Represents the state of the bill acceptor.
• CollectMode
  Represents the device mode for collecting notes.
• ConfId
  Represents the JCM device configuration ID.
• CurrencyCode
  ISO 4217 currency codes https://en.wikipedia.org/wiki/ISO_4217
• DenominationDisableMode
  Represents the request mode for the [DenominationDisableRequest].
• DirectionDisableMode
  Represents the request mode for the [DirectionDisableRequest].
• DirectionInhibit
  Represents variants for inhibiting a denomination direction.
• Error
  Represents error variants for the library.
• EscrowData
  Represents the additional data of an [EscrowEvent].
• EventCode
  Represents code variants for specific request messages.
• EventType
  Represents the sequence number of the device-to-host event status message.
• FailureCode
  Represents JCM device failure codes.
• FuncId
  Represents the function ID of the JCM device.
• FunctionErrors
  Represents whether the device unit is functional.
• FunctionStatus
  Represents the function status of device unit.
• MajorMinorStatus
  Represents the major-minor status of the JCM device status.
• MessageCode
• MessageId
  Represents the ID field of a message.
• MessageType
  Represents the message type.
• RejectCode
  Represents note rejection codes.
• RequestCode
  Represents code variants for specific request messages.
• RequestMode
  Represents the mode for a Request.
• RequestType
  Represents the type of host-to-device request message.
• ResponseCode
  Represents response code variants for reponse messages.
• StackStatusChange
  Represents the device status change after completing the collection operation.
• StatusCode
  Represents status codes returned by JCM devices.
• UnitAvailability
  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

• FunctionMode
  Convenience alias for FuncId for consistency with the specification.
• Result
  Convenience alias for the library Result.