Home

PosSharp API Reference (Wiki)

Welcome to the PosSharp API documentation. This reference is automatically generated from the source code.

🏗️ Architecture Overview

PosSharp is designed with a clear separation between contracts and implementations.

graph TD
    subgraph Core ["PosSharp.Core (Implementations)"]
        CoreLogic[Base Implementation]
        MediatorImpl[UposMediator]
        LifecycleLogic[Lifecycle Orchestration]
    end

    subgraph Abstractions ["PosSharp.Abstractions (Contracts)"]
        Interfaces[IUposDevice / IUposMediator]
        Reactive[Reactive Streams / R3]
        Enums[Error Codes / Constants]
    end

    %% Dependency relationship
    Core -.->|Depends on| Abstractions

    %% Usage Patterns
    App([Your Application]) -.->|Uses| Abstractions
    Dev([Your Device]) -.->|Implements| Core

Loading

🧱 Assemblies

• PosSharp.Abstractions: Core Contracts & Definitions. Contains UPOS standard interfaces, common error codes, event arguments, and reactive state types that define the framework's behavior.
• PosSharp.Core: Reference Implementations. Provides functional base classes for device developers, lifecycle orchestration logic, and the default mediator implementation.

🔑 Key Interfaces

• IUposDevice: The primary interface for all UPOS devices.
• IUposMediator: The mediator interface for state synchronization and command routing.

📖 Main Project Documentation (GitHub Repository)

For detailed guides, design principles, and compliance information, please refer to the main repository's documentation:

• Project README (Overview & Getting Started)
• Documentation Index
• UPOS Compliance Matrix
• POS for .NET Compatibility Guide
• OPOS Mapping Table
• JavaPOS (JPOS) Mapping

---