feat: WASM modules based simulation in Companion (#6435)

2026-03-20 12:19:17 +10:00
parent 5f8a38bb18
commit 04a2231aee
80 changed files with 3126 additions and 2220 deletions
@@ -0,0 +1,47 @@
+# Simulator Plugin Interface
+
+## Methods
+
+```c
+
+/**
+ * Simu module functions
+ */
+
+/* Simulator plugin name */
+const char* simu_get_name();
+
+/* Start/stop */
+void simuInit();
+void simuStop(); // should be async but isn't
+bool simuIsRunning();
+
+/* Live data */
+unsigned int simu_get_num_outputs();
+const int16_t* simu_get_outputs();
+
+unsigned int simu_get_num_channels();
+const int16_t* simu_get_channels();
+
+unsigned int simu_get_num_logical_switches();
+uint32_t* simu_get_logical_switches();
+
+uint8_t simu_get_flight_mode();
+uint8_t simu_get_trim_value(uint8_t flight_mode, uint8_t axis);
+
+uint8_t simu_get_stick_mode();
+uint16_t simu_get_trim_range();
+
+void simu_get_flight_mode_name(uint8_t flight_mode, char* buffer, int buflen);
+
+// TODO: get GVar definitions + values
+
+/**
+ * Callbacks / native functions
+ */
+void simu_read_analogs(uint16_t* analogs, int num_analogs);
+uint32_t simu_read_keys();
+uint32_t simu_read_trims();
+void simu_flush_display(bool backlight, uint8_t* buffer, int buflen);
+```
+