Skip to content

wingflexsim/DevDocument

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

English | 中文

WINGFLEXSIM Device Integration Documentation

Documentation and examples for integrating WINGFLEXSIM flight-simulation hardware with third-party software.

Overview

This repository describes how supported WINGFLEXSIM devices communicate over USB HID. It is intended for community developers, hardware suppliers, and enthusiasts who want to add WINGFLEXSIM device support to flight-simulation software or other connection tools.

The included examples use JavaScript and HTML so that communication can be tested directly in a compatible browser. Once you understand the protocol, you can implement it in any language or framework with USB HID support.

Getting Started

  1. Read the communication basics to understand reports, frame sizes, and uplink/downlink data.
  2. Open the protocol document for your device.
  3. Review the files in examples/ for a working JavaScript/HTML reference.
  4. Adapt the protocol to your application and preferred programming language.

Supported Device Documentation

Device Documentation
A320 EFIS CUBE Protocol
A320 FCU CUBE Protocol
A320 OVHD CUBE Protocol
A320 RMP CUBE Protocol
DAP 500 English · 中文

Additional device documentation may be added as protocols are edited and tested.

Repository Structure

.
├── docs/
│   ├── EN/          # English general documentation
│   ├── CN/          # Chinese general documentation
│   └── ...          # Device protocol documents
├── examples/        # Browser-based USB HID examples
├── README.md        # English overview
└── README_CN.md     # Chinese overview

Contributing

If you find an error, ambiguity, or translation issue, please open an issue. When reporting a protocol problem, include the device model, the relevant field or byte position, the expected behavior, and the behavior you observed.

Disclaimer

  1. This documentation is provided for unofficial, non-commercial integration of WINGFLEXSIM flight-simulation devices.
  2. An integration does not imply official support, endorsement, partnership, or commercial authorization from WINGFLEXSIM. Do not claim such a relationship without written authorization.
  3. You are responsible for testing your implementation. WINGFLEXSIM is not responsible for issues arising from third-party software or integrations, including device damage, abnormal behavior, unstable connections, reduced game performance, or crashes.
  4. The documentation may contain errors, inaccuracies, or translation mistakes due to ongoing development and international collaboration.

About

WINGFLEXSIM Development Document

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors