From 85a02ebaa9d347fe6b2255592226d0729a104f5f Mon Sep 17 00:00:00 2001 From: Derek Jamison Date: Mon, 30 Jan 2023 23:17:38 -0500 Subject: [PATCH] code with only logging --- subghz/plugins/subghz_demo/subghz_demo_app.c | 255 +------------------ 1 file changed, 12 insertions(+), 243 deletions(-) diff --git a/subghz/plugins/subghz_demo/subghz_demo_app.c b/subghz/plugins/subghz_demo/subghz_demo_app.c index 187914f..67fc725 100644 --- a/subghz/plugins/subghz_demo/subghz_demo_app.c +++ b/subghz/plugins/subghz_demo/subghz_demo_app.c @@ -5,9 +5,9 @@ https://github.com/jamisonderek/flipper-zero-tutorials This is a demonstration of sending radio signals using the subghz_tx_rx worker library. Features: -Press OK on Flipper Zero to send the current count to another Flipper Zero. -Short press UP button on Flipper Zero to send 440Hz tone to another Flipper Zero. -Long press UP button on Flipper Zero to send 880Hz tone to another Flipper Zero. +Press OK on Flipper Zero to log the current count. +Short press UP button on Flipper Zero to log 440Hz tone. +Long press UP button on Flipper Zero to log 880Hz tone. */ @@ -17,38 +17,20 @@ Long press UP button on Flipper Zero to send 880Hz tone to another Flipper Zero. #include #include -#include -// This is sent at the beginning of all RF messages. -// You should make the SUBGHZ_GAME_NAME short but unique. -// NOTE: It must end with the ':' character. -#define SUBGHZ_GAME_NAME "SGDEMO:" #define TAG "subghz_demo_app" -// The message max length should be no larger than a value around 60 to 64. -#define MESSAGE_MAX_LEN 60 -// The major version must be a single character (it can be anything - like '1' or 'A' or 'a'). -#define MAJOR_VERSION 'A' -// When an RF message is sent, it includes a purpose so the receiving application -// can decide if it should process the message. -typedef enum { - DemoRfPurposeCounter = 'C', // The message is about the counter. - DemoRfPurposeTone = 'T', // The message is about a note to play. -} DemoRfPurpose; // Messages in our event queue are one of the following types. typedef enum { DemoEventTypeTick, DemoEventTypeKey, - DemoEventDataDetected, // You can add additional events here. DemoEventSendCounter, - DemoEventReceivedCounter, DemoEventSendTone, - DemoEventReceivedTone, } DemoEventType; // An item in the event queue has both the type and its associated data. @@ -58,8 +40,7 @@ typedef struct { // You can add additional data that is helpful for your events. InputEvent input; // This data is specific to DemoEventTypeKey. - unsigned int number; // This data is specific to DemoEventSendCounter/DemoEventReceivedCounter/DemoEventSendTone/DemoEventReceivedTone. - FuriString* senderName; // This data is specific to DemoEventReceivedCounter. + unsigned int number; // This data is specific to DemoEventSendCounter/DemoEventSendTone. } DemoEvent; // This is the data for our application. You might have a game board, @@ -69,7 +50,6 @@ typedef struct { // You can add additional application state here. unsigned int localCounter; - unsigned int remoteCounter; } DemoData; // This is our application context. @@ -77,87 +57,8 @@ typedef struct { FuriMessageQueue* queue; // Message queue (DemoEvent items to process). FuriMutex* mutex; // Used to provide thread safe access to data. DemoData* data; // Data accessed by multiple threads (acquire the mutex before accessing!) - - // Used for subghz communication - SubGhzTxRxWorker* subghz_txrx; } DemoContext; -// We register this callback to get invoked whenever new subghz data is received. -// We queue a DemoEventDataDetected message and then return to the caller. -static void subghz_demo_worker_update_rx_event_callback(void* ctx) { - furi_assert(ctx); - DemoContext* demo_context = ctx; - DemoEvent event = {.type = DemoEventDataDetected}; - furi_message_queue_put(demo_context->queue, &event, FuriWaitForever); -} - -// This gets invoked when we process a DemoEventDataDetected event. -// We read the message using subghz_tx_rx_worker_read. -// We determine if the message is in the valid format. -// If valid, we queue a DemoEventReceivedCounter/Tone message with the counter/frequency. -// IMPORTANT: The code processing our event needs to furi_string_free the senderName! -static void subghz_demo_receive_data(DemoContext* instance) { - uint8_t message[MESSAGE_MAX_LEN] = {0}; - memset(message, 0x00, MESSAGE_MAX_LEN); - size_t len = subghz_tx_rx_worker_read(instance->subghz_txrx, message, MESSAGE_MAX_LEN); - size_t game_name_len = strlen(SUBGHZ_GAME_NAME); - if (len < (game_name_len + 2)) { - // Message wasn't big enough to have our game name + the reason code + version; so it must not be for us. - return; - } - - // The message for a counter (like 42) should be "SGDEMO:" + "C" + "0042" + ":" + "YourFlip" + "\r\n" - if (strcmp(SUBGHZ_GAME_NAME, (const char*)message)) { - FURI_LOG_D(TAG, "Got message %s", message); - // The purpose immediately follows the game name. - DemoRfPurpose purpose = message[game_name_len]; - uint8_t version = message[game_name_len+1]; - - UNUSED(version); - // Right now we don't care about the veresion of the application, but in the future we might need to - // respond differently based on the version of the application running on the other Flipper Zero. - // Important: Don't always trust what is sent, some people with Flipper Zero might send an - // invalid version to trick your code into interpreting the payload in a special way. - - // Null terminate the buffer at the end of message so we don't accidently overrun our buffer. - message[MESSAGE_MAX_LEN - 1] = 0; - - unsigned int number; - char senderName[9]; - switch (purpose) { - case DemoRfPurposeCounter: - // We expect this mesage to contain both the count and the sender name. - if (sscanf((const char*)message+game_name_len+2, "%04u:%8s", &number, senderName) == 2) { - // IMPORTANT: The code processing the event needs to furi_string_free the senderName! - FuriString* name = furi_string_alloc(); - furi_string_set(name, senderName); - // The counter is supposed to be a 4 digit number. - if (number > 10000U) { - number %= 10000; - } - DemoEvent event = {.type = DemoEventReceivedCounter, .number = number, .senderName = name}; - furi_message_queue_put(instance->queue, &event, FuriWaitForever); - } - break; - - case DemoRfPurposeTone: - // We expect this message to contain both the frequency and the sender name. - if (sscanf((const char*)message+game_name_len+2, "%u:%8s", &number, senderName) == 2) { - // IMPORTANT: The code processing the event needs to furi_string_free the senderName! - FuriString* name = furi_string_alloc(); - furi_string_set(name, senderName); - DemoEvent event = {.type = DemoEventReceivedTone, .number = number, .senderName = name}; - furi_message_queue_put(instance->queue, &event, FuriWaitForever); - } - break; - - // Add parsing for other messages here. - - default: - break; - } - } -} // This gets invoked when input (button press) is detected. // We queue a DemoEventTypeKey message with the input event data. @@ -214,10 +115,8 @@ static void subghz_demo_render_callback(Canvas* canvas, void* ctx) { DemoData* data = demo_context->data; unsigned int localCounter = data->localCounter; - unsigned int remoteCounter = data->remoteCounter; // The counter is supposed to be a 4 digit number. furi_assert(localCounter < 10000U); - furi_assert(remoteCounter < 10000U); // Other fonts are FontPrimary, FontSecondary, FontKeyboard, FontBigNumbers, canvas_set_font(canvas, FontPrimary); @@ -228,10 +127,6 @@ static void subghz_demo_render_callback(Canvas* canvas, void* ctx) { canvas_set_font(canvas, FontSecondary); canvas_draw_str_aligned(canvas, 64, 42, AlignCenter, AlignTop, furi_string_get_cstr(data->buffer)); - if (remoteCounter > 0) { - furi_string_printf(data->buffer, "Received %04u", remoteCounter); - canvas_draw_str_aligned(canvas, 64, 52, AlignCenter, AlignTop, furi_string_get_cstr(data->buffer)); - } furi_mutex_release(demo_context->mutex); } @@ -243,114 +138,35 @@ static void subghz_demo_update_local_counter(DemoContext* demo_context) { // Increment the counter (which is supposed to be a 4 digit number for this app.) data->localCounter++; - if (data->localCounter > 10000U) { + if (data->localCounter >= 10000U) { data->localCounter = 0; } + + FURI_LOG_T(TAG, "Local counter %04u", data->localCounter); } -// Our DemoEventReceivedCounter handler invokes this method. -// We update our remote counter. -static void subghz_demo_update_remote_counter(DemoContext* demo_context, DemoEvent* event) { - // The queueing code should have made sure the value was valid. - furi_assert(event->number < 10000); - DemoData* data = demo_context->data; - - data->remoteCounter = event->number; - FURI_LOG_I(TAG, "Remote counter %04u", data->remoteCounter); - - // The message contains a sender name furi_string that we need to free, even if we didn't use it. - if (event->senderName) { - furi_string_free(event->senderName); - } -} - -// Our DemoEventReceivedTone handler invokes this method. -// We play a quick (100ms) tone of the desired frequency. -static void subghz_demo_play_tone(DemoContext* demo_context, DemoEvent* event) { - DemoData* data = demo_context->data; - - unsigned int frequency = event->number; - FURI_LOG_I(TAG, "Playing frequency %04u", frequency); - - // Make tones if the speaker is available. - if (furi_hal_speaker_acquire(1000)) { - float freq = (float)frequency; - float volume = 1.0f; - furi_hal_speaker_start(freq, volume); - furi_delay_ms(100); - furi_hal_speaker_stop(); - furi_hal_speaker_release(); - } - - // The message contains a sender name furi_string that we need to free, even if we didn't use it. - if (event->senderName) { - furi_string_free(event->senderName); - } -} - -// This is a helper method that broadcasts a buffer. -// If the message is too large, the message will get truncated. -static void subghz_demo_broadcast(DemoContext* demo_context, FuriString* buffer) { - uint8_t* message = (uint8_t*)furi_string_get_cstr(buffer); - - // Make sure our message will fit into a packet; if not truncate it. - size_t length = strlen((char*)message); - if (length>MESSAGE_MAX_LEN) { - message[MESSAGE_MAX_LEN-1] = 0; - message[MESSAGE_MAX_LEN-2] = '\n'; - message[MESSAGE_MAX_LEN-3] = '\r'; - length = MESSAGE_MAX_LEN; - } - - while(!subghz_tx_rx_worker_write(demo_context->subghz_txrx, message, length)) { - // Wait a few milliseconds on failure before trying to send again. - furi_delay_ms(20); - } -} // Our DemoEventSendCounter handler invokes this method. -// We broadcast - "game name + purpose (Counter) + 4 digit counter value + : + Flipper name + \r\n" static void subghz_demo_broadcast_counter(DemoContext* demo_context, unsigned int counterToSend) { // The counter is supposed to be a 4 digit number. - furi_assert(counterToSend < 10000); + furi_assert(counterToSend < 10000U); DemoData* data = demo_context->data; FURI_LOG_I(TAG, "Sending counter %04u", counterToSend); - // The message for a counter with value 42 should look like... "SGDEMO:CA0042:YourFlip\r\n" - furi_string_printf(data->buffer, "%s%c%c%04u:%s\r\n", SUBGHZ_GAME_NAME, DemoRfPurposeCounter, MAJOR_VERSION, counterToSend, furi_hal_version_get_name_ptr()); - - subghz_demo_broadcast(demo_context, data->buffer); } // Our DemoEventSendTone handler invokes this method. -// We broadcast - "game name + purpose (Tone) + frequency + : + Flipper name + \r\n" static void subghz_demo_broadcast_tone(DemoContext* demo_context, unsigned int frequency) { DemoData* data = demo_context->data; FURI_LOG_I(TAG, "Sending frequency %04u", frequency); - - // The message for a frequency of 440 should look like... "SGDEMO:TA440:YourFlip\r\n" - furi_string_printf(data->buffer, "%s%c%c%u:%s\r\n", SUBGHZ_GAME_NAME, DemoRfPurposeTone, MAJOR_VERSION, frequency, furi_hal_version_get_name_ptr()); - - subghz_demo_broadcast(demo_context, data->buffer); } // This is the entry point for our application, which should match the application.fam file. int32_t subghz_demo_app(void* p) { UNUSED(p); - // For this demo we hardcode to 433.92MHz. - uint32_t frequency = 433920000; - // TODO: Have an ordered list of frequencies we try, instead of just 1 frequency. - - // Since this demo transmits RF, we see if it is allowed. - if(!furi_hal_subghz_is_tx_allowed(frequency)) { - // For this demo we don't show a friendly error about not being - // allowed to broadcast on this frequency. Instead the application - // just exits. - return 1; - } // Configure our initial data. DemoContext* demo_context = malloc(sizeof(DemoContext)); @@ -358,37 +174,10 @@ int32_t subghz_demo_app(void* p) { demo_context->data = malloc(sizeof(DemoData)); demo_context->data->buffer = furi_string_alloc(); demo_context->data->localCounter = 0; - demo_context->data->remoteCounter = 0; - // Queue for events (tick or input) + // Queue for events demo_context->queue = furi_message_queue_alloc(8, sizeof(DemoEvent)); - // Subghz worker. - demo_context->subghz_txrx = subghz_tx_rx_worker_alloc(); - - // Try to start the TX/RX on the frequency and configure our callback - // whenever new data is received. - if(subghz_tx_rx_worker_start(demo_context->subghz_txrx, frequency)) { - subghz_tx_rx_worker_set_callback_have_read( - demo_context->subghz_txrx, subghz_demo_worker_update_rx_event_callback, demo_context); - } else { - // For this demo we don't show a friendly error about not being - // allowed to broadcast on this frequency. Instead the application - // just exits. - if(subghz_tx_rx_worker_is_running(demo_context->subghz_txrx)) { - subghz_tx_rx_worker_stop(demo_context->subghz_txrx); - } - subghz_tx_rx_worker_free(demo_context->subghz_txrx); - furi_message_queue_free(demo_context->queue); - furi_mutex_free(demo_context->mutex); - furi_string_free(demo_context->data->buffer); - free(demo_context->data); - free(demo_context); - return 2; - } - - // All the subghz CLI apps disable charging; so our demo does it too. - furi_hal_power_suppress_charge_enter(); // Set ViewPort callbacks ViewPort* view_port = view_port_alloc(); @@ -451,23 +240,8 @@ int32_t subghz_demo_app(void* p) { subghz_demo_broadcast_tone(demo_context, event.number); furi_mutex_release(demo_context->mutex); break; - case DemoEventDataDetected: - // Another Flipper sent us data! Process it, potentially queuing an event. - subghz_demo_receive_data(demo_context); - break; - case DemoEventReceivedCounter: - // Process the counter sent by the other Flipper Zero. - furi_mutex_acquire(demo_context->mutex, FuriWaitForever); - subghz_demo_update_remote_counter(demo_context, &event); - furi_mutex_release(demo_context->mutex); - break; - case DemoEventReceivedTone: - // Process the tone sent by the other Flipper Zero. - furi_mutex_acquire(demo_context->mutex, FuriWaitForever); - subghz_demo_play_tone(demo_context, &event); - furi_mutex_release(demo_context->mutex); - break; default: + FURI_LOG_E(TAG, "Queue had unknown message type: %u", event.type); break; } @@ -475,16 +249,13 @@ int32_t subghz_demo_app(void* p) { view_port_update(view_port); } else { // We had an issue getting message from the queue, so exit application. + FURI_LOG_E(TAG, "Issue encountered reading from queue. Exiting application."); processing = false; } } while (processing); // Free resources furi_timer_free(timer); - if(subghz_tx_rx_worker_is_running(demo_context->subghz_txrx)) { - subghz_tx_rx_worker_stop(demo_context->subghz_txrx); - } - subghz_tx_rx_worker_free(demo_context->subghz_txrx); view_port_enabled_set(view_port, false); gui_remove_view_port(gui, view_port); view_port_free(view_port); @@ -495,8 +266,6 @@ int32_t subghz_demo_app(void* p) { free(demo_context->data); free(demo_context); - // Reenable charging. - furi_hal_power_suppress_charge_exit(); - + return 0; } \ No newline at end of file