mayhem-firmware/README.md
2024-01-05 07:43:13 +01:00

7.5 KiB

Important

Shortly, this repository will be moved from my personal GitHub eried/portapack-mayhem to an organization: portapack-mayhem/portapack-mayhem. Please keep this in mind to update your links accordingly.

PortaPack Mayhem

Build Status Nightly Release CodeScene Code Health GitHub All Releases GitHub Releases Docker Hub Pulls Discord Chat

This is a fork of the Havoc firmware, which itself was a fork of the PortaPack firmware, an add-on for the HackRF. A fork is a derivate, in this case one that has extra features and fixes when compared to the older versions.

PortaPack H2+HackRF+battery (clone) with a custom 3d printed case

What is this?

If you are new to HackRF+PortaPack+Mayhem, check this video:

Beginner's Guide To The HackRF & Portapak With Mayhem

For people familiar with the Flipper Zero, this one might be interesting:
What is the HackRF One Portapack H2+?

Frequently Asked Questions

This repository expands upon the previous work by many people and aims to constantly add new features, bugfixes and generate documentation to make further development easier. Collaboration is always welcomed and appreciated.

What to buy?

✔️ A recommended one is this PortaPack H2, that includes everything you need with the plastic case "inspired" on this.

✔️ Our friends at OpenSourceSDRLab give away five units every three months in our discord (check the badge on top) of their PortaPack H2, you can support them too by ordering.

✔️ Another popular option is the clone of the PortaPack H1.

⚠️ Be cautious , ask the seller about compatibility with the latest releases. Look out for the description of the item, if they provide the firmware files for an older version or they have custom setup instructions, this means it might be NOT compatible, for example:

image

⚠️ If it looks too different, this might mean that they are using their own recipe, check the different models in our wiki. For example all the H3 and clones of that version use their own version of the firmware. They do not contribute the changes back and eventually you will be left with a device that nobody maintains:

image

Where is the latest version?

The current stable release is on the GitHub release (latest by date) page. Follow the instructions you can find in the release description. The latest (nightly) release can be found here.

How can I collaborate

You can write documentation, fix bugs and answer issues or add new functionality. Please check the following guide with details.

Consider that the hardware and firmware has been created and maintain by a lot of people, so always try collaborating your time and effort first. For coding related questions, if something does not fit as an issue, please join our Discord by clicking the chat badge on top.

Contributors

To support the people behind the hardware, please buy a genuine HackRF and PortaPack.

What if I really want something specific?

If what you need can be relevant in general, you can request a feature.

You can create a bounty and invite people to your own bounty. This will incentivize coders to work on a new feature, solving a bug or even writting documentation. Start a bounty by creating or choosing an existing issue. Then, go to Bountysource and post a bounty using the link to that specific issue.

Promote your bounty over our Discord by clicking the chat badge on top.

Bountysource has not been reliable lately, so until this changes, please DO NOT post a bounty there. Go to our Discord by clicking the chat badge on top and discuss there.

What if I need help?

First, check the documentation. If you find a bug or you think the problem is related to the current repository, please open an issue.

You can reach the official community in Facebook, and our Discord by clicking the chat badge on top.