[FL-2230] SubGhz: protocol API refactoring (RogueMaster#969)

* SubGhz: protocols library refactoring * SubGhz: new architecture and refactoring * SubGhz: simplify protocol structure, remove unused types * SubGhz: rename Subghz to SubGhz * SubGhz: add environment concept Co-authored-by: Aleksandr Kutuzov <[email protected]> Co-authored-by: DrZlo13 <[email protected]>
kevlacross · Mar 3, 2022 · 3164184 · 3164184
1 parent 052237f
commit 3164184
Show file tree

Hide file tree

Showing 173 changed files with 9,839 additions and 8,489 deletions.
diff --git a/CODING_STYLE.md b/CODING_STYLE.md
@@ -58,7 +58,7 @@ Examples:
 
 	FuriHalUsb
 	Gui
-	SubghzKeystore
+	SubGhzKeystore
 
 
 ### Functions are snake_case
@@ -73,8 +73,8 @@ This rule makes easier to locate types, functions and sources.
 
 For example:
 
-We have abstraction that we call `Subghz Keystore`, so there will be:
-file `subghz_keystore.h` we have type `SubghzKeystore` and function `subghz_keystore_read`.
+We have abstraction that we call `SubGhz Keystore`, so there will be:
+file `subghz_keystore.h` we have type `SubGhzKeystore` and function `subghz_keystore_read`.
 
 ### File names
 

diff --git a/Makefile b/Makefile
@@ -121,3 +121,8 @@ lint:
 format:
 	@echo "Reformating sources code"
 	@$(PROJECT_ROOT)/scripts/lint.py format $(PROJECT_SOURCE_DIRECTORIES)
+
+.PHONY: guruguru
+guruguru:
+	@echo "ぐるぐる回る"
+	@$(PROJECT_ROOT)/scripts/guruguru.py $(PROJECT_ROOT)
diff --git a/applications/ReadMe.md b/applications/ReadMe.md
@@ -30,7 +30,7 @@
 - `snake_game`          - Snake game application
 - `storage`             - Storage service, internal + sdcard
 - `storage_settings`    - Storage settings app
-- `subghz`              - Subghz application, 433 fobs and etc
+- `subghz`              - SubGhz application, 433 fobs and etc
 - `system`              - System settings, tools and API
 - `tests`               - Unit tests and etc
 - `u2f`                 - U2F Application

diff --git a/applications/subghz/helpers/subghz_chat.c b/applications/subghz/helpers/subghz_chat.c
@@ -23,12 +23,12 @@ static int32_t subghz_chat_worker_thread(void* context) {
     SubGhzChatWorker* instance = context;
     FURI_LOG_I(TAG, "Worker start");
     char c;
-    SubghzChatEvent event;
-    event.event = SubghzChatEventUserEntrance;
+    SubGhzChatEvent event;
+    event.event = SubGhzChatEventUserEntrance;
     osMessageQueuePut(instance->event_queue, &event, 0, 0);
     while(instance->worker_running) {
         if(furi_hal_vcp_rx_with_timeout((uint8_t*)&c, 1, 1000) == 1) {
-            event.event = SubghzChatEventInputData;
+            event.event = SubGhzChatEventInputData;
             event.c = c;
             osMessageQueuePut(instance->event_queue, &event, 0, osWaitForever);
         }
@@ -41,26 +41,26 @@ static int32_t subghz_chat_worker_thread(void* context) {
 static void subghz_chat_worker_update_rx_event_chat(void* context) {
     furi_assert(context);
     SubGhzChatWorker* instance = context;
-    SubghzChatEvent event;
+    SubGhzChatEvent event;
     if((millis() - instance->last_time_rx_data) > SUBGHZ_CHAT_WORKER_TIMEOUT_BETWEEN_MESSAGES) {
-        event.event = SubghzChatEventNewMessage;
+        event.event = SubGhzChatEventNewMessage;
         osMessageQueuePut(instance->event_queue, &event, 0, osWaitForever);
     }
     instance->last_time_rx_data = millis();
-    event.event = SubghzChatEventRXData;
+    event.event = SubGhzChatEventRXData;
     osMessageQueuePut(instance->event_queue, &event, 0, osWaitForever);
 }
 
 SubGhzChatWorker* subghz_chat_worker_alloc() {
     SubGhzChatWorker* instance = malloc(sizeof(SubGhzChatWorker));
 
     instance->thread = furi_thread_alloc();
-    furi_thread_set_name(instance->thread, "SubghzChat");
+    furi_thread_set_name(instance->thread, "SubGhzChat");
     furi_thread_set_stack_size(instance->thread, 2048);
     furi_thread_set_context(instance->thread, instance);
     furi_thread_set_callback(instance->thread, subghz_chat_worker_thread);
     instance->subghz_txrx = subghz_tx_rx_worker_alloc();
-    instance->event_queue = osMessageQueueNew(80, sizeof(SubghzChatEvent), NULL);
+    instance->event_queue = osMessageQueueNew(80, sizeof(SubGhzChatEvent), NULL);
     return instance;
 }
 
@@ -109,18 +109,18 @@ bool subghz_chat_worker_is_running(SubGhzChatWorker* instance) {
     return instance->worker_running;
 }
 
-SubghzChatEvent subghz_chat_worker_get_event_chat(SubGhzChatWorker* instance) {
+SubGhzChatEvent subghz_chat_worker_get_event_chat(SubGhzChatWorker* instance) {
     furi_assert(instance);
-    SubghzChatEvent event;
+    SubGhzChatEvent event;
     if(osMessageQueueGet(instance->event_queue, &event, NULL, osWaitForever) == osOK) {
         return event;
     } else {
-        event.event = SubghzChatEventNoEvent;
+        event.event = SubGhzChatEventNoEvent;
         return event;
     }
 }
 
-void subghz_chat_worker_put_event_chat(SubGhzChatWorker* instance, SubghzChatEvent* event) {
+void subghz_chat_worker_put_event_chat(SubGhzChatWorker* instance, SubGhzChatEvent* event) {
     furi_assert(instance);
     osMessageQueuePut(instance->event_queue, event, 0, osWaitForever);
 }

diff --git a/applications/subghz/helpers/subghz_chat.h b/applications/subghz/helpers/subghz_chat.h
@@ -4,26 +4,26 @@
 typedef struct SubGhzChatWorker SubGhzChatWorker;
 
 typedef enum {
-    SubghzChatEventNoEvent,
-    SubghzChatEventUserEntrance,
-    SubghzChatEventUserExit,
-    SubghzChatEventInputData,
-    SubghzChatEventRXData,
-    SubghzChatEventNewMessage,
-} SubghzChatEventType;
+    SubGhzChatEventNoEvent,
+    SubGhzChatEventUserEntrance,
+    SubGhzChatEventUserExit,
+    SubGhzChatEventInputData,
+    SubGhzChatEventRXData,
+    SubGhzChatEventNewMessage,
+} SubGhzChatEventType;
 
 typedef struct {
-    SubghzChatEventType event;
+    SubGhzChatEventType event;
     char c;
-} SubghzChatEvent;
+} SubGhzChatEvent;
 
 SubGhzChatWorker* subghz_chat_worker_alloc();
 void subghz_chat_worker_free(SubGhzChatWorker* instance);
 bool subghz_chat_worker_start(SubGhzChatWorker* instance, uint32_t frequency);
 void subghz_chat_worker_stop(SubGhzChatWorker* instance);
 bool subghz_chat_worker_is_running(SubGhzChatWorker* instance);
-SubghzChatEvent subghz_chat_worker_get_event_chat(SubGhzChatWorker* instance);
-void subghz_chat_worker_put_event_chat(SubGhzChatWorker* instance, SubghzChatEvent* event);
+SubGhzChatEvent subghz_chat_worker_get_event_chat(SubGhzChatWorker* instance);
+void subghz_chat_worker_put_event_chat(SubGhzChatWorker* instance, SubGhzChatEvent* event);
 size_t subghz_chat_worker_available(SubGhzChatWorker* instance);
 size_t subghz_chat_worker_read(SubGhzChatWorker* instance, uint8_t* data, size_t size);
 bool subghz_chat_worker_write(SubGhzChatWorker* instance, uint8_t* data, size_t size);
diff --git a/applications/subghz/helpers/subghz_custom_event.h b/applications/subghz/helpers/subghz_custom_event.h
@@ -1,46 +1,46 @@
 #pragma once
 
 typedef enum {
-    SubghzCustomEventManagerNoSet = 0,
-    SubghzCustomEventManagerSet,
-    SubghzCustomEventManagerSetRAW,
+    SubGhzCustomEventManagerNoSet = 0,
+    SubGhzCustomEventManagerSet,
+    SubGhzCustomEventManagerSetRAW,
 
-    SubghzCustomEventSceneDeleteSuccess = 100,
-    SubghzCustomEventSceneDelete,
-    SubghzCustomEventSceneDeleteRAW,
-    SubghzCustomEventSceneDeleteRAWBack,
+    SubGhzCustomEventSceneDeleteSuccess = 100,
+    SubGhzCustomEventSceneDelete,
+    SubGhzCustomEventSceneDeleteRAW,
+    SubGhzCustomEventSceneDeleteRAWBack,
 
-    SubghzCustomEventSceneReceiverInfoTxStart,
-    SubghzCustomEventSceneReceiverInfoTxStop,
-    SubghzCustomEventSceneReceiverInfoSave,
-    SubghzCustomEventSceneSaveName,
-    SubghzCustomEventSceneSaveSuccess,
-    SubghzCustomEventSceneShowErrorBack,
-    SubghzCustomEventSceneShowErrorOk,
-    SubghzCustomEventSceneShowErrorSub,
-    SubghzCustomEventSceneShowOnlyRX,
+    SubGhzCustomEventSceneReceiverInfoTxStart,
+    SubGhzCustomEventSceneReceiverInfoTxStop,
+    SubGhzCustomEventSceneReceiverInfoSave,
+    SubGhzCustomEventSceneSaveName,
+    SubGhzCustomEventSceneSaveSuccess,
+    SubGhzCustomEventSceneShowErrorBack,
+    SubGhzCustomEventSceneShowErrorOk,
+    SubGhzCustomEventSceneShowErrorSub,
+    SubGhzCustomEventSceneShowOnlyRX,
 
-    SubghzCustomEventSceneExit,
-    SubghzCustomEventSceneStay,
+    SubGhzCustomEventSceneExit,
+    SubGhzCustomEventSceneStay,
 
-    SubghzCustomEventViewReceverOK,
-    SubghzCustomEventViewReceverConfig,
-    SubghzCustomEventViewReceverBack,
+    SubGhzCustomEventViewReceverOK,
+    SubGhzCustomEventViewReceverConfig,
+    SubGhzCustomEventViewReceverBack,
 
-    SubghzCustomEventViewReadRAWBack,
-    SubghzCustomEventViewReadRAWIDLE,
-    SubghzCustomEventViewReadRAWREC,
-    SubghzCustomEventViewReadRAWConfig,
-    SubghzCustomEventViewReadRAWErase,
-    SubghzCustomEventViewReadRAWSendStart,
-    SubghzCustomEventViewReadRAWSendStop,
-    SubghzCustomEventViewReadRAWSave,
-    SubghzCustomEventViewReadRAWVibro,
-    SubghzCustomEventViewReadRAWTXRXStop,
-    SubghzCustomEventViewReadRAWMore,
+    SubGhzCustomEventViewReadRAWBack,
+    SubGhzCustomEventViewReadRAWIDLE,
+    SubGhzCustomEventViewReadRAWREC,
+    SubGhzCustomEventViewReadRAWConfig,
+    SubGhzCustomEventViewReadRAWErase,
+    SubGhzCustomEventViewReadRAWSendStart,
+    SubGhzCustomEventViewReadRAWSendStop,
+    SubGhzCustomEventViewReadRAWSave,
+    SubGhzCustomEventViewReadRAWVibro,
+    SubGhzCustomEventViewReadRAWTXRXStop,
+    SubGhzCustomEventViewReadRAWMore,
 
-    SubghzCustomEventViewTransmitterBack,
-    SubghzCustomEventViewTransmitterSendStart,
-    SubghzCustomEventViewTransmitterSendStop,
-    SubghzCustomEventViewTransmitterError,
-} SubghzCustomEvent;
+    SubGhzCustomEventViewTransmitterBack,
+    SubGhzCustomEventViewTransmitterSendStart,
+    SubGhzCustomEventViewTransmitterSendStop,
+    SubGhzCustomEventViewTransmitterError,
+} SubGhzCustomEvent;
diff --git a/applications/subghz/helpers/subghz_frequency_analyzer_worker.c b/applications/subghz/helpers/subghz_frequency_analyzer_worker.c
@@ -145,7 +145,7 @@ SubGhzFrequencyAnalyzerWorker* subghz_frequency_analyzer_worker_alloc() {
     SubGhzFrequencyAnalyzerWorker* instance = malloc(sizeof(SubGhzFrequencyAnalyzerWorker));
 
     instance->thread = furi_thread_alloc();
-    furi_thread_set_name(instance->thread, "SubghzFAWorker");
+    furi_thread_set_name(instance->thread, "SubGhzFAWorker");
     furi_thread_set_stack_size(instance->thread, 2048);
     furi_thread_set_context(instance->thread, instance);
     furi_thread_set_callback(instance->thread, subghz_frequency_analyzer_worker_thread);

diff --git a/applications/subghz/scenes/subghz_scene_delete.c b/applications/subghz/scenes/subghz_scene_delete.c
@@ -5,7 +5,7 @@ void subghz_scene_delete_callback(GuiButtonType result, InputType type, void* co
     furi_assert(context);
     SubGhz* subghz = context;
     if((result == GuiButtonTypeRight) && (type == InputTypeShort)) {
-        view_dispatcher_send_custom_event(subghz->view_dispatcher, SubghzCustomEventSceneDelete);
+        view_dispatcher_send_custom_event(subghz->view_dispatcher, SubGhzCustomEventSceneDelete);
     }
 }
 
@@ -31,8 +31,7 @@ void subghz_scene_delete_on_enter(void* context) {
         AlignTop,
         FontSecondary,
         string_get_cstr(modulation_str));
-
-    subghz->txrx->protocol_result->to_string(subghz->txrx->protocol_result, text);
+    subghz_protocol_decoder_base_get_string(subghz->txrx->decoder_result, text);
     widget_add_string_multiline_element(
         subghz->widget, 0, 0, AlignLeft, AlignTop, FontSecondary, string_get_cstr(text));
 
@@ -43,13 +42,13 @@ void subghz_scene_delete_on_enter(void* context) {
     widget_add_button_element(
         subghz->widget, GuiButtonTypeRight, "Delete", subghz_scene_delete_callback, subghz);
 
-    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewWidget);
+    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewIdWidget);
 }
 
 bool subghz_scene_delete_on_event(void* context, SceneManagerEvent event) {
     SubGhz* subghz = context;
     if(event.type == SceneManagerEventTypeCustom) {
-        if(event.event == SubghzCustomEventSceneDelete) {
+        if(event.event == SubGhzCustomEventSceneDelete) {
             strcpy(subghz->file_name_tmp, subghz->file_name);
             if(subghz_delete_file(subghz)) {
                 scene_manager_next_scene(subghz->scene_manager, SubGhzSceneDeleteSuccess);

diff --git a/applications/subghz/scenes/subghz_scene_delete_raw.c b/applications/subghz/scenes/subghz_scene_delete_raw.c
@@ -6,10 +6,10 @@ void subghz_scene_delete_raw_callback(GuiButtonType result, InputType type, void
     SubGhz* subghz = context;
     if((result == GuiButtonTypeRight) && (type == InputTypeShort)) {
         view_dispatcher_send_custom_event(
-            subghz->view_dispatcher, SubghzCustomEventSceneDeleteRAW);
+            subghz->view_dispatcher, SubGhzCustomEventSceneDeleteRAW);
     } else if((result == GuiButtonTypeLeft) && (type == InputTypeShort)) {
         view_dispatcher_send_custom_event(
-            subghz->view_dispatcher, SubghzCustomEventSceneDeleteRAWBack);
+            subghz->view_dispatcher, SubGhzCustomEventSceneDeleteRAWBack);
     }
 }
 
@@ -49,13 +49,13 @@ void subghz_scene_delete_raw_on_enter(void* context) {
     widget_add_button_element(
         subghz->widget, GuiButtonTypeLeft, "Back", subghz_scene_delete_raw_callback, subghz);
 
-    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewWidget);
+    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewIdWidget);
 }
 
 bool subghz_scene_delete_raw_on_event(void* context, SceneManagerEvent event) {
     SubGhz* subghz = context;
     if(event.type == SceneManagerEventTypeCustom) {
-        if(event.event == SubghzCustomEventSceneDeleteRAW) {
+        if(event.event == SubGhzCustomEventSceneDeleteRAW) {
             strcpy(subghz->file_name_tmp, subghz->file_name);
             if(subghz_delete_file(subghz)) {
                 scene_manager_next_scene(subghz->scene_manager, SubGhzSceneDeleteSuccess);
@@ -64,7 +64,7 @@ bool subghz_scene_delete_raw_on_event(void* context, SceneManagerEvent event) {
                     subghz->scene_manager, SubGhzSceneStart);
             }
             return true;
-        } else if(event.event == SubghzCustomEventSceneDeleteRAWBack) {
+        } else if(event.event == SubGhzCustomEventSceneDeleteRAWBack) {
             return scene_manager_previous_scene(subghz->scene_manager);
         }
     }

diff --git a/applications/subghz/scenes/subghz_scene_delete_success.c b/applications/subghz/scenes/subghz_scene_delete_success.c
@@ -4,7 +4,7 @@
 void subghz_scene_delete_success_popup_callback(void* context) {
     SubGhz* subghz = context;
     view_dispatcher_send_custom_event(
-        subghz->view_dispatcher, SubghzCustomEventSceneDeleteSuccess);
+        subghz->view_dispatcher, SubGhzCustomEventSceneDeleteSuccess);
 }
 
 void subghz_scene_delete_success_on_enter(void* context) {
@@ -18,14 +18,14 @@ void subghz_scene_delete_success_on_enter(void* context) {
     popup_set_context(popup, subghz);
     popup_set_callback(popup, subghz_scene_delete_success_popup_callback);
     popup_enable_timeout(popup);
-    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewPopup);
+    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewIdPopup);
 }
 
 bool subghz_scene_delete_success_on_event(void* context, SceneManagerEvent event) {
     SubGhz* subghz = context;
 
     if(event.type == SceneManagerEventTypeCustom) {
-        if(event.event == SubghzCustomEventSceneDeleteSuccess) {
+        if(event.event == SubGhzCustomEventSceneDeleteSuccess) {
             if(!scene_manager_search_and_switch_to_previous_scene(
                    subghz->scene_manager, SubGhzSceneSaved)) {
                 scene_manager_next_scene(subghz->scene_manager, SubGhzSceneSaved);

diff --git a/applications/subghz/scenes/subghz_scene_frequency_analyzer.c b/applications/subghz/scenes/subghz_scene_frequency_analyzer.c
@@ -2,7 +2,7 @@
 #include "../views/subghz_frequency_analyzer.h"
 #include <dolphin/dolphin.h>
 
-void subghz_scene_frequency_analyzer_callback(SubghzCustomEvent event, void* context) {
+void subghz_scene_frequency_analyzer_callback(SubGhzCustomEvent event, void* context) {
     furi_assert(context);
     SubGhz* subghz = context;
     view_dispatcher_send_custom_event(subghz->view_dispatcher, event);
@@ -13,7 +13,7 @@ void subghz_scene_frequency_analyzer_on_enter(void* context) {
     DOLPHIN_DEED(DolphinDeedSubGhzFrequencyAnalyzer);
     subghz_frequency_analyzer_set_callback(
         subghz->subghz_frequency_analyzer, subghz_scene_frequency_analyzer_callback, subghz);
-    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewFrequencyAnalyzer);
+    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewIdFrequencyAnalyzer);
 }
 
 bool subghz_scene_frequency_analyzer_on_event(void* context, SceneManagerEvent event) {

diff --git a/applications/subghz/scenes/subghz_scene_more_raw.c b/applications/subghz/scenes/subghz_scene_more_raw.c
@@ -30,7 +30,7 @@ void subghz_scene_more_raw_on_enter(void* context) {
     submenu_set_selected_item(
         subghz->submenu, scene_manager_get_scene_state(subghz->scene_manager, SubGhzSceneMoreRAW));
 
-    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewMenu);
+    view_dispatcher_switch_to_view(subghz->view_dispatcher, SubGhzViewIdMenu);
 }
 
 bool subghz_scene_more_raw_on_event(void* context, SceneManagerEvent event) {
@@ -39,7 +39,7 @@ bool subghz_scene_more_raw_on_event(void* context, SceneManagerEvent event) {
     if(event.type == SceneManagerEventTypeCustom) {
         if(event.event == SubmenuIndexDelete) {
             scene_manager_set_scene_state(
-                subghz->scene_manager, SubGhzSceneReadRAW, SubghzCustomEventManagerNoSet);
+                subghz->scene_manager, SubGhzSceneReadRAW, SubGhzCustomEventManagerNoSet);
             scene_manager_set_scene_state(
                 subghz->scene_manager, SubGhzSceneMoreRAW, SubmenuIndexDelete);
             scene_manager_next_scene(subghz->scene_manager, SubGhzSceneDeleteRAW);