Add the feature to decide rotate direction of encoder (#2472)

* disabling button on main menu, change labels and add 'icons'

* fix reverse order of buttons

---------

Co-authored-by: gullradriel <gullradriel@no-mail.com>

firmware/application/CMakeLists.txt

@@ -377,7 +377,7 @@ set(INCDIR ${CMAKE_CURRENT_BINARY_DIR} ${COMMON} ${PORTINC} ${KERNINC} ${TESTINC
 	hw
 	apps
 	protocols
-	bitmaps
+	bmps
 )
 
 #

firmware/application/apps/ble_rx_app.cpp

@@ -39,6 +39,14 @@ using namespace portapack;
 using namespace modems;
 namespace fs = std::filesystem;
 
+#define BLE_RX_NO_ERROR 0
+#define BLE_RX_LIST_FILENAME_EMPTY_ERROR 1
+#define BLE_RX_ENTRY_FILENAME_EMPTY_ERROR 2
+#define BLE_RX_LIST_SAVE_ERROR 3
+#define BLE_RX_ENTRY_SAVE_ERROR 4
+
+static uint8_t ble_rx_error = BLE_RX_NO_ERROR;
+
 void BLELogger::log_raw_data(const std::string& data) {
     log_file.write_entry(data);
 }
@@ -202,19 +210,23 @@ BleRecentEntryDetailView::BleRecentEntryDetailView(NavigationView& nav, const Bl
 }
 
 void BleRecentEntryDetailView::on_save_file(const std::string value, BLETxPacket packetToSave) {
-    ensure_directory(packet_save_path);
-    auto folder = packet_save_path.parent_path();
-    auto ext = packet_save_path.extension();
-    auto new_path = folder / value + ext;
-
-    saveFile(new_path, packetToSave);
+    if (value.length() > 0) {
+        ensure_directory(packet_save_path);
+        auto folder = packet_save_path.parent_path();
+        auto ext = packet_save_path.extension();
+        auto new_path = folder / value + ext;
+        ble_rx_error = saveFile(new_path, packetToSave);
+    } else {
+        nav_.pop();
+        ble_rx_error = BLE_RX_ENTRY_FILENAME_EMPTY_ERROR;
+    }
 }
 
 bool BleRecentEntryDetailView::saveFile(const std::filesystem::path& path, BLETxPacket packetToSave) {
     File f;
     auto error = f.create(path);
     if (error)
-        return false;
+        return BLE_RX_ENTRY_SAVE_ERROR;
 
     std::string macAddressStr = packetToSave.macAddress;
     std::string advertisementDataStr = packetToSave.advertisementData;
@@ -224,7 +236,7 @@ bool BleRecentEntryDetailView::saveFile(const std::filesystem::path& path, BLETx
 
     f.write(packetString.c_str(), packetString.length());
 
-    return true;
+    return BLE_RX_NO_ERROR;
 }
 
 void BleRecentEntryDetailView::update_data() {
@@ -568,11 +580,14 @@ std::string BLERxView::build_line_str(BleRecentEntry entry) {
 }
 
 void BLERxView::on_save_file(const std::string value) {
-    auto folder = packet_save_path.parent_path();
-    auto ext = packet_save_path.extension();
-    auto new_path = folder / value + ext;
-
-    saveFile(new_path);
+    if (value.length() > 0) {
+        auto folder = packet_save_path.parent_path();
+        auto ext = packet_save_path.extension();
+        auto new_path = folder / value + ext;
+        ble_rx_error = saveFile(new_path);
+    } else {
+        ble_rx_error = BLE_RX_LIST_FILENAME_EMPTY_ERROR;
+    }
 }
 
 bool BLERxView::saveFile(const std::filesystem::path& path) {
@@ -584,7 +599,7 @@ bool BLERxView::saveFile(const std::filesystem::path& path) {
     auto error = src->open(path, false, true);
 
     if (error) {
-        return false;
+        return BLE_RX_LIST_SAVE_ERROR;
     }
 
     for (const auto& entry : recent) {
@@ -615,7 +630,7 @@ bool BLERxView::saveFile(const std::filesystem::path& path) {
         auto error = dst->open(tempFilePath, false, true);
 
         if (error) {
-            return false;
+            return BLE_RX_LIST_SAVE_ERROR;
         }
 
         dst->write_line(headerStr.c_str());
@@ -695,7 +710,7 @@ bool BLERxView::saveFile(const std::filesystem::path& path) {
 
     tempList.clear();
 
-    return true;
+    return BLE_RX_NO_ERROR;
 }
 
 void BLERxView::on_data(BlePacketData* packet) {
@@ -831,6 +846,18 @@ void BLERxView::on_timer() {
             baseband::set_btlerx(randomChannel);
         }
     }
+    if (ble_rx_error != BLE_RX_NO_ERROR) {
+        if (ble_rx_error == BLE_RX_LIST_FILENAME_EMPTY_ERROR) {
+            nav_.display_modal("Error", "List filename is empty !");
+        } else if (ble_rx_error == BLE_RX_ENTRY_FILENAME_EMPTY_ERROR) {
+            nav_.display_modal("Error", "Entry filename is empty !");
+        } else if (ble_rx_error == BLE_RX_LIST_SAVE_ERROR) {
+            nav_.display_modal("Error", "Couldn't save list !");
+        } else if (ble_rx_error == BLE_RX_ENTRY_SAVE_ERROR) {
+            nav_.display_modal("Error", "Couldn't save entry !");
+        }
+        ble_rx_error = BLE_RX_NO_ERROR;
+    }
 }
 
 void BLERxView::handle_entries_sort(uint8_t index) {

firmware/application/apps/ui_about_simple.cpp

@@ -7,30 +7,33 @@
 namespace ui {
 
 // Information: a line starting with a '#' will be yellow coloured
-constexpr std::string_view authors_list[] = {
-    "#   * List of contributors *  ",
+constexpr std::string_view mayhem_information_list[] = {
+    "#****** Mayhem Community ******",
+    " ",
+    "  https://discord.mayhem.app",
+    " ",
+    "#**** List of contributors ****",
     " ",
     "#Mayhem-Firmware:",
     "jboone,eried,furrtek,",
     "NotherNgineer,gullradriel,",
     "jLynx,kallanreed,Brumi-2021,",
-    "htotoo,bernd-herzog,zxkmm,",
+    "htotoo,zxkmm,bernd-herzog,",
     "ArjanOnwezen,euquiq,u-foka,",
     "iNetro,heurist1,dqs105,",
     "teixeluis,jwetzell,",
     "jimilinuxguy,gregoryfenton,",
     "notpike,strijar,BehleZebub,",
-    "arneluehrs,rascafr,joyel24,",
-    "ImDroided,zigad,johnelder,",
-    "klockee,nnesetto,LupusE,",
-    "argilo,dc2dc,formtapez,",
+    "arneluehrs,mcules,rascafr,",
+    "joyel24,ImDroided,zigad,",
+    "johnelder,klockee,nnesetto,",
+    "LupusE,argilo,dc2dc,formtapez,",
     "RocketGod-git,mrmookie,",
     "ITAxReal,F33RNI,F4GEV,",
     "rusty-labs,mjwaxios,andrej-mk,",
     "RedFox-Fr,nemanjan00,",
     "MichalLeonBorsuk,",
-    "MatiasFernandez,Giorgiofox,",
-    "ckuethe",
+    "MatiasFernandez,Giorgiofox",
     " ",
     "#Havoc:",
     "jboone,furrtek,eried,argilo,",
@@ -72,7 +75,7 @@ AboutView::AboutView(NavigationView& nav) {
         button_ok.focus();
     };
 
-    for (auto& authors_line : authors_list) {
+    for (auto& authors_line : mayhem_information_list) {
         // if it's starting with #, it's a title and we have to substract the '#' and paint yellow
         if (authors_line.size() > 0) {
             if (authors_line[0] == '#') {
@@ -103,15 +106,13 @@ void AboutView::on_frame_sync() {
             menu_view.set_highlighted(current + 1);
         } else {
             menu_view.set_highlighted(0);
-            // ^ to go back to the REAL top instead of make the 2 at the top to make the title disappeares
-            menu_view.set_highlighted(2);  // the first line that has human name
         }
     }
 }
 
 void AboutView::focus() {
     button_ok.focus();
-    menu_view.set_highlighted(2);  // the first line that has human name
+    menu_view.set_highlighted(3);  // contributors block starting line
 }
 
 bool AboutView::on_touch(const TouchEvent) {

firmware/application/apps/ui_settings.cpp

@@ -711,10 +711,12 @@ SetEncoderDialView::SetEncoderDialView(NavigationView& nav) {
                   &button_dial_sensitivity_plus,
                   &button_dial_sensitivity_minus,
                   &button_rate_multiplier_plus,
-                  &button_rate_multiplier_minus});
+                  &button_rate_multiplier_minus,
+                  &field_encoder_dial_direction});
 
     field_encoder_dial_sensitivity.set_by_value(pmem::encoder_dial_sensitivity());
     field_encoder_rate_multiplier.set_value(pmem::encoder_rate_multiplier());
+    field_encoder_dial_direction.set_by_value(pmem::encoder_dial_direction());
 
     button_dial_sensitivity_plus.on_select = [this](Button&) {
         field_encoder_dial_sensitivity.on_encoder(1);
@@ -732,6 +734,7 @@ SetEncoderDialView::SetEncoderDialView(NavigationView& nav) {
     button_save.on_select = [&nav, this](Button&) {
         pmem::set_encoder_dial_sensitivity(field_encoder_dial_sensitivity.selected_index_value());
         pmem::set_encoder_rate_multiplier(field_encoder_rate_multiplier.value());
+        pmem::set_encoder_dial_direction(field_encoder_dial_direction.selected_index_value());
         nav.pop();
     };
 

firmware/application/apps/ui_settings.hpp

@@ -574,6 +574,7 @@ class SetQRCodeView : public View {
     };
 };
 
+using portapack::persistent_memory::encoder_dial_direction;
 using portapack::persistent_memory::encoder_dial_sensitivity;
 using portapack::persistent_memory::encoder_rate_multiplier;
 
@@ -587,44 +588,50 @@ class SetEncoderDialView : public View {
 
    private:
     Labels labels{
-        {{1 * 8, 1 * 16}, "Adjusts sensitivity to dial", Theme::getInstance()->fg_light->foreground},
-        {{1 * 8, 2 * 16}, "rotation position (number of", Theme::getInstance()->fg_light->foreground},
-        {{1 * 8, 3 * 16}, "steps per full rotation):", Theme::getInstance()->fg_light->foreground},
-        {{2 * 8, 5 * 16}, "Dial sensitivity:", Theme::getInstance()->fg_light->foreground},
-        {{1 * 8, 8 * 16}, "Adjusts sensitivity to dial", Theme::getInstance()->fg_light->foreground},
-        {{1 * 8, 9 * 16}, "rotation rate (default 1", Theme::getInstance()->fg_light->foreground},
-        {{1 * 8, 10 * 16}, "means no rate dependency):", Theme::getInstance()->fg_light->foreground},
-        {{3 * 8, 12 * 16}, "Rate multiplier:", Theme::getInstance()->fg_light->foreground},
+        {{0 * 8, 0 * 16}, "Sensitivity to dial rotation", Theme::getInstance()->fg_light->foreground},
+        {{0 * 8, 1 * 16}, "position (x steps per 360):", Theme::getInstance()->fg_light->foreground},
+        {{1 * 8, 3 * 16}, "Sensitivity:", Theme::getInstance()->fg_light->foreground},
+        {{0 * 8, 7 * 16}, "Rotation rate (default 1", Theme::getInstance()->fg_light->foreground},
+        {{0 * 8, 8 * 16}, "means no rate dependency):", Theme::getInstance()->fg_light->foreground},
+        {{2 * 8, 10 * 16}, "Rate multiplier:", Theme::getInstance()->fg_light->foreground},
+        {{4 * 8, 14 * 16}, "Direction:", Theme::getInstance()->fg_light->foreground},
+
     };
 
     OptionsField field_encoder_dial_sensitivity{
-        {20 * 8, 5 * 16},
+        {20 * 8, 3 * 16},
         6,
         {{"LOW", encoder_dial_sensitivity::DIAL_SENSITIVITY_LOW},
          {"NORMAL", encoder_dial_sensitivity::DIAL_SENSITIVITY_NORMAL},
          {"HIGH", encoder_dial_sensitivity::DIAL_SENSITIVITY_HIGH}}};
 
     NumberField field_encoder_rate_multiplier{
-        {20 * 8, 12 * 16},
+        {20 * 8, 10 * 16},
         2,
         {1, 15},
         1,
         ' '};
 
+    OptionsField field_encoder_dial_direction{
+        {18 * 8, 14 * 16},
+        7,
+        {{"NORMAL", encoder_dial_direction::DIAL_DIRECTION_NORMAL},
+         {"REVERSE", encoder_dial_direction::DIAL_DIRECTION_REVERSE}}};
+
     Button button_dial_sensitivity_plus{
-        {20 * 8, 4 * 16, 16, 16},
+        {20 * 8, 2 * 16, 16, 16},
         "+"};
 
     Button button_dial_sensitivity_minus{
-        {20 * 8, 6 * 16, 16, 16},
+        {20 * 8, 4 * 16, 16, 16},
         "-"};
 
     Button button_rate_multiplier_plus{
-        {20 * 8, 11 * 16, 16, 16},
+        {20 * 8, 9 * 16, 16, 16},
         "+"};
 
     Button button_rate_multiplier_minus{
-        {20 * 8, 13 * 16, 16, 16},
+        {20 * 8, 11 * 16, 16, 16},
         "-"};
 
     Button button_save{

firmware/application/hw/encoder.cpp

@@ -66,6 +66,11 @@ int_fast8_t Encoder::update(const uint_fast8_t phase_bits) {
     if (direction == prev_direction) {
         if ((sensitivity_map[portapack::persistent_memory::encoder_dial_sensitivity()] & (1 << state)) == 0)
             return 0;
+
+        // true: normal, false: reverse
+        if (!portapack::persistent_memory::encoder_dial_direction())
+            direction = -direction;
+
         return direction;
     }
 

firmware/application/ui/ui_btngrid.cpp

@@ -110,12 +110,12 @@ void BtnGridView::set_arrow_up_enabled(bool enabled) {
     if (enabled) {
         if (!arrow_up_enabled) {
             arrow_up_enabled = true;
-            button_pgup.set_text("PAGE UP");
+            button_pgup.set_text("< PREV");
         }
     } else if (!enabled) {
         if (arrow_up_enabled) {
             arrow_up_enabled = false;
-            button_pgup.set_text("       ");
+            button_pgup.set_text("      ");
         }
     }
 };
@@ -126,12 +126,12 @@ void BtnGridView::set_arrow_down_enabled(bool enabled) {
     if (enabled) {
         if (!arrow_down_enabled) {
             arrow_down_enabled = true;
-            button_pgdown.set_text("PAGE DOWN");
+            button_pgdown.set_text("NEXT >");
         }
     } else if (!enabled) {
         if (arrow_down_enabled) {
             arrow_down_enabled = false;
-            button_pgdown.set_text("         ");
+            button_pgdown.set_text("      ");
         }
     }
 };
@@ -228,6 +228,10 @@ NewButton* BtnGridView::item_view(size_t index) const {
 
 void BtnGridView::show_arrows_enabled(bool enabled) {
     show_arrows = enabled;
+    if (!enabled) {
+        remove_child(&button_pgup);
+        remove_child(&button_pgdown);
+    }
 }
 
 bool BtnGridView::set_highlighted(int32_t new_value) {

firmware/common/portapack_persistent_memory.cpp

@@ -212,7 +212,7 @@ struct data_t {
     bool updown_frequency_rx_correction;
     bool updown_frequency_tx_correction;
     bool lcd_inverted_mode : 1;
-    bool UNUSED_5 : 1;
+    bool encoder_dial_direction : 1;  // true = normal, false = reverse
     bool UNUSED_6 : 1;
     bool UNUSED_7 : 1;
 
@@ -290,7 +290,7 @@ struct data_t {
           updown_frequency_rx_correction(false),
           updown_frequency_tx_correction(false),
           lcd_inverted_mode(false),
-          UNUSED_5(false),
+          encoder_dial_direction(false),
           UNUSED_6(false),
           UNUSED_7(false),
 
@@ -417,6 +417,7 @@ void defaults() {
     set_config_splash(true);
     set_config_disable_external_tcxo(false);
     set_encoder_dial_sensitivity(DIAL_SENSITIVITY_NORMAL);
+    set_encoder_dial_direction(true);
     set_config_speaker_disable(true);  // Disable AK4951 speaker by default (in case of OpenSourceSDRLab H2)
     set_menu_color(Color::grey());
     set_ui_hide_numeric_battery(true);  // hide the numeric battery by default - no space to display it
@@ -1080,6 +1081,13 @@ void set_encoder_rate_multiplier(uint8_t v) {
     data->encoder_rate_multiplier = v;
 }
 
+bool encoder_dial_direction() {
+    return data->encoder_dial_direction;
+}
+void set_encoder_dial_direction(bool v) {
+    data->encoder_dial_direction = v;
+}
+
 // Recovery mode magic value storage
 static data_t* data_direct_access = reinterpret_cast<data_t*>(memory::map::backup_ram.base());
 
@@ -1246,6 +1254,7 @@ bool debug_dump() {
     pmem_dump_file.write_line("frequency_tx_correction: " + to_string_dec_uint(data->frequency_tx_correction));
     pmem_dump_file.write_line("encoder_dial_sensitivity: " + to_string_dec_uint(data->encoder_dial_sensitivity));
     pmem_dump_file.write_line("encoder_rate_multiplier: " + to_string_dec_uint(data->encoder_rate_multiplier));
+    pmem_dump_file.write_line("encoder_dial_direction: " + to_string_dec_uint(data->encoder_dial_direction));
     pmem_dump_file.write_line("headphone_volume_cb: " + to_string_dec_int(data->headphone_volume_cb));
     pmem_dump_file.write_line("config_mode_storage: 0x" + to_string_hex(data->config_mode_storage, 8));
     pmem_dump_file.write_line("dst_config: 0x" + to_string_hex((uint32_t)data->dst_config.v, 8));

firmware/common/portapack_persistent_memory.hpp

@@ -120,6 +120,11 @@ enum encoder_dial_sensitivity {
     NUM_DIAL_SENSITIVITY
 };
 
+enum encoder_dial_direction {
+    DIAL_DIRECTION_NORMAL = true,
+    DIAL_DIRECTION_REVERSE = false,
+};
+
 typedef union {
     uint32_t v;
     struct {
@@ -252,6 +257,8 @@ uint8_t encoder_dial_sensitivity();
 void set_encoder_dial_sensitivity(uint8_t v);
 uint8_t encoder_rate_multiplier();
 void set_encoder_rate_multiplier(uint8_t v);
+bool encoder_dial_direction();
+void set_encoder_dial_direction(bool v);
 
 uint32_t config_mode_storage_direct();
 void set_config_mode_storage_direct(uint32_t v);

firmware/tools/.gitignore

@@ -0,0 +1 @@
+__pycache__/

firmware/tools/generate_ui-about-simple.cpp.py

@@ -53,7 +53,7 @@ AboutView::AboutView(NavigationView& nav) {
         button_ok.focus();
     };
 
-    for (auto& authors_line : authors_list) {
+    for (auto& authors_line : mayhem_information_list) {
         // if it's starting with #, it's a title and we have to substract the '#' and paint yellow
         if (authors_line.size() > 0) {
             if (authors_line[0] == '#') {
@@ -84,15 +84,13 @@ void AboutView::on_frame_sync() {
             menu_view.set_highlighted(current + 1);
         } else {
             menu_view.set_highlighted(0);
-            // ^ to go back to the REAL top instead of make the 2 at the top to make the title disappeares
-            menu_view.set_highlighted(2);  // the first line that has human name
         }
     }
 }
 
 void AboutView::focus() {
     button_ok.focus();
-    menu_view.set_highlighted(2);  // the first line that has human name
+    menu_view.set_highlighted(3);  // contributors block starting line
 }
 
 bool AboutView::on_touch(const TouchEvent) {
@@ -141,8 +139,12 @@ def get_contributors(url):
 
 def generate_content(projects):
     project_contrib = []
-    project_contrib.append("string_view authors_list[] = {\n")
-    project_contrib.append("    \"#   * List of contributors *  \",\n")
+    project_contrib.append("string_view mayhem_information_list[] = {\n")
+    project_contrib.append("    \"#****** Mayhem Community ******\",\n")
+    project_contrib.append("    \" \",\n")
+    project_contrib.append("    \"  https://discord.mayhem.app\",\n")
+    project_contrib.append("    \" \",\n")
+    project_contrib.append("    \"#**** List of contributors ****\",\n")
     for project in projects:
         project_contrib.append("    \" \",\n")
         project_contrib.append(f"    \"#{project[0]}:\",\n")
@@ -170,7 +172,7 @@ def pp_create_ui_about_simple_cpp(cpp_file, cppheader, cppcontent, cppfooter):
 
 def pp_change_ui_about_simple_cpp(cpp_file, cppcontent):
     content = []
-    content_pattern = re.compile(r"string_view authors_list\[\] = {\n(?:\s+(?:.*,\n)+\s+.*};\n)", re.MULTILINE)
+    content_pattern = re.compile(r"string_view mayhem_information_list\[\] = {\n(?:\s+(?:.*,\n)+\s+.*};\n)", re.MULTILINE)
 
     # Read original file
     with open(cpp_file, 'r') as file: