Crate bnr

Device communication library for MEI/CPI BNR devices.

This library is for communicating with BNR cash devices using the BNR/XFS communication protocol over a USB connection.

Users can either use the stand-alone functions exposed by the module APIs, or create a local instance of a DeviceHandle.

Creating a local instance of a DeviceHandle allows the user to interact using the method calls directly.

The module APIs more closely mirror the C library provided by MEI/CPI, and utilize a global instance of a DeviceHandle. These APIs are more useful for backwards compatibility with applications already using the MEI/CPI libraries.

Re-exports

• pub extern crate bnr_xfs;
• pub extern crate time;

Modules

• arrays
  Work-around for const-generic arrays in serde from MikailBag:
• cash
  Functions for cash-related operations.
• denominations
  Functions for denomination operations.
• device_handle
• init
• maintenance
  Types and functionality for performing maintenance on BNR devices.
• status
  Types and functions for handling system status events.
• sys_config
  System configuration types and functionality.
• xfs
  XFS message types for BNR communication.

Macros

• create_xfs_bool
  Creates a new XFS boolean type.
• create_xfs_i4
  Creates a new XFS i4 type.
• impl_default
  Implements the Default trait for types that have a new function.
• impl_xfs_array
  Common functionality for XFS struct types.
• impl_xfs_bool
  Common functionality for XFS boolean types.
• impl_xfs_enum
  Implements traits common to XFS enum types.
• impl_xfs_i4
  Common functionality for XFS i4 types.
• impl_xfs_int
  Common functionality for XFS int types.
• impl_xfs_string
  Common functionality for XFS string types.
• impl_xfs_struct
  Common functionality for XFS struct types.
• inner_enum
  Provides convenience functions to destructure an enum with new-type variants.

Structs

• AllowUsbFrontSwitch
  Allows to use USB Front interface to communicate with the BNR. Default value is TRUE.
• Amount
  Represents a denomination amount.
• AutoPresent
  This specifies whether cash will be automatically presented to the user on execution of a dispense (autoPresent set to TRUE), or whether the cash will only be transported to the Bundler.
• AutoRetractAtInlet
  Specifies whether bill will be automatically retracted to positioner when jam occurred during bill presenting at inlet or outlet. Default value is FALSE.
• BillsTakenSensor
  The device has a bills taken sensor. Always TRUE in the BNR.
• CallbackIntermediateResponse
  Represents a response to a callback call made by the device.
• CallbackOperationResponse
  Represents a response to a callback call made by the device.
• CallbackResult
  Represents the result for a particular callback operation.
• CallbackStatus
  Represents the identification ID for a particular callback operation.
• CallbackStatusResponse
  Represents a response to a callback call made by the device.
• Capabilities
  Describes the BNR capabilities.
• CashBox
  The service can handle a cash box. Always TRUE in the BNR.
• CashOrder
  Represents a cash order event initiated by the device.
• CashType
  Represents a cash type ISO currency code, value, and variant.
• CashTypeList
  CashType list used for LCU’s secondary cash_type.
• CashUnit
  Represents a cash unit in a BNR device.
• Cashbox
  Represents a denomination cashbox amount.
• Category2
  Euro Article 6, Category 2 support
• Category3
  Euro Article 6, Category 3 support
• CdrPositionCapabilities
  Characteristics of an input/output position.
• CdrPositionCapabilitiesList
  List of position capabilties.
• CdrPositionStatusList
  List of CDR stacker status by position.
• CdrStatus
  Represents the CDR status returned by the get_status call.
• ContentStatusSupported
  Specifies whether there is a sensor to detect if the position is empty.
• Count
  Represents the note count of a CU module.
• Currency
  Represents a currency set used in the CDR.
• CurrencyCode
  Represents an ISO 4217 currency code.
• Denomination
  This structure handles a list of DenominationItems.
• DenominationInfo
  Denomination information for enabling and configuring BNR denominations.
• DenominationItem
  This structure describes the number of bills stored to or dispensed from a Logical Cash Unit.
• DenominationItems
• DenominationList
  Represents a list of DenominationInfo.
• Deposit
  The device can deposit cash. Always TRUE in the BNR.
• DepositCount
  Represents the DepositCounters deposit count.
• DepositCounters
  Represents counters for deposits.
• Detector
  The device supports a detector to verify accepted cash. Always TRUE in the BNR.
• DeviceHandle
  BNR XFS device handle for communication over USB.
• DisappearedCount
  Represents the DepositCounters disappeared count.
• Dispense
  The device can dispense cash. Equals to FALSE in BNA6 configuration, otherwise equals to TRUE.
• DispenseCount
  Represents the DispenseCounters reject count.
• DispenseCounters
  Represents counters for dispensed notes.
• DispenseRequest
  Structure that defines the parameters of bnr_Dispense() or bnr_Denominate(), to specify either an amount or a list of banknotes to dispense.
• EmptiedCount
  Represents the DepositCounters emptied count.
• EnableDenomination
  Represents whether to enable a denomination specified by a DenominationInfo.
• Escrow
  The device supports an escrow. Always TRUE in the BNR.
• EscrowSize
  Specifies the maximum number of bills on the escrow. Equals to 20 in BNA6 configuration, otherwise equals to 15.
• EuroArt6Capability
  Capabilities for Euro Article 6.
• Exponent
  Represents the exponent field of a [Currency].
• ExtendedCounters
  Represents extended counters for a cash unit.
• ForgeryCount
  Represents the DepositCounters forgery count.
• InitialCount
  Represents the initial note count of a CU module.
• Input
  Specifies whether this position can be used as source for an accept command.
• IntermediateIdentificationId
  Represents the specific call instance for a particular callback operation.
• IntermediateStacker
  The device has a temporary storage before presenting bills. Always TRUE in the BNR.
• Lock
  Representation of the lock field of a PhysicalCashUnit.
• LogicalCashUnit
  Represents a logical cash unit, and its parameters.
• LogicalCashUnitItems
• LogicalCashUnitList
  Represents a list of LogicalCashUnits.
• MaxInBills
  Maximum number of bills to be accepted by one command. Allways 1 for the BNR.
• MaxItems
  Maximum number of items which this position can hold.
• MaxOutBills
  Maximum number of bills to be dispensed by one command. Equals to 20 in BNA6 configuration, otherwise equals to 15.
• MaxSize
  Represents the maximum size of a list.
• Number
  Represents a CU ID number.
• OperationIdentificationId
  Represents the specific call instance for a particular callback operation.
• Output
  Specifies whether this position can be used as target for a dispense command.
• PcuName
  Represents the name of a PCU.
• PhysicalCashUnit
  Represents a XFS physical cash unit and its parameters.
• PhysicalCashUnitItems
• PhysicalCashUnitList
  Represents a list of PhysicalCashUnits.
• PositionStatus
  Status of a CDR stacker.
• RecognitionSensorType
  Recognition sensor type identification. Always ‘B’ in the BNR.
• Refill
  Can the BNR be refilled by placing bills of the same size on the stack of the Loader. Always TRUE in the BNR.
• Refusal
  Specifies whether refused notes can be moved to this position during cash_in command.
• RejectCount
  Represents the DispenseCounters reject count.
• RejectViaOutlet
  Specifies whether measured but unknown or inhibited notes are rejected via the BNR’s Outlet instead of the Inlet. Default value is FALSE.
• ReportUsbConsumption
  Specifies whether real max USB line consumption is reported on usb configuration descriptor instead of 0mA. Default value is FALSE.
• Retract
  The cash dispenser can retract presented bills. Always TRUE in the BNR since FW v1.3.0, FALSE with previous versions.
• RetractedCount
  Represents the DepositCounters retracted count.
• Rollback
  Specifies whether this position can be used as target forcash_in_rollback command.
• SafeDoorCmd
  This device supports a safe door command. Always FALSE in the BNR.
• SecurityLevel
  Represents the security level for acceptance of a denomination specified by a [DenominationInfo].
• ShutterCmd
  The shutter be accessed by commands. Allways FALSE in the BNR.
• ShutterStatusSupported
  Specifies whether shutter status reporting is supported.
• Size
  Represents the size of a list.
• Status
  Represents the status of a CU module.
• StudyVersion
  Represents the study version of a denomination specified by a DenominationInfo.
• Threshold
  Structure that defines the levels determining a physical cash unit ThresholdStatus.
• ThresholdEmpty
  The PCU ThresholdStatus becomes Empty when the bill count is lower or equal to this value.
• ThresholdFull
  The PCU ThresholdStatus becomes Full when the bill count is greater or equal to this value.
• ThresholdHigh
  The PCU ThresholdStatus becomes High when the bill count is greater than this value.
• ThresholdLow
  The PCU ThresholdStatus becomes Low when the bill count is lower to this value.
• TransportCount
  Represents the transport count of a CU module.
• TrustedUser
  Reserved for future use.
• Unfit
  Euro Article 6, Unfit classification
• Unit
  Represents a denomination unit.
• UnitId
  Represents the ID of an LCU and/or PCU.
• Value
  Represents the value of a CashType.
• Variant
  Represents the value of a CashType.

Enums

• AntiFishingLevel
  Defines the sensitivity level of string detection at Inlet.
• BnrError
  Represents BNR error codes.
• CdrPosition
  Represents a CDR position
• CdrType
  Types of CDR units.
• ContentStatus
  Represents content status values.
• CuKind
  Specifies, if cash unit can dispense, deposit cash or both.
• CuType
  Type of cash unit.
• DefaultRollbackPosition
  Represents a CDR position
• DeviceStatus
  Represents CDR device status values.
• DispenserStatus
  Represents CDR dispenser status values.
• Error
  An error type for the crate.
• HardwareStatus
  Represents the overall status of the CDR hardware.
• IntermediateEvent
  Cash Module intermediate event.
• IntermediateStackerStatus
  Represents intermediate stacker status values.
• LCU
  Represents the logical cash unit in the CDR.
• MixNumber
  Represents variants for mixing algorithms in different contexts of CDR operation.
• ReportingMode
  Defines the kind of error report to be generated when a failure is detected whith no bill being transported.
• SafeDoorStatus
  Represents safe door status values.
• SecuredCommLevel
  Values for indication of the security level in communication between Host and BNR.
• SelfTestMode
  Defines how the BNR perform the self tests.
• ShutterStatus
  Represents shutter status values.
• ThresholdMode
  Threshold mode used to determine the [ThresholdStatus] of a PCU.
• ThresholdStatus
  Filling status of a cash unit.
• TransportStatus
  Represents transport status values.
• UsbError
  Represents USB error codes.

Constants

• BNR_CALLBACK_CALL_EP
  BNR USB endpoint for device-to-host asynchronous callback calls.
• BNR_CALLBACK_RESPONSE_EP
  BNR USB endpoint for host-to-device asynchronous callback responses.
• BNR_CALL_EP
  BNR USB endpoint for host-to-device XfsMethodCalls.
• BNR_PID
  BNR USB Product ID.
• BNR_RESPONSE_EP
  BNR USB endpoint for device-to-host XfsMethodResponses.
• BNR_VID
  BNR USB Vendor ID.
• CASH_AVAILABLE
• CASH_TAKEN
• CASH_TYPE_LIST_LEN
• CASH_UNIT_CHANGED
• CASH_UNIT_CONFIG_CHANGED
• CASH_UNIT_OK
• CASH_UNIT_STATE
• CASH_UNIT_STOP
• CASH_UNIT_THRESHOLD
• CASH_UNIT_UNKNOWN
• CDR_IS_EMPTY
• CDR_IS_NOT_EMPTY
• CDR_IS_UNKNOWN
• CDR_POS_BOTTOM
• CDR_POS_CAP_LIST_LEN
• CDR_POS_TOP
• CT_EMPTY
• CT_NOT_EMPTY
• DENOMINATION_LIST_LEN
• DENOM_ITEM_LEN
• DEVICE_STATUS_CHANGED
• HARDWARE_ERROR
• LCU_BAIT_TRAP
• LCU_BILL_CASSETTE
• LCU_COIN_CYLINDER
• LCU_COIN_DISPENSER
• LCU_COUPON
• LCU_CURRENCY_CASSETTE
• LCU_DEPOSIT
• LCU_DISPENSE
• LCU_DOCUMENT
• LCU_EMPTY
• LCU_ESCROW
• LCU_FULL
• LCU_HIGH
• LCU_INOP
• LCU_LIST_LEN
  Maximum number of LogicalCashUnits that can be present on a device.
• LCU_LOW
• LCU_MISSING
• LCU_NA
• LCU_NOT_DISPENSABLE
• LCU_NO_REF
• LCU_NO_VALUE
• LCU_OK
• LCU_OVERFLOW_CASSETTE
• LCU_RECYCLE
• LCU_REJECT_CASSETTE
• LCU_RETRACT_CASSETTE
• LCU_UNKNOWN
• OFF_LINE
• ON_LINE
• PCU_LIST_LEN
  Maximum number of PhysicalCashUnits that can be present on a device.
• PCU_NAME_LEN
• POS_STATUS_LIST_LEN
• SD_LOCKED
• SD_OPEN
• SD_UNKNOWN
• SHT_CLOSED
• SHT_NOT_SUPPORTED
• SHT_OPEN
• SHT_UNKNOWN
• TRANSPORT_CHANGED
• TRANSPORT_INOP
• TRANSPORT_OK
• TRANSPORT_UNKNOWN
• UNIT_ID_LEN
• URB_LEN
  Length of the URB (USB Request Block) header length on Linux.
• USER_ERROR

Traits

• CallbackArg
  Trait for arguments to state change callbacks used by the XFS API.

Functions

• with_handle
  Locks the global DeviceHandle instance, and calls the provided callback.

Type Aliases

• IntermediateOccurredFn
  Function signature for the Intermediate Occurred callback used by the XFS API.
• OperationCompletedFn
  Function signature for the Operation Completed callback used by the XFS API.
• Result
  Convenience alias for a Result type for the crate.
• StatusOccurredFn
  Function signature for the Status Occured callback used by the XFS API.