XPIOHUB

🌐 English | 🇷🇺 Русский

---

English

XPIOHUB is a specialized input/output (I/O) plugin for the X-Plane flight simulator. It enables two-way data exchange between the simulator and external hardware (home cockpits, radio stacks, autopilot panels) based on Arduino microcontrollers using the ASCII protocol.

🚀 Key Features

• Two-way exchange: transmit commands and read simulator variables (datarefs) in real time.
• Arduino support: compatible with Arduino boards (Nano, Uno, Leonardo, Mega, etc.).
• Flexible configuration: bind physical buttons, switches, and displays via the xpiohub.ini file.
• High performance: minimal latency due to direct communication through the serial port (COM).

📁 Project Structure

• /src — plugin source code in C++.
• /arduino — reference sketches and firmware for hardware boards.
• /docs — documentation and configuration file examples.
• xpiohub.cbp — Code::Blocks project file.

🛠 Compilation and Build (For Developers)

The project is configured for building in the Code::Blocks IDE using the GCC compiler.

Requirements

1. Code::Blocks (version with MinGW included is recommended).
2. X-Plane SDK (XPLM library header files are required). Download them from the official X-Plane Developer website.

Setting up Code::Blocks

To compile the project successfully, specify the paths to the X-Plane SDK:

1. Open the xpiohub.cbp project in Code::Blocks.
2. Go to Project -> Build options...
3. Select the root target (project name in the left menu).
4. In the Search directories -> Compiler tab, click Add and specify the path to the SDK/CHeaders/XPLM folder.
5. In the Linker settings tab, make sure the necessary libraries are linked (for Windows: XPLM.lib or XPLM_64.lib depending on your architecture).

⚙️ Quick Start for Users

1. Go to the Releases section on GitHub and download the pre-built plugin.
2. Copy the plugin file (xpiohub.xpl) into your simulator folder: X-Plane/Resources/plugins/
3. Create an xpiohub.ini configuration file in the same folder.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Русский

XPIOHUB — это специализированный плагин ввода-вывода (I/O) для авиасимулятора X-Plane. Он обеспечивает двусторонний обмен данными между симулятором и внешним аппаратным обеспечением (домашними кокпитами, радиостеками, панелями автопилота) на базе микроконтроллеров Arduino через ASCII-протокол.

🚀 Основные возможности

• Двусторонний обмен: передача команд и чтение параметров (datarefs) в реальном времени.
• Поддержка Arduino: совместимость с платами Arduino (Nano, Uno, Leonardo, Mega и др.).
• Гибкая конфигурация: привязка физических кнопок, тумблеров и дисплеев через файл xpiohub.ini.
• Высокое быстродействие: минимальные задержки благодаря прямой работе через последовательный порт (COM).

📁 Структура проекта

• /src — исходный код плагина на C++.
• /arduino — эталонные скетчи и прошивки для плат.
• /docs — документация и примеры конфигурационных файлов.
• xpiohub.cbp — файл проекта для среды разработки Code::Blocks.

🛠 Компиляция и сборка (Для разработчиков)

Проект настроен для сборки в среде Code::Blocks с использованием компилятора GCC.

Требования

1. Code::Blocks (рекомендуется версия с МинGW в комплекте).
2. X-Plane SDK (необходимы заголовочные файлы библиотеки XPLM). Их можно скачать на официальном сайте X-Plane Developer.

Настройка среды Code::Blocks

Чтобы проект успешно скомпилировался, укажите пути к X-Plane SDK:

1. Откройте проект xpiohub.cbp в Code::Blocks.
2. Перейдите в меню Project -> Build options...
3. Выберите корневую цель (название проекта в левом меню).
4. На вкладке Search directories -> Compiler нажмите Add и укажите путь к папке SDK/CHeaders/XPLM.
5. На вкладке Linker settings убедитесь, что подключены необходимые библиотеки (для Windows: XPLM.lib или XPLM_64.lib в зависимости от разрядности).

⚙️ Быстрый старт для пользователей

1. Перейдите в раздел Releases на GitHub и скачайте готовую сборку.
2. Скопируйте файл плагина (xpiohub.xpl) в папку симулятора: X-Plane/Resources/plugins/
3. Создайте конфигурационный файл xpiohub.ini в той же папке.

📄 Лицензия

Проект распространяется под свободной лицензией MIT — подробности читайте в файле LICENSE.