diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000000..2d8a8a74db7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,24 @@ +Copyright (c) 2022-2023 Salvatore Sanfilippo + +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md new file mode 100644 index 00000000000..7523913ca5d --- /dev/null +++ b/README.md @@ -0,0 +1,289 @@ +ProtoView is a digital signal detection, visualization, editing and reply tool for the [Flipper Zero](https://flipperzero.one/). The Flipper default application, called Subghz, is able to identify certain RF protocols, but when the exact protocol is not implemented (and there are many undocumented and unimplemented ones, such as the ones in use in TPMS systems, car keys and many others), the curious person is left wondering what the device is sending at all. Using ProtoView she or he can visualize the high and low pulses like in the example image below (showing a TPMS signal produced by a Renault tire): + +![ProtoView screenshot raw signal](/images/protoview_1.jpg) + +This is often enough to make an initial idea about the encoding used +and if the selected modulation is correct. For example, in the signal above +you can see a set of regular pulses and gaps used for synchronization, and then +a sequence of bits encoded in [Manchester](https://en.wikipedia.org/wiki/Manchester_code) line code. If you study these things for five minutes, you'll find yourself able to decode the bits with naked eyes. + +## Decoding capabilities + +Other than showing the raw signal, ProtoView is able to decode a few interesting protocols: + +* TPMS sensors: Renault, Toyota, Schrader, Citroen, Ford. +* Microchip HSC200/300/301 Keeloq protocol. +* Oregon thermometer protocol 2. +* PT2262, SC5262 based remotes. +* ... more will be implemented soon, hopefully. Send PRs :) + +![ProtoView screenshot Renault TPMS data](/images/protoview_2.jpg) + +The app implements a framework that makes adding and experimenting with new +protocols very simple. Check the `protocols` directory to see how the +API works, or read the full documentation at the end of this `README` file. +The gist of it is that the decoder receives the signal already converted into +a bitmap, where each bit represents a short pulse duration. Then there are +functions to seek specific sync/preamble sequences inside the bitmap, to decode +from different line codes, to compute checksums and so forth. + +## Signals transmission capabilities + +Once ProtoView decodes a given message, it is able to *resample* it +in pulses and gaps of the theoretical duration, and send the signal again +via the Flipper TX capabilities. The captured signal can be sent +to different frequencies and modulations than the ones it was captured +from. + +For selected protocols, that implement the message creation methods, +ProtoView is also able to edit the message received, modify fields, +and finally re-detect the new produced signal and resend it. Signals +can also be produced from scratch, by setting all the fields to appropriate +values. + +## A well-documented app for the Flipper + +The secondary goal of ProtoView is to provide a well-documented application for the Flipper (even if ProtoView is a pretty atypical application: it doesn't make use of the standard widgets and other abstractions provided by the framework). +Most apps dealing with the *subghz subsystem* of the Flipper (the abstraction used to work with the [CC1101 chip](https://www.ti.com/product/CC1101)) tend to be complicated and completely undocumented. +Unfortunately, this is also true for the firmware of the device. +It's a shame, because especially in the case of code that talks with hardware peripherals there are tons of assumptions and hard-gained lessons that can [only be captured by comments and are in the code only implicitly](http://antirez.com/news/124). + +However, the Flipper firmware source code is well written even if it +lacks comments and documentation (and sometimes makes use of abstractions more convoluted than needed), so it is possible to make some ideas of how things work just grepping inside. In order to develop this application, I ended reading most parts of the firmware of the device. + +## Detection algorithm + +In order to detect and show unknown signals, the application attempts to understand if the samples obtained by the Flipper API (a series of pulses that are high +or low, and with different duration in microseconds) look like belonging to +a legitimate signal, and aren't just noise. + +We can't make assumptions about +the encoding and the data rate of the communication, so we use a simple +but relatively effective algorithm. As we check the signal, we try to detect +long parts of it that are composed of pulses roughly classifiable into +a maximum of three different duration classes, plus or minus a given percentage. +Most encodings are somewhat self-clocked, so they tend to have just two or +three classes of pulse lengths. + +However, often, pulses of the same theoretical +length have slightly different lengths in the case of high and low level +(RF on or off), so the detector classifies them separately for robustness. + +Once the raw signal is detected, the registered protocol decoders are called +against it, in the hope some of the decoders will make sense of the signal. + +# Usage + +In the main screen, the application shows the longest coherent signal detected so far. The user can switch to other views pressing the LEFT and RIGHT keys. The BACK key will return back to the main screen. Long pressing BACK will quit the application. + +## Main raw signal screen + +* A long press of the OK button resets the current signal, in order to capture a new one. +* The UP and DOWN buttons change the scale. Default is 100us per pixel, but it will be adapted to the signal just captured. +* A long press of the LEFT and RIGHT keys will pan the signal, to see what was transmitted before/after the current shown range. +* A short press to OK will recenter the signal and set the scale back to the default for the specific pulse duration detected. + +Under the detected sequence, you will see a small triangle marking a +specific sample. This mark means that the sequence looked coherent up +to that point, and starting from there it could be just noise. However the +signal decoders will not get just up to this point, but will get more: +sometimes the low level detector can't make sense of a signal that the +protocol-specific decoder can understand fully. + +If the protocol is decoded, the bottom-left corner of the screen +will show the name of the protocol, and going in the next screen +with the right arrow will show information about the decoded signal. + +In the bottom-right corner the application displays an amount of time +in microseconds. This is the average length of the shortest pulse length +detected among the three classes. Usually the *data rate* of the protocol +is something like `1000000/this-number*2`, but it depends on the encoding +and could actually be `1000000/this-number*N` with `N > 2` (here 1000000 +is the number of microseconds in one second, and N is the number of clock +cycles needed to represent a bit). + +## Info screen + +If a signal was detected, the info view will show the details about the signal. If the signal has more data that a single screen can fit, pressing OK will show the next fields. Pressing DOWN will go to a sub-view with an oscilloscope-alike representation of the signal, from there you can: + +1. Resend the signal, by pressing OK. +2. Save the signal as `.sub` file, by long pressing OK. + +When resending, you can select a different frequency and modulation if you +wish. + +## Frequency and modulation screen + +In this view you can just set the frequency and modulation you want to use. +There are special modulations for TPMS signals: they need an higher data +rate. + +* Many cheap remotes (gate openers, remotes, ...) are on the 433.92Mhz or nearby and use OOK modulation. +* Weather stations are often too in the 433.92Mhz OOK. +* For car keys, try 433.92 OOK650 and 868.35 Mhz in OOK or 2FSK. +* For TPMS try 433.92 in TPMS1 or TPMS2 modulations (FSK and OOK custom modulations optimized for these signals, that have a relatively high data rate). + +## Signal creator + +In this view, you can do two things: + +1. Select one of the protocols supporting message creation, and create a signal from scratch. +2. If there is already a detected signal, you can modify the signal. + +This is how it works: + +1. Select one of the protocols (the one of the currently detected signal will be already provided as default, if any, and if it supports message creation). +2. Fill the fields. Use LEFT and RIGHT to change the values of integers, or just press OK and enter the new value with the Fliper keyboard widget. +3. When you are done, long press OK to build the message. Then press BACK in order to see it. +4. Go to the INFO view, and then DOWN to the signal sending/saving subview in order to send or save it. + +## Direct sampling screen + +This final screen shows in real time the high and low level that the Flipper +RF chip, the CC1101, is receiving. This will makes very easy to understand +if a given frequency is targeted by something other than noise. This mode is +fun to watch, resembling an old CRT TV set. + +# Installing the app from source + +* Download the Flipper Zero dev kit and build it: +``` +mkdir -p ~/flipperZero/official/ +cd ~/flipperZero/official/ +git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git ./ +./fbt +``` +* Copy this application folder in `official/applications_user`. +* Connect your Flipper via USB. +* Build and install with: `./fbt launch_app APPSRC=protoview`. + +# Installing the binary file (no build needed) + +Drop the `protoview.fap` file you can find in the `binaries` folder into the +following Flipper Zero location: + + /ext/apps/Tools + +The `ext` part means that we are in the SD card. So if you don't want +to use the Android (or other) application to upload the file, +you can just take out the SD card, insert it in your computer, +copy the fine into `apps/Tools`, and that's it. + +# Protocols decoders API + +Writing a protocol decoder is not hard, and requires to write three +different methods. + +1. `decode()`. This is mandatory, and is used in order to turn a known signal into a set of fields containing certain informations. For instance for a thermometer sending data via RF, a raw message will be decoded into fields like temperature, humidity, station ID and so forth. +2. `get_fields()`. Optional, only needed if the protocol supports creating and editing signals. This method just returns the fields names, types and defaults. The app will use this list in order to allow the user to set values. The populated fields will be passed to the `build_message()` method later. +3. `build_message()`. This method gets a set of fields representing the parameters of the protocol, as set by the user, and will create a low level signal composed of pulses and gaps of specific durations. + +## `decode()` method + + bool decode(uint8_t *bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo *info); + +The method gets a bitmap `bits` long `numbytes` bytes but actually containing `bumbits` valid bits. Each bit represents a pulse of gap of the duration of the shortest time detected in the protocol (this is often called *te*, in the RF protocols jargon). So, for instance, if a signal is composed of pulses and gaps of around 500 and 1000 microseconds, each bit in the bitmap will represent 500 microseconds. + +Continuing with the example above, if the received signal was composed of a 1000 microseconds gap, then a 500 microsecond pulse, then a 500 microsecond gap and finally a 1000 microseconds pulse, its bitmap representation will be: + + 001011 + +To access the bitmap, the decoder can use the following API: + + bool bitmap_get(uint8_t *b, uint32_t blen, uint32_t bitpos); + +The `blen` parameter will be set to what the decode method gets +as `numbytes`, and is used to prevent overflows. This way if `bitpos` +is out of range, nothing bad happens. + +There are function to match and seek specific patterns inside the signal: + + bool bitmap_match_bits(uint8_t *b, uint32_t blen, uint32_t bitpos, const char *bits); + uint32_t bitmap_seek_bits(uint8_t *b, uint32_t blen, uint32_t startpos, uint32_t maxbits, const char *bits); + +Finally, there are functions to convert from different line codes: + + uint32_t convert_from_line_code(uint8_t *buf, uint64_t buflen, uint8_t *bits, uint32_t len, uint32_t offset, const char *zero_pattern, const char *one_pattern); + uint32_t convert_from_diff_manchester(uint8_t *buf, uint64_t buflen, uint8_t *bits, uint32_t len, uint32_t off, bool previous); + +This method can also access the short pulse duration by inspecting the +`info->short_pulse_dur` field (in microseconds). + +Please check the `b4b1.c` file for an easy to understand example of the decoder implementation. + +If the decoder actually detected a message, it will return `true` and will return a set of fields, like thata: + + fieldset_add_bytes(info->fieldset,"id",d,5); + fieldset_add_uint(info->fieldset,"button",d[2]&0xf,4); + +## `get_fields()` method. + + static void get_fields(ProtoViewFieldSet *fieldset); + +This method will be basically a copy of the final part of `decode()`, as +it also needs to return the set of fields this protocol is composed of. +However instead of returning the values of an actual decoded message, it +will just provide their default values for the signal creator view. + +Note that the `build_message()` method is guaranteed to receive the +same exact fields in the same exact order. + +## `build_message()` method. + + void build_message(RawSamplesBuffer *samples, ProtoViewFieldSet *fs); + +This method is responsible of creating a signal from scratch, by +appending gaps and pulses of the specific duration into `samples` +using the following API: + + raw_samples_add(RawSamplesBuffer *samples, bool level, uint32_t duration); + +Level can be true (pules) or false (gap). Duration is in microseconds. +The method receives a set of fields in `fs`. Each field is accessible +directly accessing `fs->fields[... field index ...]`, where the field +index is 0, 1, 2, ... in the same order as `get_fields()` returned the +fields. + +For now, you can access the fields in the raw way, by getting the +values directly from the data structure representing each field: + +``` +typedef struct { + ProtoViewFieldType type; + uint32_t len; // Depends on type: + // Bits for integers (signed,unsigned,binary,hex). + // Number of characters for strings. + // Number of nibbles for bytes (1 for each 4 bits). + // Number of digits after dot for floats. + char *name; // Field name. + union { + char *str; // String type. + int64_t value; // Signed integer type. + uint64_t uvalue; // Unsigned integer type. + uint8_t *bytes; // Raw bytes type. + float fvalue; // Float type. + }; +} ProtoViewField; + +``` + +However later the app will likely provide a set of macros to do it +in a more future-proof way. + +# License + +The code is released under the BSD license. + +# Disclaimer + +This application is only provided as an educational tool. The author is not liable in case the application is used to reverse engineer protocols protected by IP or for any other illegal purpose. + +# Credits + +A big thank you to the RTL433 author, [Benjamin Larsson](https://github.com/merbanan). I used the code and tools he developed in many ways: +* To capture TPMS data with rtl433 and save to a file, to later play the IQ files and speedup the development. +* As a sourve of documentation for protocols. +* As an awesome way to visualize and understand protocols, via [these great web tools](https://triq.org/). +* To have tons of fun with RTLSDR in general, now and in the past. + +The application icon was designed by Stefano Liuzzo. diff --git a/app.c b/app.c new file mode 100644 index 00000000000..868ec8f1687 --- /dev/null +++ b/app.c @@ -0,0 +1,400 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +RawSamplesBuffer *RawSamples, *DetectedSamples; +extern const SubGhzProtocolRegistry protoview_protocol_registry; + +/* Draw some text with a border. If the outside color is black and the inside + * color is white, it just writes the border of the text, but the function can + * also be used to write a bold variation of the font setting both the + * colors to black, or alternatively to write a black text with a white + * border so that it is visible if there are black stuff on the background. */ +/* The callback actually just passes the control to the actual active + * view callback, after setting up basic stuff like cleaning the screen + * and setting color to black. */ +static void render_callback(Canvas* const canvas, void* ctx) { + ProtoViewApp* app = ctx; + furi_mutex_acquire(app->view_updating_mutex, FuriWaitForever); + + /* Clear screen. */ + canvas_set_color(canvas, ColorWhite); + canvas_draw_box(canvas, 0, 0, 127, 63); + canvas_set_color(canvas, ColorBlack); + canvas_set_font(canvas, FontPrimary); + + /* Call who is in charge right now. */ + switch(app->current_view) { + case ViewRawPulses: + render_view_raw_pulses(canvas, app); + break; + case ViewInfo: + render_view_info(canvas, app); + break; + case ViewFrequencySettings: + case ViewModulationSettings: + render_view_settings(canvas, app); + break; + case ViewDirectSampling: + render_view_direct_sampling(canvas, app); + break; + case ViewBuildMessage: + render_view_build_message(canvas, app); + break; + default: + furi_crash(TAG "Invalid view selected"); + break; + } + + /* Draw the alert box if set. */ + ui_draw_alert_if_needed(canvas, app); + furi_mutex_release(app->view_updating_mutex); +} + +/* Here all we do is putting the events into the queue that will be handled + * in the while() loop of the app entry point function. */ +static void input_callback(InputEvent* input_event, void* ctx) { + ProtoViewApp* app = ctx; + furi_message_queue_put(app->event_queue, input_event, FuriWaitForever); +} + +/* Called to switch view (when left/right is pressed). Handles + * changing the current view ID and calling the enter/exit view + * callbacks if needed. + * + * The 'switchto' parameter can be the identifier of a view, or the + * special views ViewGoNext and ViewGoPrev in order to move to + * the logical next/prev view. */ +static void app_switch_view(ProtoViewApp* app, ProtoViewCurrentView switchto) { + furi_mutex_acquire(app->view_updating_mutex, FuriWaitForever); + + /* Switch to the specified view. */ + ProtoViewCurrentView old = app->current_view; + if(switchto == ViewGoNext) { + app->current_view++; + if(app->current_view == ViewLast) app->current_view = 0; + } else if(switchto == ViewGoPrev) { + if(app->current_view == 0) + app->current_view = ViewLast - 1; + else + app->current_view--; + } else { + app->current_view = switchto; + } + ProtoViewCurrentView new = app->current_view; + + /* Call the exit view callbacks. */ + if(old == ViewDirectSampling) view_exit_direct_sampling(app); + if(old == ViewBuildMessage) view_exit_build_message(app); + if(old == ViewInfo) view_exit_info(app); + /* The frequency/modulation settings are actually a single view: + * as long as the user stays between the two modes of this view we + * don't need to call the exit-view callback. */ + if((old == ViewFrequencySettings && new != ViewModulationSettings) || + (old == ViewModulationSettings && new != ViewFrequencySettings)) + view_exit_settings(app); + + /* Reset the view private data each time, before calling the enter + * callbacks that may want to setup some state. */ + memset(app->view_privdata, 0, PROTOVIEW_VIEW_PRIVDATA_LEN); + + /* Call the enter view callbacks after all the exit callback + * of the old view was already executed. */ + if(new == ViewDirectSampling) view_enter_direct_sampling(app); + if(new == ViewBuildMessage) view_enter_build_message(app); + + /* Set the current subview of the view we just left to zero. This is + * the main subview of the old view. When we re-enter the view we are + * lefting, we want to see the main thing again. */ + app->current_subview[old] = 0; + + /* If there is an alert on screen, dismiss it: if the user is + * switching view she already read it. */ + ui_dismiss_alert(app); + furi_mutex_release(app->view_updating_mutex); +} + +/* Allocate the application state and initialize a number of stuff. + * This is called in the entry point to create the application state. */ +ProtoViewApp* protoview_app_alloc() { + furi_hal_power_suppress_charge_enter(); + + ProtoViewApp* app = malloc(sizeof(ProtoViewApp)); + + // Init shared data structures + RawSamples = raw_samples_alloc(); + DetectedSamples = raw_samples_alloc(); + + //init setting + app->setting = subghz_setting_alloc(); + subghz_setting_load(app->setting, EXT_PATH("subghz/assets/setting_user")); + + // GUI + app->gui = furi_record_open(RECORD_GUI); + app->notification = furi_record_open(RECORD_NOTIFICATION); + app->view_port = view_port_alloc(); + view_port_draw_callback_set(app->view_port, render_callback, app); + view_port_input_callback_set(app->view_port, input_callback, app); + gui_add_view_port(app->gui, app->view_port, GuiLayerFullscreen); + app->event_queue = furi_message_queue_alloc(8, sizeof(InputEvent)); + app->view_dispatcher = NULL; + app->text_input = NULL; + app->show_text_input = false; + app->alert_dismiss_time = 0; + app->current_view = ViewRawPulses; + app->view_updating_mutex = furi_mutex_alloc(FuriMutexTypeNormal); + for(int j = 0; j < ViewLast; j++) app->current_subview[j] = 0; + app->direct_sampling_enabled = false; + app->view_privdata = malloc(PROTOVIEW_VIEW_PRIVDATA_LEN); + memset(app->view_privdata, 0, PROTOVIEW_VIEW_PRIVDATA_LEN); + + // Signal found and visualization defaults + app->signal_bestlen = 0; + app->signal_last_scan_idx = 0; + app->signal_decoded = false; + app->us_scale = PROTOVIEW_RAW_VIEW_DEFAULT_SCALE; + app->signal_offset = 0; + app->msg_info = NULL; + + // Init Worker & Protocol + app->txrx = malloc(sizeof(ProtoViewTxRx)); + + /* Setup rx state. */ + app->txrx->freq_mod_changed = false; + app->txrx->debug_timer_sampling = false; + app->txrx->last_g0_change_time = DWT->CYCCNT; + app->txrx->last_g0_value = false; + + app->frequency = subghz_setting_get_default_frequency(app->setting); + app->modulation = 0; /* Defaults to ProtoViewModulations[0]. */ + + // Init & set radio_device + subghz_devices_init(); + app->radio_device = + radio_device_loader_set(app->radio_device, SubGhzRadioDeviceTypeExternalCC1101); + + subghz_devices_reset(app->radio_device); + subghz_devices_idle(app->radio_device); + + app->running = 1; + + return app; +} + +/* Free what the application allocated. It is not clear to me if the + * Flipper OS, once the application exits, will be able to reclaim space + * even if we forget to free something here. */ +void protoview_app_free(ProtoViewApp* app) { + furi_assert(app); + + subghz_devices_sleep(app->radio_device); + radio_device_loader_end(app->radio_device); + + subghz_devices_deinit(); + + // View related. + view_port_enabled_set(app->view_port, false); + gui_remove_view_port(app->gui, app->view_port); + view_port_free(app->view_port); + furi_record_close(RECORD_GUI); + furi_record_close(RECORD_NOTIFICATION); + furi_message_queue_free(app->event_queue); + furi_mutex_free(app->view_updating_mutex); + app->gui = NULL; + + // Frequency setting. + subghz_setting_free(app->setting); + + // Worker stuff. + free(app->txrx); + + // Raw samples buffers. + raw_samples_free(RawSamples); + raw_samples_free(DetectedSamples); + furi_hal_power_suppress_charge_exit(); + + free(app); +} + +/* Called periodically. Do signal processing here. Data we process here + * will be later displayed by the render callback. The side effect of this + * function is to scan for signals and set DetectedSamples. */ +static void timer_callback(void* ctx) { + ProtoViewApp* app = ctx; + uint32_t delta, lastidx = app->signal_last_scan_idx; + + /* scan_for_signal(), called by this function, deals with a + * circular buffer. To never miss anything, even if a signal spawns + * cross-boundaries, it is enough if we scan each time the buffer fills + * for 50% more compared to the last scan. Thanks to this check we + * can avoid scanning too many times to just find the same data. */ + if(lastidx < RawSamples->idx) { + delta = RawSamples->idx - lastidx; + } else { + delta = RawSamples->total - lastidx + RawSamples->idx; + } + if(delta < RawSamples->total / 2) return; + app->signal_last_scan_idx = RawSamples->idx; + scan_for_signal(app, RawSamples, ProtoViewModulations[app->modulation].duration_filter); +} + +/* This is the navigation callback we use in the view dispatcher used + * to display the "text input" widget, that is the keyboard to get text. + * The text input view is implemented to ignore the "back" short press, + * so the event is not consumed and is handled by the view dispatcher. + * However the view dispatcher implementation has the strange behavior that + * if no navigation callback is set, it will not stop when handling back. + * + * We just need a dummy callback returning false. We believe the + * implementation should be changed and if no callback is set, it should be + * the same as returning false. */ +static bool keyboard_view_dispatcher_navigation_callback(void* ctx) { + UNUSED(ctx); + return false; +} + +/* App entry point, as specified in application.fam. */ +int32_t protoview_app_entry(void* p) { + UNUSED(p); + ProtoViewApp* app = protoview_app_alloc(); + + /* Create a timer. We do data analysis in the callback. */ + FuriTimer* timer = furi_timer_alloc(timer_callback, FuriTimerTypePeriodic, app); + furi_timer_start(timer, furi_kernel_get_tick_frequency() / 8); + + /* Start listening to signals immediately. */ + radio_begin(app); + radio_rx(app); + + /* This is the main event loop: here we get the events that are pushed + * in the queue by input_callback(), and process them one after the + * other. The timeout is 100 milliseconds, so if not input is received + * before such time, we exit the queue_get() function and call + * view_port_update() in order to refresh our screen content. */ + InputEvent input; + while(app->running) { + FuriStatus qstat = furi_message_queue_get(app->event_queue, &input, 100); + if(qstat == FuriStatusOk) { + if(DEBUG_MSG) + FURI_LOG_E(TAG, "Main Loop - Input: type %d key %u", input.type, input.key); + + /* Handle navigation here. Then handle view-specific inputs + * in the view specific handling function. */ + if(input.type == InputTypeShort && input.key == InputKeyBack) { + if(app->current_view != ViewRawPulses) { + /* If this is not the main app view, go there. */ + app_switch_view(app, ViewRawPulses); + } else { + /* If we are in the main app view, warn the user + * they needs to long press to really quit. */ + ui_show_alert(app, "Long press to exit", 1000); + } + } else if(input.type == InputTypeLong && input.key == InputKeyBack) { + app->running = 0; + } else if( + input.type == InputTypeShort && input.key == InputKeyRight && + ui_get_current_subview(app) == 0) { + /* Go to the next view. */ + app_switch_view(app, ViewGoNext); + } else if( + input.type == InputTypeShort && input.key == InputKeyLeft && + ui_get_current_subview(app) == 0) { + /* Go to the previous view. */ + app_switch_view(app, ViewGoPrev); + } else { + /* This is where we pass the control to the currently + * active view input processing. */ + switch(app->current_view) { + case ViewRawPulses: + process_input_raw_pulses(app, input); + break; + case ViewInfo: + process_input_info(app, input); + break; + case ViewFrequencySettings: + case ViewModulationSettings: + process_input_settings(app, input); + break; + case ViewDirectSampling: + process_input_direct_sampling(app, input); + break; + case ViewBuildMessage: + process_input_build_message(app, input); + break; + default: + furi_crash(TAG "Invalid view selected"); + break; + } + } + } else { + /* Useful to understand if the app is still alive when it + * does not respond because of bugs. */ + if(DEBUG_MSG) { + static int c = 0; + c++; + if(!(c % 20)) FURI_LOG_E(TAG, "Loop timeout"); + } + } + if(app->show_text_input) { + /* Remove our viewport: we need to use a view dispatcher + * in order to show the standard Flipper keyboard. */ + gui_remove_view_port(app->gui, app->view_port); + + /* Allocate a view dispatcher, add a text input view to it, + * and activate it. */ + app->view_dispatcher = view_dispatcher_alloc(); + view_dispatcher_enable_queue(app->view_dispatcher); + /* We need to set a navigation callback for the view dispatcher + * otherwise when the user presses back on the keyboard to + * abort, the dispatcher will not stop. */ + view_dispatcher_set_navigation_event_callback( + app->view_dispatcher, keyboard_view_dispatcher_navigation_callback); + app->text_input = text_input_alloc(); + view_dispatcher_set_event_callback_context(app->view_dispatcher, app); + view_dispatcher_add_view( + app->view_dispatcher, 0, text_input_get_view(app->text_input)); + view_dispatcher_switch_to_view(app->view_dispatcher, 0); + + /* Setup the text input view. The different parameters are set + * in the app structure by the view that wanted to show the + * input text. The callback, buffer and buffer len must be set. */ + text_input_set_header_text(app->text_input, "Save signal filename"); + text_input_set_result_callback( + app->text_input, + app->text_input_done_callback, + app, + app->text_input_buffer, + app->text_input_buffer_len, + false); + + /* Run the dispatcher with the keyboard. */ + view_dispatcher_attach_to_gui( + app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen); + view_dispatcher_run(app->view_dispatcher); + + /* Undo all it: remove the view from the dispatcher, free it + * so that it removes itself from the current gui, finally + * restore our viewport. */ + view_dispatcher_remove_view(app->view_dispatcher, 0); + text_input_free(app->text_input); + view_dispatcher_free(app->view_dispatcher); + app->view_dispatcher = NULL; + gui_add_view_port(app->gui, app->view_port, GuiLayerFullscreen); + app->show_text_input = false; + } else { + view_port_update(app->view_port); + } + } + + /* App no longer running. Shut down and free. */ + if(app->txrx->txrx_state == TxRxStateRx) { + FURI_LOG_E(TAG, "Putting CC1101 to sleep before exiting."); + radio_rx_end(app); + radio_sleep(app); + } + + furi_timer_free(timer); + protoview_app_free(app); + return 0; +} diff --git a/app.h b/app.h new file mode 100644 index 00000000000..5fb0adf34a0 --- /dev/null +++ b/app.h @@ -0,0 +1,377 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "raw_samples.h" +#include "helpers/radio_device_loader.h" + +#define TAG "ProtoView" +#define PROTOVIEW_RAW_VIEW_DEFAULT_SCALE 100 // 100us is 1 pixel by default +#define BITMAP_SEEK_NOT_FOUND UINT32_MAX // Returned by function as sentinel +#define PROTOVIEW_VIEW_PRIVDATA_LEN 64 // View specific private data len + +#define DEBUG_MSG 0 + +/* Forward declarations. */ + +typedef struct ProtoViewApp ProtoViewApp; +typedef struct ProtoViewMsgInfo ProtoViewMsgInfo; +typedef struct ProtoViewFieldSet ProtoViewFieldSet; +typedef struct ProtoViewDecoder ProtoViewDecoder; + +/* ============================== enumerations ============================== */ + +/* Subghz system state */ +typedef enum { + TxRxStateIDLE, + TxRxStateRx, + TxRxStateTx, + TxRxStateSleep, +} TxRxState; + +/* Currently active view. */ +typedef enum { + ViewRawPulses, + ViewInfo, + ViewFrequencySettings, + ViewModulationSettings, + ViewBuildMessage, + ViewDirectSampling, + ViewLast, /* Just a sentinel to wrap around. */ + + /* The following are special views that are not iterated, but + * have meaning for the API. */ + ViewGoNext, + ViewGoPrev, +} ProtoViewCurrentView; + +/* ================================== RX/TX ================================= */ + +typedef struct { + const char* name; // Name to show to the user. + const char* id; // Identifier in the Flipper API/file. + FuriHalSubGhzPreset preset; // The preset ID. + uint8_t* custom; /* If not null, a set of registers for + the CC1101, specifying a custom preset.*/ + uint32_t duration_filter; /* Ignore pulses and gaps that are less + than the specified microseconds. This + depends on the data rate. */ +} ProtoViewModulation; + +extern ProtoViewModulation ProtoViewModulations[]; /* In app_subghz.c */ + +/* This is the context of our subghz worker and associated thread. + * It receives data and we get our protocol "feed" callback called + * with the level (1 or 0) and duration. */ +struct ProtoViewTxRx { + bool freq_mod_changed; /* The user changed frequency and/or modulation + from the interface. There is to restart the + radio with the right parameters. */ + TxRxState txrx_state; /* Receiving, idle or sleeping? */ + + /* Timer sampling mode state. */ + bool debug_timer_sampling; /* Read data from GDO0 in a busy loop. Only + for testing. */ + uint32_t last_g0_change_time; /* Last high->low (or reverse) switch. */ + bool last_g0_value; /* Current value (high or low): we are + checking the duration in the timer + handler. */ +}; + +typedef struct ProtoViewTxRx ProtoViewTxRx; + +/* ============================== Main app state ============================ */ + +#define ALERT_MAX_LEN 32 +struct ProtoViewApp { + /* GUI */ + Gui* gui; + NotificationApp* notification; + ViewPort* view_port; /* We just use a raw viewport and we render + everything into the low level canvas. */ + ProtoViewCurrentView current_view; /* Active left-right view ID. */ + FuriMutex* view_updating_mutex; /* The Flipper GUI calls the screen redraw + callback in a different thread. We + use this mutex to protect the redraw + from changes in app->view_privdata. */ + int current_subview[ViewLast]; /* Active up-down subview ID. */ + FuriMessageQueue* event_queue; /* Keypress events go here. */ + + /* Input text state. */ + ViewDispatcher* view_dispatcher; /* Used only when we want to show + the text_input view for a moment. + Otherwise it is set to null. */ + TextInput* text_input; + bool show_text_input; + char* text_input_buffer; + uint32_t text_input_buffer_len; + void (*text_input_done_callback)(void*); + + /* Alert state. */ + uint32_t alert_dismiss_time; /* Millisecond when the alert will be + no longer shown. Or zero if the alert + is currently not set at all. */ + char alert_text[ALERT_MAX_LEN]; /* Alert content. */ + + /* Radio related. */ + ProtoViewTxRx* txrx; /* Radio state. */ + SubGhzSetting* setting; /* A list of valid frequencies. */ + + const SubGhzDevice* radio_device; + + /* Generic app state. */ + int running; /* Once false exists the app. */ + uint32_t signal_bestlen; /* Longest coherent signal observed so far. */ + uint32_t signal_last_scan_idx; /* Index of the buffer last time we + performed the scan. */ + bool signal_decoded; /* Was the current signal decoded? */ + ProtoViewMsgInfo* msg_info; /* Decoded message info if not NULL. */ + bool direct_sampling_enabled; /* This special view needs an explicit + acknowledge to work. */ + void* view_privdata; /* This is a piece of memory of total size + PROTOVIEW_VIEW_PRIVDATA_LEN that it is + initialized to zero when we switch to + a a new view. While the view we are using + is the same, it can be used by the view to + store any kind of info inside, just casting + the pointer to a few specific-data structure. */ + + /* Raw view apps state. */ + uint32_t us_scale; /* microseconds per pixel. */ + uint32_t signal_offset; /* Long press left/right panning in raw view. */ + + /* Configuration view app state. */ + uint32_t frequency; /* Current frequency. */ + uint8_t modulation; /* Current modulation ID, array index in the + ProtoViewModulations table. */ +}; + +/* =========================== Protocols decoders =========================== */ + +/* This stucture is filled by the decoder for specific protocols with the + * informations about the message. ProtoView will display such information + * in the message info view. */ +#define PROTOVIEW_MSG_STR_LEN 32 +typedef struct ProtoViewMsgInfo { + ProtoViewDecoder* decoder; /* The decoder that decoded the message. */ + ProtoViewFieldSet* fieldset; /* Decoded fields. */ + /* Low level information of the detected signal: the following are filled + * by the protocol decoding function: */ + uint32_t start_off; /* Pulses start offset in the bitmap. */ + uint32_t pulses_count; /* Number of pulses of the full message. */ + /* The following are passed already filled to the decoder. */ + uint32_t short_pulse_dur; /* Microseconds duration of the short pulse. */ + /* The following are filled by ProtoView core after the decoder returned + * success. */ + uint8_t* bits; /* Bitmap with the signal. */ + uint32_t bits_bytes; /* Number of full bytes in the bitmap, that + is 'pulses_count/8' rounded to the next + integer. */ +} ProtoViewMsgInfo; + +/* This structures describe a set of protocol fields. It is used by decoders + * supporting message building to receive and return information about the + * protocol. */ +typedef enum { + FieldTypeStr, + FieldTypeSignedInt, + FieldTypeUnsignedInt, + FieldTypeBinary, + FieldTypeHex, + FieldTypeBytes, + FieldTypeFloat, +} ProtoViewFieldType; + +typedef struct { + ProtoViewFieldType type; + uint32_t len; // Depends on type: + // Bits for integers (signed,unsigned,binary,hex). + // Number of characters for strings. + // Number of nibbles for bytes (1 for each 4 bits). + // Number of digits after dot for floats. + char* name; // Field name. + union { + char* str; // String type. + int64_t value; // Signed integer type. + uint64_t uvalue; // Unsigned integer type. + uint8_t* bytes; // Raw bytes type. + float fvalue; // Float type. + }; +} ProtoViewField; + +typedef struct ProtoViewFieldSet { + ProtoViewField** fields; + uint32_t numfields; +} ProtoViewFieldSet; + +typedef struct ProtoViewDecoder { + const char* name; /* Protocol name. */ + /* The decode function takes a buffer that is actually a bitmap, with + * high and low levels represented as 0 and 1. The number of high/low + * pulses represented by the bitmap is passed as the 'numbits' argument, + * while 'numbytes' represents the total size of the bitmap pointed by + * 'bits'. So 'numbytes' is mainly useful to pass as argument to other + * functions that perform bit extraction with bound checking, such as + * bitmap_get() and so forth. */ + bool (*decode)(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info); + /* This method is used by the decoder to return the fields it needs + * in order to build a new message. This way the message builder view + * can ask the user to fill the right set of fields of the specified + * type. */ + void (*get_fields)(ProtoViewFieldSet* fields); + /* This method takes the fields supported by the decoder, and + * renders a message in 'samples'. */ + void (*build_message)(RawSamplesBuffer* samples, ProtoViewFieldSet* fields); +} ProtoViewDecoder; + +extern RawSamplesBuffer *RawSamples, *DetectedSamples; + +/* app_subghz.c */ +void radio_begin(ProtoViewApp* app); +uint32_t radio_rx(ProtoViewApp* app); +void radio_idle(ProtoViewApp* app); +void radio_rx_end(ProtoViewApp* app); +void radio_sleep(ProtoViewApp* app); +void raw_sampling_worker_start(ProtoViewApp* app); +void raw_sampling_worker_stop(ProtoViewApp* app); +void radio_tx_signal(ProtoViewApp* app, FuriHalSubGhzAsyncTxCallback data_feeder, void* ctx); +void protoview_rx_callback(bool level, uint32_t duration, void* context); + +/* signal.c */ +uint32_t duration_delta(uint32_t a, uint32_t b); +void reset_current_signal(ProtoViewApp* app); +void scan_for_signal(ProtoViewApp* app, RawSamplesBuffer* source, uint32_t min_duration); +bool bitmap_get(uint8_t* b, uint32_t blen, uint32_t bitpos); +void bitmap_set(uint8_t* b, uint32_t blen, uint32_t bitpos, bool val); +void bitmap_copy( + uint8_t* d, + uint32_t dlen, + uint32_t doff, + uint8_t* s, + uint32_t slen, + uint32_t soff, + uint32_t count); +void bitmap_set_pattern(uint8_t* b, uint32_t blen, uint32_t off, const char* pat); +void bitmap_reverse_bytes_bits(uint8_t* p, uint32_t len); +bool bitmap_match_bits(uint8_t* b, uint32_t blen, uint32_t bitpos, const char* bits); +uint32_t bitmap_seek_bits( + uint8_t* b, + uint32_t blen, + uint32_t startpos, + uint32_t maxbits, + const char* bits); +bool bitmap_match_bitmap( + uint8_t* b1, + uint32_t b1len, + uint32_t b1off, + uint8_t* b2, + uint32_t b2len, + uint32_t b2off, + uint32_t cmplen); +void bitmap_to_string(char* dst, uint8_t* b, uint32_t blen, uint32_t off, uint32_t len); +uint32_t convert_from_line_code( + uint8_t* buf, + uint64_t buflen, + uint8_t* bits, + uint32_t len, + uint32_t offset, + const char* zero_pattern, + const char* one_pattern); +uint32_t convert_from_diff_manchester( + uint8_t* buf, + uint64_t buflen, + uint8_t* bits, + uint32_t len, + uint32_t off, + bool previous); +void init_msg_info(ProtoViewMsgInfo* i, ProtoViewApp* app); +void free_msg_info(ProtoViewMsgInfo* i); + +/* signal_file.c */ +bool save_signal(ProtoViewApp* app, const char* filename); + +/* view_*.c */ +void render_view_raw_pulses(Canvas* const canvas, ProtoViewApp* app); +void process_input_raw_pulses(ProtoViewApp* app, InputEvent input); +void render_view_settings(Canvas* const canvas, ProtoViewApp* app); +void process_input_settings(ProtoViewApp* app, InputEvent input); +void render_view_info(Canvas* const canvas, ProtoViewApp* app); +void process_input_info(ProtoViewApp* app, InputEvent input); +void render_view_direct_sampling(Canvas* const canvas, ProtoViewApp* app); +void process_input_direct_sampling(ProtoViewApp* app, InputEvent input); +void render_view_build_message(Canvas* const canvas, ProtoViewApp* app); +void process_input_build_message(ProtoViewApp* app, InputEvent input); +void view_enter_build_message(ProtoViewApp* app); +void view_exit_build_message(ProtoViewApp* app); +void view_enter_direct_sampling(ProtoViewApp* app); +void view_exit_direct_sampling(ProtoViewApp* app); +void view_exit_settings(ProtoViewApp* app); +void view_exit_info(ProtoViewApp* app); +void adjust_raw_view_scale(ProtoViewApp* app, uint32_t short_pulse_dur); + +/* ui.c */ +int ui_get_current_subview(ProtoViewApp* app); +void ui_show_available_subviews(Canvas* canvas, ProtoViewApp* app, int last_subview); +bool ui_process_subview_updown(ProtoViewApp* app, InputEvent input, int last_subview); +void ui_show_keyboard( + ProtoViewApp* app, + char* buffer, + uint32_t buflen, + void (*done_callback)(void*)); +void ui_dismiss_keyboard(ProtoViewApp* app); +void ui_show_alert(ProtoViewApp* app, const char* text, uint32_t ttl); +void ui_dismiss_alert(ProtoViewApp* app); +void ui_draw_alert_if_needed(Canvas* canvas, ProtoViewApp* app); +void canvas_draw_str_with_border( + Canvas* canvas, + uint8_t x, + uint8_t y, + const char* str, + Color text_color, + Color border_color); + +/* fields.c */ +void fieldset_free(ProtoViewFieldSet* fs); +ProtoViewFieldSet* fieldset_new(void); +void fieldset_add_int(ProtoViewFieldSet* fs, const char* name, int64_t val, uint8_t bits); +void fieldset_add_uint(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits); +void fieldset_add_hex(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits); +void fieldset_add_bin(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits); +void fieldset_add_str(ProtoViewFieldSet* fs, const char* name, const char* s, size_t len); +void fieldset_add_bytes( + ProtoViewFieldSet* fs, + const char* name, + const uint8_t* bytes, + uint32_t count); +void fieldset_add_float( + ProtoViewFieldSet* fs, + const char* name, + float val, + uint32_t digits_after_dot); +const char* field_get_type_name(ProtoViewField* f); +int field_to_string(char* buf, size_t len, ProtoViewField* f); +bool field_set_from_string(ProtoViewField* f, char* buf, size_t len); +bool field_incr_value(ProtoViewField* f, int incr); +void fieldset_copy_matching_fields(ProtoViewFieldSet* dst, ProtoViewFieldSet* src); +void field_set_from_field(ProtoViewField* dst, ProtoViewField* src); + +/* crc.c */ +uint8_t crc8(const uint8_t* data, size_t len, uint8_t init, uint8_t poly); +uint8_t sum_bytes(const uint8_t* data, size_t len, uint8_t init); +uint8_t xor_bytes(const uint8_t* data, size_t len, uint8_t init); diff --git a/app_subghz.c b/app_subghz.c new file mode 100644 index 00000000000..204dcba0d89 --- /dev/null +++ b/app_subghz.c @@ -0,0 +1,206 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" +#include "custom_presets.h" + +#include +#include +#include +#include + +void raw_sampling_timer_start(ProtoViewApp* app); +void raw_sampling_timer_stop(ProtoViewApp* app); + +ProtoViewModulation ProtoViewModulations[] = { + {"OOK 650Khz", "FuriHalSubGhzPresetOok650Async", FuriHalSubGhzPresetOok650Async, NULL, 30}, + {"OOK 270Khz", "FuriHalSubGhzPresetOok270Async", FuriHalSubGhzPresetOok270Async, NULL, 30}, + {"2FSK 2.38Khz", + "FuriHalSubGhzPreset2FSKDev238Async", + FuriHalSubGhzPreset2FSKDev238Async, + NULL, + 30}, + {"2FSK 47.6Khz", + "FuriHalSubGhzPreset2FSKDev476Async", + FuriHalSubGhzPreset2FSKDev476Async, + NULL, + 30}, + {"TPMS 1 (FSK)", NULL, 0, (uint8_t*)protoview_subghz_tpms1_fsk_async_regs, 30}, + {"TPMS 2 (OOK)", NULL, 0, (uint8_t*)protoview_subghz_tpms2_ook_async_regs, 30}, + {"TPMS 3 (GFSK)", NULL, 0, (uint8_t*)protoview_subghz_tpms3_gfsk_async_regs, 30}, + {"OOK 40kBaud", NULL, 0, (uint8_t*)protoview_subghz_40k_ook_async_regs, 15}, + {"FSK 40kBaud", NULL, 0, (uint8_t*)protoview_subghz_40k_fsk_async_regs, 15}, + {NULL, NULL, 0, NULL, 0} /* End of list sentinel. */ +}; + +/* Called after the application initialization in order to setup the + * subghz system and put it into idle state. */ +void radio_begin(ProtoViewApp* app) { + furi_assert(app); + subghz_devices_reset(app->radio_device); + subghz_devices_idle(app->radio_device); + + /* The CC1101 preset can be either one of the standard presets, if + * the modulation "custom" field is NULL, or a custom preset we + * defined in custom_presets.h. */ + if(ProtoViewModulations[app->modulation].custom == NULL) { + subghz_devices_load_preset( + app->radio_device, ProtoViewModulations[app->modulation].preset, NULL); + } else { + subghz_devices_load_preset( + app->radio_device, + FuriHalSubGhzPresetCustom, + ProtoViewModulations[app->modulation].custom); + } + furi_hal_gpio_init( + subghz_devices_get_data_gpio(app->radio_device), GpioModeInput, GpioPullNo, GpioSpeedLow); + app->txrx->txrx_state = TxRxStateIDLE; +} + +/* ================================= Reception ============================== */ + +/* We avoid the subghz provided abstractions and put the data in our + * simple abstraction: the RawSamples circular buffer. */ +void protoview_rx_callback(bool level, uint32_t duration, void* context) { + UNUSED(context); + /* Add data to the circular buffer. */ + raw_samples_add(RawSamples, level, duration); + // FURI_LOG_E(TAG, "FEED: %d %d", (int)level, (int)duration); + return; +} + +/* Setup the CC1101 to start receiving using a background worker. */ +uint32_t radio_rx(ProtoViewApp* app) { + furi_assert(app); + + if(!subghz_devices_is_frequency_valid(app->radio_device, app->frequency)) { + furi_crash(TAG " Incorrect RX frequency."); + } + + if(app->txrx->txrx_state == TxRxStateRx) return app->frequency; + + subghz_devices_idle(app->radio_device); /* Put it into idle state in case it is sleeping. */ + uint32_t value = subghz_devices_set_frequency(app->radio_device, app->frequency); + FURI_LOG_E(TAG, "Switched to frequency: %lu", value); + + subghz_devices_flush_rx(app->radio_device); + subghz_devices_set_rx(app->radio_device); + + if(!app->txrx->debug_timer_sampling) { + subghz_devices_start_async_rx(app->radio_device, protoview_rx_callback, NULL); + } else { + furi_hal_gpio_init( + subghz_devices_get_data_gpio(app->radio_device), + GpioModeInput, + GpioPullNo, + GpioSpeedLow); + raw_sampling_worker_start(app); + } + app->txrx->txrx_state = TxRxStateRx; + return value; +} + +/* Stop receiving (if active) and put the radio on idle state. */ +void radio_rx_end(ProtoViewApp* app) { + furi_assert(app); + + if(app->txrx->txrx_state == TxRxStateRx) { + if(!app->txrx->debug_timer_sampling) { + subghz_devices_stop_async_rx(app->radio_device); + } else { + raw_sampling_worker_stop(app); + } + } + subghz_devices_idle(app->radio_device); + app->txrx->txrx_state = TxRxStateIDLE; +} + +/* Put radio on sleep. */ +void radio_sleep(ProtoViewApp* app) { + furi_assert(app); + if(app->txrx->txrx_state == TxRxStateRx) { + /* Stop the asynchronous receiving system before putting the + * chip into sleep. */ + radio_rx_end(app); + } + subghz_devices_sleep(app->radio_device); + app->txrx->txrx_state = TxRxStateSleep; +} + +/* =============================== Transmission ============================= */ + +/* This function suspends the current RX state, switches to TX mode, + * transmits the signal provided by the callback data_feeder, and later + * restores the RX state if there was one. */ +void radio_tx_signal(ProtoViewApp* app, FuriHalSubGhzAsyncTxCallback data_feeder, void* ctx) { + TxRxState oldstate = app->txrx->txrx_state; + + if(oldstate == TxRxStateRx) radio_rx_end(app); + radio_begin(app); + + subghz_devices_idle(app->radio_device); + uint32_t value = subghz_devices_set_frequency(app->radio_device, app->frequency); + FURI_LOG_E(TAG, "Switched to frequency: %lu", value); + + subghz_devices_start_async_tx(app->radio_device, data_feeder, ctx); + while(!subghz_devices_is_async_complete_tx(app->radio_device)) furi_delay_ms(10); + subghz_devices_stop_async_tx(app->radio_device); + subghz_devices_idle(app->radio_device); + + radio_begin(app); + if(oldstate == TxRxStateRx) radio_rx(app); +} + +/* ============================= Raw sampling mode ============================= + * This is a special mode that uses a high frequency timer to sample the + * CC1101 pin directly. It's useful for debugging purposes when we want + * to get the raw data from the chip and completely bypass the subghz + * Flipper system. + * ===========================================================================*/ + +void protoview_timer_isr(void* ctx) { + ProtoViewApp* app = ctx; + + bool level = furi_hal_gpio_read(subghz_devices_get_data_gpio(app->radio_device)); + if(app->txrx->last_g0_value != level) { + uint32_t now = DWT->CYCCNT; + uint32_t dur = now - app->txrx->last_g0_change_time; + dur /= furi_hal_cortex_instructions_per_microsecond(); + if(dur > 15000) dur = 15000; + raw_samples_add(RawSamples, app->txrx->last_g0_value, dur); + app->txrx->last_g0_value = level; + app->txrx->last_g0_change_time = now; + } + LL_TIM_ClearFlag_UPDATE(TIM2); +} + +void raw_sampling_worker_start(ProtoViewApp* app) { + UNUSED(app); + + furi_hal_bus_enable(FuriHalBusTIM2); + + LL_TIM_InitTypeDef tim_init = { + .Prescaler = 63, /* CPU frequency is ~64Mhz. */ + .CounterMode = LL_TIM_COUNTERMODE_UP, + .Autoreload = 5, /* Sample every 5 us */ + }; + + LL_TIM_Init(TIM2, &tim_init); + LL_TIM_SetClockSource(TIM2, LL_TIM_CLOCKSOURCE_INTERNAL); + LL_TIM_DisableCounter(TIM2); + LL_TIM_SetCounter(TIM2, 0); + furi_hal_interrupt_set_isr(FuriHalInterruptIdTIM2, protoview_timer_isr, app); + LL_TIM_EnableIT_UPDATE(TIM2); + LL_TIM_EnableCounter(TIM2); + FURI_LOG_E(TAG, "Timer enabled"); +} + +void raw_sampling_worker_stop(ProtoViewApp* app) { + UNUSED(app); + FURI_CRITICAL_ENTER(); + LL_TIM_DisableCounter(TIM2); + LL_TIM_DisableIT_UPDATE(TIM2); + furi_hal_interrupt_set_isr(FuriHalInterruptIdTIM2, NULL, NULL); + furi_hal_bus_disable(FuriHalBusTIM2); + FURI_CRITICAL_EXIT(); +} diff --git a/appicon.png b/appicon.png new file mode 100644 index 00000000000..fa712251554 Binary files /dev/null and b/appicon.png differ diff --git a/application.fam b/application.fam new file mode 100644 index 00000000000..942552daad2 --- /dev/null +++ b/application.fam @@ -0,0 +1,14 @@ +App( + appid="protoview", + name="ProtoView", + apptype=FlipperAppType.EXTERNAL, + entry_point="protoview_app_entry", + requires=["gui"], + stack_size=8*1024, + order=50, + fap_icon="appicon.png", + fap_category="Sub-GHz", + fap_author="@antirez & (fixes by @xMasterX)", + fap_version="1.0", + fap_description="Digital signal detection, visualization, editing and reply tool", +) diff --git a/crc.c b/crc.c new file mode 100644 index 00000000000..e99786952ed --- /dev/null +++ b/crc.c @@ -0,0 +1,36 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include +#include + +/* CRC8 with the specified initialization value 'init' and + * polynomial 'poly'. */ +uint8_t crc8(const uint8_t* data, size_t len, uint8_t init, uint8_t poly) { + uint8_t crc = init; + size_t i, j; + for(i = 0; i < len; i++) { + crc ^= data[i]; + for(j = 0; j < 8; j++) { + if((crc & 0x80) != 0) + crc = (uint8_t)((crc << 1) ^ poly); + else + crc <<= 1; + } + } + return crc; +} + +/* Sum all the specified bytes modulo 256. + * Initialize the sum with 'init' (usually 0). */ +uint8_t sum_bytes(const uint8_t* data, size_t len, uint8_t init) { + for(size_t i = 0; i < len; i++) init += data[i]; + return init; +} + +/* Perform the bitwise xor of all the specified bytes. + * Initialize xor value with 'init' (usually 0). */ +uint8_t xor_bytes(const uint8_t* data, size_t len, uint8_t init) { + for(size_t i = 0; i < len; i++) init ^= data[i]; + return init; +} diff --git a/custom_presets.h b/custom_presets.h new file mode 100644 index 00000000000..aa7ac23ad32 --- /dev/null +++ b/custom_presets.h @@ -0,0 +1,317 @@ +#include +/* ========================== DATA RATE SETTINGS =============================== + * + * This is how to configure registers MDMCFG3 and MDMCFG4. + * + * MDMCFG3 is the data rate mantissa, the exponent is in MDMCFG4, + * last 4 bits of the register. + * + * The rate (assuming 26Mhz crystal) is calculated as follows: + * + * ((256+MDMCFG3)*(2^MDMCFG4:0..3bits)) / 2^28 * 26000000. + * + * For instance for the default values of MDMCFG3[0..3] (34) and MDMCFG4 (12): + * + * ((256+34)*(2^12))/(2^28)*26000000 = 115051.2688000000, that is 115KBaud + * + * ============================ BANDWIDTH FILTER =============================== + * + * Bandwidth filter setting: + * + * BW filter as just 16 possibilities depending on how the first nibble + * (first 4 bits) of the MDMCFG4 bits are set. Instead of providing the + * formula, it is simpler to show all the values of the nibble and the + * corresponding bandwidth filter. + * + * 0 812khz + * 1 650khz + * 2 541khz + * 3 464khz + * 4 406khz + * 5 325khz + * 6 270khz + * 7 232khz + * 8 203khz + * 9 162khz + * a 135khz + * b 116khz + * c 102khz + * d 82 khz + * e 68 khz + * f 58 khz + * + * ============================== FSK DEVIATION ================================ + * + * FSK deviation is controlled by the DEVIATION register. In Ruby: + * + * dev = (26000000.0/2**17)*(8+(deviation&7))*(2**(deviation>>4&7)) + * + * deviation&7 (last three bits) is the deviation mantissa, while + * deviation>>4&7 (bits 6,5,4) are the exponent. + * + * Deviations values according to certain configuration of DEVIATION: + * + * 0x04 -> 2.380371 kHz + * 0x24 -> 9.521484 kHz + * 0x34 -> 19.042969 Khz + * 0x40 -> 25.390625 Khz + * 0x43 -> 34.912109 Khz + * 0x45 -> 41.259765 Khz + * 0x47 -> 47.607422 kHz + */ + +/* 20 KBaud, 2FSK, 28.56 kHz deviation, 325 Khz bandwidth filter. */ +static uint8_t protoview_subghz_tpms1_fsk_async_regs[][2] = { + /* GPIO GD0 */ + {CC1101_IOCFG0, 0x0D}, // GD0 as async serial data output/input + + /* Frequency Synthesizer Control */ + {CC1101_FSCTRL1, 0x06}, // IF = (26*10^6) / (2^10) * 0x06 = 152343.75Hz + + /* Packet engine */ + {CC1101_PKTCTRL0, 0x32}, // Async, continious, no whitening + {CC1101_PKTCTRL1, 0x04}, + + // // Modem Configuration + {CC1101_MDMCFG0, 0x00}, + {CC1101_MDMCFG1, 0x02}, + {CC1101_MDMCFG2, + 0x04}, // Format 2-FSK/FM, No preamble/sync, Disable (current optimized). Other code reading TPMS uses GFSK, but should be the same when in RX mode. + {CC1101_MDMCFG3, 0x93}, // Data rate is 20kBaud + {CC1101_MDMCFG4, 0x59}, // Rx bandwidth filter is 325 kHz + {CC1101_DEVIATN, 0x41}, // Deviation 28.56 kHz + + /* Main Radio Control State Machine */ + {CC1101_MCSM0, 0x18}, // Autocalibrate on idle-to-rx/tx, PO_TIMEOUT is 64 cycles(149-155us) + + /* Frequency Offset Compensation Configuration */ + {CC1101_FOCCFG, + 0x16}, // no frequency offset compensation, POST_K same as PRE_K, PRE_K is 4K, GATE is off + + /* Automatic Gain Control */ + {CC1101_AGCCTRL0, + 0x91}, //10 - Medium hysteresis, medium asymmetric dead zone, medium gain ; 01 - 16 samples agc; 00 - Normal AGC, 01 - 8dB boundary + {CC1101_AGCCTRL1, + 0x00}, // 0; 0 - LNA 2 gain is decreased to minimum before decreasing LNA gain; 00 - Relative carrier sense threshold disabled; 0000 - RSSI to MAIN_TARGET + {CC1101_AGCCTRL2, 0x07}, // 00 - DVGA all; 000 - MAX LNA+LNA2; 111 - MAIN_TARGET 42 dB + + /* Wake on radio and timeouts control */ + {CC1101_WORCTRL, 0xFB}, // WOR_RES is 2^15 periods (0.91 - 0.94 s) 16.5 - 17.2 hours + + /* Frontend configuration */ + {CC1101_FREND0, 0x10}, // Adjusts current TX LO buffer + {CC1101_FREND1, 0x56}, + + /* End */ + {0, 0}, + + /* CC1101 2FSK PATABLE. */ + {0xC0, 0}, + {0, 0}, + {0, 0}, + {0, 0}}; + +/* This is like the default Flipper OOK 640Khz bandwidth preset, but + * the bandwidth is changed to 10kBaud to accomodate TPMS frequency. */ +static const uint8_t protoview_subghz_tpms2_ook_async_regs[][2] = { + /* GPIO GD0 */ + {CC1101_IOCFG0, 0x0D}, // GD0 as async serial data output/input + + /* FIFO and internals */ + {CC1101_FIFOTHR, 0x07}, // The only important bit is ADC_RETENTION + + /* Packet engine */ + {CC1101_PKTCTRL0, 0x32}, // Async, continious, no whitening + + /* Frequency Synthesizer Control */ + {CC1101_FSCTRL1, 0x06}, // IF = (26*10^6) / (2^10) * 0x06 = 152343.75Hz + + // Modem Configuration + {CC1101_MDMCFG0, 0x00}, // Channel spacing is 25kHz + {CC1101_MDMCFG1, 0x00}, // Channel spacing is 25kHz + {CC1101_MDMCFG2, 0x30}, // Format ASK/OOK, No preamble/sync + {CC1101_MDMCFG3, 0x93}, // Data rate is 10kBaud + {CC1101_MDMCFG4, 0x18}, // Rx BW filter is 650.000kHz + + /* Main Radio Control State Machine */ + {CC1101_MCSM0, 0x18}, // Autocalibrate on idle-to-rx/tx, PO_TIMEOUT is 64 cycles(149-155us) + + /* Frequency Offset Compensation Configuration */ + {CC1101_FOCCFG, + 0x18}, // no frequency offset compensation, POST_K same as PRE_K, PRE_K is 4K, GATE is off + + /* Automatic Gain Control */ + {CC1101_AGCCTRL0, + 0x91}, // 10 - Medium hysteresis, medium asymmetric dead zone, medium gain ; 01 - 16 samples agc; 00 - Normal AGC, 01 - 8dB boundary + {CC1101_AGCCTRL1, + 0x0}, // 0; 0 - LNA 2 gain is decreased to minimum before decreasing LNA gain; 00 - Relative carrier sense threshold disabled; 0000 - RSSI to MAIN_TARGET + {CC1101_AGCCTRL2, 0x07}, // 00 - DVGA all; 000 - MAX LNA+LNA2; 111 - MAIN_TARGET 42 dB + + /* Wake on radio and timeouts control */ + {CC1101_WORCTRL, 0xFB}, // WOR_RES is 2^15 periods (0.91 - 0.94 s) 16.5 - 17.2 hours + + /* Frontend configuration */ + {CC1101_FREND0, 0x11}, // Adjusts current TX LO buffer + high is PATABLE[1] + {CC1101_FREND1, 0xB6}, // + + /* End */ + {0, 0}, + + /* CC1101 OOK PATABLE. */ + {0, 0xC0}, + {0, 0}, + {0, 0}, + {0, 0}}; + +/* GFSK 19k dev, 325 Khz filter, 20kBaud. Different AGI settings. + * Works well with Toyota. */ +static uint8_t protoview_subghz_tpms3_gfsk_async_regs[][2] = { + /* GPIO GD0 */ + {CC1101_IOCFG0, 0x0D}, // GD0 as async serial data output/input + + /* Frequency Synthesizer Control */ + {CC1101_FSCTRL1, 0x06}, // IF = (26*10^6) / (2^10) * 0x06 = 152343.75Hz + + /* Packet engine */ + {CC1101_PKTCTRL0, 0x32}, // Async, continious, no whitening + {CC1101_PKTCTRL1, 0x04}, + + // // Modem Configuration + {CC1101_MDMCFG0, 0x00}, + {CC1101_MDMCFG1, 0x02}, // 2 is the channel spacing exponet: not used + {CC1101_MDMCFG2, 0x10}, // GFSK without any other check + {CC1101_MDMCFG3, 0x93}, // Data rate is 20kBaud + {CC1101_MDMCFG4, 0x59}, // Rx bandwidth filter is 325 kHz + {CC1101_DEVIATN, 0x34}, // Deviation 19.04 Khz. + + /* Main Radio Control State Machine */ + {CC1101_MCSM0, 0x18}, // Autocalibrate on idle-to-rx/tx, PO_TIMEOUT is 64 cycles(149-155us) + + /* Frequency Offset Compensation Configuration */ + {CC1101_FOCCFG, + 0x16}, // no frequency offset compensation, POST_K same as PRE_K, PRE_K is 4K, GATE is off + + /* Automatic Gain Control */ + {CC1101_AGCCTRL0, 0x80}, + {CC1101_AGCCTRL1, 0x58}, + {CC1101_AGCCTRL2, 0x87}, + + /* Wake on radio and timeouts control */ + {CC1101_WORCTRL, 0xFB}, // WOR_RES is 2^15 periods (0.91 - 0.94 s) 16.5 - 17.2 hours + + /* Frontend configuration */ + {CC1101_FREND0, 0x10}, // Adjusts current TX LO buffer + {CC1101_FREND1, 0x56}, + + /* End */ + {0, 0}, + + /* CC1101 2FSK PATABLE. */ + {0xC0, 0}, + {0, 0}, + {0, 0}, + {0, 0}}; + +/* 40 KBaud, 2FSK, 28 kHz deviation, 270 Khz bandwidth filter. */ +static uint8_t protoview_subghz_40k_fsk_async_regs[][2] = { + /* GPIO GD0 */ + {CC1101_IOCFG0, 0x0D}, // GD0 as async serial data output/input + + /* Frequency Synthesizer Control */ + {CC1101_FSCTRL1, 0x06}, // IF = (26*10^6) / (2^10) * 0x06 = 152343.75Hz + + /* Packet engine */ + {CC1101_PKTCTRL0, 0x32}, // Async, continious, no whitening + {CC1101_PKTCTRL1, 0x04}, + + // // Modem Configuration + {CC1101_MDMCFG0, 0x00}, + {CC1101_MDMCFG1, 0x02}, + {CC1101_MDMCFG2, + 0x04}, // Format 2-FSK/FM, No preamble/sync, Disable (current optimized). Other code reading TPMS uses GFSK, but should be the same when in RX mode. + {CC1101_MDMCFG3, 0x93}, // Data rate is 40kBaud + {CC1101_MDMCFG4, 0x6A}, // 6 = BW filter 270kHz, A = Data rate exp + {CC1101_DEVIATN, 0x41}, // Deviation 28kHz + + /* Main Radio Control State Machine */ + {CC1101_MCSM0, 0x18}, // Autocalibrate on idle-to-rx/tx, PO_TIMEOUT is 64 cycles(149-155us) + + /* Frequency Offset Compensation Configuration */ + {CC1101_FOCCFG, + 0x16}, // no frequency offset compensation, POST_K same as PRE_K, PRE_K is 4K, GATE is off + + /* Automatic Gain Control */ + {CC1101_AGCCTRL0, + 0x91}, //10 - Medium hysteresis, medium asymmetric dead zone, medium gain ; 01 - 16 samples agc; 00 - Normal AGC, 01 - 8dB boundary + {CC1101_AGCCTRL1, + 0x00}, // 0; 0 - LNA 2 gain is decreased to minimum before decreasing LNA gain; 00 - Relative carrier sense threshold disabled; 0000 - RSSI to MAIN_TARGET + {CC1101_AGCCTRL2, 0x07}, // 00 - DVGA all; 000 - MAX LNA+LNA2; 111 - MAIN_TARGET 42 dB + + /* Wake on radio and timeouts control */ + {CC1101_WORCTRL, 0xFB}, // WOR_RES is 2^15 periods (0.91 - 0.94 s) 16.5 - 17.2 hours + + /* Frontend configuration */ + {CC1101_FREND0, 0x10}, // Adjusts current TX LO buffer + {CC1101_FREND1, 0x56}, + + /* End */ + {0, 0}, + + /* CC1101 2FSK PATABLE. */ + {0xC0, 0}, + {0, 0}, + {0, 0}, + {0, 0}}; + +/* This is like the default Flipper OOK 640Khz bandwidth preset, but + * the bandwidth is changed to 40kBaud, in order to receive signals + * with a pulse width ~25us/30us. */ +static const uint8_t protoview_subghz_40k_ook_async_regs[][2] = { + /* GPIO GD0 */ + {CC1101_IOCFG0, 0x0D}, // GD0 as async serial data output/input + + /* FIFO and internals */ + {CC1101_FIFOTHR, 0x07}, // The only important bit is ADC_RETENTION + + /* Packet engine */ + {CC1101_PKTCTRL0, 0x32}, // Async, continious, no whitening + + /* Frequency Synthesizer Control */ + {CC1101_FSCTRL1, 0x06}, // IF = (26*10^6) / (2^10) * 0x06 = 152343.75Hz + + // Modem Configuration + {CC1101_MDMCFG0, 0x00}, // Channel spacing is 25kHz + {CC1101_MDMCFG1, 0x00}, // Channel spacing is 25kHz + {CC1101_MDMCFG2, 0x30}, // Format ASK/OOK, No preamble/sync + {CC1101_MDMCFG3, 0x93}, // Data rate is 40kBaud + {CC1101_MDMCFG4, 0x1A}, // Rx BW filter is 650.000kHz + + /* Main Radio Control State Machine */ + {CC1101_MCSM0, 0x18}, // Autocalibrate on idle-to-rx/tx, PO_TIMEOUT is 64 cycles(149-155us) + + /* Frequency Offset Compensation Configuration */ + {CC1101_FOCCFG, + 0x18}, // no frequency offset compensation, POST_K same as PRE_K, PRE_K is 4K, GATE is off + + /* Automatic Gain Control */ + {CC1101_AGCCTRL0, + 0x91}, // 10 - Medium hysteresis, medium asymmetric dead zone, medium gain ; 01 - 16 samples agc; 00 - Normal AGC, 01 - 8dB boundary + {CC1101_AGCCTRL1, + 0x0}, // 0; 0 - LNA 2 gain is decreased to minimum before decreasing LNA gain; 00 - Relative carrier sense threshold disabled; 0000 - RSSI to MAIN_TARGET + {CC1101_AGCCTRL2, 0x07}, // 00 - DVGA all; 000 - MAX LNA+LNA2; 111 - MAIN_TARGET 42 dB + + /* Wake on radio and timeouts control */ + {CC1101_WORCTRL, 0xFB}, // WOR_RES is 2^15 periods (0.91 - 0.94 s) 16.5 - 17.2 hours + + /* Frontend configuration */ + {CC1101_FREND0, 0x11}, // Adjusts current TX LO buffer + high is PATABLE[1] + {CC1101_FREND1, 0xB6}, // + + /* End */ + {0, 0}, + + /* CC1101 OOK PATABLE. */ + {0, 0xC0}, + {0, 0}, + {0, 0}, + {0, 0}}; diff --git a/fields.c b/fields.c new file mode 100644 index 00000000000..18dee65024e --- /dev/null +++ b/fields.c @@ -0,0 +1,369 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Protocol fields implementation. */ + +#include "app.h" + +/* Create a new field of the specified type. Without populating its + * type-specific value. */ +static ProtoViewField* field_new(ProtoViewFieldType type, const char* name) { + ProtoViewField* f = malloc(sizeof(*f)); + f->type = type; + f->name = strdup(name); + return f; +} + +/* Free only the auxiliary data of a field, used to represent the + * current type. Name and type are not touched. */ +static void field_free_aux_data(ProtoViewField* f) { + switch(f->type) { + case FieldTypeStr: + free(f->str); + break; + case FieldTypeBytes: + free(f->bytes); + break; + default: + break; // Nothing to free for other types. + } +} + +/* Free a field an associated data. */ +static void field_free(ProtoViewField* f) { + field_free_aux_data(f); + free(f->name); + free(f); +} + +/* Return the type of the field as string. */ +const char* field_get_type_name(ProtoViewField* f) { + switch(f->type) { + case FieldTypeStr: + return "str"; + case FieldTypeSignedInt: + return "int"; + case FieldTypeUnsignedInt: + return "uint"; + case FieldTypeBinary: + return "bin"; + case FieldTypeHex: + return "hex"; + case FieldTypeBytes: + return "bytes"; + case FieldTypeFloat: + return "float"; + } + return "unknown"; +} + +/* Set a string representation of the specified field in buf. */ +int field_to_string(char* buf, size_t len, ProtoViewField* f) { + switch(f->type) { + case FieldTypeStr: + return snprintf(buf, len, "%s", f->str); + case FieldTypeSignedInt: + return snprintf(buf, len, "%lld", (long long)f->value); + case FieldTypeUnsignedInt: + return snprintf(buf, len, "%llu", (unsigned long long)f->uvalue); + case FieldTypeBinary: { + uint64_t test_bit = (1 << (f->len - 1)); + uint64_t idx = 0; + while(idx < len - 1 && test_bit) { + buf[idx++] = (f->uvalue & test_bit) ? '1' : '0'; + test_bit >>= 1; + } + buf[idx] = 0; + return idx; + } + case FieldTypeHex: + return snprintf(buf, len, "%*llX", (int)(f->len + 7) / 8, f->uvalue); + case FieldTypeFloat: + return snprintf(buf, len, "%.*f", (int)f->len, (double)f->fvalue); + case FieldTypeBytes: { + uint64_t idx = 0; + while(idx < len - 1 && idx < f->len) { + const char* charset = "0123456789ABCDEF"; + uint32_t nibble = idx & 1 ? (f->bytes[idx / 2] & 0xf) : (f->bytes[idx / 2] >> 4); + buf[idx++] = charset[nibble]; + } + buf[idx] = 0; + return idx; + } + } + return 0; +} + +/* Set the field value from its string representation in 'buf'. + * The field type must already be set and the field should be valid. + * The string represenation 'buf' must be null termianted. Note that + * even when representing binary values containing zero, this values + * are taken as representations, so that would be the string "00" as + * the Bytes type representation. + * + * The function returns true if the filed was successfully set to the + * new value, otherwise if the specified value is invalid for the + * field type, false is returned. */ +bool field_set_from_string(ProtoViewField* f, char* buf, size_t len) { + // Initialize values to zero since the Flipper sscanf() implementation + // is fuzzy... may populate only part of the value. + long long val = 0; + unsigned long long uval = 0; + float fval = 0; + + switch(f->type) { + case FieldTypeStr: + free(f->str); + f->len = len; + f->str = malloc(len + 1); + memcpy(f->str, buf, len + 1); + break; + case FieldTypeSignedInt: + if(!sscanf(buf, "%lld", &val)) return false; + f->value = val; + break; + case FieldTypeUnsignedInt: + if(!sscanf(buf, "%llu", &uval)) return false; + f->uvalue = uval; + break; + case FieldTypeBinary: { + uint64_t bit_to_set = (1 << (len - 1)); + uint64_t idx = 0; + uval = 0; + while(buf[idx]) { + if(buf[idx] == '1') + uval |= bit_to_set; + else if(buf[idx] != '0') + return false; + bit_to_set >>= 1; + idx++; + } + f->uvalue = uval; + } break; + case FieldTypeHex: + if(!sscanf(buf, "%llx", &uval) && !sscanf(buf, "%llX", &uval)) return false; + f->uvalue = uval; + break; + case FieldTypeFloat: + if(!sscanf(buf, "%f", &fval)) return false; + f->fvalue = fval; + break; + case FieldTypeBytes: { + if(len > f->len) return false; + uint64_t idx = 0; + while(buf[idx]) { + uint8_t nibble = 0; + char c = toupper(buf[idx]); + if(c >= '0' && c <= '9') + nibble = c - '0'; + else if(c >= 'A' && c <= 'F') + nibble = 10 + (c - 'A'); + else + return false; + + if(idx & 1) { + f->bytes[idx / 2] = (f->bytes[idx / 2] & 0xF0) | nibble; + } else { + f->bytes[idx / 2] = (f->bytes[idx / 2] & 0x0F) | (nibble << 4); + } + idx++; + } + buf[idx] = 0; + } break; + } + return true; +} + +/* Set the 'dst' field to contain a copy of the value of the 'src' + * field. The field name is not modified. */ +void field_set_from_field(ProtoViewField* dst, ProtoViewField* src) { + field_free_aux_data(dst); + dst->type = src->type; + dst->len = src->len; + switch(src->type) { + case FieldTypeStr: + dst->str = strdup(src->str); + break; + case FieldTypeBytes: + dst->bytes = malloc(src->len); + memcpy(dst->bytes, src->bytes, dst->len); + break; + case FieldTypeSignedInt: + dst->value = src->value; + break; + case FieldTypeUnsignedInt: + case FieldTypeBinary: + case FieldTypeHex: + dst->uvalue = src->uvalue; + break; + case FieldTypeFloat: + dst->fvalue = src->fvalue; + break; + } +} + +/* Increment the specified field value of 'incr'. If the field type + * does not support increments false is returned, otherwise the + * action is performed. */ +bool field_incr_value(ProtoViewField* f, int incr) { + switch(f->type) { + case FieldTypeStr: + return false; + case FieldTypeSignedInt: { + /* Wrap around depending on the number of bits (f->len) + * the integer was declared to have. */ + int64_t max = (1ULL << (f->len - 1)) - 1; + int64_t min = -max - 1; + int64_t v = (int64_t)f->value + incr; + if(v > max) v = min + (v - max - 1); + if(v < min) v = max + (v - min + 1); + f->value = v; + break; + } + case FieldTypeBinary: + case FieldTypeHex: + case FieldTypeUnsignedInt: { + /* Wrap around like for the unsigned case, but here + * is simpler. */ + uint64_t max = (1ULL << f->len) - 1; // Broken for 64 bits. + uint64_t uv = (uint64_t)f->value + incr; + if(uv > max) uv = uv & max; + f->uvalue = uv; + break; + } + case FieldTypeFloat: + f->fvalue += incr; + break; + case FieldTypeBytes: { + // For bytes we only support single unit increments. + if(incr != -1 && incr != 1) return false; + for(int j = f->len - 1; j >= 0; j--) { + uint8_t nibble = (j & 1) ? (f->bytes[j / 2] & 0x0F) : ((f->bytes[j / 2] & 0xF0) >> 4); + + nibble += incr; + nibble &= 0x0F; + + f->bytes[j / 2] = (j & 1) ? ((f->bytes[j / 2] & 0xF0) | nibble) : + ((f->bytes[j / 2] & 0x0F) | (nibble << 4)); + + /* Propagate the operation on overflow of this nibble. */ + if((incr == 1 && nibble == 0) || (incr == -1 && nibble == 0xf)) { + continue; + } + break; // Otherwise stop the loop here. + } + break; + } + } + return true; +} + +/* Free a field set and its contained fields. */ +void fieldset_free(ProtoViewFieldSet* fs) { + for(uint32_t j = 0; j < fs->numfields; j++) field_free(fs->fields[j]); + free(fs->fields); + free(fs); +} + +/* Allocate and init an empty field set. */ +ProtoViewFieldSet* fieldset_new(void) { + ProtoViewFieldSet* fs = malloc(sizeof(*fs)); + fs->numfields = 0; + fs->fields = NULL; + return fs; +} + +/* Append an already allocated field at the end of the specified field set. */ +static void fieldset_add_field(ProtoViewFieldSet* fs, ProtoViewField* field) { + fs->numfields++; + fs->fields = realloc(fs->fields, sizeof(ProtoViewField*) * fs->numfields); + fs->fields[fs->numfields - 1] = field; +} + +/* Allocate and append an integer field. */ +void fieldset_add_int(ProtoViewFieldSet* fs, const char* name, int64_t val, uint8_t bits) { + ProtoViewField* f = field_new(FieldTypeSignedInt, name); + f->value = val; + f->len = bits; + fieldset_add_field(fs, f); +} + +/* Allocate and append an unsigned field. */ +void fieldset_add_uint(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits) { + ProtoViewField* f = field_new(FieldTypeUnsignedInt, name); + f->uvalue = uval; + f->len = bits; + fieldset_add_field(fs, f); +} + +/* Allocate and append a hex field. This is an unsigned number but + * with an hex representation. */ +void fieldset_add_hex(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits) { + ProtoViewField* f = field_new(FieldTypeHex, name); + f->uvalue = uval; + f->len = bits; + fieldset_add_field(fs, f); +} + +/* Allocate and append a bin field. This is an unsigned number but + * with a binary representation. */ +void fieldset_add_bin(ProtoViewFieldSet* fs, const char* name, uint64_t uval, uint8_t bits) { + ProtoViewField* f = field_new(FieldTypeBinary, name); + f->uvalue = uval; + f->len = bits; + fieldset_add_field(fs, f); +} + +/* Allocate and append a string field. The string 's' does not need to point + * to a null terminated string, but must have at least 'len' valid bytes + * starting from the pointer. The field object will be correctly null + * terminated. */ +void fieldset_add_str(ProtoViewFieldSet* fs, const char* name, const char* s, size_t len) { + ProtoViewField* f = field_new(FieldTypeStr, name); + f->len = len; + f->str = malloc(len + 1); + memcpy(f->str, s, len); + f->str[len] = 0; + fieldset_add_field(fs, f); +} + +/* Allocate and append a bytes field. Note that 'count' is specified in + * nibbles (bytes*2). */ +void fieldset_add_bytes( + ProtoViewFieldSet* fs, + const char* name, + const uint8_t* bytes, + uint32_t count_nibbles) { + uint32_t numbytes = (count_nibbles + count_nibbles % 2) / 2; + ProtoViewField* f = field_new(FieldTypeBytes, name); + f->bytes = malloc(numbytes); + memcpy(f->bytes, bytes, numbytes); + f->len = count_nibbles; + fieldset_add_field(fs, f); +} + +/* Allocate and append a float field. */ +void fieldset_add_float( + ProtoViewFieldSet* fs, + const char* name, + float val, + uint32_t digits_after_dot) { + ProtoViewField* f = field_new(FieldTypeFloat, name); + f->fvalue = val; + f->len = digits_after_dot; + fieldset_add_field(fs, f); +} + +/* For each field of the destination filedset 'dst', look for a matching + * field name/type in the source fieldset 'src', and if one is found copy + * its value into the 'dst' field. */ +void fieldset_copy_matching_fields(ProtoViewFieldSet* dst, ProtoViewFieldSet* src) { + for(uint32_t j = 0; j < dst->numfields; j++) { + for(uint32_t i = 0; i < src->numfields; i++) { + if(dst->fields[j]->type == src->fields[i]->type && + !strcmp(dst->fields[j]->name, src->fields[i]->name)) { + field_set_from_field(dst->fields[j], src->fields[i]); + } + } + } +} diff --git a/helpers/radio_device_loader.c b/helpers/radio_device_loader.c new file mode 100644 index 00000000000..d2cffde5830 --- /dev/null +++ b/helpers/radio_device_loader.c @@ -0,0 +1,64 @@ +#include "radio_device_loader.h" + +#include +#include + +static void radio_device_loader_power_on() { + uint8_t attempts = 0; + while(!furi_hal_power_is_otg_enabled() && attempts++ < 5) { + furi_hal_power_enable_otg(); + //CC1101 power-up time + furi_delay_ms(10); + } +} + +static void radio_device_loader_power_off() { + if(furi_hal_power_is_otg_enabled()) furi_hal_power_disable_otg(); +} + +bool radio_device_loader_is_connect_external(const char* name) { + bool is_connect = false; + bool is_otg_enabled = furi_hal_power_is_otg_enabled(); + + if(!is_otg_enabled) { + radio_device_loader_power_on(); + } + + const SubGhzDevice* device = subghz_devices_get_by_name(name); + if(device) { + is_connect = subghz_devices_is_connect(device); + } + + if(!is_otg_enabled) { + radio_device_loader_power_off(); + } + return is_connect; +} + +const SubGhzDevice* radio_device_loader_set( + const SubGhzDevice* current_radio_device, + SubGhzRadioDeviceType radio_device_type) { + const SubGhzDevice* radio_device; + + if(radio_device_type == SubGhzRadioDeviceTypeExternalCC1101 && + radio_device_loader_is_connect_external(SUBGHZ_DEVICE_CC1101_EXT_NAME)) { + radio_device_loader_power_on(); + radio_device = subghz_devices_get_by_name(SUBGHZ_DEVICE_CC1101_EXT_NAME); + subghz_devices_begin(radio_device); + } else if(current_radio_device == NULL) { + radio_device = subghz_devices_get_by_name(SUBGHZ_DEVICE_CC1101_INT_NAME); + } else { + radio_device_loader_end(current_radio_device); + radio_device = subghz_devices_get_by_name(SUBGHZ_DEVICE_CC1101_INT_NAME); + } + + return radio_device; +} + +void radio_device_loader_end(const SubGhzDevice* radio_device) { + furi_assert(radio_device); + radio_device_loader_power_off(); + if(radio_device != subghz_devices_get_by_name(SUBGHZ_DEVICE_CC1101_INT_NAME)) { + subghz_devices_end(radio_device); + } +} \ No newline at end of file diff --git a/helpers/radio_device_loader.h b/helpers/radio_device_loader.h new file mode 100644 index 00000000000..bee4e2c362b --- /dev/null +++ b/helpers/radio_device_loader.h @@ -0,0 +1,15 @@ +#pragma once + +#include + +/** SubGhzRadioDeviceType */ +typedef enum { + SubGhzRadioDeviceTypeInternal, + SubGhzRadioDeviceTypeExternalCC1101, +} SubGhzRadioDeviceType; + +const SubGhzDevice* radio_device_loader_set( + const SubGhzDevice* current_radio_device, + SubGhzRadioDeviceType radio_device_type); + +void radio_device_loader_end(const SubGhzDevice* radio_device); \ No newline at end of file diff --git a/images/ProtoViewSignal.jpg b/images/ProtoViewSignal.jpg new file mode 100644 index 00000000000..2c1938e7bfd Binary files /dev/null and b/images/ProtoViewSignal.jpg differ diff --git a/images/protoview_1.jpg b/images/protoview_1.jpg new file mode 100644 index 00000000000..10d9d6ec551 Binary files /dev/null and b/images/protoview_1.jpg differ diff --git a/images/protoview_2.jpg b/images/protoview_2.jpg new file mode 100644 index 00000000000..2560297707d Binary files /dev/null and b/images/protoview_2.jpg differ diff --git a/protocols/b4b1.c b/protocols/b4b1.c new file mode 100644 index 00000000000..6d0b8237a19 --- /dev/null +++ b/protocols/b4b1.c @@ -0,0 +1,93 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * PT/SC remotes. Usually 443.92 Mhz OOK. + * + * This line code is used in many remotes such as Princeton chips + * named PT2262, Silian Microelectronics SC5262 and others. + * Basically every 4 pulsee represent a bit, where 1000 means 0, and + * 1110 means 1. Usually we can read 24 bits of data. + * In this specific implementation we check for a prelude that is + * 1 bit high, 31 bits low, but the check is relaxed. */ + +#include "../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + if(numbits < 30) return false; + + /* Test different pulse + gap + first byte possibilities. */ + const char* sync_patterns[6] = { + "100000000000000000000000000000011101", /* 30 times gap + one. */ + "100000000000000000000000000000010001", /* 30 times gap + zero. */ + "1000000000000000000000000000000011101", /* 31 times gap + one. */ + "1000000000000000000000000000000010001", /* 31 times gap + zero. */ + "10000000000000000000000000000000011101", /* 32 times gap + one. */ + "10000000000000000000000000000000010001", /* 32 times gap + zero. */ + }; + + uint32_t off; + int j; + for(j = 0; j < 3; j++) { + off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_patterns[j]); + if(off != BITMAP_SEEK_NOT_FOUND) break; + } + if(off == BITMAP_SEEK_NOT_FOUND) return false; + if(DEBUG_MSG) FURI_LOG_E(TAG, "B4B1 preamble id:%d at: %lu", j, off); + info->start_off = off; + + // Seek data setction. Why -5? Last 5 half-bit-times are data. + off += strlen(sync_patterns[j]) - 5; + + uint8_t d[3]; /* 24 bits of data. */ + uint32_t decoded = convert_from_line_code(d, sizeof(d), bits, numbytes, off, "1000", "1110"); + + if(DEBUG_MSG) FURI_LOG_E(TAG, "B4B1 decoded: %lu", decoded); + if(decoded < 24) return false; + + off += 24 * 4; // seek to end symbol offset to calculate the length. + off++; // In this protocol there is a final pulse as terminator. + info->pulses_count = off - info->start_off; + + fieldset_add_bytes(info->fieldset, "id", d, 5); + fieldset_add_uint(info->fieldset, "button", d[2] & 0xf, 4); + return true; +} + +/* Give fields and defaults for the signal creator. */ +static void get_fields(ProtoViewFieldSet* fieldset) { + uint8_t default_id[3] = {0xAB, 0xCD, 0xE0}; + fieldset_add_bytes(fieldset, "id", default_id, 5); + fieldset_add_uint(fieldset, "button", 1, 4); +} + +/* Create a signal. */ +static void build_message(RawSamplesBuffer* samples, ProtoViewFieldSet* fs) { + uint32_t te = 334; // Short pulse duration in microseconds. + + // Sync: 1 te pulse, 31 te gap. + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te * 31); + + // ID + button state + uint8_t data[3]; + memcpy(data, fs->fields[0]->bytes, 3); + data[2] = (data[2] & 0xF0) | (fs->fields[1]->uvalue & 0xF); + for(uint32_t j = 0; j < 24; j++) { + if(bitmap_get(data, sizeof(data), j)) { + raw_samples_add(samples, true, te * 3); + raw_samples_add(samples, false, te); + } else { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te * 3); + } + } + + // Signal terminator. Just a single short pulse. + raw_samples_add(samples, true, te); +} + +ProtoViewDecoder B4B1Decoder = { + .name = "PT/SC remote", + .decode = decode, + .get_fields = get_fields, + .build_message = build_message}; diff --git a/protocols/keeloq.c b/protocols/keeloq.c new file mode 100644 index 00000000000..c09cc35fcb0 --- /dev/null +++ b/protocols/keeloq.c @@ -0,0 +1,121 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Microchip HCS200/HCS300/HSC301 KeeLoq, rolling code remotes. + * + * Usually 443.92 Mhz OOK, ~200us or ~400us pulse len, depending + * on the configuration. + * + * Preamble: 12 pairs of alternating pulse/gap. + * Sync: long gap of around 10 times the duration of the short-pulse. + * Data: pulse width encoded data. Each bit takes three cycles: + * + * 0 = 110 + * 1 = 100 + * + * There are a total of 66 bits transmitted. + * 0..31: 32 bits of encrypted rolling code. + * 32..59: Remote ID, 28 bits + * 60..63: Buttons pressed + * 64..64: Low battery if set + * 65..65: Always set to 1 + * + * Bits in bytes are inverted: least significant bit is first. + * For some reason there is no checksum whatsoever, so we only decode + * if we find everything well formed. + */ + +#include "../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + /* In the sync pattern, we require the 12 high/low pulses and at least + * half the gap we expect (5 pulses times, one is the final zero in the + * 24 symbols high/low sequence, then other 4). */ + const char* sync_pattern = "101010101010101010101010" + "0000"; + uint8_t sync_len = 24 + 4; + if(numbits - sync_len + sync_len < 3 * 66) return false; + uint32_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + + info->start_off = off; + off += sync_len; // Seek start of message. + + /* Now there is half the gap left, but we allow from 3 to 7, instead of 5 + * symbols of gap, to avoid missing the signal for a matter of wrong + * timing. */ + uint8_t gap_len = 0; + while(gap_len <= 7 && bitmap_get(bits, numbytes, off + gap_len) == 0) gap_len++; + if(gap_len < 3 || gap_len > 7) return false; + + off += gap_len; + FURI_LOG_E(TAG, "Keeloq preamble+sync found"); + + uint8_t raw[9] = {0}; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "110", "100"); /* Pulse width modulation. */ + FURI_LOG_E(TAG, "Keeloq decoded bits: %lu", decoded); + if(decoded < 66) return false; /* Require the full 66 bits. */ + + info->pulses_count = (off + 66 * 3) - info->start_off; + + bitmap_reverse_bytes_bits(raw, sizeof(raw)); /* Keeloq is LSB first. */ + + int buttons = raw[7] >> 4; + int lowbat = (raw[8] & 0x1) == 0; // Actual bit meaning: good battery level + int alwaysone = (raw[8] & 0x2) != 0; + + fieldset_add_bytes(info->fieldset, "encr", raw, 8); + raw[7] = raw[7] << 4; // Make ID bits contiguous + fieldset_add_bytes(info->fieldset, "id", raw + 4, 7); // 28 bits, 7 nibbles + fieldset_add_bin(info->fieldset, "s[2,1,0,3]", buttons, 4); + fieldset_add_bin(info->fieldset, "low battery", lowbat, 1); + fieldset_add_bin(info->fieldset, "always one", alwaysone, 1); + return true; +} + +static void get_fields(ProtoViewFieldSet* fieldset) { + uint8_t remote_id[4] = {0xab, 0xcd, 0xef, 0xa0}; + uint8_t encr[4] = {0xab, 0xab, 0xab, 0xab}; + fieldset_add_bytes(fieldset, "encr", encr, 8); + fieldset_add_bytes(fieldset, "id", remote_id, 7); + fieldset_add_bin(fieldset, "s[2,1,0,3]", 2, 4); + fieldset_add_bin(fieldset, "low battery", 0, 1); + fieldset_add_bin(fieldset, "always one", 1, 1); +} + +static void build_message(RawSamplesBuffer* samples, ProtoViewFieldSet* fieldset) { + uint32_t te = 380; // Short pulse duration in microseconds. + + // Sync: 12 pairs of pulse/gap + 9 times gap + for(int j = 0; j < 12; j++) { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te); + } + raw_samples_add(samples, false, te * 9); + + // Data, 66 bits. + uint8_t data[9] = {0}; + memcpy(data, fieldset->fields[0]->bytes, 4); // Encrypted part. + memcpy(data + 4, fieldset->fields[1]->bytes, 4); // ID. + data[7] = data[7] >> 4 | fieldset->fields[2]->uvalue << 4; // s[2,1,0,3] + int low_battery = fieldset->fields[3] != 0; + int always_one = fieldset->fields[4] != 0; + low_battery = !low_battery; // Bit real meaning is good battery level. + data[8] |= low_battery; + data[8] |= (always_one << 1); + bitmap_reverse_bytes_bits(data, sizeof(data)); /* Keeloq is LSB first. */ + + for(int j = 0; j < 66; j++) { + if(bitmap_get(data, 9, j)) { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te * 2); + } else { + raw_samples_add(samples, true, te * 2); + raw_samples_add(samples, false, te); + } + } +} + +ProtoViewDecoder KeeloqDecoder = + {.name = "Keeloq", .decode = decode, .get_fields = get_fields, .build_message = build_message}; diff --git a/protocols/oregon2.c b/protocols/oregon2.c new file mode 100644 index 00000000000..f7b123deb32 --- /dev/null +++ b/protocols/oregon2.c @@ -0,0 +1,84 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Oregon remote termometers. Usually 443.92 Mhz OOK. + * + * The protocol is described here: + * https://wmrx00.sourceforge.net/Arduino/OregonScientific-RF-Protocols.pdf + * This implementation is not very complete. */ + +#include "../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + if(numbits < 32) return false; + const char* sync_pattern = "01100110" + "01100110" + "10010110" + "10010110"; + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Oregon2 preamble+sync found"); + + info->start_off = off; + off += 32; /* Skip preamble. */ + + uint8_t buffer[8], raw[8] = {0}; + uint32_t decoded = + convert_from_line_code(buffer, sizeof(buffer), bits, numbytes, off, "1001", "0110"); + FURI_LOG_E(TAG, "Oregon2 decoded bits: %lu", decoded); + + if(decoded < 11 * 4) return false; /* Minimum len to extract some data. */ + info->pulses_count = (off + 11 * 4 * 4) - info->start_off; + + char temp[3] = {0}, hum[2] = {0}; + uint8_t deviceid[2]; + for(int j = 0; j < 64; j += 4) { + uint8_t nib[1]; + nib[0] = + (bitmap_get(buffer, 8, j + 0) | bitmap_get(buffer, 8, j + 1) << 1 | + bitmap_get(buffer, 8, j + 2) << 2 | bitmap_get(buffer, 8, j + 3) << 3); + if(DEBUG_MSG) FURI_LOG_E(TAG, "Not inverted nibble[%d]: %x", j / 4, (unsigned int)nib[0]); + raw[j / 8] |= nib[0] << (4 - (j % 4)); + switch(j / 4) { + case 1: + deviceid[0] |= nib[0]; + break; + case 0: + deviceid[0] |= nib[0] << 4; + break; + case 3: + deviceid[1] |= nib[0]; + break; + case 2: + deviceid[1] |= nib[0] << 4; + break; + case 10: + temp[0] = nib[0]; + break; + /* Fixme: take the temperature sign from nibble 11. */ + case 9: + temp[1] = nib[0]; + break; + case 8: + temp[2] = nib[0]; + break; + case 13: + hum[0] = nib[0]; + break; + case 12: + hum[1] = nib[0]; + break; + } + } + + float tempval = ((temp[0] - '0') * 10) + (temp[1] - '0') + ((float)(temp[2] - '0') * 0.1); + int humval = (hum[0] - '0') * 10 + (hum[1] - '0'); + + fieldset_add_bytes(info->fieldset, "Sensor ID", deviceid, 4); + fieldset_add_float(info->fieldset, "Temperature", tempval, 1); + fieldset_add_uint(info->fieldset, "Humidity", humval, 7); + return true; +} + +ProtoViewDecoder Oregon2Decoder = + {.name = "Oregon2", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/pvchat.c b/protocols/pvchat.c new file mode 100644 index 00000000000..779248c5b74 --- /dev/null +++ b/protocols/pvchat.c @@ -0,0 +1,205 @@ +#include "../app.h" + +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * ---------------------------------------------------------- + * ProtoView chat protocol. This is just a fun test protocol + * that can be used between two Flippers in order to send + * and receive text messages. + * ---------------------------------------------------------- + * + * Protocol description + * ==================== + * + * The protocol works with different data rates. However here is defined + * to use a short pulse/gap duration of 300us and a long pulse/gap + * duration of 600us. Even with the Flipper hardware, the protocol works + * with 100/200us, but becomes less reliable and standard presets can't + * be used because of the higher data rate. + * + * In the following description we have that: + * + * "1" represents a pulse of one-third bit time (300us) + * "0" represents a gap of one-third bit time (300us) + * + * The message starts with a preamble + a sync pattern: + * + * preamble = 1010101010101010 x 3 + * sync = 1100110011001010 + * + * The a variable amount of bytes follow, where each bit + * is encoded in the following way: + * + * zero 100 (300 us pulse, 600 us gap) + * one 110 (600 us pulse, 300 us gap) + * + * Bytes are sent MSB first, so receiving, in sequence, bits + * 11100001, means byte E1. + * + * This is the data format: + * + * +--+------+-------+--+--+--+ + * |SL|Sender|Message|FF|AA|CS| + * +--+------+-------+--+--+--+ + * | | | + * | | \_ N bytes of message terminated by FF AA + 1 byte of checksum + * | | + * | \_ SL bytes of sender name + * \ + * \_ 1 byte of sender len, 8 bit unsigned integer. + * + * + * Checksum = sum of bytes modulo 256, with checksum set + * to 0 for the computation. + * + * Design notes + * ============ + * + * The protocol is designed in order to have certain properties: + * + * 1. Pulses and gaps can only be 100 or 200 microseconds, so the + * message can be described, encoded and decoded with only two + * fixed durations. + * + * 2. The preamble + sync is designed to have a well recognizable + * pattern that can't be reproduced just for accident inside + * the encoded pattern. There is no combinatio of encoded bits + * leading to the preamble+sync. Also the sync pattern final + * part can't be mistaken for actual bits of data, since it + * contains alternating short pulses/gaps at 100us. + * + * 3. Data encoding wastes some bandwidth in order to be more + * robust. Even so, with a 300us clock period, a single bit + * bit takes 900us, reaching a data transfer of 138 characters per + * second. More than enough for the simple chat we have here. + */ + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + const char* sync_pattern = "1010101010101010" // Preamble + "1100110011001010"; // Sync + uint8_t sync_len = 32; + + /* This is a variable length message, however the minimum length + * requires a sender len byte (of value zero) and the terminator + * FF 00 plus checksum: a total of 4 bytes. */ + if(numbits - sync_len < 8 * 4) return false; + + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Chat preamble+sync found"); + + /* If there is room on the left, let's mark the start of the message + * a bit before: we don't try to detect all the preamble, but only + * the first part, however it is likely present. */ + if(off >= 16) { + off -= 16; + sync_len += 16; + } + + info->start_off = off; + off += sync_len; /* Skip preamble and sync. */ + + uint8_t raw[64] = {(uint8_t)'.'}; + uint32_t decoded = + convert_from_line_code(raw, sizeof(raw), bits, numbytes, off, "100", "110"); /* PWM */ + FURI_LOG_E(TAG, "Chat decoded bits: %lu", decoded); + + if(decoded < 8 * 4) return false; /* Min message len. */ + + // The message needs to have a two bytes terminator before + // the checksum. + uint32_t j; + for(j = 0; j < sizeof(raw) - 1; j++) + if(raw[j] == 0xff && raw[j + 1] == 0xaa) break; + + if(j == sizeof(raw) - 1) { + FURI_LOG_E(TAG, "Chat: terminator not found"); + return false; // No terminator found. + } + + uint32_t datalen = j + 3; // If the terminator was found at j, then + // we need to sum three more bytes to have + // the len: FF itself, AA, checksum. + info->pulses_count = sync_len + 8 * 3 * datalen; + + // Check if the control sum matches. + if(sum_bytes(raw, datalen - 1, 0) != raw[datalen - 1]) { + FURI_LOG_E(TAG, "Chat: checksum mismatch"); + return false; + } + + // Check if the length of the sender looks sane + uint8_t senderlen = raw[0]; + if(senderlen >= sizeof(raw)) { + FURI_LOG_E(TAG, "Chat: invalid sender length"); + return false; // Overflow + } + + fieldset_add_str(info->fieldset, "sender", (char*)raw + 1, senderlen); + fieldset_add_str( + info->fieldset, "message", (char*)raw + 1 + senderlen, datalen - senderlen - 4); + return true; +} + +/* Give fields and defaults for the signal creator. */ +static void get_fields(ProtoViewFieldSet* fieldset) { + fieldset_add_str(fieldset, "sender", "Carol", 5); + fieldset_add_str(fieldset, "message", "Anyone hearing?", 15); +} + +/* Create a signal. */ +static void build_message(RawSamplesBuffer* samples, ProtoViewFieldSet* fs) { + uint32_t te = 300; /* Short pulse duration in microseconds. + Our protocol needs three symbol times to send + a bit, so 300 us per bit = 3.33 kBaud. */ + + // Preamble: 24 alternating 300us pulse/gap pairs. + for(int j = 0; j < 24; j++) { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te); + } + + // Sync: 3 alternating 600 us pulse/gap pairs. + for(int j = 0; j < 3; j++) { + raw_samples_add(samples, true, te * 2); + raw_samples_add(samples, false, te * 2); + } + + // Sync: plus 2 alternating 300 us pluse/gap pairs. + for(int j = 0; j < 2; j++) { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te); + } + + // Data: build the array. + uint32_t datalen = 1 + fs->fields[0]->len + // Userlen + Username + fs->fields[1]->len + 3; // Message + FF + 00 + CRC + uint8_t *data = malloc(datalen), *p = data; + *p++ = fs->fields[0]->len; + memcpy(p, fs->fields[0]->str, fs->fields[0]->len); + p += fs->fields[0]->len; + memcpy(p, fs->fields[1]->str, fs->fields[1]->len); + p += fs->fields[1]->len; + *p++ = 0xff; + *p++ = 0xaa; + *p = sum_bytes(data, datalen - 1, 0); + + // Emit bits + for(uint32_t j = 0; j < datalen * 8; j++) { + if(bitmap_get(data, datalen, j)) { + raw_samples_add(samples, true, te * 2); + raw_samples_add(samples, false, te); + } else { + raw_samples_add(samples, true, te); + raw_samples_add(samples, false, te * 2); + } + } + free(data); +} + +ProtoViewDecoder ProtoViewChatDecoder = { + .name = "ProtoView chat", + .decode = decode, + .get_fields = get_fields, + .build_message = build_message}; diff --git a/protocols/tpms/citroen.c b/protocols/tpms/citroen.c new file mode 100644 index 00000000000..a86e5f7d6c2 --- /dev/null +++ b/protocols/tpms/citroen.c @@ -0,0 +1,58 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Citroen TPMS. Usually 443.92 Mhz FSK. + * + * Preamble of ~14 high/low 52 us pulses + * Sync of high 100us pulse then 50us low + * Then Manchester bits, 10 bytes total. + * Simple XOR checksum. */ + +#include "../../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + /* We consider a preamble of 17 symbols. They are more, but the decoding + * is more likely to happen if we don't pretend to receive from the + * very start of the message. */ + uint32_t sync_len = 17; + const char* sync_pattern = "10101010101010110"; + if(numbits - sync_len < 8 * 10) return false; /* Expect 10 bytes. */ + + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Renault TPMS preamble+sync found"); + + info->start_off = off; + off += sync_len; /* Skip preamble + sync. */ + + uint8_t raw[10]; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "01", "10"); /* Manchester. */ + FURI_LOG_E(TAG, "Citroen TPMS decoded bits: %lu", decoded); + + if(decoded < 8 * 10) return false; /* Require the full 10 bytes. */ + + /* Check the CRC. It's a simple XOR of bytes 1-9, the first byte + * is not included. The meaning of the first byte is unknown and + * we don't display it. */ + uint8_t crc = 0; + for(int j = 1; j < 10; j++) crc ^= raw[j]; + if(crc != 0) return false; /* Require sane checksum. */ + + info->pulses_count = (off + 8 * 10 * 2) - info->start_off; + + int repeat = raw[5] & 0xf; + float kpa = (float)raw[6] * 1.364; + int temp = raw[7] - 50; + int battery = raw[8]; /* This may be the battery. It's not clear. */ + + fieldset_add_bytes(info->fieldset, "Tire ID", raw + 1, 4 * 2); + fieldset_add_float(info->fieldset, "Pressure kpa", kpa, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp, 8); + fieldset_add_uint(info->fieldset, "Repeat", repeat, 4); + fieldset_add_uint(info->fieldset, "Battery", battery, 8); + return true; +} + +ProtoViewDecoder CitroenTPMSDecoder = + {.name = "Citroen TPMS", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/tpms/ford.c b/protocols/tpms/ford.c new file mode 100644 index 00000000000..06633259089 --- /dev/null +++ b/protocols/tpms/ford.c @@ -0,0 +1,61 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Ford tires TPMS. Usually 443.92 Mhz FSK (in Europe). + * + * 52 us short pules + * Preamble: 0101010101010101010101010101 + * Sync: 0110 (that is 52 us gap + 104 us pulse + 52 us gap) + * Data: 8 bytes Manchester encoded + * 01 = zero + * 10 = one + */ + +#include "../../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + const char* sync_pattern = "010101010101" + "0110"; + uint8_t sync_len = 12 + 4; /* We just use 12 preamble symbols + sync. */ + if(numbits - sync_len < 8 * 8) return false; + + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Fort TPMS preamble+sync found"); + + info->start_off = off; + off += sync_len; /* Skip preamble and sync. */ + + uint8_t raw[8]; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "01", "10"); /* Manchester. */ + FURI_LOG_E(TAG, "Ford TPMS decoded bits: %lu", decoded); + + if(decoded < 8 * 8) return false; /* Require the full 8 bytes. */ + + /* CRC is just the sum of the first 7 bytes MOD 256. */ + uint8_t crc = 0; + for(int j = 0; j < 7; j++) crc += raw[j]; + if(crc != raw[7]) return false; /* Require sane CRC. */ + + info->pulses_count = (off + 8 * 8 * 2) - info->start_off; + + float psi = 0.25 * (((raw[6] & 0x20) << 3) | raw[4]); + + /* Temperature apperas to be valid only if the most significant + * bit of the value is not set. Otherwise its meaning is unknown. + * Likely useful to alternatively send temperature or other info. */ + int temp = raw[5] & 0x80 ? 0 : raw[5] - 56; + int flags = raw[5] & 0x7f; + int car_moving = (raw[6] & 0x44) == 0x44; + + fieldset_add_bytes(info->fieldset, "Tire ID", raw, 4 * 2); + fieldset_add_float(info->fieldset, "Pressure psi", psi, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp, 8); + fieldset_add_hex(info->fieldset, "Flags", flags, 7); + fieldset_add_uint(info->fieldset, "Moving", car_moving, 1); + return true; +} + +ProtoViewDecoder FordTPMSDecoder = + {.name = "Ford TPMS", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/tpms/renault.c b/protocols/tpms/renault.c new file mode 100644 index 00000000000..0755a515fcb --- /dev/null +++ b/protocols/tpms/renault.c @@ -0,0 +1,119 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Renault tires TPMS. Usually 443.92 Mhz FSK. + * + * Preamble + sync + Manchester bits. ~48us short pulse. + * 9 Bytes in total not counting the preamble. */ + +#include "../../app.h" + +#define USE_TEST_VECTOR 0 +static const char* test_vector = + "...01010101010101010110" // Preamble + sync + + /* The following is Marshal encoded, so each two characters are + * actaully one bit. 01 = 0, 10 = 1. */ + "010110010110" // Flags. + "10011001101010011001" // Pressure, multiply by 0.75 to obtain kpa. + // 244 kpa here. + "1010010110011010" // Temperature, subtract 30 to obtain celsius. 22C here. + "1001010101101001" + "0101100110010101" + "1001010101100110" // Tire ID. 0x7AD779 here. + "0101010101010101" + "0101010101010101" // Two FF bytes (usually). Unknown. + "0110010101010101"; // CRC8 with (poly 7, initialization 0). + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + if(USE_TEST_VECTOR) { /* Test vector to check that decoding works. */ + bitmap_set_pattern(bits, numbytes, 0, test_vector); + numbits = strlen(test_vector); + } + + if(numbits - 12 < 9 * 8) return false; + + const char* sync_pattern = "01010101010101010110"; + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Renault TPMS preamble+sync found"); + + info->start_off = off; + off += 20; /* Skip preamble. */ + + uint8_t raw[9]; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "01", "10"); /* Manchester. */ + FURI_LOG_E(TAG, "Renault TPMS decoded bits: %lu", decoded); + + if(decoded < 8 * 9) return false; /* Require the full 9 bytes. */ + if(crc8(raw, 8, 0, 7) != raw[8]) return false; /* Require sane CRC. */ + + info->pulses_count = (off + 8 * 9 * 2) - info->start_off; + + uint8_t flags = raw[0] >> 2; + float kpa = 0.75 * ((uint32_t)((raw[0] & 3) << 8) | raw[1]); + int temp = raw[2] - 30; + + fieldset_add_bytes(info->fieldset, "Tire ID", raw + 3, 3 * 2); + fieldset_add_float(info->fieldset, "Pressure kpa", kpa, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp, 8); + fieldset_add_hex(info->fieldset, "Flags", flags, 6); + fieldset_add_bytes(info->fieldset, "Unknown1", raw + 6, 2); + fieldset_add_bytes(info->fieldset, "Unknown2", raw + 7, 2); + return true; +} + +/* Give fields and defaults for the signal creator. */ +static void get_fields(ProtoViewFieldSet* fieldset) { + uint8_t default_id[3] = {0xAB, 0xCD, 0xEF}; + fieldset_add_bytes(fieldset, "Tire ID", default_id, 3 * 2); + fieldset_add_float(fieldset, "Pressure kpa", 123, 2); + fieldset_add_int(fieldset, "Temperature C", 20, 8); + // We don't know what flags are, but 1B is a common value. + fieldset_add_hex(fieldset, "Flags", 0x1b, 6); + fieldset_add_bytes(fieldset, "Unknown1", (uint8_t*)"\xff", 2); + fieldset_add_bytes(fieldset, "Unknown2", (uint8_t*)"\xff", 2); +} + +/* Create a Renault TPMS signal, according to the fields provided. */ +static void build_message(RawSamplesBuffer* samples, ProtoViewFieldSet* fieldset) { + uint32_t te = 50; // Short pulse duration in microseconds. + + // Preamble + sync + const char* psync = "01010101010101010101010101010110"; + const char* p = psync; + while(*p) { + raw_samples_add_or_update(samples, *p == '1', te); + p++; + } + + // Data, 9 bytes + uint8_t data[9] = {0}; + unsigned int raw_pressure = fieldset->fields[1]->fvalue * 4 / 3; + data[0] = fieldset->fields[3]->uvalue << 2; // Flags + data[0] |= (raw_pressure >> 8) & 3; // Pressure kpa high 2 bits + data[1] = raw_pressure & 0xff; // Pressure kpa low 8 bits + data[2] = fieldset->fields[2]->value + 30; // Temperature C + memcpy(data + 3, fieldset->fields[0]->bytes, 6); // ID, 24 bits. + data[6] = fieldset->fields[4]->bytes[0]; // Unknown 1 + data[7] = fieldset->fields[5]->bytes[0]; // Unknown 2 + data[8] = crc8(data, 8, 0, 7); + + // Generate Manchester code for each bit + for(uint32_t j = 0; j < 9 * 8; j++) { + if(bitmap_get(data, sizeof(data), j)) { + raw_samples_add_or_update(samples, true, te); + raw_samples_add_or_update(samples, false, te); + } else { + raw_samples_add_or_update(samples, false, te); + raw_samples_add_or_update(samples, true, te); + } + } +} + +ProtoViewDecoder RenaultTPMSDecoder = { + .name = "Renault TPMS", + .decode = decode, + .get_fields = get_fields, + .build_message = build_message}; diff --git a/protocols/tpms/schrader.c b/protocols/tpms/schrader.c new file mode 100644 index 00000000000..2b53d313c80 --- /dev/null +++ b/protocols/tpms/schrader.c @@ -0,0 +1,70 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Schrader TPMS. Usually 443.92 Mhz OOK, 120us pulse len. + * + * 500us high pulse + Preamble + Manchester coded bits where: + * 1 = 10 + * 0 = 01 + * + * 60 bits of data total (first 4 nibbles is the preamble, 0xF). + * + * Used in FIAT-Chrysler, Mercedes, ... */ + +#include "../../app.h" + +#define USE_TEST_VECTOR 0 +static const char* test_vector = + "000000111101010101011010010110010110101001010110100110011001100101010101011010100110100110011010101010101010101010101010101010101010101010101010"; + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + if(USE_TEST_VECTOR) { /* Test vector to check that decoding works. */ + bitmap_set_pattern(bits, numbytes, 0, test_vector); + numbits = strlen(test_vector); + } + + if(numbits < 64) return false; /* Preamble + data. */ + + const char* sync_pattern = "1111010101" + "01011010"; + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Schrader TPMS gap+preamble found"); + + info->start_off = off; + off += 10; /* Skip just the long pulse and the first 3 bits of sync, so + that we have the first byte of data with the sync nibble + 0011 = 0x3. */ + + uint8_t raw[8]; + uint8_t id[4]; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "01", "10"); /* Manchester code. */ + FURI_LOG_E(TAG, "Schrader TPMS decoded bits: %lu", decoded); + + if(decoded < 64) return false; /* Require the full 8 bytes. */ + + raw[0] |= 0xf0; // Fix the preamble nibble for checksum computation. + uint8_t cksum = crc8(raw, sizeof(raw) - 1, 0xf0, 0x7); + if(cksum != raw[7]) { + FURI_LOG_E(TAG, "Schrader TPMS checksum mismatch"); + return false; + } + + info->pulses_count = (off + 8 * 8 * 2) - info->start_off; + + float kpa = (float)raw[5] * 2.5; + int temp = raw[6] - 50; + id[0] = raw[1] & 7; + id[1] = raw[2]; + id[2] = raw[3]; + id[3] = raw[4]; + + fieldset_add_bytes(info->fieldset, "Tire ID", id, 4 * 2); + fieldset_add_float(info->fieldset, "Pressure kpa", kpa, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp, 8); + return true; +} + +ProtoViewDecoder SchraderTPMSDecoder = + {.name = "Schrader TPMS", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/tpms/schrader_eg53ma4.c b/protocols/tpms/schrader_eg53ma4.c new file mode 100644 index 00000000000..b186f57b187 --- /dev/null +++ b/protocols/tpms/schrader_eg53ma4.c @@ -0,0 +1,62 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Schrader variant EG53MA4 TPMS. + * Usually 443.92 Mhz OOK, 100us pulse len. + * + * Preamble: alternating pulse/gap, 100us. + * Sync (as pulses and gaps): "01100101", already part of the data stream + * (first nibble) corresponding to 0x4 + * + * A total of 10 bytes payload, Manchester encoded. + * + * 0 = 01 + * 1 = 10 + * + * Used in certain Open cars and others. + */ + +#include "../../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + const char* sync_pattern = "010101010101" + "01100101"; + uint8_t sync_len = 12 + 8; /* We just use 12 preamble symbols + sync. */ + if(numbits - sync_len + 8 < 8 * 10) return false; + + uint64_t off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync_pattern); + if(off == BITMAP_SEEK_NOT_FOUND) return false; + FURI_LOG_E(TAG, "Schrader EG53MA4 TPMS preamble+sync found"); + + info->start_off = off; + off += sync_len - 8; /* Skip preamble, not sync that is part of the data. */ + + uint8_t raw[10]; + uint32_t decoded = convert_from_line_code( + raw, sizeof(raw), bits, numbytes, off, "01", "10"); /* Manchester code. */ + FURI_LOG_E(TAG, "Schrader EG53MA4 TPMS decoded bits: %lu", decoded); + + if(decoded < 10 * 8) return false; /* Require the full 10 bytes. */ + + /* CRC is just all bytes added mod 256. */ + uint8_t crc = 0; + for(int j = 0; j < 9; j++) crc += raw[j]; + if(crc != raw[9]) return false; /* Require sane CRC. */ + + info->pulses_count = (off + 10 * 8 * 2) - info->start_off; + + /* To convert the raw pressure to kPa, RTL433 uses 2.5, but is likely + * wrong. Searching on Google for users experimenting with the value + * reported, the value appears to be 2.75. */ + float kpa = (float)raw[7] * 2.75; + int temp_f = raw[8]; + int temp_c = (temp_f - 32) * 5 / 9; /* Convert Fahrenheit to Celsius. */ + + fieldset_add_bytes(info->fieldset, "Tire ID", raw + 4, 3 * 2); + fieldset_add_float(info->fieldset, "Pressure kpa", kpa, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp_c, 8); + return true; +} + +ProtoViewDecoder SchraderEG53MA4TPMSDecoder = + {.name = "Schrader EG53MA4 TPMS", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/tpms/toyota.c b/protocols/tpms/toyota.c new file mode 100644 index 00000000000..3a02447b7df --- /dev/null +++ b/protocols/tpms/toyota.c @@ -0,0 +1,81 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * Toyota tires TPMS. Usually 443.92 Mhz FSK (In Europe). + * + * Preamble + sync + 64 bits of data. ~48us short pulse length. + * + * The preamble + sync is something like: + * + * 10101010101 (preamble) + 001111[1] (sync) + * + * Note: the final [1] means that sometimes it is four 1s, sometimes + * five, depending on the short pulse length detection and the exact + * duration of the high long pulse. After the sync, a differential + * Manchester encoded payload follows. However the Flipper's CC1101 + * often can't decode correctly the initial alternating pattern 101010101, + * so what we do is to seek just the sync, that is "001111" or "0011111", + * however we now that it must be followed by one differenitally encoded + * bit, so we can use also the first symbol of data to force a more robust + * detection, and look for one of the following: + * + * [001111]00 + * [0011111]00 + * [001111]01 + * [0011111]01 + */ + +#include "../../app.h" + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + if(numbits - 6 < 64 * 2) + return false; /* Ask for 64 bit of data (each bit + is two symbols in the bitmap). */ + + char* sync[] = {"00111100", "001111100", "00111101", "001111101", NULL}; + + int j; + uint32_t off = 0; + for(j = 0; sync[j]; j++) { + off = bitmap_seek_bits(bits, numbytes, 0, numbits, sync[j]); + if(off != BITMAP_SEEK_NOT_FOUND) { + info->start_off = off; + off += strlen(sync[j]) - 2; + break; + } + } + if(off == BITMAP_SEEK_NOT_FOUND) return false; + + FURI_LOG_E(TAG, "Toyota TPMS sync[%s] found", sync[j]); + + uint8_t raw[9]; + uint32_t decoded = convert_from_diff_manchester(raw, sizeof(raw), bits, numbytes, off, true); + FURI_LOG_E(TAG, "Toyota TPMS decoded bits: %lu", decoded); + + if(decoded < 8 * 9) return false; /* Require the full 8 bytes. */ + if(crc8(raw, 8, 0x80, 7) != raw[8]) return false; /* Require sane CRC. */ + + /* We detected a valid signal. However now info->start_off is actually + * pointing to the sync part, not the preamble of alternating 0 and 1. + * Protoview decoders get called with some space to the left, in order + * for the decoder itself to fix the signal if neeeded, so that its + * logical representation will be more accurate and better to save + * and retransmit. */ + if(info->start_off >= 12) { + info->start_off -= 12; + bitmap_set_pattern(bits, numbytes, info->start_off, "010101010101"); + } + + info->pulses_count = (off + 8 * 9 * 2) - info->start_off; + + float psi = (float)((raw[4] & 0x7f) << 1 | raw[5] >> 7) * 0.25 - 7; + int temp = ((raw[5] & 0x7f) << 1 | raw[6] >> 7) - 40; + + fieldset_add_bytes(info->fieldset, "Tire ID", raw, 4 * 2); + fieldset_add_float(info->fieldset, "Pressure psi", psi, 2); + fieldset_add_int(info->fieldset, "Temperature C", temp, 8); + return true; +} + +ProtoViewDecoder ToyotaTPMSDecoder = + {.name = "Toyota TPMS", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/protocols/unknown.c b/protocols/unknown.c new file mode 100644 index 00000000000..ec87d59b9e6 --- /dev/null +++ b/protocols/unknown.c @@ -0,0 +1,326 @@ +#include "../app.h" + +/* Copyright (C) 2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. + * + * ---------------------------------------------------------------------------- + * The "unknown" decoder fires as the last one, once we are sure no other + * decoder was able to identify the signal. The goal is to detect the + * preamble and line code used in the received signal, then turn the + * decoded bits into bytes. + * + * The techniques used for the detection are described in the comments + * below. + * ---------------------------------------------------------------------------- + */ + +/* Scan the signal bitmap looking for a PWM modulation. In this case + * for PWM we are referring to two exact patterns of high and low + * signal (each bit in the bitmap is worth the smallest gap/pulse duration + * we detected) that repeat each other in a given segment of the message. + * + * This modulation is quite common, for instance sometimes zero and + * one are rappresented by a 700us pulse followed by 350 gap, + * and 350us pulse followed by a 700us gap. So the signal bitmap received + * by the decoder would contain 110 and 100 symbols. + * + * The way this function work is commented inline. + * + * The function returns the number of consecutive symbols found, having + * a symbol length of 'symlen' (3 in the above example), and stores + * in *s1i the offset of the first symbol found, and in *s2i the offset + * of the second symbol. The function can't tell which is one and which + * zero. */ +static uint32_t find_pwm( + uint8_t* bits, + uint32_t numbytes, + uint32_t numbits, + uint32_t symlen, + uint32_t* s1i, + uint32_t* s2i) { + uint32_t best_count = 0; /* Max number of symbols found in this try. */ + uint32_t best_idx1 = 0; /* First symbol offset of longest sequence found. + * This is also the start sequence offset. */ + uint32_t best_idx2 = 0; /* Second symbol offset. */ + + /* Try all the possible symbol offsets that are less of our + * symbol len. This is likely not really useful but we take + * a conservative approach. Because if have have, for instance, + * repeating symbols "100" and "110", they will form a sequence + * that is choerent at different offsets, but out-of-sync. + * + * Anyway at the end of the function we try to fix the sync. */ + for(uint32_t off = 0; off < symlen; off++) { + uint32_t c = 0; // Number of contiguous symbols found. + uint32_t c1 = 0, c2 = 0; // Occurrences of first/second symbol. + *s1i = off; // Assume we start at one symbol boundaty. + *s2i = UINT32_MAX; // Second symbol first index still unknown. + uint32_t next = off; + + /* We scan the whole bitmap in one pass, resetting the state + * each time we find a pattern that is not one of the two + * symbols we found so far. */ + while(next < numbits - symlen) { + bool match1 = bitmap_match_bitmap(bits, numbytes, next, bits, numbytes, *s1i, symlen); + if(!match1 && *s2i == UINT32_MAX) { + /* It's not the first sybol. We don't know how the + * second look like. Assume we found an occurrence of + * the second symbol. */ + *s2i = next; + } + + bool match2 = bitmap_match_bitmap(bits, numbytes, next, bits, numbytes, *s2i, symlen); + + /* One or the other should match. */ + if(match1 || match2) { + c++; + if(match1) c1++; + if(match2) c2++; + if(c > best_count && c1 >= best_count / 5 && // Require enough presence of both + c2 >= best_count / 5) // zero and one. + { + best_count = c; + best_idx1 = *s1i; + best_idx2 = *s2i; + } + next += symlen; + } else { + /* No match. Continue resetting the signal info. */ + c = 0; // Start again to count contiguous symbols. + c1 = 0; + c2 = 0; + *s1i = next; // First symbol always at start. + *s2i = UINT32_MAX; // Second symbol unknown. + } + } + } + + /* We don't know if we are really synchronized with the bits at this point. + * For example if zero bit is 100 and one bit is 110 in a specific + * line code, our detector could randomly believe it's 001 and 101. + * However PWD line codes normally start with a pulse in both symbols. + * If that is the case, let's align. */ + uint32_t shift; + for(shift = 0; shift < symlen; shift++) { + if(bitmap_get(bits, numbytes, best_idx1 + shift) && + bitmap_get(bits, numbytes, best_idx2 + shift)) + break; + } + if(shift != symlen) { + best_idx1 += shift; + best_idx2 += shift; + } + + *s1i = best_idx1; + *s2i = best_idx2; + return best_count; +} + +/* Find the longest sequence that looks like Manchester coding. + * + * Manchester coding requires each pairs of bits to be either + * 01 or 10. We'll have to try odd and even offsets to be + * sure to find it. + * + * Note that this will also detect differential Manchester, but + * will report it as Manchester. I can't think of any way to + * distinguish between the two line codes, because shifting them + * one symbol will make one to look like the other. + * + * Only option could be to decode the message with both line + * codes and use statistical properties (common byte values) + * to determine what's more likely, but this looks very fragile. + * + * Fortunately differential Manchester is more rarely used, + * so we can assume Manchester most of the times. Yet we are left + * with the indetermination about zero being pulse-gap or gap-pulse + * or the other way around. + * + * If the 'only_raising' parameter is true, the function detects + * only sequences going from gap to pulse: this is useful in order + * to locate preambles of alternating gaps and pulses. */ +static uint32_t find_alternating_bits( + uint8_t* bits, + uint32_t numbytes, + uint32_t numbits, + uint32_t* start, + bool only_raising) { + uint32_t best_count = 0; // Max number of symbols found + uint32_t best_off = 0; // Max symbols start offset. + for(int odd = 0; odd < 2; odd++) { + uint32_t count = 0; // Symbols found so far + uint32_t start_off = odd; + uint32_t j = odd; + while(j < numbits - 1) { + bool bit1 = bitmap_get(bits, numbytes, j); + bool bit2 = bitmap_get(bits, numbytes, j + 1); + if((!only_raising && bit1 != bit2) || (only_raising && !bit1 && bit2)) { + count++; + if(count > best_count) { + best_count = count; + best_off = start_off; + } + } else { + /* End of sequence. Continue with the next + * part of the signal. */ + count = 0; + start_off = j + 2; + } + j += 2; + } + } + *start = best_off; + return best_count; +} + +/* Wrapper to find Manchester code. */ +static uint32_t + find_manchester(uint8_t* bits, uint32_t numbytes, uint32_t numbits, uint32_t* start) { + return find_alternating_bits(bits, numbytes, numbits, start, false); +} + +/* Wrapper to find preamble sections. */ +static uint32_t + find_preamble(uint8_t* bits, uint32_t numbytes, uint32_t numbits, uint32_t* start) { + return find_alternating_bits(bits, numbytes, numbits, start, true); +} + +typedef enum { + LineCodeNone, + LineCodeManchester, + LineCodePWM3, + LineCodePWM4, +} LineCodeGuess; + +static char* get_linecode_name(LineCodeGuess lc) { + switch(lc) { + case LineCodeNone: + return "none"; + case LineCodeManchester: + return "Manchester"; + case LineCodePWM3: + return "PWM3"; + case LineCodePWM4: + return "PWM4"; + } + return "unknown"; +} + +static bool decode(uint8_t* bits, uint32_t numbytes, uint32_t numbits, ProtoViewMsgInfo* info) { + /* No decoder was able to detect this message. Let's try if we can + * find some structure. To start, we'll see if it looks like is + * manchester coded, or PWM with symbol len of 3 or 4. */ + + /* For PWM, start1 and start2 are the offsets at which the two + * sequences composing the message appear the first time. + * So start1 is also the message start offset. Start2 is not used + * for Manchester, that does not have two separated symbols like + * PWM. */ + uint32_t start1 = 0, start2 = 0; + uint32_t msgbits; // Number of message bits in the bitmap, so + // this will be the number of symbols, not actual + // bits after the message is decoded. + uint32_t tmp1, tmp2; // Temp vars to store the start. + uint32_t minbits = 16; // Less than that gets undetected. + uint32_t pwm_len; // Bits per symbol, in the case of PWM. + LineCodeGuess linecode = LineCodeNone; + + // Try PWM3 + uint32_t pwm3_bits = find_pwm(bits, numbytes, numbits, 3, &tmp1, &tmp2); + if(pwm3_bits >= minbits) { + linecode = LineCodePWM3; + start1 = tmp1; + start2 = tmp2; + pwm_len = 3; + msgbits = pwm3_bits * pwm_len; + } + + // Try PWM4 + uint32_t pwm4_bits = find_pwm(bits, numbytes, numbits, 4, &tmp1, &tmp2); + if(pwm4_bits >= minbits && pwm4_bits > pwm3_bits) { + linecode = LineCodePWM4; + start1 = tmp1; + start2 = tmp2; + pwm_len = 4; + msgbits = pwm3_bits * pwm_len; + } + + // Try Manchester + uint32_t manchester_bits = find_manchester(bits, numbytes, numbits, &tmp1); + if(manchester_bits > minbits && manchester_bits > pwm3_bits && manchester_bits > pwm4_bits) { + linecode = LineCodeManchester; + start1 = tmp1; + msgbits = manchester_bits * 2; + //FURI_LOG_T(TAG, "MANCHESTER START: %lu", tmp1); + } + + if(linecode == LineCodeNone) return false; + + /* Often there is a preamble before the signal. We'll try to find + * it, and if it is not too far away from our signal, we'll claim + * our signal starts at the preamble. */ + uint32_t preamble_len = find_preamble(bits, numbytes, numbits, &tmp1); + uint32_t min_preamble_len = 10; + uint32_t max_preamble_distance = 32; + uint32_t preamble_start = 0; + bool preamble_found = false; + + /* Note that because of the following checks, if the Manchester detector + * detected the preamble bits as data, we are ok with that, since it + * means that the synchronization is not designed to "break" the bits + * flow. In this case we ignore the preamble and return all as data. */ + if(preamble_len >= min_preamble_len && // Not too short. + tmp1 < start1 && // Should be before the data. + start1 - tmp1 <= max_preamble_distance) // Not too far. + { + preamble_start = tmp1; + preamble_found = true; + } + + info->start_off = preamble_found ? preamble_start : start1; + info->pulses_count = (start1 + msgbits) - info->start_off; + info->pulses_count += 20; /* Add a few more, so that if the user resends + * the message, it is more likely we will + * transfer all that is needed, like a message + * terminator (that we don't detect). */ + + /*if(preamble_found) FURI_LOG_T(TAG, "PREAMBLE AT: %lu", preamble_start); + FURI_LOG_T(TAG, "START: %lu", info->start_off); + FURI_LOG_T(TAG, "MSGBITS: %lu", msgbits); + FURI_LOG_T(TAG, "DATASTART: %lu", start1); + FURI_LOG_T(TAG, "PULSES: %lu", info->pulses_count);*/ + + /* We think there is a message and we know where it starts and the + * line code used. We can turn it into bits and bytes. */ + uint32_t decoded; + uint8_t data[32]; + uint32_t datalen; + + char symbol1[5], symbol2[5]; + if(linecode == LineCodePWM3 || linecode == LineCodePWM4) { + bitmap_to_string(symbol1, bits, numbytes, start1, pwm_len); + bitmap_to_string(symbol2, bits, numbytes, start2, pwm_len); + } else if(linecode == LineCodeManchester) { + memcpy(symbol1, "01", 3); + memcpy(symbol2, "10", 3); + } + + decoded = convert_from_line_code(data, sizeof(data), bits, numbytes, start1, symbol1, symbol2); + datalen = (decoded + 7) / 8; + + char* linecode_name = get_linecode_name(linecode); + fieldset_add_str(info->fieldset, "line code", linecode_name, strlen(linecode_name)); + fieldset_add_uint(info->fieldset, "data bits", decoded, 8); + if(preamble_found) fieldset_add_uint(info->fieldset, "preamble len", preamble_len, 8); + fieldset_add_str(info->fieldset, "first symbol", symbol1, strlen(symbol1)); + fieldset_add_str(info->fieldset, "second symbol", symbol2, strlen(symbol2)); + for(uint32_t j = 0; j < datalen; j++) { + char label[16]; + snprintf(label, sizeof(label), "data[%lu]", j); + fieldset_add_bytes(info->fieldset, label, data + j, 2); + } + return true; +} + +ProtoViewDecoder UnknownDecoder = + {.name = "Unknown", .decode = decode, .get_fields = NULL, .build_message = NULL}; diff --git a/raw_samples.c b/raw_samples.c new file mode 100644 index 00000000000..54773f43f34 --- /dev/null +++ b/raw_samples.c @@ -0,0 +1,93 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include +#include +#include +#include +#include "raw_samples.h" + +/* Allocate and initialize a samples buffer. */ +RawSamplesBuffer* raw_samples_alloc(void) { + RawSamplesBuffer* buf = malloc(sizeof(*buf)); + buf->mutex = furi_mutex_alloc(FuriMutexTypeNormal); + raw_samples_reset(buf); + return buf; +} + +/* Free a sample buffer. Should be called when the mutex is released. */ +void raw_samples_free(RawSamplesBuffer* s) { + furi_mutex_free(s->mutex); + free(s); +} + +/* This just set all the samples to zero and also resets the internal + * index. There is no need to call it after raw_samples_alloc(), but only + * when one wants to reset the whole buffer of samples. */ +void raw_samples_reset(RawSamplesBuffer* s) { + furi_mutex_acquire(s->mutex, FuriWaitForever); + s->total = RAW_SAMPLES_NUM; + s->idx = 0; + s->short_pulse_dur = 0; + memset(s->samples, 0, sizeof(s->samples)); + furi_mutex_release(s->mutex); +} + +/* Set the raw sample internal index so that what is currently at + * offset 'offset', will appear to be at 0 index. */ +void raw_samples_center(RawSamplesBuffer* s, uint32_t offset) { + s->idx = (s->idx + offset) % RAW_SAMPLES_NUM; +} + +/* Add the specified sample in the circular buffer. */ +void raw_samples_add(RawSamplesBuffer* s, bool level, uint32_t dur) { + furi_mutex_acquire(s->mutex, FuriWaitForever); + s->samples[s->idx].level = level; + s->samples[s->idx].dur = dur; + s->idx = (s->idx + 1) % RAW_SAMPLES_NUM; + furi_mutex_release(s->mutex); +} + +/* This is like raw_samples_add(), however in case a sample of the + * same level of the previous one is added, the duration of the last + * sample is updated instead. Needed mainly for the decoders build_message() + * methods: it is simpler to write an encoder of a signal like that, + * just creating messages piece by piece. + * + * This function is a bit slower so the internal data sampling should + * be performed with raw_samples_add(). */ +void raw_samples_add_or_update(RawSamplesBuffer* s, bool level, uint32_t dur) { + furi_mutex_acquire(s->mutex, FuriWaitForever); + uint32_t previdx = (s->idx - 1) % RAW_SAMPLES_NUM; + if(s->samples[previdx].level == level && s->samples[previdx].dur != 0) { + /* Update the last sample: it has the same level. */ + s->samples[previdx].dur += dur; + } else { + /* Add a new sample. */ + s->samples[s->idx].level = level; + s->samples[s->idx].dur = dur; + s->idx = (s->idx + 1) % RAW_SAMPLES_NUM; + } + furi_mutex_release(s->mutex); +} + +/* Get the sample from the buffer. It is possible to use out of range indexes + * as 'idx' because the modulo operation will rewind back from the start. */ +void raw_samples_get(RawSamplesBuffer* s, uint32_t idx, bool* level, uint32_t* dur) { + furi_mutex_acquire(s->mutex, FuriWaitForever); + idx = (s->idx + idx) % RAW_SAMPLES_NUM; + *level = s->samples[idx].level; + *dur = s->samples[idx].dur; + furi_mutex_release(s->mutex); +} + +/* Copy one buffer to the other, including current index. */ +void raw_samples_copy(RawSamplesBuffer* dst, RawSamplesBuffer* src) { + furi_mutex_acquire(src->mutex, FuriWaitForever); + furi_mutex_acquire(dst->mutex, FuriWaitForever); + dst->idx = src->idx; + dst->short_pulse_dur = src->short_pulse_dur; + memcpy(dst->samples, src->samples, sizeof(dst->samples)); + furi_mutex_release(src->mutex); + furi_mutex_release(dst->mutex); +} diff --git a/raw_samples.h b/raw_samples.h new file mode 100644 index 00000000000..3493f07fdb0 --- /dev/null +++ b/raw_samples.h @@ -0,0 +1,33 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +/* Our circular buffer of raw samples, used in order to display + * the signal. */ + +#define RAW_SAMPLES_NUM \ + 2048 /* Use a power of two: we take the modulo + of the index quite often to normalize inside + the range, and division is slow. */ +typedef struct RawSamplesBuffer { + FuriMutex* mutex; + struct { + uint16_t level : 1; + uint16_t dur : 15; + } samples[RAW_SAMPLES_NUM]; + uint32_t idx; /* Current idx (next to write). */ + uint32_t total; /* Total samples: same as RAW_SAMPLES_NUM, we provide + this field for a cleaner interface with the user, but + we always use RAW_SAMPLES_NUM when taking the modulo so + the compiler can optimize % as bit masking. */ + /* Signal features. */ + uint32_t short_pulse_dur; /* Duration of the shortest pulse. */ +} RawSamplesBuffer; + +RawSamplesBuffer* raw_samples_alloc(void); +void raw_samples_reset(RawSamplesBuffer* s); +void raw_samples_center(RawSamplesBuffer* s, uint32_t offset); +void raw_samples_add(RawSamplesBuffer* s, bool level, uint32_t dur); +void raw_samples_add_or_update(RawSamplesBuffer* s, bool level, uint32_t dur); +void raw_samples_get(RawSamplesBuffer* s, uint32_t idx, bool* level, uint32_t* dur); +void raw_samples_copy(RawSamplesBuffer* dst, RawSamplesBuffer* src); +void raw_samples_free(RawSamplesBuffer* s); diff --git a/signal.c b/signal.c new file mode 100644 index 00000000000..71fbe823fc0 --- /dev/null +++ b/signal.c @@ -0,0 +1,692 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +bool decode_signal(RawSamplesBuffer* s, uint64_t len, ProtoViewMsgInfo* info); + +/* ============================================================================= + * Protocols table. + * + * Supported protocols go here, with the relevant implementation inside + * protocols/.c + * ===========================================================================*/ + +extern ProtoViewDecoder Oregon2Decoder; +extern ProtoViewDecoder B4B1Decoder; +extern ProtoViewDecoder RenaultTPMSDecoder; +extern ProtoViewDecoder ToyotaTPMSDecoder; +extern ProtoViewDecoder SchraderTPMSDecoder; +extern ProtoViewDecoder SchraderEG53MA4TPMSDecoder; +extern ProtoViewDecoder CitroenTPMSDecoder; +extern ProtoViewDecoder FordTPMSDecoder; +extern ProtoViewDecoder KeeloqDecoder; +extern ProtoViewDecoder ProtoViewChatDecoder; +extern ProtoViewDecoder UnknownDecoder; + +ProtoViewDecoder* Decoders[] = { + &Oregon2Decoder, /* Oregon sensors v2.1 protocol. */ + &B4B1Decoder, /* PT, SC, ... 24 bits remotes. */ + &RenaultTPMSDecoder, /* Renault TPMS. */ + &ToyotaTPMSDecoder, /* Toyota TPMS. */ + &SchraderTPMSDecoder, /* Schrader TPMS. */ + &SchraderEG53MA4TPMSDecoder, /* Schrader EG53MA4 TPMS. */ + &CitroenTPMSDecoder, /* Citroen TPMS. */ + &FordTPMSDecoder, /* Ford TPMS. */ + &KeeloqDecoder, /* Keeloq remote. */ + &ProtoViewChatDecoder, /* Protoview simple text messages. */ + + /* Warning: the following decoder must stay at the end of the + * list. Otherwise would detect most signals and prevent the actaul + * decoders from handling them. */ + &UnknownDecoder, /* General protocol detector. */ + NULL}; + +/* ============================================================================= + * Raw signal detection + * ===========================================================================*/ + +/* Return the time difference between a and b, always >= 0 since + * the absolute value is returned. */ +uint32_t duration_delta(uint32_t a, uint32_t b) { + return a > b ? a - b : b - a; +} + +/* Reset the current signal, so that a new one can be detected. */ +void reset_current_signal(ProtoViewApp* app) { + app->signal_bestlen = 0; + app->signal_offset = 0; + app->signal_decoded = false; + raw_samples_reset(DetectedSamples); + raw_samples_reset(RawSamples); + free_msg_info(app->msg_info); + app->msg_info = NULL; +} + +/* This function starts scanning samples at offset idx looking for the + * longest run of pulses, either high or low, that are not much different + * from each other, for a maximum of three duration classes. + * So for instance 50 successive pulses that are roughly long 340us or 670us + * will be sensed as a coherent signal (example: 312, 361, 700, 334, 667, ...) + * + * The classes are counted separtely for high and low signals (RF on / off) + * because many devices tend to have different pulse lenghts depending on + * the level of the pulse. + * + * For instance Oregon2 sensors, in the case of protocol 2.1 will send + * pulses of ~400us (RF on) VS ~580us (RF off). */ +#define SEARCH_CLASSES 3 +uint32_t search_coherent_signal(RawSamplesBuffer* s, uint32_t idx, uint32_t min_duration) { + struct { + uint32_t dur[2]; /* dur[0] = low, dur[1] = high */ + uint32_t count[2]; /* Associated observed frequency. */ + } classes[SEARCH_CLASSES]; + + memset(classes, 0, sizeof(classes)); + + // Set a min/max duration limit for samples to be considered part of a + // coherent signal. The maximum length is fixed while the minimum + // is passed as argument, as depends on the data rate and in general + // on the signal to analyze. + uint32_t max_duration = 4000; + + uint32_t len = 0; /* Observed len of coherent samples. */ + s->short_pulse_dur = 0; + for(uint32_t j = idx; j < idx + s->total; j++) { + bool level; + uint32_t dur; + raw_samples_get(s, j, &level, &dur); + + if(dur < min_duration || dur > max_duration) break; /* return. */ + + /* Let's see if it matches a class we already have or if we + * can populate a new (yet empty) class. */ + uint32_t k; + for(k = 0; k < SEARCH_CLASSES; k++) { + if(classes[k].count[level] == 0) { + classes[k].dur[level] = dur; + classes[k].count[level] = 1; + break; /* Sample accepted. */ + } else { + uint32_t classavg = classes[k].dur[level]; + uint32_t count = classes[k].count[level]; + uint32_t delta = duration_delta(dur, classavg); + /* Is the difference in duration between this signal and + * the class we are inspecting less than a given percentage? + * If so, accept this signal. */ + if(delta < classavg / 5) { /* 100%/5 = 20%. */ + /* It is useful to compute the average of the class + * we are observing. We know how many samples we got so + * far, so we can recompute the average easily. + * By always having a better estimate of the pulse len + * we can avoid missing next samples in case the first + * observed samples are too off. */ + classavg = ((classavg * count) + dur) / (count + 1); + classes[k].dur[level] = classavg; + classes[k].count[level]++; + break; /* Sample accepted. */ + } + } + } + + if(k == SEARCH_CLASSES) break; /* No match, return. */ + + /* If we are here, we accepted this sample. Try with the next + * one. */ + len++; + } + + /* Update the buffer setting the shortest pulse we found + * among the three classes. This will be used when scaling + * for visualization. */ + uint32_t short_dur[2] = {0, 0}; + for(int j = 0; j < SEARCH_CLASSES; j++) { + for(int level = 0; level < 2; level++) { + if(classes[j].dur[level] == 0) continue; + if(classes[j].count[level] < 3) continue; + if(short_dur[level] == 0 || short_dur[level] > classes[j].dur[level]) { + short_dur[level] = classes[j].dur[level]; + } + } + } + + /* Use the average between high and low short pulses duration. + * Often they are a bit different, and using the average is more robust + * when we do decoding sampling at short_pulse_dur intervals. */ + if(short_dur[0] == 0) short_dur[0] = short_dur[1]; + if(short_dur[1] == 0) short_dur[1] = short_dur[0]; + s->short_pulse_dur = (short_dur[0] + short_dur[1]) / 2; + + return len; +} + +/* Called when we detect a message. Just blinks when the message was + * not decoded. Vibrates, too, when the message was correctly decoded. */ +void notify_signal_detected(ProtoViewApp* app, bool decoded) { + static const NotificationSequence decoded_seq = { + &message_vibro_on, + &message_green_255, + &message_delay_50, + &message_green_0, + &message_vibro_off, + NULL}; + + static const NotificationSequence unknown_seq = { + &message_red_255, &message_delay_50, &message_red_0, NULL}; + + if(decoded) + notification_message(app->notification, &decoded_seq); + else + notification_message(app->notification, &unknown_seq); +} + +/* Search the source buffer with the stored signal (last N samples received) + * in order to find a coherent signal. If a signal that does not appear to + * be just noise is found, it is set in DetectedSamples global signal + * buffer, that is what is rendered on the screen. */ +void scan_for_signal(ProtoViewApp* app, RawSamplesBuffer* source, uint32_t min_duration) { + /* We need to work on a copy: the source buffer may be populated + * by the background thread receiving data. */ + RawSamplesBuffer* copy = raw_samples_alloc(); + raw_samples_copy(copy, source); + + /* Try to seek on data that looks to have a regular high low high low + * pattern. */ + uint32_t minlen = 18; /* Min run of coherent samples. With less + than a few samples it's very easy to + mistake noise for signal. */ + + uint32_t i = 0; + + while(i < copy->total - 1) { + uint32_t thislen = search_coherent_signal(copy, i, min_duration); + + /* For messages that are long enough, attempt decoding. */ + if(thislen > minlen) { + /* Allocate the message information that some decoder may + * fill, in case it is able to decode a message. */ + ProtoViewMsgInfo* info = malloc(sizeof(ProtoViewMsgInfo)); + init_msg_info(info, app); + info->short_pulse_dur = copy->short_pulse_dur; + + uint32_t saved_idx = copy->idx; /* Save index, see later. */ + + /* decode_signal() expects the detected signal to start + * from index zero .*/ + raw_samples_center(copy, i); + bool decoded = decode_signal(copy, thislen, info); + copy->idx = saved_idx; /* Restore the index as we are scanning + the signal in the loop. */ + + /* Accept this signal as the new signal if either it's longer + * than the previous undecoded one, or the previous one was + * unknown and this is decoded. */ + bool oldsignal_not_decoded = app->signal_decoded == false || + app->msg_info->decoder == &UnknownDecoder; + + if(oldsignal_not_decoded && + (thislen > app->signal_bestlen || (decoded && info->decoder != &UnknownDecoder))) { + free_msg_info(app->msg_info); + app->msg_info = info; + app->signal_bestlen = thislen; + app->signal_decoded = decoded; + raw_samples_copy(DetectedSamples, copy); + raw_samples_center(DetectedSamples, i); + FURI_LOG_E( + TAG, + "===> Displayed sample updated (%d samples %lu us)", + (int)thislen, + DetectedSamples->short_pulse_dur); + + adjust_raw_view_scale(app, DetectedSamples->short_pulse_dur); + if(app->msg_info->decoder != &UnknownDecoder) notify_signal_detected(app, decoded); + } else { + /* If the structure was not filled, discard it. Otherwise + * now the owner is app->msg_info. */ + free_msg_info(info); + } + } + i += thislen ? thislen : 1; + } + raw_samples_free(copy); +} + +/* ============================================================================= + * Decoding + * + * The following code will translates the raw singals as received by + * the CC1101 into logical signals: a bitmap of 0s and 1s sampled at + * the detected data clock interval. + * + * Then the converted signal is passed to the protocols decoders, that look + * for protocol-specific information. We stop at the first decoder that is + * able to decode the data, so protocols here should be registered in + * order of complexity and specificity, with the generic ones at the end. + * ===========================================================================*/ + +/* Set the 'bitpos' bit to value 'val', in the specified bitmap + * 'b' of len 'blen'. + * Out of range bits will silently be discarded. */ +void bitmap_set(uint8_t* b, uint32_t blen, uint32_t bitpos, bool val) { + uint32_t byte = bitpos / 8; + uint32_t bit = 7 - (bitpos & 7); + if(byte >= blen) return; + if(val) + b[byte] |= 1 << bit; + else + b[byte] &= ~(1 << bit); +} + +/* Get the bit 'bitpos' of the bitmap 'b' of 'blen' bytes. + * Out of range bits return false (not bit set). */ +bool bitmap_get(uint8_t* b, uint32_t blen, uint32_t bitpos) { + uint32_t byte = bitpos / 8; + uint32_t bit = 7 - (bitpos & 7); + if(byte >= blen) return 0; + return (b[byte] & (1 << bit)) != 0; +} + +/* Copy 'count' bits from the bitmap 's' of 'slen' total bytes, to the + * bitmap 'd' of 'dlen' total bytes. The bits are copied starting from + * offset 'soff' of the source bitmap to the offset 'doff' of the + * destination bitmap. */ +void bitmap_copy( + uint8_t* d, + uint32_t dlen, + uint32_t doff, + uint8_t* s, + uint32_t slen, + uint32_t soff, + uint32_t count) { + /* If we are byte-aligned in both source and destination, use a fast + * path for the number of bytes we can consume this way. */ + if((doff & 7) == 0 && (soff & 7) == 0) { + uint32_t didx = doff / 8; + uint32_t sidx = soff / 8; + while(count > 8 && didx < dlen && sidx < slen) { + d[didx++] = s[sidx++]; + count -= 8; + } + doff = didx * 8; + soff = sidx * 8; + /* Note that if we entered this path, the count at the end + * of the loop will be < 8. */ + } + + /* Copy the bits needed to reach an offset where we can copy + * two half bytes of src to a full byte of destination. */ + while(count > 8 && (doff & 7) != 0) { + bool bit = bitmap_get(s, slen, soff++); + bitmap_set(d, dlen, doff++, bit); + count--; + } + + /* If we are here and count > 8, we have an offset that is byte aligned + * to the destination bitmap, but not aligned to the source bitmap. + * We can copy fast enough by shifting each two bytes of the original + * bitmap. + * + * This is how it works: + * + * dst: + * +--------+--------+--------+ + * | 0 | 1 | 2 | + * | | | | <- data to fill + * +--------+--------+--------+ + * ^ + * | + * doff = 8 + * + * src: + * +--------+--------+--------+ + * | 0 | 1 | 2 | + * |hellowor|ld!HELLO|WORLDS!!| <- data to copy + * +--------+--------+--------+ + * ^ + * | + * soff = 11 + * + * skew = 11%8 = 3 + * each destination byte in dst will receive: + * + * dst[doff/8] = (src[soff/8] << skew) | (src[soff/8+1] >> (8-skew)) + * + * dstbyte = doff/8 = 8/8 = 1 + * srcbyte = soff/8 = 11/8 = 1 + * + * so dst[1] will get: + * src[1] << 3, that is "ld!HELLO" << 3 = "HELLO..." + * xored with + * src[2] << 5, that is "WORLDS!!" >> 5 = ".....WOR" + * That is "HELLOWOR" + */ + if(count > 8) { + uint8_t skew = soff % 8; /* Don't worry, compiler will optimize. */ + uint32_t didx = doff / 8; + uint32_t sidx = soff / 8; + while(count > 8 && didx < dlen && sidx < slen) { + d[didx] = ((s[sidx] << skew) | (s[sidx + 1] >> (8 - skew))); + sidx++; + didx++; + soff += 8; + doff += 8; + count -= 8; + } + } + + /* Here count is guaranteed to be < 8. + * Copy the final bits bit by bit. */ + while(count) { + bool bit = bitmap_get(s, slen, soff++); + bitmap_set(d, dlen, doff++, bit); + count--; + } +} + +/* We decode bits assuming the first bit we receive is the MSB + * (see bitmap_set/get functions). Certain devices send data + * encoded in the reverse way. */ +void bitmap_reverse_bytes_bits(uint8_t* p, uint32_t len) { + for(uint32_t j = 0; j < len; j++) { + uint32_t b = p[j]; + /* Step 1: swap the two nibbles: 12345678 -> 56781234 */ + b = (b & 0xf0) >> 4 | (b & 0x0f) << 4; + /* Step 2: swap adjacent pairs : 56781234 -> 78563412 */ + b = (b & 0xcc) >> 2 | (b & 0x33) << 2; + /* Step 3: swap adjacent bits : 78563412 -> 87654321 */ + b = (b & 0xaa) >> 1 | (b & 0x55) << 1; + p[j] = b; + } +} + +/* Return true if the specified sequence of bits, provided as a string in the + * form "11010110..." is found in the 'b' bitmap of 'blen' bits at 'bitpos' + * position. */ +bool bitmap_match_bits(uint8_t* b, uint32_t blen, uint32_t bitpos, const char* bits) { + for(size_t j = 0; bits[j]; j++) { + bool expected = (bits[j] == '1') ? true : false; + if(bitmap_get(b, blen, bitpos + j) != expected) return false; + } + return true; +} + +/* Search for the specified bit sequence (see bitmap_match_bits() for details) + * in the bitmap 'b' of 'blen' bytes, looking forward at most 'maxbits' ahead. + * Returns the offset (in bits) of the match, or BITMAP_SEEK_NOT_FOUND if not + * found. + * + * Note: there are better algorithms, such as Boyer-Moore. Here we hope that + * for the kind of patterns we search we'll have a lot of early stops so + * we use a vanilla approach. */ +uint32_t bitmap_seek_bits( + uint8_t* b, + uint32_t blen, + uint32_t startpos, + uint32_t maxbits, + const char* bits) { + uint32_t endpos = startpos + blen * 8; + uint32_t end2 = startpos + maxbits; + if(end2 < endpos) endpos = end2; + for(uint32_t j = startpos; j < endpos; j++) + if(bitmap_match_bits(b, blen, j, bits)) return j; + return BITMAP_SEEK_NOT_FOUND; +} + +/* Compare bitmaps b1 and b2 (possibly overlapping or the same bitmap), + * at the specified offsets, for cmplen bits. Returns true if the + * exact same bits are found, otherwise false. */ +bool bitmap_match_bitmap( + uint8_t* b1, + uint32_t b1len, + uint32_t b1off, + uint8_t* b2, + uint32_t b2len, + uint32_t b2off, + uint32_t cmplen) { + for(uint32_t j = 0; j < cmplen; j++) { + bool bit1 = bitmap_get(b1, b1len, b1off + j); + bool bit2 = bitmap_get(b2, b2len, b2off + j); + if(bit1 != bit2) return false; + } + return true; +} + +/* Convert 'len' bitmap bits of the bitmap 'bitmap' into a null terminated + * string, stored at 'dst', that must have space at least for len+1 bytes. + * The bits are extracted from the specified offset. */ +void bitmap_to_string(char* dst, uint8_t* b, uint32_t blen, uint32_t off, uint32_t len) { + for(uint32_t j = 0; j < len; j++) dst[j] = bitmap_get(b, blen, off + j) ? '1' : '0'; + dst[len] = 0; +} + +/* Set the pattern 'pat' into the bitmap 'b' of max length 'blen' bytes, + * starting from the specified offset. + * + * The pattern is given as a string of 0s and 1s characters, like "01101001". + * This function is useful in order to set the test vectors in the protocol + * decoders, to see if the decoding works regardless of the fact we are able + * to actually receive a given signal. */ +void bitmap_set_pattern(uint8_t* b, uint32_t blen, uint32_t off, const char* pat) { + uint32_t i = 0; + while(pat[i]) { + bitmap_set(b, blen, i + off, pat[i] == '1'); + i++; + } +} + +/* Take the raw signal and turn it into a sequence of bits inside the + * buffer 'b'. Note that such 0s and 1s are NOT the actual data in the + * signal, but is just a low level representation of the line code. Basically + * if the short pulse we find in the signal is 320us, we convert high and + * low levels in the raw sample in this way: + * + * If for instance we see a high level lasting ~600 us, we will add + * two 1s bit. If then the signal goes down for 330us, we will add one zero, + * and so forth. So for each period of high and low we find the closest + * multiple and set the relevant number of bits. + * + * In case of a short pulse of 320us detected, 320*2 is the closest to a + * high pulse of 600us, so 2 bits will be set. + * + * In other terms what this function does is sampling the signal at + * fixed 'rate' intervals. + * + * This representation makes it simple to decode the signal at a higher + * level later, translating it from Marshal coding or other line codes + * to the actual bits/bytes. + * + * The 'idx' argument marks the detected signal start index into the + * raw samples buffer. The 'count' tells the function how many raw + * samples to convert into bits. The function returns the number of + * bits set into the buffer 'b'. The 'rate' argument, in microseconds, is + * the detected short-pulse duration. We expect the line code to be + * meaningful when interpreted at multiples of 'rate'. */ +uint32_t convert_signal_to_bits( + uint8_t* b, + uint32_t blen, + RawSamplesBuffer* s, + uint32_t idx, + uint32_t count, + uint32_t rate) { + if(rate == 0) return 0; /* We can't perform the conversion. */ + uint32_t bitpos = 0; + for(uint32_t j = 0; j < count; j++) { + uint32_t dur; + bool level; + raw_samples_get(s, j + idx, &level, &dur); + + uint32_t numbits = dur / rate; /* full bits that surely fit. */ + uint32_t rest = dur % rate; /* How much we are left with. */ + if(rest > rate / 2) numbits++; /* There is another one. */ + + /* Limit how much a single sample can spawn. There are likely no + * protocols doing such long pulses when the rate is low. */ + if(numbits > 1024) numbits = 1024; + + if(0) /* Super verbose, so not under the DEBUG_MSG define. */ + FURI_LOG_E(TAG, "%lu converted into %lu (%d) bits", dur, numbits, (int)level); + + /* If the signal is too short, let's claim it an interference + * and ignore it completely. */ + if(numbits == 0) continue; + + while(numbits--) bitmap_set(b, blen, bitpos++, level); + } + return bitpos; +} + +/* This function converts the line code used to the final data representation. + * The representation is put inside 'buf', for up to 'buflen' bytes of total + * data. For instance in order to convert manchester you can use "10" and "01" + * as zero and one patterns. However this function does not handle differential + * encodings. See below for convert_from_diff_manchester(). + * + * The function returns the number of bits converted. It will stop as soon + * as it finds a pattern that does not match zero or one patterns, or when + * the end of the bitmap pointed by 'bits' is reached (the length is + * specified in bytes by the caller, via the 'len' parameters). + * + * The decoding starts at the specified offset (in bits) 'off'. */ +uint32_t convert_from_line_code( + uint8_t* buf, + uint64_t buflen, + uint8_t* bits, + uint32_t len, + uint32_t off, + const char* zero_pattern, + const char* one_pattern) { + uint32_t decoded = 0; /* Number of bits extracted. */ + len *= 8; /* Convert bytes to bits. */ + while(off < len) { + bool bitval; + if(bitmap_match_bits(bits, len, off, zero_pattern)) { + bitval = false; + off += strlen(zero_pattern); + } else if(bitmap_match_bits(bits, len, off, one_pattern)) { + bitval = true; + off += strlen(one_pattern); + } else { + break; + } + bitmap_set(buf, buflen, decoded++, bitval); + if(decoded / 8 == buflen) break; /* No space left on target buffer. */ + } + return decoded; +} + +/* Convert the differential Manchester code to bits. This is similar to + * convert_from_line_code() but specific for diff-Manchester. The user must + * supply the value of the previous symbol before this stream, since + * in differential codings the next bits depend on the previous one. + * + * Parameters and return values are like convert_from_line_code(). */ +uint32_t convert_from_diff_manchester( + uint8_t* buf, + uint64_t buflen, + uint8_t* bits, + uint32_t len, + uint32_t off, + bool previous) { + uint32_t decoded = 0; + len *= 8; /* Conver to bits. */ + for(uint32_t j = off; j < len; j += 2) { + bool b0 = bitmap_get(bits, len, j); + bool b1 = bitmap_get(bits, len, j + 1); + if(b0 == previous) break; /* Each new bit must switch value. */ + bitmap_set(buf, buflen, decoded++, b0 == b1); + previous = b1; + if(decoded / 8 == buflen) break; /* No space left on target buffer. */ + } + return decoded; +} + +/* Free the message info and allocated data. */ +void free_msg_info(ProtoViewMsgInfo* i) { + if(i == NULL) return; + fieldset_free(i->fieldset); + free(i->bits); + free(i); +} + +/* Reset the message info structure before passing it to the decoding + * functions. */ +void init_msg_info(ProtoViewMsgInfo* i, ProtoViewApp* app) { + UNUSED(app); + memset(i, 0, sizeof(ProtoViewMsgInfo)); + i->bits = NULL; + i->fieldset = fieldset_new(); +} + +/* This function is called when a new signal is detected. It converts it + * to a bitstream, and the calls the protocol specific functions for + * decoding. If the signal was decoded correctly by some protocol, true + * is returned. Otherwise false is returned. */ +bool decode_signal(RawSamplesBuffer* s, uint64_t len, ProtoViewMsgInfo* info) { + uint32_t bitmap_bits_size = 4096 * 8; + uint32_t bitmap_size = bitmap_bits_size / 8; + + /* We call the decoders with an offset a few samples before the actual + * signal detected and for a len of a few bits after its end. */ + uint32_t before_samples = 32; + uint32_t after_samples = 100; + + uint8_t* bitmap = malloc(bitmap_size); + uint32_t bits = convert_signal_to_bits( + bitmap, + bitmap_size, + s, + -before_samples, + len + before_samples + after_samples, + s->short_pulse_dur); + + if(DEBUG_MSG) { /* Useful for debugging purposes. Don't remove. */ + char* str = malloc(1024); + uint32_t j; + for(j = 0; j < bits && j < 1023; j++) { + str[j] = bitmap_get(bitmap, bitmap_size, j) ? '1' : '0'; + } + str[j] = 0; + FURI_LOG_E(TAG, "%lu bits sampled: %s", bits, str); + free(str); + } + + /* Try all the decoders available. */ + int j = 0; + + bool decoded = false; + while(Decoders[j]) { + uint32_t start_time = furi_get_tick(); + decoded = Decoders[j]->decode(bitmap, bitmap_size, bits, info); + uint32_t delta = furi_get_tick() - start_time; + FURI_LOG_E(TAG, "Decoder %s took %lu ms", Decoders[j]->name, (unsigned long)delta); + if(decoded) { + info->decoder = Decoders[j]; + break; + } + j++; + } + + if(!decoded) { + FURI_LOG_E(TAG, "No decoding possible"); + } else { + FURI_LOG_E(TAG, "+++ Decoded %s", info->decoder->name); + /* The message was correctly decoded: fill the info structure + * with the decoded signal. The decoder may not implement offset/len + * filling of the structure. In such case we have no info and + * pulses_count will be set to zero. */ + if(info->pulses_count) { + info->bits_bytes = (info->pulses_count + 7) / 8; // Round to full byte. + info->bits = malloc(info->bits_bytes); + bitmap_copy( + info->bits, + info->bits_bytes, + 0, + bitmap, + bitmap_size, + info->start_off, + info->pulses_count); + } + } + free(bitmap); + return decoded; +} diff --git a/signal_file.c b/signal_file.c new file mode 100644 index 00000000000..e7934d04bff --- /dev/null +++ b/signal_file.c @@ -0,0 +1,138 @@ +/* Copyright (C) 2023 Salvatore Sanfilippo -- All Rights Reserved + * Copyright (C) 2023 Maciej Wojtasik -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" +#include +#include + +/* ========================= Signal file operations ========================= */ + +/* This function saves the current logical signal on disk. What is saved here + * is not the signal as level and duration as we received it from CC1101, + * but it's logical representation stored in the app->msg_info bitmap, where + * each 1 or 0 means a puls or gap for the specified short pulse duration time + * (te). */ +bool save_signal(ProtoViewApp* app, const char* filename) { + /* We have a message at all? */ + if(app->msg_info == NULL || app->msg_info->pulses_count == 0) return false; + + Storage* storage = furi_record_open(RECORD_STORAGE); + FlipperFormat* file = flipper_format_file_alloc(storage); + Stream* stream = flipper_format_get_raw_stream(file); + FuriString* file_content = NULL; + bool success = true; + + if(flipper_format_file_open_always(file, filename)) { + /* Write the file header. */ + FuriString* file_content = furi_string_alloc(); + const char* preset_id = ProtoViewModulations[app->modulation].id; + + furi_string_printf( + file_content, + "Filetype: Flipper SubGhz RAW File\n" + "Version: 1\n" + "Frequency: %ld\n" + "Preset: %s\n", + app->frequency, + preset_id ? preset_id : "FuriHalSubGhzPresetCustom"); + + /* For custom modulations, we need to emit a set of registers. */ + if(preset_id == NULL) { + FuriString* custom = furi_string_alloc(); + uint8_t* regs = ProtoViewModulations[app->modulation].custom; + furi_string_printf( + custom, + "Custom_preset_module: CC1101\n" + "Custom_preset_data: "); + for(int j = 0; regs[j]; j += 2) { + furi_string_cat_printf(custom, "%02X %02X ", (int)regs[j], (int)regs[j + 1]); + } + // Add patable + furi_string_cat(custom, "00 00 C0 00 00 00 00 00 00 00 "); + //size_t len = furi_string_size(file_content); + //furi_string_set_char(custom, len - 1, '\n'); + furi_string_cat(custom, "\n"); + furi_string_cat(file_content, custom); + furi_string_free(custom); + } + + /* We always save raw files. */ + furi_string_cat_printf( + file_content, + "Protocol: RAW\n" + "RAW_Data: -10000\n"); // Start with 10 ms of gap + + /* Write header. */ + size_t len = furi_string_size(file_content); + if(stream_write(stream, (uint8_t*)furi_string_get_cstr(file_content), len) != len) { + FURI_LOG_W(TAG, "Short write to file"); + success = false; + goto write_err; + } + furi_string_reset(file_content); + + /* Write raw data sections. The Flipper subghz parser can't handle + * too much data on a single line, so we generate a new one + * every few samples. */ + uint32_t this_line_samples = 0; + uint32_t max_line_samples = 100; + uint32_t idx = 0; // Iindex in the signal bitmap. + ProtoViewMsgInfo* i = app->msg_info; + while(idx < i->pulses_count) { + bool level = bitmap_get(i->bits, i->bits_bytes, idx); + uint32_t te_times = 1; + idx++; + /* Count the duration of the current pulse/gap. */ + while(idx < i->pulses_count && bitmap_get(i->bits, i->bits_bytes, idx) == level) { + te_times++; + idx++; + } + // Invariant: after the loop 'idx' is at the start of the + // next gap or pulse. + + int32_t dur = (int32_t)i->short_pulse_dur * te_times; + if(level == 0) dur = -dur; /* Negative is gap in raw files. */ + + /* Emit the sample. If this is the first sample of the line, + * also emit the RAW_Data: field. */ + if(this_line_samples == 0) furi_string_cat_printf(file_content, "RAW_Data: "); + furi_string_cat_printf(file_content, "%d ", (int)dur); + this_line_samples++; + + /* Store the current set of samples on disk, when we reach a + * given number or the end of the signal. */ + bool end_reached = (idx == i->pulses_count); + if(this_line_samples == max_line_samples || end_reached) { + /* If that's the end, terminate the signal with a long + * gap. */ + if(end_reached) furi_string_cat_printf(file_content, "-10000 "); + + /* We always have a trailing space in the last sample. Make it + * a newline. */ + size_t len = furi_string_size(file_content); + furi_string_set_char(file_content, len - 1, '\n'); + + if(stream_write(stream, (uint8_t*)furi_string_get_cstr(file_content), len) != + len) { + FURI_LOG_W(TAG, "Short write to file"); + success = false; + goto write_err; + } + + /* Prepare for next line. */ + furi_string_reset(file_content); + this_line_samples = 0; + } + } + } else { + success = false; + FURI_LOG_W(TAG, "Unable to open file"); + } + +write_err: + furi_record_close(RECORD_STORAGE); + flipper_format_free(file); + if(file_content != NULL) furi_string_free(file_content); + return success; +} diff --git a/ui.c b/ui.c new file mode 100644 index 00000000000..b0251f09fbe --- /dev/null +++ b/ui.c @@ -0,0 +1,145 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +/* =========================== Subview handling ================================ + * Note that these are not the Flipper subviews, but the subview system + * implemented inside ProtoView. + * ========================================================================== */ + +/* Return the ID of the currently selected subview, of the current + * view. */ +int ui_get_current_subview(ProtoViewApp* app) { + return app->current_subview[app->current_view]; +} + +/* Called by view rendering callback that has subviews, to show small triangles + * facing down/up if there are other subviews the user can access with up + * and down. */ +void ui_show_available_subviews(Canvas* canvas, ProtoViewApp* app, int last_subview) { + int subview = ui_get_current_subview(app); + if(subview != 0) canvas_draw_triangle(canvas, 120, 5, 8, 5, CanvasDirectionBottomToTop); + if(subview != last_subview - 1) + canvas_draw_triangle(canvas, 120, 59, 8, 5, CanvasDirectionTopToBottom); +} + +/* Handle up/down keys when we are in a subview. If the function catched + * such keypress, it returns true, so that the actual view input callback + * knows it can just return ASAP without doing anything. */ +bool ui_process_subview_updown(ProtoViewApp* app, InputEvent input, int last_subview) { + int subview = ui_get_current_subview(app); + if(input.type == InputTypePress) { + if(input.key == InputKeyUp) { + if(subview != 0) app->current_subview[app->current_view]--; + return true; + } else if(input.key == InputKeyDown) { + if(subview != last_subview - 1) app->current_subview[app->current_view]++; + return true; + } + } + return false; +} + +/* ============================= Text input ==================================== + * Normally we just use our own private UI widgets. However for the text input + * widget, that is quite complex, visualizes a keyboard and must be standardized + * for user coherent experience, we use the one provided by the Flipper + * framework. The following two functions allow to show the keyboard to get + * text and later dismiss it. + * ========================================================================== */ + +/* Show the keyboard, take the user input and store it into the specified + * 'buffer' of 'buflen' total bytes. When the user is done, the done_callback + * is called passing the application context to it. Such callback needs + * to do whatever it wants with the input buffer and dismissi the keyboard + * calling: dismiss_keyboard(app); + * + * Note: if the buffer is not a null-termined zero string, what it contains will + * be used as initial input for the user. */ +void ui_show_keyboard( + ProtoViewApp* app, + char* buffer, + uint32_t buflen, + void (*done_callback)(void*)) { + app->show_text_input = true; + app->text_input_buffer = buffer; + app->text_input_buffer_len = buflen; + app->text_input_done_callback = done_callback; +} + +void ui_dismiss_keyboard(ProtoViewApp* app) { + view_dispatcher_stop(app->view_dispatcher); +} + +/* ================================= Alert ================================== */ + +/* Set an alert message to be shown over any currently active view, for + * the specified amount of time of 'ttl' milliseconds. */ +void ui_show_alert(ProtoViewApp* app, const char* text, uint32_t ttl) { + app->alert_dismiss_time = furi_get_tick() + furi_ms_to_ticks(ttl); + snprintf(app->alert_text, ALERT_MAX_LEN, "%s", text); +} + +/* Cancel the alert before its time has elapsed. */ +void ui_dismiss_alert(ProtoViewApp* app) { + app->alert_dismiss_time = 0; +} + +/* Show the alert if an alert is set. This is called after the currently + * active view displayed its stuff, so we overwrite the screen with the + * alert message. */ +void ui_draw_alert_if_needed(Canvas* canvas, ProtoViewApp* app) { + if(app->alert_dismiss_time == 0) { + /* No active alert. */ + return; + } else if(app->alert_dismiss_time < furi_get_tick()) { + /* Alert just expired. */ + ui_dismiss_alert(app); + return; + } + + /* Show the alert. A box with black border and a text inside. */ + canvas_set_font(canvas, FontPrimary); + uint8_t w = canvas_string_width(canvas, app->alert_text); + uint8_t h = 8; // Font height. + uint8_t text_x = 64 - (w / 2); + uint8_t text_y = 32 + 4; + uint8_t padding = 3; + canvas_set_color(canvas, ColorBlack); + canvas_draw_box( + canvas, text_x - padding, text_y - padding - h, w + padding * 2, h + padding * 2); + canvas_set_color(canvas, ColorWhite); + canvas_draw_box( + canvas, + text_x - padding + 1, + text_y - padding - h + 1, + w + padding * 2 - 2, + h + padding * 2 - 2); + canvas_set_color(canvas, ColorBlack); + canvas_draw_str(canvas, text_x, text_y, app->alert_text); +} + +/* =========================== Canvas extensions ============================ */ + +void canvas_draw_str_with_border( + Canvas* canvas, + uint8_t x, + uint8_t y, + const char* str, + Color text_color, + Color border_color) { + struct { + uint8_t x; + uint8_t y; + } dir[8] = {{-1, -1}, {0, -1}, {1, -1}, {1, 0}, {1, 1}, {0, 1}, {-1, 1}, {-1, 0}}; + + /* Rotate in all the directions writing the same string to create a + * border, then write the actual string in the other color in the + * middle. */ + canvas_set_color(canvas, border_color); + for(int j = 0; j < 8; j++) canvas_draw_str(canvas, x + dir[j].x, y + dir[j].y, str); + canvas_set_color(canvas, text_color); + canvas_draw_str(canvas, x, y, str); + canvas_set_color(canvas, ColorBlack); +} diff --git a/view_build.c b/view_build.c new file mode 100644 index 00000000000..57e6e4fbcc8 --- /dev/null +++ b/view_build.c @@ -0,0 +1,248 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +extern ProtoViewDecoder* Decoders[]; // Defined in signal.c. + +/* Our view private data. */ +#define USER_VALUE_LEN 64 +typedef struct { + ProtoViewDecoder* decoder; /* Decoder we are using to create a + message. */ + uint32_t cur_decoder; /* Decoder index when we are yet selecting + a decoder. Used when decoder is NULL. */ + ProtoViewFieldSet* fieldset; /* The fields to populate. */ + uint32_t cur_field; /* Field we are editing right now. This + is the index inside the 'fieldset' + fields. */ + char* user_value; /* Keyboard input to replace the current + field value goes here. */ +} BuildViewPrivData; + +/* Not all the decoders support message bulding, so we can't just + * increment / decrement the cur_decoder index here. */ +static void select_next_decoder(ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + do { + privdata->cur_decoder++; + if(Decoders[privdata->cur_decoder] == NULL) privdata->cur_decoder = 0; + } while(Decoders[privdata->cur_decoder]->get_fields == NULL); +} + +/* Like select_next_decoder() but goes backward. */ +static void select_prev_decoder(ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + do { + if(privdata->cur_decoder == 0) { + /* Go one after the last one to wrap around. */ + while(Decoders[privdata->cur_decoder]) privdata->cur_decoder++; + } + privdata->cur_decoder--; + } while(Decoders[privdata->cur_decoder]->get_fields == NULL); +} + +/* Render the view to select the decoder, among the ones that + * support message building. */ +static void render_view_select_decoder(Canvas* const canvas, ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + canvas_set_font(canvas, FontPrimary); + canvas_draw_str(canvas, 0, 9, "Signal creator"); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 0, 19, "up/down: select, ok: choose"); + + canvas_set_font(canvas, FontPrimary); + canvas_draw_str_aligned( + canvas, 64, 38, AlignCenter, AlignCenter, Decoders[privdata->cur_decoder]->name); +} + +/* Render the view that allows the user to populate the fields needed + * for the selected decoder to build a message. */ +static void render_view_set_fields(Canvas* const canvas, ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + char buf[32]; + snprintf( + buf, + sizeof(buf), + "%s field %d/%d", + privdata->decoder->name, + (int)privdata->cur_field + 1, + (int)privdata->fieldset->numfields); + canvas_set_color(canvas, ColorBlack); + canvas_draw_box(canvas, 0, 0, 128, 21); + canvas_set_color(canvas, ColorWhite); + canvas_set_font(canvas, FontPrimary); + canvas_draw_str(canvas, 1, 9, buf); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 1, 19, "up/down: next field, ok: edit"); + + /* Write the field name, type, current content. */ + canvas_set_color(canvas, ColorBlack); + ProtoViewField* field = privdata->fieldset->fields[privdata->cur_field]; + snprintf( + buf, sizeof(buf), "%s %s:%d", field->name, field_get_type_name(field), (int)field->len); + buf[0] = toupper(buf[0]); + canvas_set_font(canvas, FontPrimary); + canvas_draw_str_aligned(canvas, 64, 30, AlignCenter, AlignCenter, buf); + canvas_set_font(canvas, FontSecondary); + + /* Render the current value between "" */ + unsigned int written = (unsigned int)field_to_string(buf + 1, sizeof(buf) - 1, field); + buf[0] = '"'; + if(written + 3 < sizeof(buf)) memcpy(buf + written + 1, "\"\x00", 2); + canvas_draw_str_aligned(canvas, 63, 45, AlignCenter, AlignCenter, buf); + + /* Footer instructions. */ + canvas_draw_str(canvas, 0, 62, "Long ok: create, < > incr/decr"); +} + +/* Render the build message view. */ +void render_view_build_message(Canvas* const canvas, ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + + if(privdata->decoder) + render_view_set_fields(canvas, app); + else + render_view_select_decoder(canvas, app); +} + +/* Handle input for the decoder selection. */ +static void process_input_select_decoder(ProtoViewApp* app, InputEvent input) { + BuildViewPrivData* privdata = app->view_privdata; + if(input.type == InputTypeShort) { + if(input.key == InputKeyOk) { + privdata->decoder = Decoders[privdata->cur_decoder]; + privdata->fieldset = fieldset_new(); + privdata->decoder->get_fields(privdata->fieldset); + + /* If the currently decoded message was produced with the + * same decoder the user selected, let's populate the + * defaults with the current values. So the user will + * actaully edit the current message. */ + if(app->signal_decoded && app->msg_info->decoder == privdata->decoder) { + fieldset_copy_matching_fields(privdata->fieldset, app->msg_info->fieldset); + } + + /* Now we use the subview system in order to protect the + message editing mode from accidental < or > presses. + Since we are technically into a subview now, we'll have + control of < and >. */ + InputEvent ii = {.type = InputTypePress, .key = InputKeyDown}; + ui_process_subview_updown(app, ii, 2); + } else if(input.key == InputKeyDown) { + select_next_decoder(app); + } else if(input.key == InputKeyUp) { + select_prev_decoder(app); + } + } +} + +/* Called after the user typed the new field value in the keyboard. + * Let's save it and remove the keyboard view. */ +static void text_input_done_callback(void* context) { + ProtoViewApp* app = context; + BuildViewPrivData* privdata = app->view_privdata; + + if(field_set_from_string( + privdata->fieldset->fields[privdata->cur_field], + privdata->user_value, + strlen(privdata->user_value)) == false) { + ui_show_alert(app, "Invalid value", 1500); + } + + free(privdata->user_value); + privdata->user_value = NULL; + ui_dismiss_keyboard(app); +} + +/* Handles the effects of < and > keys in field editing mode. + * Instead of force the user to enter the text input mode, delete + * the old value, enter the one, we allow to increment and + * decrement the current field in a much simpler way. + * + * The current filed is changed by 'incr' amount. */ +static bool increment_current_field(ProtoViewApp* app, int incr) { + BuildViewPrivData* privdata = app->view_privdata; + ProtoViewFieldSet* fs = privdata->fieldset; + ProtoViewField* f = fs->fields[privdata->cur_field]; + return field_incr_value(f, incr); +} + +/* Handle input for fields editing mode. */ +static void process_input_set_fields(ProtoViewApp* app, InputEvent input) { + BuildViewPrivData* privdata = app->view_privdata; + ProtoViewFieldSet* fs = privdata->fieldset; + + if(input.type == InputTypeShort && input.key == InputKeyOk) { + /* Show the keyboard to let the user type the new + * value. */ + if(privdata->user_value == NULL) privdata->user_value = malloc(USER_VALUE_LEN); + field_to_string(privdata->user_value, USER_VALUE_LEN, fs->fields[privdata->cur_field]); + ui_show_keyboard(app, privdata->user_value, USER_VALUE_LEN, text_input_done_callback); + } else if(input.type == InputTypeShort && input.key == InputKeyDown) { + privdata->cur_field = (privdata->cur_field + 1) % fs->numfields; + } else if(input.type == InputTypeShort && input.key == InputKeyUp) { + if(privdata->cur_field == 0) + privdata->cur_field = fs->numfields - 1; + else + privdata->cur_field--; + } else if(input.type == InputTypeShort && input.key == InputKeyRight) { + increment_current_field(app, 1); + } else if(input.type == InputTypeShort && input.key == InputKeyLeft) { + increment_current_field(app, -1); + } else if(input.type == InputTypeRepeat && input.key == InputKeyRight) { + // The reason why we don't use a large increment directly + // is that certain field types only support +1 -1 increments. + int times = 10; + while(times--) increment_current_field(app, 1); + } else if(input.type == InputTypeRepeat && input.key == InputKeyLeft) { + int times = 10; + while(times--) increment_current_field(app, -1); + } else if(input.type == InputTypeLong && input.key == InputKeyOk) { + // Build the message in a fresh raw buffer. + if(privdata->decoder->build_message) { + RawSamplesBuffer* rs = raw_samples_alloc(); + privdata->decoder->build_message(rs, privdata->fieldset); + app->signal_decoded = false; // So that the new signal will be + // accepted as the current signal. + scan_for_signal(app, rs, 5); + raw_samples_free(rs); + ui_show_alert(app, "Done: press back key", 3000); + } + } +} + +/* Handle input for the build message view. */ +void process_input_build_message(ProtoViewApp* app, InputEvent input) { + BuildViewPrivData* privdata = app->view_privdata; + if(privdata->decoder) + process_input_set_fields(app, input); + else + process_input_select_decoder(app, input); +} + +/* Enter view callback. */ +void view_enter_build_message(ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + + // When we enter the view, the current decoder is just set to zero. + // Seek the next valid if needed. + if(Decoders[privdata->cur_decoder]->get_fields == NULL) { + select_next_decoder(app); + } + + // However if there is currently a decoded message, and the + // decoder of such message supports message building, let's + // select it. + if(app->signal_decoded && app->msg_info->decoder->get_fields && + app->msg_info->decoder->build_message) { + while(Decoders[privdata->cur_decoder] != app->msg_info->decoder) select_next_decoder(app); + } +} + +/* Called on exit for cleanup. */ +void view_exit_build_message(ProtoViewApp* app) { + BuildViewPrivData* privdata = app->view_privdata; + if(privdata->fieldset) fieldset_free(privdata->fieldset); + if(privdata->user_value) free(privdata->user_value); +} diff --git a/view_direct_sampling.c b/view_direct_sampling.c new file mode 100644 index 00000000000..f43c77042fd --- /dev/null +++ b/view_direct_sampling.c @@ -0,0 +1,173 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" +#include + +static void direct_sampling_timer_start(ProtoViewApp* app); +static void direct_sampling_timer_stop(ProtoViewApp* app); + +#define CAPTURED_BITMAP_BITS (128 * 64) +#define CAPTURED_BITMAP_BYTES (CAPTURED_BITMAP_BITS / 8) +#define DEFAULT_USEC_PER_PIXEL 50 +#define USEC_PER_PIXEL_SMALL_CHANGE 5 +#define USEC_PER_PIXEL_LARGE_CHANGE 25 +#define USEC_PER_PIXEL_MIN 5 +#define USEC_PER_PIXEL_MAX 300 +typedef struct { + uint8_t* captured; // Bitmap with the last captured screen. + uint32_t captured_idx; // Current index to write into the bitmap + uint32_t usec_per_pixel; // Number of useconds a pixel should represent + bool show_usage_info; +} DirectSamplingViewPrivData; + +/* Read directly from the G0 CC1101 pin, and draw a black or white + * dot depending on the level. */ +void render_view_direct_sampling(Canvas* const canvas, ProtoViewApp* app) { + DirectSamplingViewPrivData* privdata = app->view_privdata; + + if(!app->direct_sampling_enabled && privdata->show_usage_info) { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 2, 9, "Direct sampling displays the"); + canvas_draw_str(canvas, 2, 18, "the captured signal in real"); + canvas_draw_str(canvas, 2, 27, "time, like in a CRT TV set."); + canvas_draw_str(canvas, 2, 36, "Use UP/DOWN to change the"); + canvas_draw_str(canvas, 2, 45, "resolution (usec/pixel)."); + canvas_set_font(canvas, FontPrimary); + canvas_draw_str(canvas, 5, 60, "To start/stop, press OK"); + return; + } + privdata->show_usage_info = false; + + /* Draw on screen. */ + int idx = 0; + for(int y = 0; y < 64; y++) { + for(int x = 0; x < 128; x++) { + bool level = bitmap_get(privdata->captured, CAPTURED_BITMAP_BYTES, idx++); + if(level) canvas_draw_dot(canvas, x, y); + } + } + + char buf[32]; + snprintf(buf, sizeof(buf), "%lu usec/px", privdata->usec_per_pixel); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_with_border(canvas, 1, 60, buf, ColorWhite, ColorBlack); +} + +/* Handle input */ +void process_input_direct_sampling(ProtoViewApp* app, InputEvent input) { + DirectSamplingViewPrivData* privdata = app->view_privdata; + + if(input.type == InputTypePress && input.key == InputKeyOk) { + app->direct_sampling_enabled = !app->direct_sampling_enabled; + } + + if((input.key == InputKeyUp || input.key == InputKeyDown) && + (input.type == InputTypePress || input.type == InputTypeRepeat)) { + uint32_t change = input.type == InputTypePress ? USEC_PER_PIXEL_SMALL_CHANGE : + USEC_PER_PIXEL_LARGE_CHANGE; + if(input.key == InputKeyUp) change = -change; + privdata->usec_per_pixel += change; + if(privdata->usec_per_pixel < USEC_PER_PIXEL_MIN) + privdata->usec_per_pixel = USEC_PER_PIXEL_MIN; + else if(privdata->usec_per_pixel > USEC_PER_PIXEL_MAX) + privdata->usec_per_pixel = USEC_PER_PIXEL_MAX; + /* Update the timer frequency. */ + direct_sampling_timer_stop(app); + direct_sampling_timer_start(app); + } +} + +/* Enter view. Stop the subghz thread to prevent access as we read + * the CC1101 data directly. */ +void view_enter_direct_sampling(ProtoViewApp* app) { + /* Set view defaults. */ + DirectSamplingViewPrivData* privdata = app->view_privdata; + privdata->usec_per_pixel = DEFAULT_USEC_PER_PIXEL; + privdata->captured = malloc(CAPTURED_BITMAP_BYTES); + privdata->show_usage_info = true; + + if(app->txrx->txrx_state == TxRxStateRx && !app->txrx->debug_timer_sampling) { + subghz_devices_stop_async_rx(app->radio_device); + + /* To read data asynchronously directly from the view, we need + * to put the CC1101 back into reception mode (the previous call + * to stop the async RX will put it into idle) and configure the + * G0 pin for reading. */ + subghz_devices_set_rx(app->radio_device); + furi_hal_gpio_init( + subghz_devices_get_data_gpio(app->radio_device), + GpioModeInput, + GpioPullNo, + GpioSpeedLow); + } else { + raw_sampling_worker_stop(app); + } + + // Start the timer to capture raw data + direct_sampling_timer_start(app); +} + +/* Exit view. Restore the subghz thread. */ +void view_exit_direct_sampling(ProtoViewApp* app) { + DirectSamplingViewPrivData* privdata = app->view_privdata; + if(privdata->captured) free(privdata->captured); + app->direct_sampling_enabled = false; + + direct_sampling_timer_stop(app); + + /* Restart normal data feeding. */ + if(app->txrx->txrx_state == TxRxStateRx && !app->txrx->debug_timer_sampling) { + subghz_devices_start_async_rx(app->radio_device, protoview_rx_callback, NULL); + } else { + furi_hal_gpio_init( + subghz_devices_get_data_gpio(app->radio_device), + GpioModeInput, + GpioPullNo, + GpioSpeedLow); + raw_sampling_worker_start(app); + } +} + +/* =========================== Timer implementation ========================= */ + +static void ds_timer_isr(void* ctx) { + ProtoViewApp* app = ctx; + DirectSamplingViewPrivData* privdata = app->view_privdata; + + if(app->direct_sampling_enabled) { + bool level = furi_hal_gpio_read(subghz_devices_get_data_gpio(app->radio_device)); + bitmap_set(privdata->captured, CAPTURED_BITMAP_BYTES, privdata->captured_idx, level); + privdata->captured_idx = (privdata->captured_idx + 1) % CAPTURED_BITMAP_BITS; + } + LL_TIM_ClearFlag_UPDATE(TIM2); +} + +static void direct_sampling_timer_start(ProtoViewApp* app) { + DirectSamplingViewPrivData* privdata = app->view_privdata; + + furi_hal_bus_enable(FuriHalBusTIM2); + + LL_TIM_InitTypeDef tim_init = { + .Prescaler = 63, /* CPU frequency is ~64Mhz. */ + .CounterMode = LL_TIM_COUNTERMODE_UP, + .Autoreload = privdata->usec_per_pixel}; + + LL_TIM_Init(TIM2, &tim_init); + LL_TIM_SetClockSource(TIM2, LL_TIM_CLOCKSOURCE_INTERNAL); + LL_TIM_DisableCounter(TIM2); + LL_TIM_SetCounter(TIM2, 0); + furi_hal_interrupt_set_isr(FuriHalInterruptIdTIM2, ds_timer_isr, app); + LL_TIM_EnableIT_UPDATE(TIM2); + LL_TIM_EnableCounter(TIM2); +} + +static void direct_sampling_timer_stop(ProtoViewApp* app) { + UNUSED(app); + FURI_CRITICAL_ENTER(); + LL_TIM_DisableCounter(TIM2); + LL_TIM_DisableIT_UPDATE(TIM2); + furi_hal_interrupt_set_isr(FuriHalInterruptIdTIM2, NULL, NULL); + furi_hal_bus_disable(FuriHalBusTIM2); + FURI_CRITICAL_EXIT(); +} diff --git a/view_info.c b/view_info.c new file mode 100644 index 00000000000..75fc584111a --- /dev/null +++ b/view_info.c @@ -0,0 +1,332 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" +#include +#include + +/* This view has subviews accessible navigating up/down. This + * enumaration is used to track the currently active subview. */ +enum { + SubViewInfoMain, + SubViewInfoSave, + SubViewInfoLast, /* Just a sentinel. */ +}; + +/* Our view private data. */ +#define SAVE_FILENAME_LEN 64 +typedef struct { + /* Our save view displays an oscilloscope-alike resampled signal, + * so that the user can see what they are saving. With left/right + * you can move to next rows. Here we store where we are. */ + uint32_t signal_display_start_row; + char* filename; + uint8_t cur_info_page; // Info page to display. Useful when there are + // too many fields populated by the decoder that + // a single page is not enough. +} InfoViewPrivData; + +/* Draw the text label and value of the specified info field at x,y. */ +static void render_info_field(Canvas* const canvas, ProtoViewField* f, uint8_t x, uint8_t y) { + char buf[64]; + char strval[32]; + + field_to_string(strval, sizeof(strval), f); + snprintf(buf, sizeof(buf), "%s: %s", f->name, strval); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, x, y, buf); +} + +/* Render the view with the detected message information. */ +#define INFO_LINES_PER_PAGE 5 +static void render_subview_main(Canvas* const canvas, ProtoViewApp* app) { + InfoViewPrivData* privdata = app->view_privdata; + uint8_t pages = + (app->msg_info->fieldset->numfields + (INFO_LINES_PER_PAGE - 1)) / INFO_LINES_PER_PAGE; + privdata->cur_info_page %= pages; + uint8_t current_page = privdata->cur_info_page; + char buf[32]; + + /* Protocol name as title. */ + canvas_set_font(canvas, FontPrimary); + uint8_t y = 8, lineheight = 10; + + if(pages > 1) { + snprintf( + buf, sizeof(buf), "%s %u/%u", app->msg_info->decoder->name, current_page + 1, pages); + canvas_draw_str(canvas, 0, y, buf); + } else { + canvas_draw_str(canvas, 0, y, app->msg_info->decoder->name); + } + y += lineheight; + + /* Draw the info fields. */ + uint8_t max_lines = INFO_LINES_PER_PAGE; + uint32_t j = current_page * max_lines; + while(j < app->msg_info->fieldset->numfields) { + render_info_field(canvas, app->msg_info->fieldset->fields[j++], 0, y); + y += lineheight; + if(--max_lines == 0) break; + } + + /* Draw a vertical "save" label. Temporary solution, to switch to + * something better ASAP. */ + y = 37; + lineheight = 7; + canvas_draw_str(canvas, 119, y, "s"); + y += lineheight; + canvas_draw_str(canvas, 119, y, "a"); + y += lineheight; + canvas_draw_str(canvas, 119, y, "v"); + y += lineheight; + canvas_draw_str(canvas, 119, y, "e"); + y += lineheight; +} + +/* Render view with save option. */ +static void render_subview_save(Canvas* const canvas, ProtoViewApp* app) { + InfoViewPrivData* privdata = app->view_privdata; + + /* Display our signal in digital form: here we don't show the + * signal with the exact timing of the received samples, but as it + * is in its logic form, in exact multiples of the short pulse length. */ + uint8_t rows = 6; + uint8_t rowheight = 11; + uint8_t bitwidth = 4; + uint8_t bitheight = 5; + uint32_t idx = privdata->signal_display_start_row * (128 / 4); + bool prevbit = false; + for(uint8_t y = bitheight + 12; y <= rows * rowheight; y += rowheight) { + for(uint8_t x = 0; x < 128; x += 4) { + bool bit = bitmap_get(app->msg_info->bits, app->msg_info->bits_bytes, idx); + uint8_t prevy = y + prevbit * (bitheight * -1) - 1; + uint8_t thisy = y + bit * (bitheight * -1) - 1; + canvas_draw_line(canvas, x, prevy, x, thisy); + canvas_draw_line(canvas, x, thisy, x + bitwidth - 1, thisy); + prevbit = bit; + if(idx >= app->msg_info->pulses_count) { + canvas_set_color(canvas, ColorWhite); + canvas_draw_dot(canvas, x + 1, thisy); + canvas_draw_dot(canvas, x + 3, thisy); + canvas_set_color(canvas, ColorBlack); + } + idx++; // Draw next bit + } + } + + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 0, 6, "ok: send, long ok: save"); +} + +/* Render the selected subview of this view. */ +void render_view_info(Canvas* const canvas, ProtoViewApp* app) { + if(app->signal_decoded == false) { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 30, 36, "No signal decoded"); + return; + } + + ui_show_available_subviews(canvas, app, SubViewInfoLast); + switch(app->current_subview[app->current_view]) { + case SubViewInfoMain: + render_subview_main(canvas, app); + break; + case SubViewInfoSave: + render_subview_save(canvas, app); + break; + } +} + +/* The user typed the file name. Let's save it and remove the keyboard + * view. */ +static void text_input_done_callback(void* context) { + ProtoViewApp* app = context; + InfoViewPrivData* privdata = app->view_privdata; + + FuriString* save_path = + furi_string_alloc_printf("%s/%s.sub", EXT_PATH("subghz"), privdata->filename); + save_signal(app, furi_string_get_cstr(save_path)); + furi_string_free(save_path); + + free(privdata->filename); + privdata->filename = NULL; // Don't free it again on view exit + ui_dismiss_keyboard(app); + ui_show_alert(app, "Signal saved", 1500); +} + +/* Replace all the occurrences of character c1 with c2 in the specified + * string. */ +void str_replace(char* buf, char c1, char c2) { + char* p = buf; + while(*p) { + if(*p == c1) *p = c2; + p++; + } +} + +/* Set a random filename the user can edit. */ +void set_signal_random_filename(ProtoViewApp* app, char* buf, size_t buflen) { + char suffix[6]; + set_random_name(suffix, sizeof(suffix)); + snprintf(buf, buflen, "%.10s-%s-%d", app->msg_info->decoder->name, suffix, rand() % 1000); + str_replace(buf, ' ', '_'); + str_replace(buf, '-', '_'); + str_replace(buf, '/', '_'); +} + +/* ========================== Signal transmission =========================== */ + +/* This is the context we pass to the data yield callback for + * asynchronous tx. */ +typedef enum { + SendSignalSendStartGap, + SendSignalSendBits, + SendSignalSendEndGap, + SendSignalEndTransmission +} SendSignalState; + +#define PROTOVIEW_SENDSIGNAL_START_GAP 10000 /* microseconds. */ +#define PROTOVIEW_SENDSIGNAL_END_GAP 10000 /* microseconds. */ + +typedef struct { + SendSignalState state; // Current state. + uint32_t curpos; // Current bit position of data to send. + ProtoViewApp* app; // App reference. + uint32_t start_gap_dur; // Gap to send at the start. + uint32_t end_gap_dur; // Gap to send at the end. +} SendSignalCtx; + +/* Setup the state context for the callback responsible to feed data + * to the subghz async tx system. */ +static void send_signal_init(SendSignalCtx* ss, ProtoViewApp* app) { + ss->state = SendSignalSendStartGap; + ss->curpos = 0; + ss->app = app; + ss->start_gap_dur = PROTOVIEW_SENDSIGNAL_START_GAP; + ss->end_gap_dur = PROTOVIEW_SENDSIGNAL_END_GAP; +} + +/* Send signal data feeder callback. When the asynchronous transmission is + * active, this function is called to return new samples from the currently + * decoded signal in app->msg_info. The subghz subsystem aspects this function, + * that is the data feeder, to return LevelDuration types (that is a structure + * with level, that is pulse or gap, and duration in microseconds). + * + * The position into the transmission is stored in the context 'ctx', that + * references a SendSignalCtx structure. + * + * In the SendSignalCtx structure 'ss' we remember at which bit of the + * message we are, in ss->curoff. We also send a start and end gap in order + * to make sure the transmission is clear. + */ +LevelDuration radio_tx_feed_data(void* ctx) { + SendSignalCtx* ss = ctx; + + /* Send start gap. */ + if(ss->state == SendSignalSendStartGap) { + ss->state = SendSignalSendBits; + return level_duration_make(0, ss->start_gap_dur); + } + + /* Send data. */ + if(ss->state == SendSignalSendBits) { + uint32_t dur = 0, j; + uint32_t level = 0; + + /* Let's see how many consecutive bits we have with the same + * level. */ + for(j = 0; ss->curpos + j < ss->app->msg_info->pulses_count; j++) { + uint32_t l = + bitmap_get(ss->app->msg_info->bits, ss->app->msg_info->bits_bytes, ss->curpos + j); + if(j == 0) { + /* At the first bit of this sequence, we store the + * level of the sequence. */ + level = l; + dur += ss->app->msg_info->short_pulse_dur; + continue; + } + + /* As long as the level is the same, we update the duration. + * Otherwise stop the loop and return this sample. */ + if(l != level) break; + dur += ss->app->msg_info->short_pulse_dur; + } + ss->curpos += j; + + /* If this was the last set of bits, change the state to + * send the final gap. */ + if(ss->curpos >= ss->app->msg_info->pulses_count) ss->state = SendSignalSendEndGap; + return level_duration_make(level, dur); + } + + /* Send end gap. */ + if(ss->state == SendSignalSendEndGap) { + ss->state = SendSignalEndTransmission; + return level_duration_make(0, ss->end_gap_dur); + } + + /* End transmission. Here state is guaranteed + * to be SendSignalEndTransmission */ + return level_duration_reset(); +} + +/* Vibrate and produce a click sound when a signal is sent. */ +void notify_signal_sent(ProtoViewApp* app) { + static const NotificationSequence sent_seq = { + &message_blue_255, + &message_vibro_on, + &message_note_g1, + &message_delay_10, + &message_sound_off, + &message_vibro_off, + &message_blue_0, + NULL}; + notification_message(app->notification, &sent_seq); +} + +/* Handle input for the info view. */ +void process_input_info(ProtoViewApp* app, InputEvent input) { + /* If we don't have a decoded signal, we don't allow to go up/down + * in the subviews: they are only useful when a loaded signal. */ + if(app->signal_decoded && ui_process_subview_updown(app, input, SubViewInfoLast)) return; + + InfoViewPrivData* privdata = app->view_privdata; + int subview = ui_get_current_subview(app); + + /* Main subview. */ + if(subview == SubViewInfoMain) { + if(input.type == InputTypeLong && input.key == InputKeyOk) { + /* Reset the current sample to capture the next. */ + reset_current_signal(app); + } else if(input.type == InputTypeShort && input.key == InputKeyOk) { + /* Show next info page. */ + privdata->cur_info_page++; + } + } else if(subview == SubViewInfoSave) { + /* Save subview. */ + if(input.type == InputTypePress && input.key == InputKeyRight) { + privdata->signal_display_start_row++; + } else if(input.type == InputTypePress && input.key == InputKeyLeft) { + if(privdata->signal_display_start_row != 0) privdata->signal_display_start_row--; + } else if(input.type == InputTypeLong && input.key == InputKeyOk) { + // We have have the buffer already allocated, in case the + // user aborted with BACK a previous saving. + if(privdata->filename == NULL) privdata->filename = malloc(SAVE_FILENAME_LEN); + set_signal_random_filename(app, privdata->filename, SAVE_FILENAME_LEN); + ui_show_keyboard(app, privdata->filename, SAVE_FILENAME_LEN, text_input_done_callback); + } else if(input.type == InputTypeShort && input.key == InputKeyOk) { + SendSignalCtx send_state; + send_signal_init(&send_state, app); + radio_tx_signal(app, radio_tx_feed_data, &send_state); + notify_signal_sent(app); + } + } +} + +/* Called on view exit. */ +void view_exit_info(ProtoViewApp* app) { + InfoViewPrivData* privdata = app->view_privdata; + // When the user aborts the keyboard input, we are left with the + // filename buffer allocated. + if(privdata->filename) free(privdata->filename); +} diff --git a/view_raw_signal.c b/view_raw_signal.c new file mode 100644 index 00000000000..38354bef961 --- /dev/null +++ b/view_raw_signal.c @@ -0,0 +1,114 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +/* Render the received signal. + * + * The screen of the flipper is 128 x 64. Even using 4 pixels per line + * (where low level signal is one pixel high, high level is 4 pixels + * high) and 4 pixels of spacing between the different lines, we can + * plot comfortably 8 lines. + * + * The 'idx' argument is the first sample to render in the circular + * buffer. */ +void render_signal(ProtoViewApp* app, Canvas* const canvas, RawSamplesBuffer* buf, uint32_t idx) { + canvas_set_color(canvas, ColorBlack); + + int rows = 8; + uint32_t time_per_pixel = app->us_scale; + uint32_t start_idx = idx; + bool level = 0; + uint32_t dur = 0, sample_num = 0; + for(int row = 0; row < rows; row++) { + for(int x = 0; x < 128; x++) { + int y = 3 + row * 8; + if(dur < time_per_pixel / 2) { + /* Get more data. */ + raw_samples_get(buf, idx++, &level, &dur); + sample_num++; + } + + canvas_draw_line(canvas, x, y, x, y - (level * 3)); + + /* Write a small triangle under the last sample detected. */ + if(app->signal_bestlen != 0 && sample_num + start_idx == app->signal_bestlen + 1) { + canvas_draw_dot(canvas, x, y + 2); + canvas_draw_dot(canvas, x - 1, y + 3); + canvas_draw_dot(canvas, x, y + 3); + canvas_draw_dot(canvas, x + 1, y + 3); + sample_num++; /* Make sure we don't mark the next, too. */ + } + + /* Remove from the current level duration the time we + * just plot. */ + if(dur > time_per_pixel) + dur -= time_per_pixel; + else + dur = 0; + } + } +} + +/* Raw pulses rendering. This is our default view. */ +void render_view_raw_pulses(Canvas* const canvas, ProtoViewApp* app) { + /* Show signal. */ + render_signal(app, canvas, DetectedSamples, app->signal_offset); + + /* Show signal information. */ + char buf[64]; + snprintf(buf, sizeof(buf), "%luus", (unsigned long)DetectedSamples->short_pulse_dur); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_with_border(canvas, 97, 63, buf, ColorWhite, ColorBlack); + if(app->signal_decoded) { + canvas_set_font(canvas, FontPrimary); + canvas_draw_str_with_border( + canvas, 1, 61, app->msg_info->decoder->name, ColorWhite, ColorBlack); + } +} + +/* Handle input for the raw pulses view. */ +void process_input_raw_pulses(ProtoViewApp* app, InputEvent input) { + if(input.type == InputTypeRepeat) { + /* Handle panning of the signal window. Long pressing + * right will show successive samples, long pressing left + * previous samples. */ + if(input.key == InputKeyRight) + app->signal_offset++; + else if(input.key == InputKeyLeft) + app->signal_offset--; + } else if(input.type == InputTypeLong) { + if(input.key == InputKeyOk) { + /* Reset the current sample to capture the next. */ + reset_current_signal(app); + } + } else if(input.type == InputTypeShort) { + if(input.key == InputKeyOk) { + app->signal_offset = 0; + adjust_raw_view_scale(app, DetectedSamples->short_pulse_dur); + } else if(input.key == InputKeyDown) { + /* Rescaling. The set becomes finer under 50us per pixel. */ + uint32_t scale_step = app->us_scale >= 50 ? 50 : 10; + if(app->us_scale < 500) app->us_scale += scale_step; + } else if(input.key == InputKeyUp) { + uint32_t scale_step = app->us_scale > 50 ? 50 : 10; + if(app->us_scale > 10) app->us_scale -= scale_step; + } + } +} + +/* Adjust raw view scale depending on short pulse duration. */ +void adjust_raw_view_scale(ProtoViewApp* app, uint32_t short_pulse_dur) { + if(short_pulse_dur == 0) + app->us_scale = PROTOVIEW_RAW_VIEW_DEFAULT_SCALE; + else if(short_pulse_dur < 75) + app->us_scale = 10; + else if(short_pulse_dur < 145) + app->us_scale = 30; + else if(short_pulse_dur < 400) + app->us_scale = 100; + else if(short_pulse_dur < 1000) + app->us_scale = 200; + else + app->us_scale = PROTOVIEW_RAW_VIEW_DEFAULT_SCALE; +} diff --git a/view_settings.c b/view_settings.c new file mode 100644 index 00000000000..09abf5a2aeb --- /dev/null +++ b/view_settings.c @@ -0,0 +1,119 @@ +/* Copyright (C) 2022-2023 Salvatore Sanfilippo -- All Rights Reserved + * See the LICENSE file for information about the license. */ + +#include "app.h" + +/* Renders a single view with frequency and modulation setting. However + * this are logically two different views, and only one of the settings + * will be highlighted. */ +void render_view_settings(Canvas* const canvas, ProtoViewApp* app) { + canvas_set_font(canvas, FontPrimary); + if(app->current_view == ViewFrequencySettings) + canvas_draw_str_with_border(canvas, 1, 10, "Frequency", ColorWhite, ColorBlack); + else + canvas_draw_str(canvas, 1, 10, "Frequency"); + + if(app->current_view == ViewModulationSettings) + canvas_draw_str_with_border(canvas, 70, 10, "Modulation", ColorWhite, ColorBlack); + else + canvas_draw_str(canvas, 70, 10, "Modulation"); + canvas_set_font(canvas, FontSecondary); + canvas_draw_str(canvas, 10, 61, "Use up and down to modify"); + + if(app->txrx->debug_timer_sampling) + canvas_draw_str(canvas, 3, 52, "(DEBUG timer sampling is ON)"); + + /* Show frequency. We can use big numbers font since it's just a number. */ + if(app->current_view == ViewFrequencySettings) { + char buf[16]; + snprintf(buf, sizeof(buf), "%.2f", (double)app->frequency / 1000000); + canvas_set_font(canvas, FontBigNumbers); + canvas_draw_str(canvas, 30, 40, buf); + } else if(app->current_view == ViewModulationSettings) { + int current = app->modulation; + canvas_set_font(canvas, FontPrimary); + canvas_draw_str(canvas, 33, 39, ProtoViewModulations[current].name); + } +} + +/* Handle input for the settings view. */ +void process_input_settings(ProtoViewApp* app, InputEvent input) { + if(input.type == InputTypeLong && input.key == InputKeyOk) { + /* Long pressing to OK sets the default frequency and + * modulation. */ + app->frequency = subghz_setting_get_default_frequency(app->setting); + app->modulation = 0; + } else if(0 && input.type == InputTypeLong && input.key == InputKeyDown) { + /* Long pressing to down switches between normal and debug + * timer sampling mode. NOTE: this feature is disabled for users, + * only useful for devs (if useful at all). */ + + /* We have to stop the previous sampling system. */ + radio_rx_end(app); + + /* Then switch mode and start the new one. */ + app->txrx->debug_timer_sampling = !app->txrx->debug_timer_sampling; + radio_begin(app); + radio_rx(app); + } else if(input.type == InputTypePress && (input.key != InputKeyDown || input.key != InputKeyUp)) { + /* Handle up and down to change frequency or modulation. */ + if(app->current_view == ViewFrequencySettings) { + size_t curidx = 0, i; + size_t count = subghz_setting_get_frequency_count(app->setting); + + /* Scan the list of frequencies to check for the index of the + * currently set frequency. */ + for(i = 0; i < count; i++) { + uint32_t freq = subghz_setting_get_frequency(app->setting, i); + if(freq == app->frequency) { + curidx = i; + break; + } + } + if(i == count) return; /* Should never happen. */ + + if(input.key == InputKeyUp) { + curidx = curidx == 0 ? count - 1 : curidx - 1; + } else if(input.key == InputKeyDown) { + curidx = (curidx + 1) % count; + } else { + return; + } + app->frequency = subghz_setting_get_frequency(app->setting, curidx); + } else if(app->current_view == ViewModulationSettings) { + uint32_t count = 0; + uint32_t modid = app->modulation; + + while(ProtoViewModulations[count].name != NULL) count++; + if(input.key == InputKeyUp) { + modid = modid == 0 ? count - 1 : modid - 1; + } else if(input.key == InputKeyDown) { + modid = (modid + 1) % count; + } else { + return; + } + app->modulation = modid; + } + } else { + return; + } + + /* Apply changes when switching to other views. */ + app->txrx->freq_mod_changed = true; +} + +/* When the user switches to some other view, if they changed the parameters + * we need to restart the radio with the right frequency and modulation. */ +void view_exit_settings(ProtoViewApp* app) { + if(app->txrx->freq_mod_changed) { + FURI_LOG_E( + TAG, + "Setting view, setting frequency/modulation to %lu %s", + app->frequency, + ProtoViewModulations[app->modulation].name); + radio_rx_end(app); + radio_begin(app); + radio_rx(app); + app->txrx->freq_mod_changed = false; + } +}