New LF-RFID app (#534)

* Hal lfrfid: add read timer pulse and period config fns
* New debug application for lfrfid subsystem
* New lfrfid: app, fix naming
* App lfrfid: assets
* Container view module
* App ibutton: remove unused header
* App lfrfid scenes
* App notification, add yield to blocking operations, add speaker volume control
* App lfrfid: reading key scene
* Assets: placeholder icon
* App lfrfid: reworked container view module
* App lfrfid: new scenes
* App lfrfid: write scene
* App lfrfid: write hid
* App lfrfid: emulate scene
* App lfrfid: save name scene
* App lfrfid: add missing file

applications/lfrfid-debug/lfrfid-debug-app-launcher.cpp

@@ -0,0 +1,10 @@
+#include "lfrfid-debug-app.h"
+
+// app enter function
+extern "C" int32_t lfrfid_debug_app(void* p) {
+    LfRfidDebugApp* app = new LfRfidDebugApp();
+    app->run();
+    delete app;
+
+    return 0;
+}

applications/lfrfid-debug/lfrfid-debug-app.cpp

@@ -0,0 +1,16 @@
+#include "lfrfid-debug-app.h"
+#include "scene/lfrfid-debug-app-scene-start.h"
+#include "scene/lfrfid-debug-app-scene-tune.h"
+
+LfRfidDebugApp::LfRfidDebugApp()
+    : scene_controller{this} {
+}
+
+LfRfidDebugApp::~LfRfidDebugApp() {
+}
+
+void LfRfidDebugApp::run() {
+    scene_controller.add_scene(SceneType::Start, new LfRfidDebugAppSceneStart());
+    scene_controller.add_scene(SceneType::TuneScene, new LfRfidDebugAppSceneTune());
+    scene_controller.process(100);
+}

applications/lfrfid-debug/lfrfid-debug-app.h

@@ -0,0 +1,40 @@
+#pragma once
+#include <furi.h>
+#include <api-hal.h>
+
+#include <generic-scene.hpp>
+#include <scene-controller.hpp>
+#include <view-controller.hpp>
+
+#include <view-modules/submenu-vm.h>
+#include "view-modules/lfrfid-view-tune-vm.h"
+
+class LfRfidDebugApp {
+public:
+    enum class EventType : uint8_t {
+        GENERIC_EVENT_ENUM_VALUES,
+        MenuSelected,
+    };
+
+    enum class SceneType : uint8_t {
+        GENERIC_SCENE_ENUM_VALUES,
+        TuneScene,
+    };
+
+    class Event {
+    public:
+        union {
+            int32_t menu_index;
+        } payload;
+
+        EventType type;
+    };
+
+    SceneController<GenericScene<LfRfidDebugApp>, LfRfidDebugApp> scene_controller;
+    ViewController<LfRfidDebugApp, SubmenuVM, LfRfidViewTuneVM> view_controller;
+
+    ~LfRfidDebugApp();
+    LfRfidDebugApp();
+
+    void run();
+};

applications/lfrfid-debug/scene/lfrfid-debug-app-scene-start.cpp

@@ -0,0 +1,47 @@
+#include "lfrfid-debug-app-scene-start.h"
+
+typedef enum {
+    SubmenuTune,
+} SubmenuIndex;
+
+void LfRfidDebugAppSceneStart::on_enter(LfRfidDebugApp* app, bool need_restore) {
+    auto submenu = app->view_controller.get<SubmenuVM>();
+    auto callback = cbc::obtain_connector(this, &LfRfidDebugAppSceneStart::submenu_callback);
+
+    submenu->add_item("Tune", SubmenuTune, callback, app);
+
+    if(need_restore) {
+        submenu->set_selected_item(submenu_item_selected);
+    }
+    app->view_controller.switch_to<SubmenuVM>();
+}
+
+bool LfRfidDebugAppSceneStart::on_event(LfRfidDebugApp* app, LfRfidDebugApp::Event* event) {
+    bool consumed = false;
+
+    if(event->type == LfRfidDebugApp::EventType::MenuSelected) {
+        submenu_item_selected = event->payload.menu_index;
+        switch(event->payload.menu_index) {
+        case SubmenuTune:
+            app->scene_controller.switch_to_next_scene(LfRfidDebugApp::SceneType::TuneScene);
+            break;
+        }
+        consumed = true;
+    }
+
+    return consumed;
+}
+
+void LfRfidDebugAppSceneStart::on_exit(LfRfidDebugApp* app) {
+    app->view_controller.get<SubmenuVM>()->clean();
+}
+
+void LfRfidDebugAppSceneStart::submenu_callback(void* context, uint32_t index) {
+    LfRfidDebugApp* app = static_cast<LfRfidDebugApp*>(context);
+    LfRfidDebugApp::Event event;
+
+    event.type = LfRfidDebugApp::EventType::MenuSelected;
+    event.payload.menu_index = index;
+
+    app->view_controller.send_event(&event);
+}

applications/lfrfid-debug/scene/lfrfid-debug-app-scene-start.h

@@ -0,0 +1,13 @@
+#pragma once
+#include "../lfrfid-debug-app.h"
+
+class LfRfidDebugAppSceneStart : public GenericScene<LfRfidDebugApp> {
+public:
+    void on_enter(LfRfidDebugApp* app, bool need_restore) final;
+    bool on_event(LfRfidDebugApp* app, LfRfidDebugApp::Event* event) final;
+    void on_exit(LfRfidDebugApp* app) final;
+
+private:
+    void submenu_callback(void* context, uint32_t index);
+    uint32_t submenu_item_selected = 0;
+};

applications/lfrfid-debug/scene/lfrfid-debug-app-scene-tune.cpp

@@ -0,0 +1,28 @@
+#include "lfrfid-debug-app-scene-tune.h"
+
+void LfRfidDebugAppSceneTune::on_enter(LfRfidDebugApp* app, bool need_restore) {
+    app->view_controller.switch_to<LfRfidViewTuneVM>();
+
+    api_hal_rfid_pins_read();
+    api_hal_rfid_tim_read(125000, 0.5);
+    api_hal_rfid_tim_read_start();
+}
+
+bool LfRfidDebugAppSceneTune::on_event(LfRfidDebugApp* app, LfRfidDebugApp::Event* event) {
+    bool consumed = false;
+
+    LfRfidViewTuneVM* tune = app->view_controller;
+
+    if(tune->is_dirty()) {
+        api_hal_rfid_set_read_period(tune->get_ARR());
+        api_hal_rfid_set_read_pulse(tune->get_CCR());
+    }
+
+    return consumed;
+}
+
+void LfRfidDebugAppSceneTune::on_exit(LfRfidDebugApp* app) {
+    api_hal_rfid_tim_read_stop();
+    api_hal_rfid_tim_reset();
+    api_hal_rfid_pins_reset();
+}

applications/lfrfid-debug/scene/lfrfid-debug-app-scene-tune.h

@@ -0,0 +1,9 @@
+#pragma once
+#include "../lfrfid-debug-app.h"
+
+class LfRfidDebugAppSceneTune : public GenericScene<LfRfidDebugApp> {
+public:
+    void on_enter(LfRfidDebugApp* app, bool need_restore) final;
+    bool on_event(LfRfidDebugApp* app, LfRfidDebugApp::Event* event) final;
+    void on_exit(LfRfidDebugApp* app) final;
+};

applications/lfrfid-debug/view-modules/lfrfid-view-tune-vm.cpp

@@ -0,0 +1,212 @@
+#include "lfrfid-view-tune-vm.h"
+#include <callback-connector.h>
+#include <gui/elements.h>
+
+struct LfRfidViewTuneVMModel {
+    bool dirty;
+    bool fine;
+    uint32_t ARR;
+    uint32_t CCR;
+    int pos;
+};
+
+void LfRfidViewTuneVM::view_draw_callback(Canvas* canvas, void* _model) {
+    LfRfidViewTuneVMModel* model = reinterpret_cast<LfRfidViewTuneVMModel*>(_model);
+    canvas_clear(canvas);
+    canvas_set_color(canvas, ColorBlack);
+
+    if(model->fine) {
+        canvas_draw_box(
+            canvas,
+            128 - canvas_string_width(canvas, "Fine") - 4,
+            0,
+            canvas_string_width(canvas, "Fine") + 4,
+            canvas_current_font_height(canvas) + 1);
+        canvas_set_color(canvas, ColorWhite);
+    }
+    canvas_draw_str_aligned(canvas, 128 - 2, 2, AlignRight, AlignTop, "Fine");
+    canvas_set_color(canvas, ColorBlack);
+
+    constexpr uint8_t buffer_size = 128;
+    char buffer[buffer_size + 1];
+    snprintf(
+        buffer,
+        buffer_size,
+        "%sARR: %lu\n"
+        "freq = %.4f\n"
+        "%sCCR: %lu\n"
+        "duty = %.4f",
+        model->pos == 0 ? ">" : "",
+        model->ARR,
+        (float)SystemCoreClock / ((float)model->ARR + 1),
+        model->pos == 1 ? ">" : "",
+        model->CCR,
+        ((float)model->CCR + 1) / ((float)model->ARR + 1) * 100.0f);
+    elements_multiline_text_aligned(canvas, 2, 2, AlignLeft, AlignTop, buffer);
+}
+
+bool LfRfidViewTuneVM::view_input_callback(InputEvent* event, void* context) {
+    LfRfidViewTuneVM* _this = reinterpret_cast<LfRfidViewTuneVM*>(context);
+    bool consumed = false;
+
+    // Process key presses only
+    if(event->type == InputTypeShort || event->type == InputTypeRepeat) {
+        consumed = true;
+
+        switch(event->key) {
+        case InputKeyLeft:
+            _this->button_left();
+            break;
+        case InputKeyRight:
+            _this->button_right();
+            break;
+        case InputKeyUp:
+            _this->button_up();
+            break;
+        case InputKeyDown:
+            _this->button_down();
+            break;
+        case InputKeyOk:
+            _this->button_ok();
+            break;
+        default:
+            consumed = false;
+            break;
+        }
+    }
+
+    return consumed;
+}
+
+void LfRfidViewTuneVM::button_up() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        if(model->pos > 0) model->pos--;
+        return true;
+    });
+}
+
+void LfRfidViewTuneVM::button_down() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        if(model->pos < 1) model->pos++;
+        return true;
+    });
+}
+
+void LfRfidViewTuneVM::button_left() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        if(model->pos == 0) {
+            if(model->fine) {
+                model->ARR -= 1;
+            } else {
+                model->ARR -= 10;
+            }
+        } else if(model->pos == 1) {
+            if(model->fine) {
+                model->CCR -= 1;
+            } else {
+                model->CCR -= 10;
+            }
+        }
+
+        model->dirty = true;
+        return true;
+    });
+}
+
+void LfRfidViewTuneVM::button_right() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        if(model->pos == 0) {
+            if(model->fine) {
+                model->ARR += 1;
+            } else {
+                model->ARR += 10;
+            }
+        } else if(model->pos == 1) {
+            if(model->fine) {
+                model->CCR += 1;
+            } else {
+                model->CCR += 10;
+            }
+        }
+
+        model->dirty = true;
+        return true;
+    });
+}
+
+void LfRfidViewTuneVM::button_ok() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        model->fine = !model->fine;
+        return true;
+    });
+}
+
+LfRfidViewTuneVM::LfRfidViewTuneVM() {
+    view = view_alloc();
+    view_set_context(view, this);
+    view_allocate_model(view, ViewModelTypeLocking, sizeof(LfRfidViewTuneVMModel));
+
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        model->dirty = true;
+        model->fine = false;
+        model->ARR = 511;
+        model->CCR = 255;
+        model->pos = 0;
+        return true;
+    });
+
+    view_set_draw_callback(
+        view, cbc::obtain_connector(this, &LfRfidViewTuneVM::view_draw_callback));
+    view_set_input_callback(
+        view, cbc::obtain_connector(this, &LfRfidViewTuneVM::view_input_callback));
+}
+
+LfRfidViewTuneVM::~LfRfidViewTuneVM() {
+    view_free(view);
+}
+
+View* LfRfidViewTuneVM::get_view() {
+    return view;
+}
+
+void LfRfidViewTuneVM::clean() {
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        model->dirty = true;
+        model->fine = false;
+        model->ARR = 511;
+        model->CCR = 255;
+        model->pos = 0;
+        return true;
+    });
+}
+
+bool LfRfidViewTuneVM::is_dirty() {
+    bool result;
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        result = model->dirty;
+        model->dirty = false;
+        return false;
+    });
+
+    return result;
+}
+
+uint32_t LfRfidViewTuneVM::get_ARR() {
+    uint32_t result;
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        result = model->ARR;
+        return false;
+    });
+
+    return result;
+}
+
+uint32_t LfRfidViewTuneVM::get_CCR() {
+    uint32_t result;
+    with_view_model_cpp(view, LfRfidViewTuneVMModel, model, {
+        result = model->CCR;
+        return false;
+    });
+
+    return result;
+}

applications/lfrfid-debug/view-modules/lfrfid-view-tune-vm.h

@@ -0,0 +1,26 @@
+#pragma once
+#include <gui/view.h>
+#include <view-modules/generic-view-module.h>
+
+class LfRfidViewTuneVM : public GenericViewModule {
+public:
+    LfRfidViewTuneVM();
+    ~LfRfidViewTuneVM() final;
+    View* get_view() final;
+    void clean() final;
+
+    bool is_dirty();
+    uint32_t get_ARR();
+    uint32_t get_CCR();
+
+private:
+    View* view;
+    void view_draw_callback(Canvas* canvas, void* _model);
+    bool view_input_callback(InputEvent* event, void* context);
+
+    void button_up();
+    void button_down();
+    void button_left();
+    void button_right();
+    void button_ok();
+};