This is the source code of ZUMspot/MMDVM_HS firmware for personal hotspots (ADF7021 version of the MMDVM firmware), based on Jonathan G4KLX's [MMDVM](https://github.com/g4klx/MMDVM) software. This firmware supports D-Star, DMR, System Fusion, P25 and NXDN digital voice modes and POCSAG 1200 pager protocol.
@ -8,7 +10,8 @@ This software comes with ABSOLUTELY NO WARRANTY, it is provided "AS IS" with the
This software is licenced under the GPL v2 and is intended for amateur and educational use only. Use of this software for commercial purposes is strictly forbidden.
@ -23,9 +26,10 @@ This software is licenced under the GPL v2 and is intended for amateur and educa
- CW ID support
- Full duplex support with two ADF7021
# Known issues
## Common issues for simplex and duplex boards
## Known issues ##
### Common issues for simplex and duplex boards ###
- High RX BER or not RX, poor TX audio (4FSK modes): adjust frequency offset, specially RXOffset.
- Not instantaneous mode detection (2 modes or more enabled): mode detection could be slow and sometimes you need to hold PTT several seconds, in order to activate the hotspot. There is no solution for that, since ADF7021 works only one mode at once. You can disable mode scanning, enabling just one mode.
@ -34,13 +38,15 @@ This software is licenced under the GPL v2 and is intended for amateur and educa
- Not working with RPi 3B+ (USB): be sure your firmware version is >= 1.4.8 and update to new USB bootloader with long reset pulse (make stlink-bl, for example).
- Not working with USB (not RPi 3B+): compile with "LONG_USB_RESET" option disabled, and use old bootloader (make stlink-bl-old, for example).
## Duplex boards
### Duplex boards ###
- Very difficult DMR activation ("repeater fail" error): disable mode scanning, select just DMR mode.
- Not DMR activation ("repeater fail" error) with MD380, Ailunce HD1 or some other radios: increase DMR deviation to 55 % or 60 %.
- RX timeout: this is due to TX and RX clock differences, which does not have easy solution. Be sure your firmware version is >= 1.4.7, which minimizes this problem.
# Notes for previous users of MMDVM boards
## Notes for previous users of MMDVM boards ##
MMDVM_HS boards do not need deviation calibration like MMDVM boards, but could be necessary some frequency offset calibration (ADF7021 does not have AFC for 4FSK modes).
@ -67,7 +73,8 @@ The following options in MMDVM.ini ([Modem] section) are very important for MMDV
The ADF7021 (or RF7021SE module) must operate with a 14.7456 MHz TCXO and with at least 2.5 ppm of frequency stability or better. For 800-900 MHz frequency band you will need even a better frequency stability TCXO. You could use also 12.2880 MHz TCXO. Any other TCXO frequency is not supported. Please note that a bad quality TCXO not only affects the frequency offset, also affects clock data rate, which is not possible to fix and will cause BER issues.
@ -85,57 +92,62 @@ If you can't decode any 4FSK modulation (DMR, YSF, P25 or NXDN) with your ZUMspo
If you have problems updating firmware using USB bootloader (DFU mode) on Orange Pi or any other system different from RPi, you could compile the dfu tool directly. You could get the source code of a dfu tool [here](https://sourceforge.net/projects/dfu-programmer/files/dfu-programmer/0.7.0/).
# Quick start
## Quick start ##
Please see [BUILD.md](BUILD.md) for more details, and also [MMDVM](https://groups.yahoo.com/neo/groups/mmdvm/info) Yahoo Groups. You also can check at MMDVM_HS/scripts folder for some automatic tasks.
## Binary firmware installation
### Binary firmware installation ###
Please check the latest firmware [here](https://github.com/juribeparada/MMDVM_HS/releases).
### Pi-Star binary firmware installation
#### Pi-Star binary firmware installation ####
You could use some pi-star commands under SSH console:
- sudo pistar-zumspotflash rpi: ZUMspot RPi board
- sudo pistar-zumspotflash rpi_duplex: ZUMSpot duplex board conected to GPIO
- sudo pistar-zumspotflash usb: ZUMspot USB dongle
- sudo pistar-zumspotflash libre: ZUMspot Libre Kit or generic MMDVM_HS board with USB
Download the ZUMspotFW firmware upgrade utility (ZUMspotFW_setup.exe) from the [releases section](https://github.com/juribeparada/MMDVM_HS/releases).
#### Windows ####
Download the ZUMspotFW firmware upgrade utility (`ZUMspotFW_setup.exe`) from the [releases section](https://github.com/juribeparada/MMDVM_HS/releases).
This utility includes firmwares binaries and USB drivers for Windows 7/8/10. If you have problems with the installer, you can download [ZUMspotFW.zip](https://github.com/juribeparada/MMDVM_HS/releases/download/v1.0.2/ZUMspotFW.zip) for a manual installation.
### Linux or macOS
Download the script (*.sh) that matches with your ZUMspot/MMDVM_HS board:
- install_fw_librekit.sh: only for ZUMspot Libre Kit board (KI6ZUM & VE2GZI) or generic MMDVM_HS board with USB interface
- install_fw_rpi.sh: only for ZUMspot RPi board (KI6ZUM & VE2GZI)
- install_fw_usb.sh: only for ZUMspot USB dongle (KI6ZUM)
- install_fw_duplex.sh: only for ZUMspot Duplex for RPi (KI6ZUM)
- install_fw_dualband.sh: only for ZUMspot Dualband for RPi (KI6ZUM)
- install_fw_hshat.sh: only for MMDVM_HS_Hat board (DB9MAT & DF2ET)
- install_fw_hshat-12mhz.sh: only for MMDVM_HS_Hat board with 12.288 MHz TCXO (DB9MAT & DF2ET)
- install_fw_hsdualhat.sh: only for MMDVM_HS_Dual_Hat board (DB9MAT & DF2ET & DO7EN)
- install_fw_hsdualhat-12mhz.sh: only for MMDVM_HS_Dual_Hat board with 12.288 MHz TCXO (DB9MAT & DF2ET & DO7EN)
- install_fw_nanohs.sh: only for Nano hotSPOT board (BI7JTA)
- install_fw_nanodv_npi.sh: only for NanoDV NPi board 1.0 (BG4TGO & BG5HHP)
- install_fw_nanodv_usb.sh: only for NanoDV USB board 1.0 (BG4TGO & BG5HHP)
- install_fw_d2rg_mmdvmhs.sh: only for D2RG MMDVM_HS board (BG3MDO, VE2GZI, CA6JAU)
- install_fw_gen_gpio.sh: only for generic MMDVM_HS board (EA7GIB) with GPIO serial interface
- install_fw_duplex_gpio.sh: only for MMDVM_HS with dual ADF7021 (EA7GIB) or generic dual ADF7021 board with GPIO serial interface
- install_fw_duplex_usb.sh: only for MMDVM_HS with dual ADF7021 (EA7GIB) or generic dual ADF7021 board with USB interface
- install_fw_skybridge_rpi.sh: only for BridgeCom SkyBridge HotSpot
#### Linux or macOS ####
Download the script (`*.sh`) that matches with your ZUMspot/MMDVM_HS board:
- `install_fw_librekit.sh`: only for ZUMspot Libre Kit board (KI6ZUM & VE2GZI) or generic MMDVM_HS board with USB interface
- `install_fw_rpi.sh`: only for ZUMspot RPi board (KI6ZUM & VE2GZI)
- `install_fw_usb.sh`: only for ZUMspot USB dongle (KI6ZUM)
- `install_fw_duplex.sh`: only for ZUMspot Duplex for RPi (KI6ZUM)
- `install_fw_dualband.sh`: only for ZUMspot Dualband for RPi (KI6ZUM)
- `install_fw_hshat.sh`: only for MMDVM_HS_Hat board (DB9MAT & DF2ET)
- `install_fw_hshat-12mhz.sh`: only for MMDVM_HS_Hat board with 12.288 MHz TCXO (DB9MAT & DF2ET)
- `install_fw_hsdualhat.sh`: only for MMDVM_HS_Dual_Hat board (DB9MAT & DF2ET & DO7EN)
- `install_fw_hsdualhat-12mhz.sh`: only for MMDVM_HS_Dual_Hat board with 12.288 MHz TCXO (DB9MAT & DF2ET & DO7EN)
- `install_fw_nanohs.sh`: only for Nano hotSPOT board (BI7JTA)
- `install_fw_nanodv_npi.sh`: only for NanoDV NPi board 1.0 (BG4TGO & BG5HHP)
- `install_fw_nanodv_usb.sh`: only for NanoDV USB board 1.0 (BG4TGO & BG5HHP)
- `install_fw_d2rg_mmdvmhs.sh`: only for D2RG MMDVM_HS board (BG3MDO, VE2GZI, CA6JAU)
- `install_fw_gen_gpio.sh`: only for generic MMDVM_HS board (EA7GIB) with GPIO serial interface
- `install_fw_duplex_gpio.sh`: only for MMDVM_HS with dual ADF7021 (EA7GIB) or generic dual ADF7021 board with GPIO serial interface
- `install_fw_duplex_usb.sh`: only for MMDVM_HS with dual ADF7021 (EA7GIB) or generic dual ADF7021 board with USB interface
- `install_fw_skybridge_rpi.sh`: only for BridgeCom SkyBridge HotSpot
For example, download the ZUMspot RPi upgrade script:
@ -156,13 +168,14 @@ You could optionally install a beta firmware for testing:
./install_fw_rpi.sh beta
## Build from the sources
You could use example files from MMDVM_HS/configs folder and overwrite the Config.h file, in order to compile a firmware with default settings. There are a specific config file for each ZUMspot or any MMDVM_HS compatible boards. In general, there are two possible compilation ways:
### Build from the sources ###
You could use example files from `MMDVM_HS/configs` folder and overwrite the `Config.h` file, in order to compile a firmware with default settings. There are a specific config file for each ZUMspot or any MMDVM_HS compatible boards. In general, there are two possible compilation ways:
- Boards with USB interface:
Boards with STM32_USB_HOST option enabled in Config.h (ZUMspot Libre Kit, ZUMspot USB, GIBSpot USB, NanoDV USB, etc). Those boards need to have the USB bootloader installed. For example:
Boards with `STM32_USB_HOST` option enabled in `Config.h` (ZUMspot Libre Kit, ZUMspot USB, GIBSpot USB, NanoDV USB, etc). Those boards need to have the USB bootloader installed. For example:
make clean
make bl
@ -184,15 +197,18 @@ Boards with STM32_USART1_HOST option enabled in Config.h (ZUMspot RPi, MMDVM_HS_
Some detailed examples as follows:
### MMDVM_HS_Hat
#### MMDVM_HS_Hat
Please visit Mathis Schmieder GitHub [here](https://github.com/mathisschmieder/MMDVM_HS_Hat/blob/master/README.md) for detailed instructions.
### D2RG MMDVM_HS board
#### D2RG MMDVM_HS board
This hotspot needs Raspbian support for SPI-UART converter included in this board. If you don't see /dev/ttySC0, please visit Yuan BG3MDO GitHub [here](https://github.com/bg3mdo/D2RG_MMDVM_HS_ambe_uart_service) for driver installation instructions.
### ZUMspot Libre Kit (under Linux Raspbian)
#### ZUMspot Libre Kit (under Linux Raspbian)
If you are using Pi-Star, expand filesystem (if you haven't done before):
@ -230,9 +246,10 @@ Upload the firmware to ZUMspot Libre Kit using the USB port (your Libre Kit has
sudo make dfu devser=/dev/ttyACM0
### ZUMspot RPi
#### Enable serial port in Raspberry Pi 3 or Pi Zero W
#### ZUMspot RPi
##### Enable serial port in Raspberry Pi 3 or Pi Zero W
This this necessary only if you are installing a fresh copy of Raspbian OS.
@ -259,7 +276,8 @@ Reboot your RPi:
sudo reboot
#### Build the firmware and upload to ZUMspot RPi
##### Build the firmware and upload to ZUMspot RPi
If you are using Pi-Star, expand filesystem (if you haven't done before):
@ -320,7 +338,8 @@ Upload the firmware to ZUMspot RPi board:
sudo make zumspot-pi
### MMDVM_HS_Dual_Hat\MMDVM_HS_Hat gpio firmware update on OrangePI PC/PC2/PC Plus
#### MMDVM_HS_Dual_Hat\MMDVM_HS_Hat gpio firmware update on OrangePI PC/PC2/PC Plus
Gerad Munsch
3 years ago