mirror of
https://github.com/armel/uv-k1-k5v3-firmware-custom.git
synced 2026-10-02 03:15:37 +00:00
Update README
This commit is contained in:
Armel FAUVEAU committed
1 parent
926787ddf3
commit
f904b87172
1 file changed
+212
-127
@@ -46,7 +46,7 @@ Special thanks to Jean-Cyrille F6IWW (3 times), Fabrice 14RC123, David F4BPP, Ol
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [My Features](#main-features)
|
||||
* [Main features and improvements from F4HWN](#main-features-and-improvements-from-f4hwn)
|
||||
* [Main Features from Egzumer](#main-features-from-egzumer)
|
||||
* [Manual](#manual)
|
||||
* [Compiling and Building from Docker](#compiling-and-Building-from-docker)
|
||||
@@ -55,133 +55,218 @@ Special thanks to Jean-Cyrille F6IWW (3 times), Fabrice 14RC123, David F4BPP, Ol
|
||||
* [Other sources of information](#other-sources-of-information)
|
||||
* [License](#license)
|
||||
|
||||
## Main features and improvements from F4HWN:
|
||||
## Main features and improvements from F4HWN
|
||||
|
||||
* Fusion is now the reference edition of the project:
|
||||
* all-in-one firmware for UV-K1 and UV-K5 V3,
|
||||
* spectrum analyzer made by Fagci,
|
||||
* commercial FM radio support,
|
||||
* Vox and Aircopy support,
|
||||
* screenshots and K5Viewer support,
|
||||
* advanced RX audio profiles and Audio Scope,
|
||||
* first-responder oriented options,
|
||||
* small breakout game,
|
||||
* improve default power settings level:
|
||||
* Low1 to Low5 (<~20mW, ~125mW, ~250mW, ~500mW, ~1W),
|
||||
* Mid ~2W,
|
||||
* High ~5W,
|
||||
* User (see SetPwr),
|
||||
* improve S-Meter (IARU Region 1 Technical Recommendation R.1 for VHF/UHF - [read more](https://hamwaves.com/decibel/en/)),
|
||||
* S-Meter (S0/S9) Level EEPROM settings that were introduced in the Egzumer firmware are now ignored and replaced by hardcoded values to comply with the IARU Recommendation.
|
||||
* improve bandscope (Spectrum Analyser):
|
||||
* add channel name,
|
||||
* add save of some spectrum parameters,
|
||||
* improve UI:
|
||||
* menu index is always visible, even if a menu is selected,
|
||||
* s-meter new design (Classic or Tiny),
|
||||
* MAIN ONLY screen mode,
|
||||
* DUAL and CROSS screen mode,
|
||||
* RX blink on VFO RX,
|
||||
* RX LED blink,
|
||||
* Squelch level and Monitor,
|
||||
* Step value,
|
||||
* CTCSS or DCS value,
|
||||
* KeyLock message,
|
||||
* last RX,
|
||||
* move BatTxt menu from 34/63 to 30/63 (just after BatSave menu 29/63),
|
||||
* rename BackLt to BLTime,
|
||||
* rename BltTRX to BLTxRx,
|
||||
* improve memory channel input,
|
||||
* improve keyboard frequency input,
|
||||
* add percent and gauge to Air Copy,
|
||||
* improve audio bar,
|
||||
* add backlight fading,
|
||||
* add Audio Scope on TX,
|
||||
* and more...
|
||||
* new menu entries and changes:
|
||||
* add SetPwr menu to set User power (<20mW, 125mW, 250mW, 500mW, 1W, 2W or 5W),
|
||||
* add SetPTT menu to set PTT mode (Classic or OnePush),
|
||||
* add SetTOT menu to set TOT alert (Off, Sound, Visual, All),
|
||||
* add SetCtr menu to set contrast (0 to 15),
|
||||
* add SetInv menu to set screen in invert mode (Off or On),
|
||||
* add SetEOT menu to set EOT (End Of Transmission) alert (Off, Sound, Visual, All),
|
||||
* add SetMet menu to set s-meter style (Classic or Tiny),
|
||||
* add SetLck menu to set what is locked (Keys or Keys + PTT),
|
||||
* add SetGUI menu to set font size on the VFO baseline (Classic or Tiny),
|
||||
* add SetRxA menu to select RX audio profiles,
|
||||
* add TXLock menu to open TX on channel,
|
||||
* add SetTmr menu to set RX and TX timers (Off or On),
|
||||
* add SetOff menu to set the delay before the transceiver goes into deep sleep (Off or 1 minute to 2 hours),
|
||||
* add SetNFM menu to set Narrow width (12.5kHz or 6.25kHz),
|
||||
* add SetVol menu to adjust RX audio volume,
|
||||
* add SetScn menu to set Scan mode
|
||||
* rename BatVol menu (52/63) to SysInf, which displays the firmware version in addition to the battery status,
|
||||
* improve PonMsg menu,
|
||||
* improve BackLt menu,
|
||||
* improve TxTOut menu,
|
||||
* improve ScnRev menu (CARRIER from 250ms to 20s, STOP, TIMEOUT from 5s to 2m)
|
||||
* improve KeyLck menu (OFF, delay from 15s to 10m)
|
||||
* add HAM CA F Lock band (for Canadian zone),
|
||||
* add PMR 446 F Lock band,
|
||||
* add FRS/GMRS/MURS F Lock band,
|
||||
* add SetNav hidden menu to select the navigation layout according to the radio model,
|
||||
* remove blink and SOS functionality,
|
||||
* remove AM Fix menu (AM Fix is ENABLED by default),
|
||||
* add support of 3500mAh battery,
|
||||
* improve status bar:
|
||||
* add SetPtt mode in status bar,
|
||||
* change font and bitmaps,
|
||||
* move USB icon to left of battery information,
|
||||
* add RX and TX timers,
|
||||
* improve channel scanning:
|
||||
* support up to 24 scan lists,
|
||||
* each memory channel can be assigned to `OFF`, to one list (`01` to `24`), or to `ALL`,
|
||||
* `ALL` scans every channel except those set to `OFF`,
|
||||
* named scan lists are shown in the UI and status bar when available,
|
||||
* if the selected scan list is empty or invalid, the firmware automatically jumps to the next valid one,
|
||||
* very fast scan mode (around 150 freq/s),
|
||||
* 64 frequencies exclusions,
|
||||
* add resume mode on startup (scan, spectrum analyzer and FM radio),
|
||||
* improve VFO persistence and restore behavior:
|
||||
* save the Squelch level adjusted with F + UP or F + DOWN,
|
||||
* restore the full VFO state on long press of EXIT,
|
||||
* new actions:
|
||||
* RX MODE,
|
||||
* MAIN ONLY,
|
||||
* PTT,
|
||||
* WIDE NARROW,
|
||||
* 1750Hz,
|
||||
* MUTE,
|
||||
* POWER HIGH,
|
||||
* REMOVE OFFSET,
|
||||
* BEAM,
|
||||
* RF LOG,
|
||||
* new key combinations:
|
||||
* add the F + UP or F + DOWN key combination to dynamically change the Squelch level,
|
||||
* add the F + F1 or F + F2 key combination to dynamically change the Step,
|
||||
* add F + 8 to quickly switch backlight between BLMin and BLMax on demand (this bypass BackLt strategy),
|
||||
* add F + 9 to return to BackLt strategy,
|
||||
* add long press on MENU, in * SCAN mode, to exclude the current memory channel,
|
||||
* add direct scan list selection while scanning with two digits (`00` = `ALL`, `01` to `24` = scan list).
|
||||
* many fix:
|
||||
* squelch,
|
||||
* s-meter,
|
||||
* DTMF overlaying,
|
||||
* scan range limit,
|
||||
* clean display on startup,
|
||||
* no more PWM noise,
|
||||
* K5Viewer/serial key handling,
|
||||
* spectrum freeze on USB-C unplug,
|
||||
* Audio Scope behavior in OnePush mode and after DTMF/1750,
|
||||
* and more...
|
||||
* enabled AIR COPY
|
||||
* disabled ENABLE_DTMF_CALLING,
|
||||
* disabled SCRAMBLER,
|
||||
* remove 200Tx, 350Tx and 500Tx,
|
||||
* unlock TX on all bands needs only to be repeat 3 times,
|
||||
* code refactoring and many memory optimization,
|
||||
* stream the live screen of the Quansheng K5 to K5Viewer and capture screenshots over a USB-to-Serial cable,
|
||||
* and more...
|
||||
### 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,
|
||||
- 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](https://hamwaves.com/decibel/en/):
|
||||
- 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.
|
||||
- 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,
|
||||
- TX-lock, modulation and battery-safety checks.
|
||||
- Fox Hunt and Beacon screens are mirrored to 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 K5Viewer.
|
||||
|
||||
### Connectivity and data transfer
|
||||
|
||||
- Live screen streaming to K5Viewer over a USB serial connection.
|
||||
- Screenshot capture and download.
|
||||
- Remote keyboard control from K5Viewer.
|
||||
- Automatic K5Viewer reconnection after a USB disconnect.
|
||||
- RF Log monitoring and analytics in K5Viewer.
|
||||
- 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:
|
||||
|
||||
Reference in new issue
Block a user