mayhem-firmware

The SD Card provides a memory resource that can be tailored to the specific user. Technical details of the card are given here. The SD Card Standard image is supplied as part of the standard firmware download. Instructions for its use are supplied elsewhere. The following folders on the SD Card contains various app-specific information (some of these folders are included in the SD Card image file, and some may be created afterwards either by firmware or by the user):

ADSB: The ADBS Folder has databases of Airlines, IACO and is where the world map is located. See separate page on how to generate the map.
AIS: Holds the AIS database.
APPS: Holds "external" apps. Several apps have been moved from firmware flash ROM to external files (with .ppma extension) stored on the SD card, to make room in the Mayhem ROM for new apps and features.
APRS: Holds log files from the APRS-RX app.
AUDIO: Holds audio recordings (WAV) from the Audio app.
BLERX: Holds log files from the BLE-RX app.
BLETX: Holds files for the BLE-TX app.
CAPTURES: Holds IQ capture files (C16/C8 and their metadata TXT files) from the Capture app.
DEBUG: Holds various debugging log files.
FIRMWARE: bin files can be placed here and used to update the PortaPack firmware without a computer.
FREQMAN: Holds FreqMan DB files which are lists of frequencies that can be loaded by various apps. They can be viewed and edited using the FreqMan app.
- Fixed frequencies in Apps: It should be noted that in some Apps that the frequency ranges are fixed in the App and are not selectable in from FREQMAN lists. Example of this are "AIS" and TPMS. (In some cases the .ini settings file may be modified manually to change the frequency and other settings that aren't configurable when running the app itself.)
GPS: This file holds information on how to generate GPS-Simulation files.
LOGS: Holds log files for various apps like ADSB, POCSAG, ERT, etc.
LOOKINGGLASS: This folder holds a text file that is used in the LOOKINGGLASS App and is a list of the frequency scan ranges and a description. It should be noted that this APP can have only have ranges that are a minimum of 240MHz in size.In addition the range must start form 10MHz. the nominal Minimum operational frequency of HackRF. Therefore you need to consider this in planning the frequency range listed. For example you could not have a range for VHF amature band , You can only have a range from 10-250 MHz. These are very wide ranges in keeping with the Ap concept of Wide Scan of the spectrum.
PLAYLIST: Holds playlist files (PPL) for the Replay app.
REMOTES: Holds remote files (REM) used by the Remote and TouchTune apps.
SAMPLES: Holds an example of some settings for the use in OOK TX App
SCREENSHOTS: Holds screenshots (SCR) taken on the device.
SETTINGS: Holds settings for applications. If you're having a problem with an app, try deleting its settings file to restore defaults (the .ini file will be rewritten any time an app is exited). An optional "blacklist" file may also be stored in this directory (lists any unwanted apps).
SPECTRUM: Holds BMP images for the Spectrum Painter app.
SPLASH: Holds custom splash screen BMP files. (Note however that the currently-active splash image file must be in the root directory and named "splash.bmp").
SSTV: Holds some Standard Images for the use in the SSTV app.
WAV: Holds sound files that are used in the SoundBoard app.
WHIPCALC: Holds information on the Whip lengths that are used in the App calculation. Additional Whips can be added with their specific details.

SD card contents can be viewed/edited using the File Manager application, or via USB from a computer using the "SD over USB" app, or the physical SD card can be removed from PortaPack and plugged into a computer. Use caution when reinstalling the SD card into the PortaPack as it may fall into the device and require case disassembly to fetch it.

NOTE: The File Manager app currently has a memory limitation; an "out of memory" fault may occur with a large number of files in a single folder (more than about 80, depending on firmware version).

Start here

How to collaborate
How to ask questions correctly

User manual

First steps
- About firmwares
- Redirections on this manual/project
Usage cautions
Intended use and Legality
Features
PortaPack Versions (which one to buy)
HackRF Versions
- Original GSG HackRF One
- Clifford's-version
Firmware update procedure
- Updating the Xilinx CPLD on hackrf board
Description of the hardware
- Enclosure/cases
  - 3d printed enclosure
- Internal speaker
- SMD buttons and caps
- Encoder knob
- SMA Antenna connector
User interface
Powering the PortaPack
Troubleshooting
Applications
- Receivers
  - ADS-B
  - AFSK
  - AIS Boats
  - Analog TV
  - APRS
  - Audio
  - BLE RX
  - ERT Meter
  - Level
  - NRF
  - POCSAG
  - Radiosonde
  - Recon
  - Search
  - TPMS Cars
  - Weather/SubGhzD
  - Fox-Hunt
  - ProtoView
- Transmitters
  - ADS-B(S)
  - APRS
  - BHT Xy/EP
  - BLE TX
  - Burger Pager
  - GPS Sim
  - Jammer
  - LGE Tool
  - Morse
  - OOK
  - OOK Editor
  - POCSAG
  - RDS
  - Soundboard
  - Spectrum Painter
  - SSTV
  - TEDI/LCR
  - TouchTunes
  - BLESpam
- Capture
  - C16 Format
- Replay
- Remote
- Scanner
- Microphone Transceiver
- Looking Glass
- Utilities
- Settings
  - App Settings
  - Audio
  - Blacklist
  - Calibration
  - Touchscreen Threshold
  - Config Mode
  - Converter
  - Date/time
  - Encoder Dial
  - Freq. Correct
  - P.Mem Mgmt
  - QR code
  - Radio
  - User Interface
  - Brightness
  - Menu Color
- Debug
- HackRF Mode
- USB Serial Console

Developer Manual

Compilation of the firmware
Create a custom map
Code formatting
PR process
Description of the Structure
Software Dev Guides
- Code contribution rules
- Create a Simple App
- Building External Apps
- Widgets
- SD Card
- Access Radio Hardware
- Interpret Guru meditation crashes
- Create a Complex App
- Theme-system
- Debug via SWD & JTAG
- Debug with serial
- I2C drivers
Tools
Research
- Dissecting the Temperature Logger
- Differences between H1 and H2
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.