Share via

CoinAcceptor Class (POS for .NET v1.12 SDK Documentation)

  • Article

2/27/2008

Defines the programmatic interface of a UPOS Coin Acceptor device.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustInherit Class CoinAcceptor
    Inherits PosCommon

public abstract class CoinAcceptor : PosCommon

public ref class CoinAcceptor abstract : public PosCommon

public abstract class CoinAcceptor extends PosCommon

public abstract class CoinAcceptor extends PosCommon

Remarks

Capabilities

The Coin Acceptor can do the following:

  • Reports the cash units and corresponding unit counts available in the Coin Acceptor.

  • Reports the cash units and cash counts of the coins which are deposited into the device between the start and end of cash acceptance to the application.

  • Reports jam conditions within the device.

  • Supports more than one currency.

The Coin Acceptor may also have the following additional capabilities:

  • Reporting the fullness levels of the Coin Acceptor’s cash units. Conditions which may be indicated include full, and almost full states.

  • Reporting of a possible (or probable) cash count discrepancy in the data reported by the ReadCashCounts method.

The general model of a Coin Acceptor is as follows:

  • The Coin Acceptor device is set to support several coin denominations. The supported cash type for a particular currency is noted by the list of cash units in the DepositCashList property.

  • This specification provides programmatic control only for the accepting of cash. The removal of cash from the device, for example, removing deposited cash, is controlled by the AdjustCashCounts method, unless the device can determine the cash on its own. The application can call ReadCashCounts to retrieve the current unit count for each cash unit, but cannot control when or how cash is removed from the device.

  • The Coin Acceptor may be set to support more than one currency. The CurrencyCode property may be set to the currency, selecting from a currency in the list DepositCodeList. DepositCashList and ReadCashCounts all act upon the current currency only.

  • Set the cash slot (or cash bin) conditions in the FullStatus property to show full and almost full status. If there are one or more full cash slots, then FullStatus is Full.

  • Coin acceptance is started by invoking the BeginDeposit method. The previous values of the properties DepositCounts and DepositAmount are initialized to zero.

The total amount of cash put into the device continues to be accumulated until either the FixDeposit method or the PauseDeposit method is executed. When the FixDeposit method is executed, the total amount of accumulated cash is stored in the DepositCounts and DepositAmount properties. If the PauseDeposit method is executed with a parameter value of Pause, then the counting of the deposited cash is suspended and the current amount of accumulated cash is also updated to the DepositCounts and DepositAmount properties. When PauseDeposit method is executed with a parameter value of Restart, counting of deposited cash is resumed and added to the accumulated totals. When the FixDeposit method is executed, the current amount of accumulated cash is updated in the DepositCounts and DepositAmount properties, and the process remains static until the EndDeposit method is invoked by using a Complete parameter to complete the deposit.

  • When the ClearInput method is executed, the queued DataEvent associated with the receipt of cash is cleared. The DepositCounts and DepositAmount properties remain set and are not cleared.

Device Sharing

The Coin Acceptor is an exclusive-use device, as follows:

  • The application must claim the device before the application enables it.

  • The application must claim and enable the device before accessing some properties, dispensing or collecting, or receiving events.

Platforms

The CoinAcceptor class requires POS for .NET version 1.11 or later versions.

Inheritance Hierarchy

System.Object
   Microsoft.PointOfService.PosDevice
     Microsoft.PointOfService.PosCommon
      Microsoft.PointOfService.CoinAcceptor
         Microsoft.PointOfService.BasicServiceObjects.CoinAcceptorBasic

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

CoinAcceptor Members
Microsoft.PointOfService Namespace