mayhem-firmware/firmware/application/external/ook_remote/ui_ook_remote.hpp

/*
 * Copyright (C) 2024 Samir Sánchez Garnica @sasaga92
 *
 * This file is part of PortaPack.
 *
 */

#ifndef __UI_OOK_REMOTE_H__
#define __UI_OOK_REMOTE_H__

#include "ui.hpp"
#include "ui_language.hpp"
#include "ui_widget.hpp"
#include "ui_navigation.hpp"
#include "string_format.hpp"
#include "radio_state.hpp"
#include "ui_freq_field.hpp"
#include "ui_transmitter.hpp"
#include "app_settings.hpp"
#include "transmitter_model.hpp"
#include <string>

using namespace ui;

namespace ui::external_app::ook_remote {

#define PROGRESS_MAX 100
#define OOK_SAMPLERATE_DEFAULT 2280000U            // Set the default Sample Rate
#define TRANSMISSION_FREQUENCY_DEFAULT 433920000U  // Sets the default transmission frequency (27 MHz).
#define WAVEFORM_BUFFER_SIZE 550

class OOKRemoteAppView : public View {
   public:
    void focus() override;
    OOKRemoteAppView(NavigationView& nav);

    ~OOKRemoteAppView();

    std::string title() const override {
        return "OOKRemote";
    };

   private:
    NavigationView& nav_;                           // Reference to the navigation system.
    std::string payload{""};                        // Holds the data payload as a string.
    uint32_t progress = 0;                          // Stores the current transmission progress.
    int16_t waveform_buffer[WAVEFORM_BUFFER_SIZE];  // Buffer for waveform data.
    bool is_transmitting = false;                   // State of transmission.
    rf::Frequency ook_remote_tx_freq{24000000};     // last used transmit frequency
    std::string outputFileBuffer{};                 // buffer for output file

    void update();
    void draw_waveform();

    // Initiates data transmission with a specified message.
    void start_tx(const std::string& message);

    // Stops data transmission.
    void stop_tx();

    // Updates the transmission progress on the progress bar.
    void on_tx_progress(const uint32_t progress, const bool done);

    // Updates data when a new file is loaded.
    void on_file_changed(const std::filesystem::path& new_file_path);

    // Prepare a new std::filesystem::path from string value and call saveFile
    void on_save_file(const std::string value);

    // Called by on_save_file to save the current OOK parameters to the file
    bool save_ook_to_file(const std::filesystem::path& path);

    // Registers a message handler for transmission progress updates.
    MessageHandlerRegistration message_handler_tx_progress{
        Message::ID::TXProgress,          // Transmission progress message ID.
        [this](const Message* const p) {  // Callback to handle the message.
            const auto message = *reinterpret_cast<const TXProgressMessage*>(p);
            this->on_tx_progress(message.progress, message.done);
        }};

    // Sets transmission frequency, bandwidth, and default sample rate for OOK.
    TxRadioState radio_state_{TRANSMISSION_FREQUENCY_DEFAULT, 1750000, OOK_SAMPLERATE_DEFAULT};

    // Settings manager for app configuration.
    app_settings::SettingsManager settings_{
        "ook_remote",
        app_settings::Mode::TX,
        {{"ook_remote_tx_freq"sv, &ook_remote_tx_freq}}};

    // UI components for frequency and transmitter view.
    FrequencyField field_frequency{{0 * 8, 0 * 16}};
    TransmitterView2 tx_view{{20 * 7, 0 * 16}, true};

    // Labels for various fields such as sample rate and repeat count.
    Labels label_bit_duration_step{{{111, 18}, "BitTimeStep:", Theme::getInstance()->fg_light->foreground}};
    Labels label_sample_rate{{{0, 18}, "S/Rate:", Theme::getInstance()->fg_light->foreground}};
    Labels label_bit_duration{{{111, 40}, "BitTime:", Theme::getInstance()->fg_light->foreground}};
    Labels label_bit_duration_unit{{{210, 40}, "us", Theme::getInstance()->fg_light->foreground}};
    Labels label_repeat{{{0, 40}, "Repeat:", Theme::getInstance()->fg_light->foreground}};
    Labels label_pause_symbol{{{0, 60}, "Pause/Sym:", Theme::getInstance()->fg_light->foreground}};
    Labels label_payload{{{0, 76}, "Payload:", Theme::getInstance()->fg_light->foreground}};
    Labels label_waveform{{{0, 188}, "Waveform:", Theme::getInstance()->fg_light->foreground}};

    // Text field to display the loaded file if any
    Text text_loaded_file{{0, 140, 30 * 8, 16}, ""};

    // OptionsField for selectable sample rates.
    OptionsField field_sample_rate{{55, 18}, 7, {{"250k", 250000U}, {"1M", 1000000U}, {"2M", 2000000U}, {"5M", 5000000U}, {"10M", 10000000U}, {"20M", 20000000U}}};

    // OptionsField for step symbol rates.
    OptionsField field_bit_duration_step{{210, 18}, 7, {{"1", 1}, {"10", 10}, {"100", 100}}};

    // Number fields for symbols, pause between symbols, and repeat count.
    NumberField field_bit_duration{{176, 40}, 4, {0, 9999}, 1, '0', false};
    NumberField field_pause_symbol{{78, 60}, 4, {0, 200}, 1, '0', false};
    NumberField field_repeat{{55, 40}, 3, {0, 100}, 1, '0', false};

    // Text field to display the payload data.
    Text text_payload{{0 * 8, 90, 30 * 8, 16}, ""};

    // Buttons for setting configurations, opening files, and starting transmission.
    Button button_set{{0, 110, 60, 28}, LanguageHelper::currentMessages[LANG_SET]};
    Button button_open{{68, 110, 80, 28}, LanguageHelper::currentMessages[LANG_OPEN_FILE]};
    Button button_save{{154, 110, 80, 28}, LanguageHelper::currentMessages[LANG_SAVE_FILE]};
    Button button_send_stop{{80, 273, 80, 32}, LanguageHelper::currentMessages[LANG_SEND]};

    // Progress bar to display transmission progress.
    ProgressBar progressbar{{2 * 8, 250, 208, 16}};

    // Waveform display using waveform buffer and yellow theme color.
    Waveform waveform{{0, 208, 240, 32}, waveform_buffer, 0, 0, true, Theme::getInstance()->fg_yellow->foreground};
};

};  // namespace ui::external_app::ook_remote

#endif /*__UI_OOK_REMOTE_H__*/