This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Common workflow
- Update your SD card content
- Connect USB cable
- Use one of the following methods:
- Enter HackRF mode, flash with hackrf_spiflash
- Stay in Mayhem mode, use hackrf.app website (this automatically update external sdcard apps corresponding to the firmware version)
- Copy firmware all in one tar package into SD card, and offline update with Flash Utility app in portapack (this automatically update external sdcard apps corresponding to the firmware version)
Detailed video guide
If you prefer watching a video guide, check this.
Detailed Firmware Update procedures
Using firmware file from github release page and the Flash Utility
-
Copy it to your SDCARD, put it back in your PortaPack
-
Flash it via the Flash Utility in "Utilities" menu on your PortaPack
Note
- If you don't see the Flash Utility app, try using other methods to update to latest version
- The Flash Utility can also be used to program new firmware from a bin file stored on a MicroSD card
Using firmware file from github release page and the classic hackrf_spiflash tool
Note
⚠️ Using that method, you NEED to update the SDCARD content accordingly to the release you choose, else the external apps will not work !
Windows
- Connect the device via USB.
- Switch to HackRF mode via the on-screen option. (In the PortaPack)
- Double click
flash_portapack_mayhem.bat
and follow the instructions. - Reboot the device.
Linux
- Connect the device via USB
- Switch to HackRF mode via the on-screen option. (In the PortaPack)
- Upload the firmware with
hackrf_spiflash -w new_firmware_file.bin
(eg. portapack-h1_h2-mayhem.bin for mayhem firmware or hackrf_one_usb.bin for stock HackRF firmware) - Reboot the device
Note
- To Ubuntu and Mint user: Ubuntu based distro never maintains their repo for HackRF host (cli client) package. You’ll face a lot of weird problems if your HackRF is R9. To resolve these, please compile the HackRF package yourself, or use another distro.
MacOS
- If necessary, install the HackRF tools:
brew install hackrf
- Connect the device via USB
- Switch to HackRF mode via the on-screen option (in the PortaPack)
- Upload the firmware with
hackrf_spiflash -w new_firmware_file.bin
- Reboot the device
Update SDCARD files
You need to provide a MicroSD with enough space (16GB is recommended, over 32GB will be omitted due the limits of the FAT32). This is necessary for certain functionality, like the world map, GPS simulator, external apps, and others.
Get the latest files from the page. You need to uncompress (using 7-zip) the files from mayhem_vX.Y.Z_COPY_TO_SDCARD.7z
to a FAT32 formatted MicroSD card.
Note
How to put into SD card?
Extract the root directory of the 7z archive into the root directory of your SD card.
Using the hackrf.app website
- You need to use a browser compatible with Web USB Serial
- The update using the website is only updating the firmware and external apps on the sdcard. If you want/need a full sdcard content update, please follow first the Update SDCARD files article, then update using the website
Procedure
- Connect portapack using an USB cable with DATA enabled
- Navigate to https://hackrf.app/
- If never done, click on "Connect Device"
- On the little pop up, select your Portapack, click 'Connect'
- You should see "HackRF Connected" on top of the page, and the Live Screen will load the first screenshot
- Scroll down to "Manage Firmware", and click it
- Choose the firmware version to install (stable, nightly, or from a custom ppfw file)
- Wait for the file to be uploaded, and for your device to automatically reboot
- Done !
Troubleshooting
- Please check this guide
- External apps (.ppma files in the APPS folder) will only function if their version matches the firmware version
- Please check the FAQ
- If your fimware version is lower or equal to v2.0.0 or nightly n_240114, you can only update firmware in HackRF mode with classic procedure
- Updating using the hackrf.app website is only working for stable version bigger or equal to v2.0.1, nightly version newer than n_240114
- When downgrading, please make sure SD card content versions match.
- Mayhem firmware contains HackRF firmware. You DO NOT need to flash HackRF firmware.
- In theory, it is impossible to brick the device, since you can always try the DFU recovery procedure. However, the updating might become fiddly in certain conditions. So you probably need basic computer usage knowledge (running/installing software, read documents, knowing USB ports, adjust system settings, reading English, etc.) if you don't, you probably should ask your friends or someone who knows these things to do it for you.
How to collaborate
How to ask questions correctly
User manual
- First steps
- Usage cautions
- Intended use and Legality
- Features
- PortaPack Versions (which one to buy)
- HackRF Versions
- Firmware update procedure
- Description of the hardware
- User interface
- Powering the PortaPack
- Troubleshooting
- Applications
Developer Manual
- Compilation of the firmware
- Compile on WSL with ninja
- How to compile on Windows faster with WSL 2
- Using Docker and Kitematic
- Docker command-line reference
- Using Buddyworks and other CI platforms
- Notes for Buddy.Works (and other CI platforms)
- Using ARM on Debian host
- All in one script for ARM on Debian host
- Compile on Arch based distro (exclude Asahi)
- Dev build versions
- Notes About ccache
- Create a custom map
- Code formatting
- PR process
- Description of the Structure
- Software Dev Guides
- Tools
- Research
- UI Screenshots
- Maintaining
- Creating a prod/stable release (Maintainers only)
- Maintaining rules
- Development States Notes
Note
The wiki is incomplete. Please add content and collaborate.
Important
- This is a public wiki. Everything is visible to everyone. Don't use it for personal notes.
- Avoid linking to external tutorials/articles; they may become outdated or contain false information.