From 0860e097858e61c404b64f3510a62fef2d3c16e8 Mon Sep 17 00:00:00 2001 From: Derek Jamison Date: Sat, 8 Apr 2023 08:57:13 -0400 Subject: [PATCH] Add install directions for Wiegand. --- gpio/wiegand/README.md | 54 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/gpio/wiegand/README.md b/gpio/wiegand/README.md index c571cb4..b492bce 100644 --- a/gpio/wiegand/README.md +++ b/gpio/wiegand/README.md @@ -27,3 +27,57 @@ This is similar to W26, but without the leading and trailing parity bits. The fi ## W32/W34/W37/W40: 32/34/37/40-bit Wiegand These formats are not very standardized, so the application will not try to interpret the data. You can modify the wiegand_data.c file to add your own interpretation. + +## Installation +### Step 1. Install Git and VS Code. + +If you have not already installed Git and VS Code, you will need to do so. The following links will take you to the download pages for Git and VS Code. + +- [Git](https://git-scm.com/downloads) +- [VS Code](https://code.visualstudio.com/download) + +### Step 2. Clone the Flipper Zero firmware. + +Clone the Flipper Zero firmware from GitHub. The following command will clone the firmware into a folder named official-firmware. (The below commands may wrap on your screen. You can copy and paste the entire command; there should only be two lines.) + +```console +cd +git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git official-firmware +``` + +Replace _<your working directory>_ with the directory where you want to clone the firmware. + +### Step 3. Run FBT to build the firmware and configure VS Code. + +Run the following commands from the root of the firmware folder to build the firmware and configure VS Code. Replace _<your working directory>_ with the directory where you cloned the firmware. In some environments you do not need the "./" at the beginning of the command. + +```console +cd +cd official-firmware +./fbt vscode_dist +./fbt updater_package +``` + +\*\*\* **Please follow the steps at [FBT VSCode integration](https://github.com/flipperdevices/flipperzero-firmware/blob/dev/documentation/fbt.md#vscode-integration) before proceeding.** \*\*\* + +### Step 4. Open the applications_user folder in VS Code. + +After following the previous step, navigate to the **applications_user** folder in VS Code. + +### Step 5. Crete a new folder for the application. + +Create a new folder for the application. The name of the folder will be the name of the application. For this example, we will use the name **wiegand**. + +### Step 6. Copy the application files. + +Copy the files from this project to the **wiegand** folder. Be sure to copy the scenes directory into a scenes directory in the **wiegand** folder. + +### Step 7. Build the application. + +Build the application by running the following command from the root of the firmware folder. Replace _<your working directory>_ with the directory where you cloned the firmware. In some environments you do not need the "./" at the beginning of the command. + +```console +cd +cd official-firmware +./fbt launch_app APPSRC=applications_users/wiegand +```