flipperzero-firmware-wPlugins/MACOS_GUIDE.md
tonywald 84970f6d55
Update MACOS_GUIDE.md
Added instructions to fix brew bundle errors
2023-12-27 14:20:49 -08:00

3.1 KiB

macOS compile guide by deafbed,

  • Updated by @eltonalvess, and @tonywald

Tested with M1 Macbook Air, macOS Monterey (12.4)

⬆️ Update

  • Tested with M1 Macbook Pro, macOS Ventura (13.4, 22F66) [06-06-2023]
  • Tested with M1 Macbook Air, macOS Sonoma (14.1.2) [12-27-2023]

FROM THE BEGINNING

Install qFlipper


Install the Homebrew application

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Open Terminal.app or iTerm.app and run source ~/.bashrc of if you are using zsh the command should be source ~/.zshrc (It will refresh enviroment variables that Homebrew creates).

To have sure that Brew was installed sucessfully then run

brew help it should output something like this:

out


Download the source code of the firmware

To clone the repository, just run the command below:

git clone --recursive https://github.com/RogueMaster/flipperzero-firmware-wPlugins.git

It will download the latest build files from the github repository (in your prefered folder)

Inside the source code folder (flipperzero-firmware-wPlugins) run the follow command:

chmod u+x buildRelease.sh

This command will give permission to execute the Shell Script (.sh).


Install the necessary prerequisites

Go to the downloaded firmware folder

cd flipperzero-firmware-wPlugins

Next, we run the following command to download the remaining requirements:

brew bundle --verbose

If you get the error Homebrew Bundle failed! 1 Brewfile dependency failed to install., try running brew install --cask gcc-arm-embedded. You can verify that this fixes the error by running brew bundle --verbose again.


Compile

To compile the source code just run the following command inside the root folder.

./buildRelease.sh

😴 It will start to compile, be patient it take a while!


The output files

If everything goes well it will appear some 3 files in the root folder like the image below:

image


Updating using qFlipper

  1. Connect the Flipper Zero to your pc.

image

  1. Click in Install from File
  2. Select the compiled firmware file created on the root folder i.e RM0606-0922-0.84.3-36d65f3.tgz

image

  1. Click Install.

If everything worked, your Flipper should be recognized and the firmware version should match the github commit shown here:

https://github.com/RogueMaster/flipperzero-firmware-wPlugins