Merge branch 'ul_dev' into dev

Flipper-XFW · Mar 11, 2024 · f50d9f5 · f50d9f5
2 parents 071b666 + 2f5be8f
commit f50d9f5
Show file tree

Hide file tree

Showing 70 changed files with 2,079 additions and 349 deletions.
diff --git a/.vscode/ReadMe.md b/.vscode/ReadMe.md
@@ -1,4 +1,4 @@
-# Visual Studio Code workspace for Flipper Zero
+# Visual Studio Code workspace for Flipper Zero {#vscode}
 
 ## Setup
 

diff --git a/applications/drivers/subghz/cc1101_ext/cc1101_ext.h b/applications/drivers/subghz/cc1101_ext/cc1101_ext.h
@@ -1,6 +1,6 @@
 /**
- * @file furi_hal_subghz.h
- * SubGhz HAL API
+ * @file cc1101_ext.h
+ * @brief External CC1101 transceiver access API.
  */
 
 #pragma once

diff --git a/applications/examples/example_apps_assets/README.md b/applications/examples/example_apps_assets/README.md
@@ -1,7 +1,11 @@
-# Apps Assets folder Example
+# Apps Assets folder Example {#example_app_assets}
 
 This example shows how to use the Apps Assets folder to store data that is not part of the application itself, but is required for its operation, and that data is provided with the application.
 
+## Source code
+
+Source code for this example can be found [here](https://github.com/flipperdevices/flipperzero-firmware/tree/dev/applications/examples/example_apps_assets).
+
 ## What is the Apps Assets Folder?
 
 The **Apps Assets** folder is a folder where external applications unpack their assets.

diff --git a/applications/examples/example_apps_assets/example_apps_assets.c b/applications/examples/example_apps_assets/example_apps_assets.c
@@ -1,3 +1,7 @@
+/**
+ * @file example_apps_assets.c
+ * @brief Application assets example.
+ */
 #include <furi.h>
 #include <storage/storage.h>
 #include <toolbox/stream/stream.h>

diff --git a/applications/examples/example_apps_data/README.md b/applications/examples/example_apps_data/README.md
@@ -1,7 +1,11 @@
-# Apps Data folder Example
+# Apps Data folder Example {#example_app_data}
 
 This example demonstrates how to utilize the Apps Data folder to store data that is not part of the app itself, such as user data, configuration files, and so forth.
 
+## Source code
+
+Source code for this example can be found [here](https://github.com/flipperdevices/flipperzero-firmware/tree/dev/applications/examples/example_apps_data).
+
 ## What is the Apps Data Folder?
 
 The **Apps Data** folder is a folder used to store data for external apps that are not part of the main firmware. 

diff --git a/applications/examples/example_apps_data/example_apps_data.c b/applications/examples/example_apps_data/example_apps_data.c
@@ -1,3 +1,7 @@
+/**
+ * @file example_apps_data.c
+ * @brief Application data example.
+ */
 #include <furi.h>
 #include <storage/storage.h>
 

diff --git a/applications/examples/example_ble_beacon/ble_beacon_app.h b/applications/examples/example_ble_beacon/ble_beacon_app.h
@@ -1,3 +1,7 @@
+/**
+ * @file ble_beacon_app.h
+ * @brief BLE beacon example.
+ */
 #pragma once
 
 #include "extra_beacon.h"

diff --git a/applications/examples/example_custom_font/example_custom_font.c b/applications/examples/example_custom_font/example_custom_font.c
@@ -1,3 +1,7 @@
+/**
+ * @file example_custom_font.c
+ * @brief Custom font example.
+ */
 #include <furi.h>
 #include <furi_hal.h>
 

diff --git a/applications/examples/example_images/ReadMe.md b/applications/examples/example_images/ReadMe.md
@@ -1,11 +1,21 @@
-# Application icons
+# Application icons {#example_app_images}
+
+## Source code
+
+Source code for this example can be found [here](https://github.com/flipperdevices/flipperzero-firmware/tree/dev/applications/examples/example_images).
+
+## General principle
+
 To use icons, do the following:
-* add a line to the application manifest: `fap_icon_assets="folder"`, where `folder` points to the folder where your icons are located
-* add `#include "application_id_icons.h"` to the application code, where `application_id` is the appid from the manifest
-* every icon in the folder will be available as a `I_icon_name` variable, where `icon_name` is the name of the icon file without the extension
+
+* Add a line to the application manifest: `fap_icon_assets="folder"`, where `folder` points to the folder where your icons are located
+* Add `#include "application_id_icons.h"` to the application code, where `application_id` is the appid from the manifest
+* Every icon in the folder will be available as a `I_icon_name` variable, where `icon_name` is the name of the icon file without the extension
 
 ## Example
+
 We have an application with the following manifest:
+
 ```
 App(
     appid="example_images",
@@ -17,6 +27,7 @@ App(
 So the icons are in the `images` folder and will be available in the generated `example_images_icons.h` file.
 
 The example code is located in `example_images_main.c` and contains the following line:
+
 ```
 #include "example_images_icons.h"
 ```

diff --git a/applications/examples/example_images/example_images.c b/applications/examples/example_images/example_images.c
@@ -1,3 +1,7 @@
+/**
+ * @file example_images.c
+ * @brief Custom images example.
+ */
 #include <furi.h>
 #include <furi_hal.h>
 

diff --git a/applications/examples/example_plugins/example_plugins.c b/applications/examples/example_plugins/example_plugins.c
@@ -1,5 +1,7 @@
-/* 
- * An example of a plugin host application.
+/**
+ * @file example_plugins.c
+ * @brief Plugin host application example.
+ *
  * Loads a single plugin and calls its methods.
  */
 

diff --git a/applications/examples/example_plugins/example_plugins_multi.c b/applications/examples/example_plugins/example_plugins_multi.c
@@ -1,5 +1,7 @@
-/*
- * An example of an advanced plugin host application.
+/**
+ * @file example_plugins_multi.c
+ * @brief Advanced plugin host application example.
+ *
  * It uses PluginManager to load all plugins from a directory
  */
 

diff --git a/applications/examples/example_plugins/plugin1.c b/applications/examples/example_plugins/plugin1.c
@@ -1,4 +1,9 @@
-/* A simple plugin implementing example_plugins application's plugin interface */
+/**
+ * @file plugin1.c
+ * @brief Plugin example 1.
+ *
+ * A simple plugin implementing example_plugins application's plugin interface
+ */
 
 #include "plugin_interface.h"
 

diff --git a/applications/examples/example_plugins/plugin2.c b/applications/examples/example_plugins/plugin2.c
@@ -1,4 +1,9 @@
-/* Second plugin implementing example_plugins application's plugin interface */
+/**
+ * @file plugin2.c
+ * @brief Plugin example 2.
+ *
+ * Second plugin implementing example_plugins application's plugin interface
+ */
 
 #include "plugin_interface.h"
 

diff --git a/applications/examples/example_plugins/plugin_interface.h b/applications/examples/example_plugins/plugin_interface.h
@@ -1,7 +1,11 @@
+/**
+ * @file plugin_interface.h
+ * @brief Example plugin interface.
+ *
+ * Common interface between a plugin and host application
+ */
 #pragma once
 
-/* Common interface between a plugin and host application */
-
 #define PLUGIN_APP_ID "example_plugins"
 #define PLUGIN_API_VERSION 1
 

diff --git a/applications/examples/example_plugins_advanced/app_api.h b/applications/examples/example_plugins_advanced/app_api.h
@@ -1,9 +1,12 @@
-#pragma once
-
-/* 
+/**
+ * @file app_api.h
+ * @brief Application API example.
+ *
  * This file contains an API that is internally implemented by the application
  * It is also exposed to plugins to allow them to use the application's API.
  */
+#pragma once
+
 #include <stdint.h>
 
 #ifdef __cplusplus

diff --git a/applications/examples/example_plugins_advanced/plugin1.c b/applications/examples/example_plugins_advanced/plugin1.c
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file plugin1.c
+ * @brief Plugin example 1.
+ *
  * This plugin uses both firmware's API interface and private application headers.
  * It can be loaded by a plugin manager that uses CompoundApiInterface,
  * which combines both interfaces.

diff --git a/applications/examples/example_plugins_advanced/plugin2.c b/applications/examples/example_plugins_advanced/plugin2.c
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file plugin2.c
+ * @brief Plugin example 2.
+ *
  * This plugin uses both firmware's API interface and private application headers.
  * It can be loaded by a plugin manager that uses CompoundApiInterface,
  * which combines both interfaces.

diff --git a/applications/examples/example_plugins_advanced/plugin_interface.h b/applications/examples/example_plugins_advanced/plugin_interface.h
@@ -1,7 +1,11 @@
+/**
+ * @file plugin_interface.h
+ * @brief Example plugin interface.
+ *
+ * Common interface between a plugin and host application
+ */
 #pragma once
 
-/* Common interface between a plugin and host application */
-
 #define PLUGIN_APP_ID "example_plugins_advanced"
 #define PLUGIN_API_VERSION 1
 

diff --git a/applications/examples/example_thermo/README.md b/applications/examples/example_thermo/README.md
@@ -1,8 +1,14 @@
-# 1-Wire Thermometer
+# 1-Wire Thermometer {#example_thermo}
+
 This example application demonstrates the use of the 1-Wire library with a DS18B20 thermometer. 
 It also covers basic GUI, input handling, threads and localisation.
 
+## Source code
+
+Source code for this example can be found [here](https://github.com/flipperdevices/flipperzero-firmware/tree/dev/applications/examples/example_thermo).
+
 ## Electrical connections
+
 Before launching the application, connect the sensor to Flipper's external GPIO according to the table below:
 | DS18B20 | Flipper |
 | :-----: | :-----: |
@@ -15,12 +21,14 @@ Before launching the application, connect the sensor to Flipper's external GPIO
 *NOTE 2*: For any other pin than 17, connect an external 4.7k pull-up resistor to pin 9.
 
 ## Launching the application
+
 In order to launch this demo, follow the steps below:
 1. Make sure your Flipper has an SD card installed.
 2. Connect your Flipper to the computer via a USB cable.
 3. Run `./fbt launch APPSRC=example_thermo` in your terminal emulator of choice.
 
 ## Changing the data pin
+
 It is possible to use other GPIO pin as a 1-Wire data pin. In order to change it, set the `THERMO_GPIO_PIN` macro to any of the options listed below:
 
 ```c

diff --git a/applications/examples/example_thermo/example_thermo.c b/applications/examples/example_thermo/example_thermo.c
@@ -1,4 +1,7 @@
-/*
+/**
+ * @file example_thermo.c
+ * @brief 1-Wire thermometer example.
+ *
  * This file contains an example application that reads and displays
  * the temperature from a DS18B20 1-wire thermometer.
  *

diff --git a/applications/main/infrared/resources/infrared/assets/ac.ir b/applications/main/infrared/resources/infrared/assets/ac.ir
@@ -1,43 +1,43 @@
 Filetype: IR library file
 Version: 1
-# Last Updated 16th Aug, 2023
-# Last Checked 16th Aug, 2023
+# Last Updated 21st Feb, 2024
+# Last Checked 21st Feb, 2024
 #
 # Model: Electrolux EACM-16 HP/N3
 name: Off
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 502 3436 510 475 509 476 508 477 507 477 507 479 505 480 504 480 504 490 504 481 502 482 501 483 563 420 511 474 510 475 509 476 508 485 561 423 508 476 508 477 507 478 506 479 505 480 504 481 503 517 508 476 508 478 506 479 505 479 505 481 503 483 521 1456 501 498 507 479 505 480 504 481 503 482 501 483 563 421 562 422 509 499 506 479 505 480 504 481 503 482 502 484 510 1451 506 479 505 1542 562 1396 509 471 502 476 508 469 504 3425 511
 #
 name: Dh
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 507 3430 506 479 505 480 504 481 503 481 503 483 501 485 509 1453 504 1465 503 482 502 483 511 473 500 485 509 476 508 477 507 478 506 487 507 477 507 478 506 479 505 480 504 482 502 483 501 484 500 523 503 482 502 484 500 485 509 476 508 476 508 478 506 1456 501 501 504 482 502 483 501 484 500 485 509 476 508 477 507 1455 502 509 506 479 505 1457 500 485 509 476 508 1454 503 482 502 483 501 568 499 1459 509 1450 507 471 502 474 510 3421 505
 #
 name: Cool_hi
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 504 3433 503 482 502 484 510 474 510 475 509 476 508 478 506 1456 564 1405 510 475 509 476 508 502 482 477 507 478 506 479 505 480 504 489 505 480 504 481 503 482 502 483 511 473 511 474 510 475 509 509 506 479 505 480 504 481 503 482 512 473 511 474 510 476 508 1469 509 475 509 476 508 477 507 478 506 479 505 480 504 481 503 505 510 475 509 502 482 503 481 504 480 505 478 507 477 1459 509 560 507 1451 506 473 511 493 480 1450 507 3422 503
 #
 name: Cool_lo
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 525 3615 530 506 561 474 562 474 562 473 563 473 531 505 562 1502 528 1542 562 474 562 474 530 505 531 504 532 504 532 504 616 419 533 510 589 447 526 509 527 509 527 509 527 508 528 508 528 507 529 542 525 510 526 509 527 509 527 509 527 508 528 508 528 1535 527 524 533 503 533 503 533 502 534 502 534 502 534 501 535 501 525 534 533 502 534 502 534 501 535 502 534 1529 533 503 533 503 533 587 533 497 528 501 524 1536 526 501 524 3609 526
 #
 name: Heat_hi
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 531 3406 530 455 529 456 528 457 537 447 537 448 535 450 534 1429 528 1442 536 448 536 449 534 451 532 452 532 453 530 454 530 455 529 464 530 454 529 456 528 457 537 448 536 449 535 450 533 451 533 490 535 449 534 450 534 451 533 452 532 453 531 455 529 1433 534 1443 535 449 535 450 534 452 531 453 530 454 530 455 529 456 538 472 532 452 532 454 530 1433 535 1427 530 1432 536 1427 530 1431 537 1511 530 448 536 1422 535 1423 534 1422 535 3395 530
 #
 name: Heat_lo
 type: raw
 frequency: 38000
-duty_cycle: 0.33
+duty_cycle: 0.330000
 data: 506 3430 506 478 506 479 505 480 504 481 503 482 502 484 500 1463 505 1465 503 482 502 483 501 484 500 485 509 476 508 477 507 478 506 486 508 477 507 478 506 479 505 480 504 481 503 482 502 483 500 523 502 482 502 483 501 484 500 485 509 476 508 478 506 1455 502 498 507 478 506 479 505 481 503 482 501 483 500 484 500 485 509 500 505 481 502 482 502 1461 507 1455 502 1459 509 476 508 477 507 563 504 1453 504 1454 503 1454 503 1453 504 3426 499
 #
 # Model: Hisense Generic
@@ -959,3 +959,27 @@ type: raw
 frequency: 38000
 duty_cycle: 0.330000
 data: 664 17757 3057 8901 528 469 550 1434 556 465 553 440 529 465 554 439 555 439 555 438 555 440 553 1435 552 443 550 470 524 1466 522 472 522 472 521 1467 523 1466 549 1440 549 1440 548 1440 548 445 549 445 549 445 549 446 548 470 524 471 523 471 523 471 523 472 522 472 522 473 522 472 523 472 548 446 549 445 550 445 548 446 548 446 548 446 548 446 548 447 547 470 524 471 523 471 523 471 523 471 523 474 519 474 521 474 521 473 522 473 546 447 547 1441 548 1442 546 1442 547 1442 546 2947 3023 8935 522 1466 522 472 522 498 496 498 495 499 496 498 496 498 521 473 522 471 523 1466 522 471 523 471 522 1466 523 471 523 1467 522 1467 522 1467 521 1493 495 1494 496 1493 521 473 522 472 522 471 523 472 522 471 523 472 522 472 522 472 522 472 522 472 522 472 522 472 522 473 521 499 495 499 495 499 495 499 496 498 522 473 522 472 523 471 522 472 522 472 522 472 522 472 522 472 522 472 522 473 521 473 521 473 521 473 521 499 495 500 494 500 495 499 496 498 522 2947 3023 8937 521 1468 520 473 521 473 521 473 521 473 521 473 521 473 521 474 520 474 520 1470 518 500 494 500 494 500 494 500 494 1494 521 1468 521 473 521 1468 520 1468 520 1469 520 1469 520 1470 518 1495 493 1496 493 1495 494 500 519 475 520 474 520 1469 519 1469 520 1469 519 474 520 474 520 475 519 477 517 500 494 1496 493 1496 493 1496 493 500 495 1495 519 475 518 475 519 475 518 476 518 475 519 1470 519 500 494 500 494 501 493 501 493 501 493 1499 490 1497 493 1497 492 1496 518
+#
+name: Heat_hi
+type: raw
+frequency: 38000
+duty_cycle: 0.330000
+data: 148 110377 9082 4422 707 499 706 500 704 1603 703 1606 701 505 700 507 699 506 700 507 699 506 700 1607 700 1608 700 1609 699 506 699 507 699 506 699 507 699 507 699 506 700 507 699 507 699 507 699 1608 699 1607 699 507 699 507 699 507 699 507 699 507 699 1609 699 507 699 1608 699 507 699 507 699 1609 699 507 699 19940 700 506 700 506 699 507 699 507 699 506 700 506 700 507 699 507 699 507 700 507 699 506 699 507 699 507 699 507 699 507 699 507 699 507 699 507 699 507 698 507 700 507 699 507 699 507 699 507 699 507 699 508 698 508 698 507 699 507 699 508 698 1610 699 508 698
+#
+name: Cool_hi
+type: raw
+frequency: 38000
+duty_cycle: 0.330000
+data: 315 101050 3094 3056 3093 4437 580 1648 572 534 576 1649 582 525 574 530 580 1646 574 1653 578 529 570 534 576 529 571 534 576 529 570 1655 576 1651 580 527 572 532 578 1647 573 1654 577 1651 580 526 573 531 579 526 573 531 579 526 573 531 579 526 573 531 579 526 573 531 579 525 574 531 579 525 574 531 579 1646 574 532 578 526 573 531 579 526 573 531 579 526 573 1652 579 527 572 1653 578 528 571 534 576 528 571 533 577 528 571 533 577 528 572 533 577 528 572 532 578 527 572 532 578 527 572 532 578 526 573 1652 579 527 572 532 578 527 572 532 578 527 572 532 578 526 573 531 579 526 573 531 579 526 573 531 579 525 574 530 580 525 574 530 580 525 574 530 580 524 575 529 581 524 575 529 571 534 576 528 571 533 577 528 571 533 577 528 571 533 577 527 572 532 578 527 572 532 578 526 573 531 579 526 573 531 579 525 574 531 579 525 574 530 580 525 574 1650 581 525 574 1651 580 1647 573 533 577 527 572 1653 578 528 572 1654 577 1650 581 1646 574 71637 254
+#
+name: Cool_lo
+type: raw
+frequency: 38000
+duty_cycle: 0.330000
+data: 284 19161 3098 3053 3096 4435 572 1656 575 532 578 1648 572 534 576 530 570 1682 549 1652 579 527 572 534 576 1649 571 1656 575 1652 579 1649 571 1656 575 531 579 527 572 1653 578 1649 571 1656 575 531 579 527 572 532 578 527 572 533 577 527 572 533 577 527 573 532 578 527 572 532 578 527 573 532 578 527 572 1652 579 527 572 533 577 528 571 533 577 528 571 533 577 1648 572 533 577 1649 571 535 575 530 569 536 574 531 569 536 574 530 569 536 574 530 570 535 575 530 570 535 575 530 569 535 575 530 569 535 575 1649 571 535 575 531 568 536 574 531 568 536 574 531 568 536 574 531 569 536 574 530 569 536 574 530 569 535 575 530 569 535 575 530 569 535 575 530 570 535 575 529 570 534 576 529 570 534 576 529 570 534 576 528 571 534 576 528 571 534 576 528 571 534 576 528 571 534 576 528 571 533 577 528 571 533 577 528 572 533 577 528 571 533 577 528 572 1652 579 527 572 1653 578 529 570 534 576 529 570 535 575 529 570 1654 577 1677 554 1673 547
+#
+name: Cool_lo
+type: raw
+frequency: 38000
+duty_cycle: 0.330000
+data: 301 132136 5036 2167 337 1766 361 689 358 692 366 684 363 1770 357 692 366 684 363 718 329 690 357 1776 361 687 360 1773 364 1767 360 689 358 1775 362 1769 357 1774 363 1768 359 1773 364 684 363 718 329 1773 364 684 363 718 329 691 356 694 364 716 331 719 328 1775 362 1769 358 1774 363 1768 359 1772 365 714 333 1770 357 1774 363 716 331 719 328 722 336 715 332 718 329 721 326 724 334 716 331 719 328 722 336 715 332 718 329 1773 364 1767 360 1772 354 1777 360 719 328 721 326 725 333 717 330 29455 5036 2139 354 1777 360 688 359 691 367 714 333 1770 356 692 366 684 363 687 360 690 357 1776 361 688 359 1773 364 1768 359 689 358 1775 362 1769 357 1774 363 1768 359 1773 364 684 363 687 360 1773 364 685 362 688 359 691 356 694 364 686 361 689 358 692 366 685 362 688 359 691 356 1777 360 1771 355 693 365 685 362 1771 355 693 365 1768 359 1773 364 1767 360 689 358 692 366 685 362 1771 355 1775 362 687 360 690 357 1775 362 687 360 690 357 693 365 716 331 689 358 1774 363 686 361 689 358 692 366 685 362 688 359 691 356 694 364 686 361 689 358 692 366 685 362 688 359 691 356 694 364 686 361 689 358 692 366 685 362 1771 355 693 365 1768 358 1773 364 684 363 687 360 690 357 693 365 1768 359 690 357 1776 361 688 359 691 356 694 364 686 361 689 358 692 366 685 362 1770 356 693 365 685 362 688 359 691 356 1777 360 1771 355 693 365 686 361 689 358 692 366 685 362 1770 356