TheArchive/mayhem-firmware
1
0
Fork 0
mirror of https://github.com/portapack-mayhem/mayhem-firmware.git synced 2024-11-27 12:05:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Update firmware (markdown)

Erwin Ried 2024-06-11 09:59:05 +02:00
parent 996b1b68a9
commit ba264e783c
1 changed files with 18 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
Update-firmware.md

@ -1,39 +1,37 @@
# TLDR # TLDR
Giving the fact that too much people still having issue reading this guide, please carefully read this chapter so you'll know basic concept of how to update.
**Please note that this chapter is just for making the concept clear, you still need to read all other chapter below for detailed guide!**
The basic updating procedure can be simply done by following two steps:
1. Update your sdcard content. This need you copy about 2 GB files, which is recommend to pull out your sdcard and use a sdcard reader on computer to copy files. (You don't need to do this every time, since the sdcard content won't change much. However if sdcard content changed in the new release, you should do it.)
2. Update firmware + external apps. This can be done by following ways (pick one of them):
* On a computer, enter HackRF mode, flash with a usb cable, then copy and paste external apps into sdcard. The basic procedure:
* Use hackrf.app website.
* Copy firmware all in one tar package into sdcard, and offline update with Flash Utilty app in portapack. 1. Update your sdcard content.
2. Update firmware, choose one method:
* Enter HackRF mode, flash with a usb cable.
* Use [hackrf.app](https://hackrf.app/) website.
* Copy firmware all in one tar package into sdcard, and offline update with Flash Utility app in portapack.
# Side notes # Side notes
- If you are UNDER v2.0.0 or nightly n_240114, you can only update with hackrf mode with normal procedure (instead of update with hackrf serial). Above v2.0.0 or nightly n_240114, you are free to update whatever you want, however, online serial update is still recommend. - UNDER v2.0.0 or nightly n_240114, you can only update with hackrf mode with normal procedure
- You can cross versions upgrade (e.g. 1.2.0 -> 2.0.1), also you can downgrade whatever you want(e.g 2.0.0 -> 1.9.1). But note that if sdcard content version not match, things may not work properly. Please make sure sdcard content versions match. - When downgrading, please make sure sdcard content versions match.
- Updating steps order doesn't matter, as long as you finish all of them at the end. - Mayhem firmware contains hackrf firmware. You DO NOT need to flash hackrf firmware.
- Mayhem firmware contains hackrf firmware. You DO NOT need to flash hackrf firmware. In another word, there are only one firmware on your device that you can manually control.
- 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 to do for you. - 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 to do for you.
# Detail guide # Detail guide
>If you prefer watching a video guide, you should watch this one: If you prefer watching a video guide, check [this](https://www.youtube.com/watch?v=qM7Q9IidK2o).
>[click here](https://www.youtube.com/watch?v=qM7Q9IidK2o)
## Firmware ## Firmware
Get the latest firmware from the [![GitHub release (latest by date)](https://img.shields.io/github/v/release/portapack-mayhem/mayhem-firmware?label=Releases&style=social)](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. Please check the [FAQ](https://github.com/portapack-mayhem/mayhem-firmware#frequently-asked-questions) if you have any additional question.
Get the latest firmware from the [![GitHub release (latest by date)](https://img.shields.io/github/v/release/portapack-mayhem/mayhem-firmware?label=Releases&style=social)](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. Please check the [FAQ](https://github.com/portapack-mayhem/mayhem-firmware#frequently-asked-questions).
### HackRF/PortaPack itself via Flash Utility ### HackRF/PortaPack itself via Flash Utility
> Note: If you didn't see the Flash Utility app, it would means your fw version is not support. Try using other methods to update to latest version. > Note: If you don't see the Flash Utility app, try using other methods to update to latest version.
The [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility) can also be used to program new firmware from a bin file stored on a MicroSD card, mentioned below. The Flash utility is the update method of choice for users that may not want to run an app on their PC, or may want to switch between firmware versions when in the field. If you download and unzip the latest mayhem_v#.##_COPY_TO_SDCARD.zip contents to your SD card, the latest firmware image will be found in the FIRMWARE folder (this method also updates the external apps in the APPS folder, mentioned below). The [Flash Utility](https://github.com/portapack-mayhem/mayhem-firmware/wiki/Flash-Utility) can also be used to program new firmware from a bin file stored on a MicroSD card.
### Windows ### Windows
@ -65,13 +63,13 @@ _HackRF CLI tools for MacOS available through MacPorts or Homebrew_
## MicroSD card files ## MicroSD card files
Your PortaPack has a slot for a memory card. 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. 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 [![GitHub release (latest by date)](https://img.shields.io/github/v/release/portapack-mayhem/mayhem-firmware?label=Releases&style=social)](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. You need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.7z` to a FAT32 formatted MicroSD card. Get the latest files from the [![GitHub release (latest by date)](https://img.shields.io/github/v/release/portapack-mayhem/mayhem-firmware?label=Releases&style=social)](https://github.com/portapack-mayhem/mayhem-firmware/releases/latest) page. You need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.7z` to a FAT32 formatted MicroSD card.
> [!NOTE] > [!NOTE]
> How to put into sdcard? > How to put into sdcard?
> Extract the root directory of the 7z archive into the root directory of your sdcard. > Extract the root directory of the 7z archive into the root directory of your sdcard.
> - Don't directly put the 7z archive file into sdcard > - Don't put the 7z archive file directly into your sdcard
> - Don't extract into any sub-folder of sdcard > - Don't extract into any sub-folder of sdcard
> - Don't use unbranded sdcard. > - Don't use unbranded sdcard.
> ![Screenshot_20240121_101958](https://github.com/portapack-mayhem/mayhem-firmware/assets/24917424/e14a2ef7-37bd-4a00-b19f-101235093e01) > ![Screenshot_20240121_101958](https://github.com/portapack-mayhem/mayhem-firmware/assets/24917424/e14a2ef7-37bd-4a00-b19f-101235093e01)