Stats

F4HWN firmware port for the UV-K1 and UV-K5 V3 using the PY32F071 MCU

This repository is a fork of the F4HWN custom firmware, who was a fork of Egzumer custom firmware. It extends the work done for the UV-K5 V1, based on the DP32G030 MCU, and adapts it to the newer UV-K1 and UV-K5 V3 built around the PY32F071 MCU. It is the result of the joint work of @muzkr and @armel.

A big thanks to DualTachyon, who paved the way by releasing the very first open-source firmware for the UV-K5 V1. None of this would have been possible without that initial work !

A note for developers who intend to fork this project

This firmware is distributed under the Apache 2.0 License, carrying forward the original copyright of DualTachyon, whose work laid the foundation for the UV-K5 open-source ecosystem. If you create a fork or a derived version, we strongly encourage you to keep your work open source.

Keeping your fork open:

• aligns with the intent and spirit of the Apache 2.0 License
• supports the amateur-radio and embedded-development community
• avoids unnecessary fragmentation
• allows others to study, audit and improve the firmware

It is also very much in line with the ham spirit: sharing knowledge, experimenting together and helping each other, rather than closing things off or claiming them as your own.

Maintaining an open-source fork is the best way to help build a healthy and sustainable ecosystem for everyone.

[!WARNING] EN - THIS FIRMWARE HAS NO REAL BRAIN. PLEASE USE YOUR OWN. Use this firmware at your own risk (entirely). There is absolutely no guarantee that it will work in any way shape or form on your radio(s), it may even brick your radio(s), in which case, you'd need to buy another radio. Anyway, have fun.

FR - CE FIRMWARE N'A PAS DE VÉRITABLE CERVEAU. VEUILLEZ UTILISER LE VÔTRE. Utilisez ce firmware à vos risques et périls. Il n'y a absolument aucune garantie qu'il fonctionnera d'une manière ou d'une autre sur votre (vos) radio(s), il peut même bousiller votre (vos) radio(s), dans ce cas, vous devrez acheter une autre radio. Quoi qu'il en soit, amusez-vous bien.

[!NOTE] EN - About CHIRP, as with many other firmwares, you need to use a dedicated driver. The matching CHIRP driver is now bundled with each release of this repository, so you can download the firmware and its driver together from the Releases page.

FR - A propos de CHIRP, comme pour beaucoup d'autres firmwares, vous devez utiliser un pilote dédié. Le driver CHIRP correspondant est désormais fourni avec chaque release de ce dépôt, ce qui permet de récupérer ensemble le firmware et son pilote depuis la page des Releases.

[!CAUTION] EN - I recommend backing up your calibration data with UV Studio immediately after flashing this firmware. It is a good habit to adopt.

FR - Je recommande de sauvegarder vos données de calibration avec UV Studio juste après avoir flashé ce firmware. C'est un bon réflexe à adopter.

Donations

Special thanks to Jean-Cyrille F6IWW (3 times), Fabrice 14RC123, David F4BPP, Olivier 14RC206, Frédéric F4ESO, Stéphane F5LGW (2 times), Jorge Ornelas (4 times), Laurent F4AXK, Christophe Morel, Clayton W0LED, Pierre Antoine F6FWB, Jean-Claude 14FRS3306, Thierry F4GVO, Eric F1NOU, PricelessToolkit, Ady M6NYJ, Tom McGovern (4 times), Joseph Roth, Pierre-Yves Colin, Frank DJ7FG, Marcel Testaz, Brian Frobisher, Yannick F4JFO, Paolo Bussola, Dirk DL8DF, Levente Szőke (2 times), Bernard-Michel Herrera, Jérôme Saintespes, Paul Davies, RS (3 times), Johan F4WAT, Robert Wörle, Rafael Sundorf, Paul Harker, Peter Fintl, Pascal F4ICR (2 times), Mike DL2MF (3 times), Eric KI1C / F4WFS (3 times), Phil G0ELM, Jérôme Lambert, Eliot Vedel, Alfonso EA7KDF, Jean-François F1EVM, Robert DC1RDB (2 times), Ian KE2CHJ, Daryl VK3AWA, Roberto Brunelli, Robert Boardman, Stephen Oliver, Nicolas F4INE, William Bruno, Daniel OK2VLK, Tayler Chew, Peter DL7RFP, Philippe Kopp, Rune LA6YMA, Jeremy Luna, Steef Wagenaar (2 times), Zhuo BG7SGA, Jamie M0JLB, Antoine LIBERT, Vince K0DKR, Julia DF7JA, Ken 2E0UMK, Victor TI2SYS, Tobi DG9LAY, Deaglan K4DFQ, Catherine PALMER, Brian WA6JFK, Stéphane Hintzy, Roger F1HCN, Marcin Kusaj, Flavio Cottarelli, Bob N1MLZ, Carlos EA1IJ, Brian M7YLF, Giuseppe IT9LLH and 邓 月 for their donations. That’s so kind of them. Thanks so much 🙏🏻

Table of Contents

• Main features and improvements from F4HWN
• Main Features from Egzumer
• Manual
• Compiling and Building from Docker
• Flashing the Firmware with UV Studio
• Credits
• Other sources of information
• License

Main features and improvements from F4HWN

Fusion edition

Fusion is the reference edition of the project. It provides an all-in-one firmware for the UV-K1 and UV-K5 V3, including:

• Fagci's spectrum analyzer,
• broadcast FM radio,
• VOX and AirCopy,
• BEAM wireless channel transfer,
• UV Studio with integrated K5Viewer screen mirroring, screenshots and remote keyboard control,
• advanced RX audio profiles and Audio Scope,
• first-responder-oriented controls,
• the Breakout game,
• automatic RX/TX activity logging with RF Log,
• full Fox Hunt and Morse Beacon support.

Radio and signal handling

• Reworked output-power levels:
  • Low 1: below approximately 20 mW,
  • Low 2: approximately 125 mW,
  • Low 3: approximately 250 mW,
  • Low 4: approximately 500 mW,
  • Low 5: approximately 1 W,
  • Mid: approximately 2 W,
  • High: approximately 5 W,
  • User: configurable through SetPwr.
• S-meter calibrated according to the IARU Region 1 recommendation for VHF/UHF:
  • fixed S0 to S9+ values replace the former EEPROM S-meter thresholds,
  • Classic and Tiny display styles are available.
• Configurable 12.5 kHz or 6.25 kHz narrow-FM bandwidth.
• Per-channel TX lock.
• Adjustable RX audio volume.
• Advanced RX audio profiles for FM and AM reception.
• Regional frequency-lock profiles for amateur bands, PMR446, FRS, GMRS and MURS.
• Support for 1600, 2200 and 3500 mAh battery profiles.

Spectrum analyzer

• Channel names displayed in the spectrum view.
• Persistent spectrum settings.
• Faster and smoother spectrum rendering.
• Improved behavior when freezing the spectrum or disconnecting USB-C.
• Spectrum analyzer state can be restored automatically at startup.

Scanning

• Support for up to 24 named scan lists.
• Each memory channel can be assigned to:
  • OFF,
  • one scan list from 01 to 24,
  • ALL.
• The ALL list scans every channel except those assigned to OFF.
• Automatic selection of the next valid list when the requested list is empty.
• Direct scan-list selection while scanning:
  • 00 selects ALL,
  • 01 to 24 select the corresponding list.
• Long press on MENU while scanning to exclude the current memory channel.
• Up to 64 frequency exclusions.
• Very fast scanning mode, reaching approximately 150 frequencies per second.
• Scan progress, RSSI and detected CTCSS/DCS information.
• Configurable scan resume behavior.
• Scan state can be restored automatically at startup.

User interface

• Improved VFO screen with:
  • Classic and Tiny S-meter styles,
  • Classic and Tiny frequency-information layouts,
  • MAIN ONLY, DUAL and CROSS display modes,
  • RX activity indication on the active VFO,
  • optional RX LED blinking,
  • squelch, monitor, step and CTCSS/DCS information,
  • last-RX indication,
  • RX and TX timers.
• Improved status bar with updated fonts and icons.
• Menu index remains visible while editing an entry.
• Improved frequency and memory-channel input.
• Improved audio-level display.
• AirCopy progress percentage and gauge.
• Smooth backlight fading.
• Manual backlight controls for quickly switching between minimum and maximum brightness.
• Configurable contrast and inverted-display mode.
• Configurable navigation layout for the different radio models.
• Improved power-on message and optional startup logo.
• System-information pages for:
  • firmware version and build information,
  • battery information,
  • Flash and SRAM usage,
  • project and documentation QR codes.

Audio and transmission controls

• Classic and OnePush PTT modes.
• Configurable timeout-timer alerts:
  • disabled,
  • sound,
  • visual,
  • sound and visual.
• Configurable end-of-transmission alerts using the same modes.
• Audio Scope during RX and TX.
• Improved Audio Scope behavior with OnePush PTT, DTMF and the 1750 Hz tone.
• Configurable automatic deep-sleep timeout.
• Quick actions for:
  • RX mode,
  • main-VFO-only display,
  • PTT,
  • wide/narrow bandwidth,
  • 1750 Hz tone,
  • mute,
  • RX audio profile,
  • maximum power,
  • offset removal.

Fox Hunt and Beacon

• Dedicated Fox Hunt receiver with:
  • calibrated S-meter display,
  • scrolling signal-history graph,
  • peak, minimum and trend indicators,
  • selectable RF attenuation,
  • silent, Geiger-style and received-audio modes,
  • long-press F keypad lock (attenuation stays adjustable with the arrow keys).
• Integrated Morse Beacon transmitter with:
  • MOE, MOI, MOS, MOH, MO5 and MO identifiers,
  • optional callsign identification,
  • configurable TX and idle periods,
  • live TX and idle countdowns,
  • persisted Beacon settings,
  • interactive control during transmission,
  • shared long-press F keypad lock,
  • TX-lock, modulation and battery-safety checks.
• Fox Hunt and Beacon screens are mirrored to UV Studio's integrated K5Viewer.

RF Log

• Automatic logging of RX and TX activity when RF Log is enabled.
• Logs stored in the radio's external Flash memory.
• Recorded information includes:
  • RX or TX direction,
  • frequency and channel,
  • channel name,
  • activity duration,
  • S-meter level,
  • battery voltage.
• On-radio history with RX/TX filtering and detailed views.
• Live RF Log dashboard and history access through UV Studio.

Connectivity and data transfer

• Live screen streaming to UV Studio over a USB serial connection.
• Screenshot capture and download.
• Remote keyboard control through the integrated K5Viewer.
• Automatic reconnection after a USB disconnect.
• RF Log monitoring, analytics and CSV export.
• Firmware flashing, calibration backup and restore, and boot-logo management from the same interface.
• BEAM transfer of complete channel settings between compatible radios.
• Improved AirCopy interface and progress reporting.

Settings and controls

• New or extended menu entries:
  • SetPwr: configurable User output power,
  • SetPTT: Classic or OnePush PTT,
  • SetTOT: timeout-timer alert,
  • SetEOT: end-of-transmission alert,
  • SetCtr: display contrast,
  • SetInv: inverted display,
  • SetLck: keypad or keypad-and-PTT lock,
  • SetMet: S-meter style,
  • SetGUI: VFO information style,
  • SetRxA: RX audio profile,
  • SetTmr: RX and TX timers,
  • SetOff: automatic deep-sleep delay,
  • SetNFM: narrow-FM bandwidth,
  • SetVol: RX audio volume,
  • SetScn: scan mode,
  • SetNav: radio-specific navigation layout.
• Improved PonMsg, BackLt, TxTOut, ScnRev and KeyLck menus.
• Full VFO state restoration with a long press on EXIT.
• Squelch changes made with F + UP or F + DOWN are persisted.

Keyboard shortcuts and assignable actions

• F + UP or F + DOWN: adjust the squelch level.
• F + F1 or F + F2: adjust the frequency step.
• F + 8: temporarily switch the backlight between minimum and maximum brightness.
• F + 9: return to the configured backlight strategy.
• Configurable short- and long-press actions include:
  • RX mode,
  • main-VFO-only display,
  • virtual PTT,
  • wide/narrow bandwidth,
  • 1750 Hz tone,
  • mute,
  • RX audio profile,
  • maximum power,
  • offset removal,
  • BEAM,
  • RF Log,
  • Fox Hunt / Beacon.

Reliability and optimization

• Improved squelch and S-meter behavior.
• Fixed DTMF overlay issues.
• Fixed scan-range limits.
• Cleaner startup display.
• Removed PWM-related audio noise.
• Improved serial and K5Viewer key handling.
• Improved VFO persistence and restoration.
• Extensive code refactoring and memory optimization.
• DTMF calling and the scrambler remain disabled in Fusion.
• Legacy AM Fix code is not used by this firmware.

Main features from Egzumer:

• many of OneOfEleven mods:
  • AM fix, huge improvement in reception quality
  • long press buttons functions replicating F+ action
  • fast scanning
  • channel name editing in the menu
  • channel name + frequency display option
  • shortcut for scan-list assignment (long press 5 NOAA)
  • scan-list toggle (long press * Scan while scanning)
  • configurable button function selectable from menu
  • battery percentage/voltage on status bar, selectable from menu
  • longer backlight times
  • mic bar
  • RSSI s-meter
  • more frequency steps
  • squelch more sensitive
• fagci spectrum analyzer (F+5 to turn on)
• some other mods introduced by me:
  • SSB demodulation (adopted from fagci)
  • backlight dimming
  • battery voltage calibration from menu
  • better battery percentage calculation, selectable for 1600mAh or 2200mAh
  • more configurable button functions
  • long press MENU as another configurable button
  • better DCS/CTCSS scanning in the menu (* SCAN while in RX DCS/CTCSS menu item)
  • Piotr022 style s-meter
  • restore initial freq/channel when scanning stopped with EXIT, remember last found transmission with MENU button
  • reordered and renamed menu entries
  • LCD interference crash fix
  • many others...

Manual

Up to date manual is available in the Wiki section

Radio performance

Please note that the Quansheng UV-Kx radios are not professional quality transceivers, their performance is strictly limited. The RX front end has no track-tuned band pass filtering at all, and so are wide band/wide open to any and all signals over a large frequency range.

Using the radio in high intensity RF environments will most likely make reception difficult, especially in AM mode. The receiver simply does not have a great dynamic range, so stronger signals can easily cause distortion, desensitization and poor AM audio. This is fundamentally a hardware limitation: firmware can improve behavior at the margins, but it cannot overcome the front-end design of the radio. In practice, AM reception will degrade first and most severely, while FM reception is generally more tolerant and should remain more usable.

But, they are nice toys for the price, fun to play with.

Compiling and Building from Docker

This project provides a Docker-based build system to compile the Fusion firmware for the UV-K1 and UV-K5 V3. Everything is handled through the compile-with-docker.sh helper script.

The documented build output is generated inside build/Fusion, using the CMake presets defined in CMakePresets.json.

Prerequisites

• Docker installed on your system
• Bash environment (Linux, macOS, WSL, Git Bash on Windows)

Build Script Overview

The script compile-with-docker.sh performs the following actions:

1. Builds the Docker image (uvk1-uvk5v3) if it does not already exist.
2. Removes any previous build directory to ensure a clean configuration.
3. Runs CMake using the Fusion preset inside the Docker container.
4. Builds the firmware and outputs .elf, .bin and .hex files.

Usage

./compile-with-docker.sh Fusion [extra CMake options]

Documented Preset

• Fusion

Examples

Build Fusion:

./compile-with-docker.sh Fusion

Passing Additional CMake Options

You can pass extra configuration options after the preset name.
These are forwarded directly to cmake --preset inside the container.

Examples:

./compile-with-docker.sh Fusion -DENABLE_SPECTRUM=ON
./compile-with-docker.sh Fusion -DENABLE_FEAT_F4HWN_GAME=ON -DENABLE_NOAA=ON
./compile-with-docker.sh Fusion -DSQL_TONE=600

To prepare the rolling development firmware:

./compile-with-docker.sh Fusion -DDEV=ON

This keeps the regular build output in build/Fusion and also updates archive/f4hwn.fusion.development.bin. The development build is identified as DEV in the firmware information screen. Publishing the updated archive file remains an explicit Git operation.

Notes

• The first run may take a few minutes while Docker builds the base image.
• Each build runs inside Docker, so your host environment remains clean.

Flashing the Firmware with UV Studio

You can flash the UV-K5 V3 and UV-K1 directly from your web browser using the Web Serial-based UV Studio.

UV Studio combines firmware flashing, calibration maintenance, boot-logo management, K5Viewer and RF Log in a single interface. It requires no application installation, server or account. Use a desktop browser with Web Serial support, such as Chrome, Brave, Edge, Opera or Firefox 151+.

Steps to flash the firmware

• Open the Flash Firmware view in UV Studio.
• Connect your radio to your computer using a compatible USB programming cable (USB-C or Baofeng/Kenwood like double jack USB cable).
• Make sure your radio is in DFU mode (flash mode).
• Select an official F4HWN Fusion release from the catalog or load a local .bin firmware file.
• Click on Flash Firmware, then select the serial port associated with your radio.
• The progress bar will guide you through the flashing steps.

Once finished, your radio restarts with the new firmware.

Steps to dump or restore calibration data

UV Studio can also dump and restore calibration data, which is highly recommended. It is best to create a dump immediately after installing the F4HWN firmware, and to restore it before installing another firmware or returning to the stock firmware.

Dump

• Open the Dump Calibration view in UV Studio.
• Power on your radio in normal mode.
• Click Dump Calibration Data.

When the process is complete, click Download calibration.dat to save the file to your computer.

[!NOTE] A good practice is to rename your calibration file using the serial number of your radio, which you can find on the label on the back of the device once you remove the battery. This helps avoid mixing up calibration files when you own multiple units.

Restore

• Open the Restore Calibration view in UV Studio.
• Power on your radio in normal mode.
• Select your calibration.dat file on your computer.

Click Restore Calibration Data and wait until the process fully completes.

Other sources of information

• k1-teardown

Credits

Many thanks to various people:

• Muzkr
• Mrkusypl
• Andrej
• Egzumer
• OneOfEleven
• DualTachyon
• Mikhail
• Manuel
• @wagner
• @Lohtse Shar
• @Matoz
• @Davide
• @Ismo OH2FTG
• OneOfEleven
• @d1ced95
• and others I forget

License

Copyright 2023 Dual Tachyon https://github.com/DualTachyon

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.