Add subghz readme files

This commit is contained in:
Derek Jamison 2023-02-15 16:11:15 -05:00
parent f23c54ac4f
commit 1a7a71e7f1
5 changed files with 26 additions and 1 deletions

View File

@ -14,7 +14,7 @@ Feel free to reach out to me at CodeAllNight@outlook.com with any questions or l
[tutorial](./gpio/gpio_polling_demo/README.md) - This is a "hello world" demonstration of reading a GPIO pin using polling. [tutorial](./gpio/gpio_polling_demo/README.md) - This is a "hello world" demonstration of reading a GPIO pin using polling.
## Subghz ## Subghz [folder](./subghz/README.md)
### subghz-plugins-subghz_demo ### subghz-plugins-subghz_demo
[tutorial](./subghz/plugins/subghz_demo/README.md) - This is a demonstration of sending & receiving radio signals using the subghz_tx_rx worker library. [tutorial](./subghz/plugins/subghz_demo/README.md) - This is a demonstration of sending & receiving radio signals using the subghz_tx_rx worker library.

7
subghz/README.md Normal file
View File

@ -0,0 +1,7 @@
# Sub-GHz
The Flipper Zero "Sub-GHz" radio is used for receiving and transmitting frequencies below the 1GHz (1000MHz) range. In particular, the firmware supports 300-348 MHz, 387-464 MHz, and 779-928 MHz operational bands. Depending on your region there may be additional [restrictions](https://docs.flipperzero.one/sub-ghz/frequencies).
This enlistment contains the following:
- [Plugins](./plugins/README.md) are applications & games that can be added to the Flipper Zero. These applications utilize the subghz radio.
- [Protcols](./protocols/README.md) extend the Sub-GHz "Read" feature of your Flipper with the ability to support new protocols.
- [Samples](./samples/README.md) are samples captured by various remotes I own.

5
subghz/plugins/README.md Normal file
View File

@ -0,0 +1,5 @@
# Sub-GHz Plugins
Add new applications to your Flipper Zero that utilize the Sub-GHz protocol.
- [Subghz demo](./subghz_demo/README.md) is a tutorial to demonstrate how to add Sub-GHz support into your own applications.
- [Rock Paper Scissors](./rock_paper_scissors/README.md) is a two-player game that utilizes the Sub-GHz chat protocol.

View File

@ -0,0 +1,4 @@
# Sub-GHz Protocols
Extend the Sub-GHz "Read" feature of your Flipper with the ability to support new protocols.
- [X10](./x10/README.md) support for x10.com devices.

9
subghz/samples/README.md Normal file
View File

@ -0,0 +1,9 @@
# Sub-GHz Samples
These are samples captured by various remotes I own.
- [Chevy HHR 2006](./chevy-hhr-2006/README.md) vehicle keyfob.
- [Quantum Fire](./quantum-fire/README.md) fireworks controller.
- [X10](./x10/README.md) x10.com controller.
Check out my [YouTube videos](../../youtube/README.md#sub-ghz) for more information on how to use these files.
The file format is [documented](https://flipperdevices.github.io/flipperzero-firmware/md_docs_file_formats__sub_ghz_file_formats.html) on the flipperdevices github account.