runcam 6 Interface and registry by Byte-Entropy · Pull Request #2 · UCSOAR/AvionicsTooling

Byte-Entropy · 2026-02-19T03:18:47Z

This pull request introduces a new C++ command-line tool for interfacing with RunCam devices over a serial connection, primarily for development and testing purposes. The main additions include an (optional) finite state machine (FSM) for serial communication, a registry of protocol constants and packet templates, and comprehensive documentation for usage and features.

Core functionality and protocol implementation:

Added New_RunCam_interface.cpp implementing a RunCam serial interface using a finite state machine (FSM), supporting command queueing, blind mode, and basic menu-driven user interaction for sending commands to the camera.
Introduced New_RunCam_registry.h containing protocol constants, command/action enums, and pre-defined packet templates for RunCam operations.

Documentation and usability:

Created README.md detailing features, usage instructions, menu options, and file structure for the new tool, improving accessibility for developers and testers.

- feat: Add new commands and UI improvements to Runcam interface

Copilot

Pull request overview

Adds a Windows-focused C++ CLI utility under Runcam_6/ to exercise the RunCam serial protocol for development/diagnostics, including protocol constants/templates and usage documentation.

Changes:

Added a menu-driven serial interface with a simple request queue + (optional) response-wait FSM and CRC handling.
Introduced a protocol “registry” header with command/action enums and prebuilt packet templates.
Added user documentation for building and operating the tool.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 10 comments.

File	Description
`Runcam_6/New_RunCam_interface.cpp`	Implements the CLI tool, serial comm setup, CRC, and an FSM-based send/receive loop.
`Runcam_6/New_RunCam_registry.h`	Defines protocol constants/enums and packet templates used by the interface.
`Runcam_6/README.md`	Documents features, build/run steps, and menu options for the tool.
`Runcam_6/New_RunCam_interface.exe`	Compiled binary included in the repo (should be removed from source control).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-19T03:24:14Z

Runcam_6/New_RunCam_interface.cpp

+#include <thread>
+#include <chrono>
+#include <functional>
+#include <conio.h> 


These includes appear unused in this file (<thread>, <chrono>, <conio.h>). Removing unused headers speeds up builds and reduces the chance of platform/define collisions.

Suggested change

#include <thread>

#include <chrono>

#include <functional>

#include <conio.h>

#include <functional>

Copilot · 2026-02-19T03:24:15Z

Runcam_6/New_RunCam_registry.h

+// --- 4. PRE-CALCULATED PACKETS ---
+namespace RunCamHex {
+    const std::vector<uint8_t> GET_INFO   = {0xCC, 0x00, 0x00};
+    const std::vector<uint8_t> START_REC  = {0xCC, 0x01, 0x03};
+    const std::vector<uint8_t> STOP_REC   = {0xCC, 0x01, 0x04};
+    const std::vector<uint8_t> OSD_OPEN   = {0xCC, 0x04, 0x01};
+    const std::vector<uint8_t> OSD_CLOSE  = {0xCC, 0x04, 0x02};
+    const std::vector<uint8_t> CHANGE_MODE = {RC_HEADER, CMD_CAM_CONTROL, ACT_CHANGE_MODE};
+    const std::vector<uint8_t> WIFI_BTN = {RC_HEADER, CMD_CAM_CONTROL, ACT_WIFI_BTN};
+    const std::vector<uint8_t> OSD_ENTER_PRESS = {RC_HEADER, CMD_5KEY_PRESS, OSD_ENTER};
+    const std::vector<uint8_t> OSD_ENTER_RELEASE = {RC_HEADER, CMD_5KEY_RELEASE, OSD_ENTER};
+    const std::vector<uint8_t> GET_SETTINGS = {RC_HEADER, CMD_GET_SETTINGS, 0x00};
+    const std::vector<uint8_t> READ_DETAIL = {RC_HEADER, CMD_READ_DETAIL, 0x00};
+    const std::vector<uint8_t> WRITE_SETTING = {RC_HEADER, CMD_WRITE_SETTING, 0x00};


The packet templates are defined as std::vector objects in a header, which incurs dynamic initialization (and potentially heap allocations) in every translation unit that includes this header. Consider switching these to inline constexpr std::array<uint8_t, N> (or std::span over arrays) to avoid runtime init overhead, and also consistently use RC_HEADER instead of mixing in raw 0xCC literals.

Copilot · 2026-02-19T03:24:15Z

Runcam_6/README.md

+- `[2]` Start Record - Non Functional (At least outside OSD)
+- `[3]` Stop Record - Non Functional (At least outside OSD)


Spelling/formatting: "Non Functional" should be hyphenated ("Non-functional") and sentence casing could be made consistent in these menu descriptions.

Suggested change

- `[2]` Start Record - Non Functional (At least outside OSD)

- `[3]` Stop Record - Non Functional (At least outside OSD)

- `[2]` Start Record - Non-functional (at least outside OSD)

- `[3]` Stop Record - Non-functional (at least outside OSD)

Copilot · 2026-02-19T03:24:15Z

Runcam_6/New_RunCam_interface.cpp

+                case RxState::WaitHeader:
+                    if (byte == 0xCC) {
+                        rxBuffer.clear();
+                        rxBuffer.push_back(byte);
+                        rxState = RxState::Buffering;
+                    }


The header byte is hard-coded as 0xCC here even though RC_HEADER is defined in the registry. Using the shared constant avoids divergence if the header ever changes and keeps the parser consistent with the sender.

Copilot · 2026-02-19T03:24:15Z

Runcam_6/New_RunCam_interface.cpp

+                int x, y;
+                std::string text;
+                std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << ") ---" << std::endl;
+                std::cout << "X (0-29): "; std::cin >> x;
+                std::cout << "Y (0-15): "; std::cin >> y;
+                std::cin.ignore(1000, '\n');
+                std::cout << "Text: "; std::getline(std::cin, text);
+                std::vector<uint8_t> packet = {0xCC, textCmdID, (uint8_t)text.length(), (uint8_t)x, (uint8_t)y};
+                for(char c : text) packet.push_back((uint8_t)c);
+                cam.queueRequest(packet);


Input validation is missing for text write parameters: text.length() is truncated to uint8_t, and negative/out-of-range x/y values will wrap when cast to uint8_t. Please clamp/validate x and y against the documented ranges and reject/limit text lengths beyond what the protocol supports before building the packet.

Copilot · 2026-02-19T03:24:15Z

Runcam_6/README.md

+
+## Features
+
+- Send basic control commands to a RunCam (power(simulation - can not turn on/off), OSD, etc.)


Spelling/grammar: "can not" should be "cannot" in this bullet for readability.

Suggested change

- Send basic control commands to a RunCam (power(simulation - can not turn on/off), OSD, etc.)

- Send basic control commands to a RunCam (power(simulation - cannot turn on/off), OSD, etc.)

Copilot · 2026-02-19T03:24:15Z

Runcam_6/New_RunCam_interface.cpp

+    int timeoutMs = 500;
+    RxState rxState = RxState::WaitHeader;
+    std::vector<uint8_t> rxBuffer;
+    size_t currentExpectedLen = 5;


currentExpectedLen is hard-coded to 5 bytes, so the receive FSM will treat all responses as fixed-length. Any variable-length response (or one longer than 5 bytes) will be truncated and CRC validation will fail, causing spurious timeouts. Consider parsing the protocol's length field (once buffered) to set the expected frame length dynamically before attempting CRC validation.

Suggested change

size_t currentExpectedLen = 5;

size_t currentExpectedLen = 0;

Copilot · 2026-02-19T03:24:16Z

Runcam_6/New_RunCam_interface.cpp

+        std::cout << " [2] Start Record   (0x03) - Non Functional?" << std::endl;
+        std::cout << " [3] Stop Record    (0x04)- Non Functional?" << std::endl;
+        std::cout << " [4] WiFi Button    (0x00)" << std::endl;
+        std::cout << " [5] Change Mode    (0x05)" << std::endl;


The menu label shows Change Mode as (0x05), but the action constant used by RunCamHex::CHANGE_MODE is ACT_CHANGE_MODE = 0x02. This mismatch will confuse users when correlating menu text to actual packets; update the displayed value (or print both command and action bytes).

Suggested change

std::cout << " [5] Change Mode (0x05)" << std::endl;

std::cout << " [5] Change Mode (cmd 0x05, act 0x02)" << std::endl;

Copilot · 2026-02-19T03:24:16Z

Runcam_6/New_RunCam_interface.cpp

+    std::cout << "Enter COM Port: ";
+    std::string comPort;
+    std::cin >> comPort;
+    std::cin.ignore(1000, '\n'); // Clear buffer
+
+    if (!cam.connect("\\\\.\\COM" + comPort)) {


The prompt accepts an arbitrary string, but the connection path is built as \\.\\COM + input. If the user types COM3 (common expectation from the prompt), it will try \\.\\COMCOM3 and fail. Either clarify the prompt to request only the port number (e.g., "3 for COM3") or normalize inputs that already include COM/\\.\\COM.

Suggested change

std::cout << "Enter COM Port: ";

std::string comPort;

std::cin >> comPort;

std::cin.ignore(1000, '\n'); // Clear buffer

if (!cam.connect("\\\\.\\COM" + comPort)) {

std::cout << "Enter COM Port (e.g., 3 or COM3): ";

std::string comPort;

std::cin >> comPort;

std::cin.ignore(1000, '\n'); // Clear buffer

// Normalize COM port input so that users can enter "3", "COM3", or a full path like "\\\\.\\COM3".

std::string devicePath;

if (comPort.rfind("\\\\.\\", 0) == 0) {

// User entered a full device path such as "\\\\.\\COM3"

devicePath = comPort;

} else if (comPort.rfind("COM", 0) == 0 || comPort.rfind("com", 0) == 0) {

// User entered "COM3" (case-insensitive); prepend the "\\\\.\\" prefix

devicePath = "\\\\.\\" + comPort;

} else {

// Assume user entered only the numeric part, e.g., "3"

devicePath = "\\\\.\\COM" + comPort;

}

if (!cam.connect(devicePath)) {

Copilot · 2026-02-19T03:24:16Z

Runcam_6/New_RunCam_interface.cpp

+            case '8': {
+                int x, y;
+                std::string text;
+                std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << ") ---" << std::endl;


std::hex is set on this stream and never restored. Stream formatting flags persist, which can lead to later integer output unexpectedly being printed in hex; consider restoring std::dec after printing the command id (or use a local std::ostringstream).

Suggested change

std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << ") ---" << std::endl;

std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << std::dec << ") ---" << std::endl;

Byte-Entropy added 2 commits February 18, 2026 20:06

ADD runcam interface to remote repos

f900fe6

- feat: Add new commands and UI improvements to Runcam interface

ADD runcam interface to remote repos

3d7f582

- feat: Add new commands and UI improvements to Runcam interface

Byte-Entropy requested review from AndreyDiDev and Copilot February 19, 2026 03:18

Byte-Entropy self-assigned this Feb 19, 2026

Copilot started reviewing on behalf of Byte-Entropy February 19, 2026 03:19 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

runcam 6 Interface and registry#2

runcam 6 Interface and registry#2
Byte-Entropy wants to merge 2 commits intomasterfrom
Javier/Runcam_6

Byte-Entropy commented Feb 19, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Copilot AI Feb 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

		- `[2]` Start Record - Non Functional (At least outside OSD)
		- `[3]` Stop Record - Non Functional (At least outside OSD)


		## Features

		- Send basic control commands to a RunCam (power(simulation - can not turn on/off), OSD, etc.)

	size_t currentExpectedLen = 5;
	size_t currentExpectedLen = 0;

	std::cout << " [5] Change Mode (0x05)" << std::endl;
	std::cout << " [5] Change Mode (cmd 0x05, act 0x02)" << std::endl;

-    std::cout << "Enter COM Port: ";
-    std::string comPort;
-    std::cin >> comPort;
-    std::cin.ignore(1000, '\n'); // Clear buffer
-    if (!cam.connect("\\\\.\\COM" + comPort)) {
+    std::cout << "Enter COM Port (e.g., 3 or COM3): ";
+    std::string comPort;
+    std::cin >> comPort;
+    std::cin.ignore(1000, '\n'); // Clear buffer
+    // Normalize COM port input so that users can enter "3", "COM3", or a full path like "\\\\.\\COM3".
+    std::string devicePath;
+    if (comPort.rfind("\\\\.\\", 0) == 0) {
+        // User entered a full device path such as "\\\\.\\COM3"
+        devicePath = comPort;
+    } else if (comPort.rfind("COM", 0) == 0 || comPort.rfind("com", 0) == 0) {
+        // User entered "COM3" (case-insensitive); prepend the "\\\\.\\" prefix
+        devicePath = "\\\\.\\" + comPort;
+    } else {
+        // Assume user entered only the numeric part, e.g., "3"
+        devicePath = "\\\\.\\COM" + comPort;
+    }
+    if (!cam.connect(devicePath)) {

	std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << ") ---" << std::endl;
	std::cout << "\n--- WRITE TEXT (" << std::hex << (int)textCmdID << std::dec << ") ---" << std::endl;

Comments

Conversation

Byte-Entropy commented Feb 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant