Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 2.49 KB

README.md

File metadata and controls

40 lines (33 loc) · 2.49 KB

Keypop Calypso Card C++ API

Overview

This repository contains C++ source files aligned with the Terminal Calypso Card specifications proposed by the Calypso Networks Association. This C++ interface is a port of the Keypop Calypso Card Java API, which remains the primary reference implementation. The C++ version aims to closely follow and maintain compatibility with the Java version, ensuring consistent functionality and adherence to the established specifications.

The focus of this project is on providing interface definitions essential for managing card selection and operations with Calypso cards. These interfaces serve as a foundational layer that can be extended and customized to suit specific application needs, while ensuring consistency across implementations, which is essential for enabling certification processes.

While the codebase primarily consists of header files, some .cpp files are included for internal consistency testing and validation.

Key Characteristics

  • Interface-Driven Design: The main source files define structures and interfaces. Concrete implementations can be provided by developers as per their specific requirements.
  • Modular Interfaces: Designed to support modular extensions, allowing developers to implement custom functionality while adhering to the standardized interface structure defined by this project.
  • Compliance: Aligned with the specifications of the Calypso Networks Association, ensuring that implementations conform to recognized standards, which is crucial for the terminal Calypso card layer certification.

Usage

To use the interface definitions in your project, include the relevant headers in your source files and provide concrete implementations of the defined interfaces as needed.

Documentation & Contribution Guide

The full documentation, including the UML diagrams and design guide, is available on the Keypop website.

Contributing

Refer to the contributing guide file for guidelines on how to contribute. Please adhere to the Code of Conduct when participating in this project.

License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.