Update Title/State Monitors to new json settings format

Author: charlestytler

Sources/backend-cpp/StreamdeckContext/ExportMonitors/ImageStateMonitor.cpp

@@ -6,54 +6,62 @@
 
 ImageStateMonitor::ImageStateMonitor(const json &settings) { update_settings(settings); }
 
-void ImageStateMonitor::update_settings(const json &settings)
+void ImageStateMonitor::update_settings(const json &state_monitor_settings)
 {
-    const std::string dcs_id_compare_monitor_raw = EPLJSONUtils::GetStringByName(settings, "dcs_id_compare_monitor");
-    const std::string dcs_id_compare_condition_raw =
-        EPLJSONUtils::GetStringByName(settings, "dcs_id_compare_condition");
-    const std::string dcs_id_comparison_value_raw = EPLJSONUtils::GetStringByName(settings, "dcs_id_comparison_value");
+    settings_per_state_.clear();
+    monitor_is_set_ = state_monitor_settings.size() > 0;
 
-    const bool compare_monitor_is_populated = is_integer(dcs_id_compare_monitor_raw);
-    const bool comparison_value_is_populated = is_number(dcs_id_comparison_value_raw);
-    settings_are_filled_ = compare_monitor_is_populated && comparison_value_is_populated;
-
-    if (settings_are_filled_) {
-        dcs_id_compare_monitor_ = std::stoi(dcs_id_compare_monitor_raw);
-        dcs_id_comparison_value_ = Decimal(dcs_id_comparison_value_raw);
-        if (dcs_id_compare_condition_raw == "EQUAL_TO") {
-            dcs_id_compare_condition_ = Comparison::EQUAL_TO;
-        } else if (dcs_id_compare_condition_raw == "LESS_THAN") {
-            dcs_id_compare_condition_ = Comparison::LESS_THAN;
-        } else // Default in Property Inspector html is GREATER_THAN.
-        {
-            dcs_id_compare_condition_ = Comparison::GREATER_THAN;
+    if (monitor_is_set_) {
+        for (const auto &state : state_monitor_settings) {
+            const auto addr = SimulatorAddress(state["monitor_address"]["address"],
+                                               state["monitor_address"]["mask"],
+                                               state["monitor_address"]["shift"]);
+            Comparison comp_type;
+            if (state["comparison_type"] == "LT") {
+                comp_type = Comparison::LESS_THAN;
+            } else if (state["comparison_type"] == "GT") {
+                comp_type = Comparison::GREATER_THAN;
+            } else {
+                comp_type = Comparison::EQUAL_TO;
+            }
+            settings_per_state_.push_back(StateMonitorSettings{addr, comp_type, Decimal(state["comparison_value"])});
         }
     }
 }
 
 int ImageStateMonitor::determineContextState(SimulatorInterface *simulator_interface) const
 {
-    if (settings_are_filled_) {
-        const auto maybe_current_game_value = simulator_interface->get_value_at_addr(dcs_id_compare_monitor_);
-        if (maybe_current_game_value.has_value()) {
-            return comparison_is_satisfied(maybe_current_game_value.value()) ? 1 : 0;
+    if (monitor_is_set_) {
+        for (int iState = 0; iState < settings_per_state_.size(); ++iState) {
+            const auto maybe_value = simulator_interface->get_value_at_addr(settings_per_state_[iState].address);
+            if (!maybe_value) {
+                return 0; // Return early if not all addresses are readable.
+            }
+            if (maybe_value && comparison_is_satisfied(maybe_value.value())) {
+                return iState;
+            }
         }
+        // If no conditional states are satisfied, then the last state is set.
+        return settings_per_state_.size() + 1;
     }
+    // Default to first state.
     return 0;
 }
 
-bool ImageStateMonitor::comparison_is_satisfied(Decimal current_game_value) const
+bool ImageStateMonitor::comparison_is_satisfied(const Decimal &current_game_value,
+                                                const Comparison &comparison,
+                                                const Decimal &comparison_value) const
 {
     bool comparison_result = false;
-    switch (dcs_id_compare_condition_) {
+    switch (comparison) {
     case Comparison::EQUAL_TO:
-        comparison_result = (current_game_value == dcs_id_comparison_value_);
+        comparison_result = (current_game_value == comparison_value);
         break;
     case Comparison::LESS_THAN:
-        comparison_result = (current_game_value < dcs_id_comparison_value_);
+        comparison_result = (current_game_value < comparison_value);
         break;
     case Comparison::GREATER_THAN:
-        comparison_result = (current_game_value > dcs_id_comparison_value_);
+        comparison_result = (current_game_value > comparison_value);
         break;
     }
     return comparison_result;

Sources/backend-cpp/StreamdeckContext/ExportMonitors/ImageStateMonitor.h

@@ -31,17 +31,24 @@ class ImageStateMonitor
   private:
     enum class Comparison { GREATER_THAN, EQUAL_TO, LESS_THAN };
 
+    using StateMonitorSettings = struct {
+        SimulatorAddress address;
+        Comparison comparison;
+        Decimal comparison_value;
+    };
+
     /**
-     * @brief Checks if current game value satisfies the comparison criteria configured in settings.
-     *
-     * @param current_game_value
+     * @brief Checks if current game value satisfies the comparison criteria for state.
      */
-    bool comparison_is_satisfied(Decimal current_game_value) const;
+    bool comparison_is_satisfied(const Decimal &current_game_value,
+                                 const Comparison &comparison,
+                                 const Decimal &comparison_value) const;
 
     // Status of user-filled fields.
-    bool settings_are_filled_ = false; // True if all DCS ID comparison monitor settings have been set.
+    bool monitor_is_set_ = false; // True if all monitor settings have been set.
 
     // Stored settings extracted from user-filled fields.
+    std::vector<StateMonitorSettings> settings_per_state_;
     int dcs_id_compare_monitor_ = 0; // DCS ID to monitor for context state setting according to value comparison.
     Comparison dcs_id_compare_condition_ = Comparison::GREATER_THAN; // Comparison to use for DCS ID compare monitor.
     Decimal dcs_id_comparison_value_; // Value to compare DCS ID compare monitor value to.

Sources/backend-cpp/StreamdeckContext/ExportMonitors/TitleMonitor.cpp

@@ -6,34 +6,15 @@
 
 TitleMonitor::TitleMonitor(const json &settings) { update_settings(settings); }
 
-void TitleMonitor::update_settings(const json &settings)
+void TitleMonitor::update_settings(const json &title_monitor_settings)
 {
-    const std::string dcs_id_string_monitor_raw = EPLJSONUtils::GetStringByName(settings, "dcs_id_string_monitor");
-    // Set boolean from checkbox using default false value if it doesn't exist in "settings".
-    const std::string string_monitor_vertical_spacing_raw =
-        EPLJSONUtils::GetStringByName(settings, "string_monitor_vertical_spacing");
-    string_monitor_passthrough_ = EPLJSONUtils::GetBoolByName(settings, "string_monitor_passthrough_check", true);
-    std::stringstream string_monitor_mapping_raw;
-    string_monitor_mapping_raw << EPLJSONUtils::GetStringByName(settings, "string_monitor_mapping");
-
-    string_monitor_is_set_ = is_integer(dcs_id_string_monitor_raw);
-
+    string_monitor_is_set_ = title_monitor_settings["is_set"];
     if (string_monitor_is_set_) {
-        const auto addr = std::stoi(dcs_id_string_monitor_raw);
-        dcs_id_string_monitor_ = settings.contains("string_monitor_max_string_length")
-                                     ? SimulatorAddress(addr, settings["string_monitor_max_string_length"])
-                                     : SimulatorAddress(addr);
-
-        if (is_integer(string_monitor_vertical_spacing_raw)) {
-            string_monitor_vertical_spacing_ = std::stoi(string_monitor_vertical_spacing_raw);
-        }
-        if (!string_monitor_passthrough_) {
-            string_monitor_mapping_.clear();
-            std::optional<std::pair<std::string, std::string>> maybe_token_pair;
-            while (maybe_token_pair = pop_key_and_value(string_monitor_mapping_raw, ',', '=')) {
-                string_monitor_mapping_[maybe_token_pair.value().first] = maybe_token_pair.value().second;
-            }
-        }
+        monitor_address_ = SimulatorAddress(title_monitor_settings["monitor_address"][0]["address"],
+                                            title_monitor_settings["monitor_address"][0]["max_len"]);
+        modify_string_ = title_monitor_settings["modify_string"];
+        vertical_spacing_ =
+            title_monitor_settings.contains("vertical_spacing") ? title_monitor_settings["vertical_spacing"] : 0;
     }
 }
 
@@ -43,7 +24,7 @@ std::string TitleMonitor::determineTitle(SimulatorInterface *simulator_interface
 
     if (string_monitor_is_set_) {
         const std::optional<std::string> maybe_current_game_value =
-            simulator_interface->get_string_at_addr(dcs_id_string_monitor_);
+            simulator_interface->get_string_at_addr(monitor_address_);
         if (maybe_current_game_value.has_value()) {
             updated_title = convertGameStateToTitle(maybe_current_game_value.value());
         }
@@ -55,18 +36,18 @@ std::string TitleMonitor::determineTitle(SimulatorInterface *simulator_interface
 std::string TitleMonitor::convertGameStateToTitle(const std::string &current_game_value)
 {
     std::string title;
-    if (string_monitor_passthrough_) {
-        title = current_game_value;
-    } else {
+    if (modify_string_) {
         title = string_monitor_mapping_[current_game_value];
+    } else {
+        title = current_game_value;
     }
     // Apply vertical spacing.
-    if (string_monitor_vertical_spacing_ < 0) {
-        for (int i = 0; i > string_monitor_vertical_spacing_; --i) {
+    if (vertical_spacing_ < 0) {
+        for (int i = 0; i > vertical_spacing_; --i) {
             title = "\n" + title;
         }
     } else {
-        for (int i = 0; i < string_monitor_vertical_spacing_; ++i) {
+        for (int i = 0; i < vertical_spacing_; ++i) {
             title = title + "\n";
         }
     }

Sources/backend-cpp/StreamdeckContext/ExportMonitors/TitleMonitor.h

@@ -38,9 +38,9 @@ class TitleMonitor
 
     bool string_monitor_is_set_ = false; // True if all DCS ID string monitor settings have been set.
 
-    SimulatorAddress dcs_id_string_monitor_{0}; // Simulator address to monitor for context title.
-    int string_monitor_vertical_spacing_ = 0;   // Vertical spacing (number of '\n') to include before or after title.
-    bool string_monitor_passthrough_ = true;    // Flag set by user to passthrough string to title unaltered.
+    SimulatorAddress monitor_address_{0}; // Simulator address to monitor for context title.
+    int vertical_spacing_ = 0;            // Vertical spacing (number of '\n') to include before or after title.
+    bool modify_string_ = false;          // Flag set if string should be modified before using as title.
     std::unordered_map<std::string, std::string>
         string_monitor_mapping_; // Map of received values to title text to display on context.
 };

Sources/frontend-react-js/src/comms/StreamdeckButtonSettings.tsx

@@ -9,15 +9,15 @@ export default interface StreamdeckButtonSettings {
 
 export interface StateMonitorSettings {
     monitor_address: SimulatorAddress;
-    condition_type: "LT" | "EQ" | "GT";
+    comparison_type: "LT" | "EQ" | "GT";
     comparison_value: string;
 }
 
 export interface TitleMonitorSettings {
     monitor_address: SimulatorAddress[];
     modify_string: boolean;
-    string_monitor_vertical_spacing: string;
-    string_monitor_mapping: string;
+    vertical_spacing?: number;
+    mapping?: string;
     is_set: boolean;
 }
 
@@ -55,7 +55,7 @@ interface SimulatorAddress {
     type: "ADDRESS_ONLY" | "INTEGER" | "STRING";
     mask?: number;
     shift?: number;
-    max_length?: number;
+    max_len?: number;
 }
 
 

Sources/frontend-react-js/src/pages/UserInput.tsx

@@ -1,5 +1,6 @@
 import { ChangeEvent, useState } from "react";
 import StreamdeckApi from "../comms/StreamdeckApi";
+import StreamdeckButtonSettings from "../comms/StreamdeckButtonSettings";
 
 interface Props {
     sdApi: StreamdeckApi
@@ -9,8 +10,8 @@ function UserInput({ sdApi }: Props): JSX.Element {
 
     const [sendAddress, setSendAddress] = useState(sdApi.buttonSettings.send_address);
     const [pressValue, setPressValue] = useState(sdApi.buttonSettings.press_value);
-    const [titleMonitorAddress, setTitleMonitorAddress] = useState(sdApi.buttonSettings.dcs_id_string_monitor);
-    const [titleMonitorStrLen, setTitleMonitorStrLen] = useState(sdApi.buttonSettings.string_monitor_max_string_length);
+    const [titleMonitorAddress, setTitleMonitorAddress] = useState("");
+    const [titleMonitorStrLen, setTitleMonitorStrLen] = useState(0);
 
     function handleSendAddressChange(event: ChangeEvent<HTMLInputElement>) {
         setSendAddress(event.currentTarget.value);
@@ -29,13 +30,26 @@ function UserInput({ sdApi }: Props): JSX.Element {
     }
 
     function handleSubmitButtonClick() {
-        const updatedSettings = Object.assign({}, sdApi.buttonSettings, {
-            send_address: sendAddress,
-            press_value: pressValue,
-            release_value: "0",
-            dcs_id_string_monitor: titleMonitorAddress,
-            string_monitor_max_string_length: titleMonitorStrLen,
-        });
+        const settings: StreamdeckButtonSettings = {
+            title_monitor: {
+                monitor_address: [{
+                    address: titleMonitorAddress,
+                    max_length: titleMonitorStrLen,
+                    type: "STRING"
+                }],
+                modify_string: false,
+                vertical_spacing: 0,
+                is_set: true,
+            },
+            constant_action: {
+                on_press: [{
+                    send_address: sendAddress,
+                    value: pressValue
+                }],
+                type: "CONST"
+            },
+        };
+        const updatedSettings = Object.assign({}, sdApi.buttonSettings, settings);
         sdApi.commFns.setSettings(updatedSettings);
     }