mayhem-firmware/README.md
2020-06-06 15:51:32 +02:00

4.9 KiB

PortaPack Mayhem

Build Status buddy pipeline CodeScene Code Health Docker Hub Pulls

This is a fork of the Havoc, which was a fork of the PortaPack firmware, which is an add-on for the HackRF. A fork means it is a derivated, so it is basically a clone that has extra features and fixes over the older versions.

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

FAQ

The intention of the current repository is to try to get all the latest features and cleanest documentation for them, embracing any colaboration. To clarify any basic question, please read the following common ones:

Does it work on H1/H2 PortaPack?

Yes, those are the same. The one I am using to test all changes is this Portapack H2+HackRF+battery, which is a clone that includes everything you need. Sadly, the people making the H2 never published the updated PCB, so it is not "optimal" for the community.

Where is the latest firmware?

The current stable release is on the Release page. Follow the instructions on the description of the release itself to get it on your device.

There is also nightly builds generated frequently, but these may contain incomplete functionality.

Is this the newest firmware for my PortaPack?

Probably YES.

Which one is actually the newest?

There is a lot of confusion of which is the latest version because no old version used any actual "version number". Additionally, since the files were distributed on facebook groups, github issue links and similar temporal sources, then there was no central location for them.

This fork (Mayhem) uses major.minor.release semantic versioning, so you can always compare your current version with the latest from Releases.

What about Havoc/GridRF/jamesshao8/jboone's?

  • jboone's PortaPack: the vainilla experience
  • Havoc: It was the most popular fork of jboone's PortaPack, right now is readonly so it is not being developed
  • jamesshao8: He keeps his own version of the fork, while not attached as a fork to anything
  • GridRF: They sell PortaPack clones with their own firmware based on a old version, which has no sourcecode available

How can I colaborate

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 colaborating your time and effort first.

As a last option, if you want to send money directly to me for getting more boards, antennas and such, please use: paypal

What if I need help?

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

You can reach the official community in Facebook.