docs & readme

xMasterX · xMasterX · commit 12a2072b8c6d · 2022-07-29T19:22:17.000+03:00
diff --git a/ReadMe.md b/ReadMe.md
@@ -25,11 +25,12 @@ Our Discord Community:
 <br>
 
 # What changed
-* SubGhz regional TX restriction removed
-* Rolling code protocols now has ability to save & send captured signals
+* SubGHz regional TX restriction removed
+* SubGHz frequecy range can be extended in settings file (Warning: It can damage flipper's hardware)
+* Many rolling code protocols now has ability to save & send captured signals
 * FAAC SLH (Spa) & BFT Mitto (secure with seed) manual creation
-* Custom plugins and games included
-* Extra SubGhz frequencies + extra mifare classic keys
+* Custom community plugins and games added
+* Extra SubGHz frequencies + extra mifare classic keys
 * Picopass/iClass plugin is included in releases
 * Recompiled IR TV Universal Remote for ALL buttons
 * Other small fixes and changes
@@ -49,31 +50,57 @@ See changelog in releases for latest updates!
 
 ### Apps included:
 
-- Clock/Stopwatch [(By CompaqDisc, Stopwatch & Sound Alert By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/unleashed/applications/clock_app/clock_app.c)
-- UniversalRF Remix (only RAW subghz files) [(By ESurge)(Original UniversalRF By jimilinuxguy)](https://github.com/ESurge/flipperzero-firmware-unirfremix)
-- Tetris [(By jeffplang)](https://github.com/jeffplang/flipperzero-firmware/tree/tetris_game/applications/tetris_game)
-- Spectrum Analyzer [(By jolcese)](https://github.com/jolcese/flipperzero-firmware/tree/spectrum/applications/spectrum_analyzer) - [Ultra Narrow mode & scan channels non-consecutively](https://github.com/theY4Kman/flipperzero-firmware/commits?author=theY4Kman)
-- Arkanoid [(By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins)
-- Tic Tac Toe [(By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins)
+- UPC-A Barcode generator plugin [(By McAzzaMan)](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator)
+- GPIO: Sentry Safe plugin [(By H4ckd4ddy)](https://github.com/H4ckd4ddy/flipperzero-sentry-safe-plugin)
+- ESP32: WiFi Marauder companion plugin [(By 0xchocolate)](https://github.com/0xchocolate/flipperzero-firmware-with-wifi-marauder-companion)
+- NRF24: Sniffer & MouseJacker (with changes) [(By mothball187)](https://github.com/mothball187/flipperzero-nrf24/tree/main/mousejacker)
+- HID Analyzer [(By Ownasaurus)](https://github.com/Ownasaurus/flipperzero-firmware/tree/hid-analyzer/applications/hid_analyzer)
+- Clock/Stopwatch (with small fixes) [(By CompaqDisc, Stopwatch & Sound Alert By RogueMaster)](https://github.com/RogueMaster/flipperzero-firmware-wPlugins/blob/unleashed/applications/clock_app/clock_app.c)
+- UniversalRF Remix (with changes)(only RAW subghz files) [(By ESurge)(Original UniversalRF By jimilinuxguy)](https://github.com/ESurge/flipperzero-firmware-unirfremix)
+- Tetris (with fixes) [(By jeffplang)](https://github.com/jeffplang/flipperzero-firmware/tree/tetris_game/applications/tetris_game)
+- Spectrum Analyzer (with changes) [(By jolcese)](https://github.com/jolcese/flipperzero-firmware/tree/spectrum/applications/spectrum_analyzer) - [Ultra Narrow mode & scan channels non-consecutively](https://github.com/theY4Kman/flipperzero-firmware/commits?author=theY4Kman)
+- Arkanoid (with fixes) [(By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins)
+- Tic Tac Toe (with fixes) [(By gotnull)](https://github.com/gotnull/flipperzero-firmware-wPlugins)
 
+### Other changes
+
+- BadUSB Keyboard layouts [(By v1nc)](https://github.com/v1nc/flipperzero-firmware)
 
 ## Support us so we can buy equipment and develop new features
 * ETH/BSC/ERC20-Tokens: `0xFebF1bBc8229418FF2408C07AF6Afa49152fEc6a`
 * BTC: `bc1q0np836jk9jwr4dd7p6qv66d04vamtqkxrecck9`
 * DOGE: `D6R6gYgBn5LwTNmPyvAQR6bZ9EtGgFCpvv`
 * LTC: `ltc1q3ex4ejkl0xpx3znwrmth4lyuadr5qgv8tmq8z9`
 
+**Big thanks to all sponsors!**
+
 # Instructions
 ## [- How to install firmware](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToInstall.md)
 
 ## [- How to build firmware](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/HowToBuild.md)
 
+## [- BadUSB: how to use different keyboard layouts](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/BadUSBLayouts.md)
+
+**Plugins**
+
 ## [- Configure UniversalRF Remix App](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/UniRFRemix.md)
 
+## [- How to use: NRF24 plugins](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/NRF24.md)
+
+## [- How to use: SentrySafe plugin](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/SentrySafe.md)
+
+## [- Barcode Generator readme](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/BarcodeGenerator.md)
+
+**SubGHz**
+
+## [- How to extend SubGHz frequency range](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/DangerousSettings.md)
+
+## [- How to add extra SubGHz frequencies](https://github.com/Eng1n33r/flipperzero-firmware/blob/dev/documentation/SubGHzSettings.md)
+
 <br>
 <br>
 
-# Where I can find IR, SubGhz, ... DBs, and other stuff?
+# Where I can find IR, SubGhz, ... files, DBs, and other stuff?
 ## [Awesome Flipper Zero - Github](https://github.com/djsime1/awesome-flipperzero)
 ## [UberGuidoZ Playground - Large collection of files - Github](https://github.com/UberGuidoZ/Flipper)
 
diff --git a/applications/mousejacker/application.fam b/applications/mousejacker/application.fam
@@ -1,6 +1,6 @@
 App(
     appid="mouse_jacker",
-    name="[HW] NRF24: Mouse Jacker",
+    name="[NRF24] Mouse Jacker",
     apptype=FlipperAppType.PLUGIN,
     entry_point="mousejacker_app",
     cdefines=["APP_MOUSEJACKER"],
diff --git a/applications/nrfsniff/application.fam b/applications/nrfsniff/application.fam
@@ -1,6 +1,6 @@
 App(
     appid="nrf_sniff",
-    name="[HW] NRF24: Sniffer",
+    name="[NRF24] Sniffer",
     apptype=FlipperAppType.PLUGIN,
     entry_point="nrfsniff_app",
     cdefines=["APP_NRFSNIFF"],
diff --git a/applications/sentry_safe/application.fam b/applications/sentry_safe/application.fam
@@ -1,6 +1,6 @@
 App(
     appid="sentry_safe",
-    name="[HW] Sentry Safe",
+    name="[GPIO] Sentry Safe",
     apptype=FlipperAppType.PLUGIN,
     entry_point="sentry_safe_app",
     cdefines=["APP_SENTRY_SAFE"],
diff --git a/applications/wifi_marauder_companion/application.fam b/applications/wifi_marauder_companion/application.fam
@@ -1,6 +1,6 @@
 App(
     appid="wifi_marauder",
-    name="[HW] WiFi (Marauder)",
+    name="[ESP32] WiFi Marauder",
     apptype=FlipperAppType.PLUGIN,
     entry_point="wifi_marauder_app",
     cdefines=["APP_WIFI_MARAUDER"],
diff --git a/assets/resources/Manifest b/assets/resources/Manifest
@@ -1,5 +1,5 @@
 V:0
-T:1659104936
+T:1659108089
 D:badusb
 D:dolphin
 D:infrared
@@ -232,11 +232,11 @@ F:41b4f08774249014cb8d3dffa5f5c07d:1757:nfc/assets/currency_code.nfc
 F:12674515290ad9edcabc82f7695350f8:50737:nfc/assets/mf_classic_dict.nfc
 D:subghz/assets
 F:dda1ef895b8a25fde57c874feaaef997:650:subghz/assets/came_atomo
-F:20b3d7ea34e38425ce3a3d2a548cc730:138:subghz/assets/dangerous_settings
+F:27d732a3362969ac187c8f5ff0afc22a:286:subghz/assets/dangerous_settings
 F:111d2b8df83e27fd889fc5e270297865:3231:subghz/assets/keeloq_mfcodes
 F:9214f9c10463b746a27e82ce0b96e040:465:subghz/assets/keeloq_mfcodes_user
 F:653bd8d349055a41e1152e557d4a52d3:202:subghz/assets/nice_flor_s
-F:c572eaba12d023a199a43098c2c6b72a:1506:subghz/assets/setting_user
+F:b6ecaec5fcf45411622d4309c5769009:1590:subghz/assets/setting_user
 F:9a50dd284146dfbd8050a2ade62174d9:266:subghz/assets/universal_rf_map
 D:u2f/assets
 F:7e11e688e39034bbb9d88410044795e1:365:u2f/assets/cert.der
diff --git a/assets/resources/subghz/assets/dangerous_settings b/assets/resources/subghz/assets/dangerous_settings
@@ -1,2 +1,4 @@
 # Do you want to damage your flipper CC1101 radio chip by using Frequencies that outside HW specs?
+# CC1101 Frequency range specs: 300-348 MHz, 386-464 MHz, and 778-928 MHz 
+# This setting will extend to: 281-361 MHz, 378-481 MHz, and 749-962 MHz
 yes_i_want_to_destroy_my_flipper: false
diff --git a/assets/resources/subghz/assets/setting_user b/assets/resources/subghz/assets/setting_user
@@ -9,6 +9,10 @@ Version: 1
 
 # Frequencies used for "Read", "Read Raw" and "Frequency Analyzer" - they added after default ones if enabled in Add_standard_frequencies
 Frequency: 302757000
+Frequency: 307000000
+Frequency: 307500000
+Frequency: 307800000
+Frequency: 309000000
 Frequency: 312000000
 Frequency: 312100000
 Frequency: 313850000
diff --git a/documentation/BadUSBLayouts.md b/documentation/BadUSBLayouts.md
@@ -0,0 +1,16 @@
+
+# BadUSB support for different layouts:
+
+## Author: [v1nc](https://github.com/v1nc/flipperzero-firmware)
+
+This firmware supports the `DUCKY_LANG` keyword to change the keyboard layout.
+
+Add `DUCKY_LANG DE` to the first or second line of the script to choose the layout.
+Currently implemented:
+* `US` = US (default)
+* `DE` = German QWERTZ
+* `FR` = AZERTY (based on [this](https://github.com/ikazeer/flipperzero-AZERTY))
+
+**If you are writing payloads on windows you need to make sure EOL Conversion is set to LF Unix in your text editor and not windows CR LF. If you do not it will fail to run the payload.**
+
+## How to add your own layout: [instruction](https://github.com/v1nc/flipperzero-firmware/blob/dev/documentation/HowToAddLayout.md)
diff --git a/documentation/BarcodeGenerator.md b/documentation/BarcodeGenerator.md
@@ -1,4 +1,4 @@
-This is a UPC-A Barcode generator for the flipper zero hardware.
+# This is a UPC-A Barcode generator for the flipper zero hardware.
 
 ## Author: [McAzzaMan](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator)
 
diff --git a/documentation/DangerousSettings.md b/documentation/DangerousSettings.md
@@ -0,0 +1,12 @@
+## How to extend SubGHz supported frequency range
+
+#### CC1101 Frequency range specs: 300-348 MHz, 386-464 MHz, and 778-928 MHz 
+#### This setting will extend to: 281-361 MHz, 378-481 MHz, and 749-962 MHz
+
+1. Please do not do that unless you know what exactly you are doing
+2. You don't need extended range for almost all use cases
+3. Extending frequency range and transmitting on frequencies that outside of hardware specs can damage your hardware!
+4. Flipper Devices team and/or unleashed fw developers is not responsible of any damage that can be caused by using CFW or extending frequency ranges!!!
+
+If you really sure you need that change, find `subghz/assets/dangerous_settings` file on your microSD, read comments on first lines
+and change `false` to `true`
diff --git a/documentation/SubGHzSettings.md b/documentation/SubGHzSettings.md
@@ -0,0 +1,63 @@
+## How to add new SubGHz frequencies
+
+#### CC1101 Frequency range specs: 300-348 MHz, 386-464 MHz, and 778-928 MHz 
+
+Edit user settings file located on your microSD card - `subghz/assets/setting_user`
+
+in this file you will find we already have extra frequencies added
+if you need your custom one, make sure it doesnt listed here
+
+### Default frequency list
+```
+    /* 300 - 348 */
+    300000000,
+    303875000,
+    304250000,
+    310000000,
+    315000000,
+    318000000,
+
+    /* 387 - 464 */
+    390000000,
+    418000000,
+    433075000, /* LPD433 first */
+    433420000,
+    433920000  /* LPD433 mid */
+    434420000,
+    434775000, /* LPD433 last channels */
+    438900000,
+
+    /* 779 - 928 */
+    868350000,
+    915000000,
+    925000000,
+```
+
+### User frequencies added AFTER that default list! You need to continue until you reach the end of that list
+
+### If you want to disable default list and use ONLY user added frequecies from user settings file
+Change that line
+`#Add_standard_frequencies: true`
+to
+`Add_standard_frequencies: false`
+
+### To add your own frequency to user list 
+Just add new line
+`Frequency: 928000000` - where `928000000` is your frequency, keep it in that format! it should be 9 digits!
+
+### Hopper frequency list
+To add new frequecy to hopper:
+add new line `Hopper_frequency: 345000000`<br>
+But remember! You should keep it as small as possible, or hopper functionality would be useless!<br>
+If `#Add_standard_frequencies: true` is not changed<br>
+Your frequencies will be added after default ones
+
+### Default hopper list
+```
+    310000000,
+    315000000,
+    318000000,
+    390000000,
+    433920000,
+    868350000,
+```

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-This is a UPC-A Barcode generator for the flipper zero hardware.`
	`1`	`+# This is a UPC-A Barcode generator for the flipper zero hardware.`
`2`	`2`
`3`	`3`	`## Author: [McAzzaMan](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator)`
`4`	`4`