From 1b1392ca7a94f5362ff49072fdbf41dd29582c03 Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 21 Aug 2023 21:27:00 +0200 Subject: [PATCH 1/2] docs: updated README --- README.md | 259 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 178 insertions(+), 81 deletions(-) diff --git a/README.md b/README.md index 0459ee7f..fb52fbd8 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,193 @@ -# Flipper-IRDB + -A **maintained** collective of different IR files for the Flipper! We'd love to have your additions! [See here.](https://github.com/UberGuidoZ/Flipper-IRDB/blob/main/README.md#organization) +

+ A maintained collective of different IR files for the Flipper Zero! +

-Maintainers/Major contributors include: -* [Lucaslhm](https://github.com/Lucaslhm) (*[Maintained Repo](https://github.com/Lucaslhm/Flipper-IRDB)*) -* [UberGuidoZ](https://github.com/UberGuidoZ) (*[Maintained Fork](https://github.com/UberGuidoZ/Flipper-IRDB)*) -* [ezod](https://github.com/ezod) (*[Maintained Fork](https://github.com/logickworkshop/Flipper-IRDB)*) -* [amec0e](https://github.com/amec0e) -* [darmiel](https://github.com/darmiel) -* [DedHedZed](https://github.com/dedhedzed) -* [SkeletonMan](https://github.com/SkeletonMan03/) -* [Seall.DEV](https://github.com/sealldeveloper) -* [jaroslavmraz](https://github.com/jaroslavmraz) -* [E_Surge](https://github.com/ESurge) -* [Zecred](https://github.com/bussardrobbie) -* [wdoekes](https://github.com/wdoekes) -* ... plus MANY others! -## Make your own manually! +## Installation + +### Method 1: Copy Files to SD Card + +Directly copying the .ir files to the Flipper's SD card is the fastest and safest method, but you have to [dismount the SD card](https://docs.flipperzero.one/basics/sd-card#g4-removing-the-sd-card) and plug it into the computer directly. + +1. [Download and extract](https://github.com/logickworkshop/Flipper-IRDB/archive/refs/heads/main.zip) or [Git-clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) this repo to your computer. +2. Open the downloaded / cloned repository in a File Explorer. +3. [Dismount the SD card](https://docs.flipperzero.one/basics/sd-card#g4-removing-the-sd-card) from the Flipper and mount it to your computer +4. Copy the desired files from the Flipper-IRDB to the `infrared/` folder on your SD Card +5. Dismount the SD card from your computer and mount it to your Flipper + +### Method 2: Copy Files using [QFlipper](https://flipperzero.one/update) + +> [!IMPORTANT] +> Because of Flipper limitations, the transfer via QFlipper can take a long time, depending on how many files you want to copy. +> If you only want to copy several files, this will work fine, but if you want to load the entire Flipper-IRDB onto your Flipper, **we strongly recommend copying the files directly onto the SD card**. + +1. [Git-clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) or [Download and extract](https://github.com/logickworkshop/Flipper-IRDB/archive/refs/heads/main.zip) this repository to your computer. +2. Connect your Flipper to your PC using a USB-C cable. +3. Open [QFlipper](https://flipperzero.one/update) +4. Verify that your Flipper shows "Connected" +5. Ensure your Flipper is fully up-to-date: + 1. Look for the green "Update" button near the middle-right of the application. + 2. Press "Update" and allow the Flipper to complete the Update process and then reboot before continuing. +6. Open the File Manager by selecting the "File Manager" icon (piece of paper) on the top left of the QFlipper application. +7. Select `SD Card`, then navigate to the `infrared` folder by double-clicking its icon. +8. Drag the downloaded `.ir` files you want on your Flipper from the File Explorer into the QFlipper File Manager. + + +## Contributing + +We welcome contributions to Flipper-IRDB! +If you have any IR files that are not included in the repository, **we would love to have your additions**. + +This repo is organized in the following fashion in descending order: + +> `Device Type` > `Device Brand` > `Device Series` (if known/applicable) + +When adding remotes to this repo, it is helpful to ensure your device name(s) follow the `_.ir` naming scheme. +It is also helpful to ensure your model numbers are capitalized, as per the following examples: + +* :white_check_mark: `LG_55UN7300AUD.ir` +* :x: `LG_55UN7300AUD.txt` (wrong extension) +* :x: `lg_55un7300aud.ir` (model numbers not capitalized) +* :x: `tv.ir` (too generic) + +It's helpful to add further information as a comment directly into the IR file if possible. +Make, model, link, or even a short description can be helpful if the name is changed +(or just in general). + +```bash +Filetype: IR signals file +Version: 1 +# +# Dynex EN-21669D TV <-- +# +name: Power +``` + +### Naming Scheme + +Please use this naming scheme for buttons. +This helps us create universal assets more easily and maintain cosistency. + +| TVs | Audio | ACs | +| --------- | -------- | --------- | +| `Power` | `Power` | `Off` | +| `Vol_up` | `Vol_up` | `Cool_hi` | +| `Vol_dn` | `Vol_dn` | `Cool_lo` | +| `Ch_next` | `Next` | `Heat_hi` | +| `Ch_prev` | `Prev` | `Heat_lo` | +| `Mute` | `Mute` | `Dh` | +| | `Play` | | +| | `Pause` | | -Did you know IR files are plain text files? If a remote is missing, you might be able to [make it manually](https://github.com/RandomDebugError/irdb). ## Universal Remotes -The maintainers (mostly amec0e) add individual additions to the various Universal Remotes in Unleashed, which are adapted by many other firmware options. If you would like to contribute to the Universal Remotes, please make sure to follow the naming convention below. For ACs, [this is an important read](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/UniversalRemotes.md). +The maintainers (mostly [amec0e](https://github.com/amec0e)) add individual additions to the various Universal Remotes in [unleashed-firmware](https://github.com/DarkFlippers/unleashed-firmware), which are adapted by many other firmware options. +If you would like to contribute to the Universal Remotes, please make sure to follow the [naming scheme](#naming-scheme) above. +For ACs, [this is an important read](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/UniversalRemotes.md). -## Organization -This repo is organized in the following fashion in descending order: -* Device Type -* Device Brand -* Device Series (Where known/applicable) +## Make your own manually! -When adding remotes to this repo, it is helpful to ensure your device name(s) follow the `brand_model.ir` naming scheme. It is also helpful to ensure your model numbers are capitalized, as per the following example: +Did you know IR files are plain text files? +If a remote is missing, you might be able to [make it manually](https://github.com/RandomDebugError/irdb). -`LG_55UN7300AUD.ir` -Please use this naming scheme for buttons. +## Maintainers -**FOR TV** +Maintainers / Major contributors include: -Power
-Mute
-Vol_up
-Ch_next
-Vol_dn
-Ch_prev + + + + + + + + + + + + + + + + + +
+ + Lucaslhm +
+ Lucaslhm + + 		+ + UberGuidoZ +
+ UberGuidoZ + + 		+ + ezod +
+ ezod + + 		+ + amec0e +
+ amec0e + + 		+ + darmiel +
+ darmiel + + 		+ + dedhedzed +
+ dedhedzed + + 		+ + SkeletonMan03 +
+ SkeletonMan03 + +
+ + sealldeveloper +
+ sealldeveloper + + 		+ + jaroslavmraz +
+ jaroslavmraz + + 		+ + ESurge +
+ ESurge + + 		+ + bussardrobbie +
+ bussardrobbie + + 		+ + wdoekes +
+ wdoekes + +
-**FOR AC** - -Off
-Cool_hi
-Cool_lo
-Heat_hi
-Heat_lo
-Dh - -**FOR AUDIO** - -Power
-Vol_up
-Vol_dn
-Mute
-Next
-Prev
-Play
-Pause - -Lastly, it's helpful to add further information as a comment directly into the IR file if possible. Example: - -`Filetype: IR signals file`
-`Version: 1`
-`#`
-`# Dynex EN-21669D TV` <---
-`#`
-`name: Power`
- -Make, model, link, or even a short description can be helpful if the name is changed (or just in general)! - -## To Install New Remotes On Your Flipper: - -1. Git clone this repo to your local PC. [Multiple options are explained here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). -2. Open the cloned repository in a File Explorer. -3. Connect your Flipper to your PC using a USB-C cable. -4. Open [QFlipper](https://flipperzero.one/update) -5. Verify that your Flipper shows "Connected" -6. Ensure your Flipper is fully up-to-date: - 1. Look for the green "Update" button near the middle-right of the application. - 2. Press "Update" and allow the Flipper to complete the Update process and then reboot before continuing. -7. Open the File Manager by selecting the "File Manager" icon (piece of paper) on the top left of the QFlipper application. -8. Select `SD Card`, then navigate to the `infrared` folder by double-clicking its icon. -9. Drag the .ir files you want on your Flipper from the File Explorer into the QFlipper File Manager. -10. Disconnect the Flipper from the PC and have fun! - -NOTE: If you plan to copy them all, it's highly recommended to [dismount the SD card](https://docs.flipperzero.one/basics/sd-card#g4-removing-the-sd-card) and plug it into the computer directly. +*plus MANY others!* From 96cf50d15e46cddbae87395b0ee24d263a232ed9 Mon Sep 17 00:00:00 2001 From: Daniel Date: Tue, 22 Aug 2023 20:47:59 +0200 Subject: [PATCH 2/2] fix: updated header ref --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fb52fbd8..9c4d5187 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ - +

A maintained collective of different IR files for the Flipper Zero!

- ## Installation ### Method 1: Copy Files to SD Card @@ -187,7 +186,8 @@ Maintainers / Major contributors include: wdoekes + + plus MANY others! + - -*plus MANY others!*