Rebrand to FreeTRX: new README, LICENSE.md, keep OpenGD77 README
- Rename the project to FreeTRX (fork of OpenGD77). - New README.md documenting the fork and its upstream source (OpenGD77 R20260131 / OpenGD77_MDUV380_DM1701_20260130). - Preserve the original project README as README.OpenGD77.md. - Add LICENSE.md reproducing the inherited OpenGD77 license (modified BSD 3-Clause + non-commercial clause). The license is NOT GPL-compatible and cannot be relicensed; all original copyrights are retained. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
Marcus Kida
parent
078d3fa665
commit
577a5d7f96
4 changed files with 198 additions and 100 deletions
|
|
@ -48,6 +48,13 @@ single running list until the first versioned release.
|
||||||
GD-77 loader into the repo.
|
GD-77 loader into the repo.
|
||||||
- **`TOOLS.md`** documents building, flashing, screenshots and language files.
|
- **`TOOLS.md`** documents building, flashing, screenshots and language files.
|
||||||
|
|
||||||
|
### Project
|
||||||
|
|
||||||
|
- **Renamed the project to FreeTRX** (fork of OpenGD77). New `README.md`
|
||||||
|
documenting the fork and its upstream source; original OpenGD77 README kept as
|
||||||
|
`README.OpenGD77.md`. Added `LICENSE.md` reproducing the inherited OpenGD77
|
||||||
|
license (modified BSD 3-Clause + non-commercial clause; not GPL-compatible).
|
||||||
|
|
||||||
### Misc
|
### Misc
|
||||||
|
|
||||||
- Added **Marcus DK1DA** to the firmware-info credits ("Modified Fork by").
|
- Added **Marcus DK1DA** to the firmware-info credits ("Modified Fork by").
|
||||||
|
|
|
||||||
43
LICENSE.md
Normal file
43
LICENSE.md
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
# License
|
||||||
|
|
||||||
|
FreeTRX is a fork of the **OpenGD77** firmware and inherits its license. The
|
||||||
|
original license terms of the OpenGD77 source are reproduced below and apply in
|
||||||
|
full to this project, including all modifications made in this fork.
|
||||||
|
|
||||||
|
> **Note on the license:** this is a modified **BSD 3-Clause** license with an
|
||||||
|
> additional **non-commercial** clause (clause 4). Because of that clause it is
|
||||||
|
> **not** an OSI-approved open-source license and is **not compatible with the
|
||||||
|
> GNU GPL** — the code cannot be relicensed under the GPL or any permissive
|
||||||
|
> license. Commercial use is prohibited.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Copyright (C) 2019-2024 OpenGD77 firmware developers
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions
|
||||||
|
are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
|
||||||
|
from this software without specific prior written permission.
|
||||||
|
|
||||||
|
4. Use of this source code or binary releases for commercial purposes is strictly forbidden. This includes, without limitation,
|
||||||
|
incorporation in a commercial product or incorporation into a product or project which allows commercial use.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||||
|
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||||
|
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Individual source files carry their own copyright headers (Kai Ludwig DG4KLU,
|
||||||
|
Roger Clark VK3KYY, Daniel Caujolle-Bert F1RMB and other OpenGD77 contributors);
|
||||||
|
those notices are retained. See also the original project README in
|
||||||
|
[`README.OpenGD77.md`](README.OpenGD77.md).
|
||||||
100
README.OpenGD77.md
Normal file
100
README.OpenGD77.md
Normal file
|
|
@ -0,0 +1,100 @@
|
||||||
|
# OpenGD77
|
||||||
|
Firmware for DMR transceivers using the STM32F405VGT MCU, AT1846S RF chip and HR-C6000 DMR chipset.
|
||||||
|
Including the Radioddiy TYT MD-380UV / Retevis RT-3S and Baofeng DM-1701 / Retevis RT-84
|
||||||
|
|
||||||
|
# Project status
|
||||||
|
|
||||||
|
The firmware is relatively stable and provides DMR and FM audio transmission and reception, as well as a DMR hotspot mode.
|
||||||
|
However it does not support some core functionality that the official firmware supports, including sending and receiving of text / SMS messages
|
||||||
|
|
||||||
|
The firmware source code does not contain a AMBE codec required for DMR operation.
|
||||||
|
This functionality is provided by the official firmware which is merged with the OpenGD77 by the OpenGD77CPS or firmware loader
|
||||||
|
|
||||||
|
|
||||||
|
# User guide
|
||||||
|
|
||||||
|
See https://github.com/LibreDMR/OpenGD77_UserGuide
|
||||||
|
|
||||||
|
|
||||||
|
# Credits
|
||||||
|
Originally conceived by Kai DG4KLU.
|
||||||
|
Further development by Roger VK3KYY, latterly assisted by Daniel F1RMB, Alex DL4LEX, Colin G4EML and others.
|
||||||
|
|
||||||
|
Current lead developer and source code gatekeeper is Roger VK3KYY
|
||||||
|
|
||||||
|
|
||||||
|
# Copyright
|
||||||
|
|
||||||
|
The firmware is copyright of the OpenGD77 developers. See individual source files for copyright information.
|
||||||
|
|
||||||
|
## MCU SDK and API code:
|
||||||
|
See license files in sub-folders
|
||||||
|
|
||||||
|
## FreeRTOS
|
||||||
|
Copyright (C) 2020 Amazon.com, Inc. or its affiliates.
|
||||||
|
All Rights Reserved.
|
||||||
|
|
||||||
|
|
||||||
|
# License
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions
|
||||||
|
are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
|
||||||
|
in the documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
|
||||||
|
from this software without specific prior written permission.
|
||||||
|
|
||||||
|
4. Use of this source code or binary releases for commercial purposes is strictly forbidden. This includes, without limitation,
|
||||||
|
incorporation in a commercial product or incorporation into a product or project which allows commercial use.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
|
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||||
|
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
||||||
|
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
|
||||||
|
# Special thanks
|
||||||
|
|
||||||
|
Thanks to those who have assisted the project including :
|
||||||
|
|
||||||
|
BD4VOW
|
||||||
|
CT1HSN
|
||||||
|
CT4TX
|
||||||
|
DG3GSP
|
||||||
|
DG4KLU
|
||||||
|
DJ0HF
|
||||||
|
DL4LEX
|
||||||
|
EA3BIL
|
||||||
|
EA3IGM
|
||||||
|
EA5SW
|
||||||
|
EB3AM
|
||||||
|
EW1ADG
|
||||||
|
F1CXG
|
||||||
|
F1RMB
|
||||||
|
G4ELM
|
||||||
|
IK0NWG
|
||||||
|
IU4LEG
|
||||||
|
IZ2EIB
|
||||||
|
JE4SMQ
|
||||||
|
JG1UAA
|
||||||
|
OH1E
|
||||||
|
OK2HAD
|
||||||
|
ON1HK
|
||||||
|
ON7LDS
|
||||||
|
OZ1MAX
|
||||||
|
PU4RON
|
||||||
|
SQ6SFO
|
||||||
|
SQ7PTE
|
||||||
|
TA5AYX
|
||||||
|
VK3KYY
|
||||||
|
VK4JWT
|
||||||
|
VK7JS
|
||||||
|
VK7ZCR
|
||||||
|
VK7ZJA
|
||||||
|
ZL1XE
|
||||||
148
README.md
148
README.md
|
|
@ -1,100 +1,48 @@
|
||||||
# OpenGD77
|
# FreeTRX
|
||||||
Firmware for DMR transceivers using the STM32F405VGT MCU, AT1846S RF chip and HR-C6000 DMR chipset.
|
|
||||||
Including the Radioddiy TYT MD-380UV / Retevis RT-3S and Baofeng DM-1701 / Retevis RT-84
|
**FreeTRX is a fork of the [OpenGD77](https://opengd77.org) firmware** for DMR
|
||||||
|
transceivers built around the STM32F405VGT MCU, AT1846S RF chip and HR-C6000 DMR
|
||||||
# Project status
|
chipset — the **TYT MD-UV380 / Retevis RT-3S** and **Baofeng DM-1701 / Retevis
|
||||||
|
RT-84**.
|
||||||
The firmware is relatively stable and provides DMR and FM audio transmission and reception, as well as a DMR hotspot mode.
|
|
||||||
However it does not support some core functionality that the official firmware supports, including sending and receiving of text / SMS messages
|
It adds a number of UI and quality-of-life changes on top of OpenGD77 (segmented
|
||||||
|
S-meter, 7-segment frequency font, screen dimming, an audio-mute function, menu
|
||||||
The firmware source code does not contain a AMBE codec required for DMR operation.
|
icons, and more). See [`CHANGELOG.md`](CHANGELOG.md) for the full list.
|
||||||
This functionality is provided by the official firmware which is merged with the OpenGD77 by the OpenGD77CPS or firmware loader
|
|
||||||
|
## Upstream source
|
||||||
|
|
||||||
# User guide
|
This fork is based on the official OpenGD77 source release **R20260131**
|
||||||
|
(source snapshot `OpenGD77_MDUV380_DM1701_20260130`):
|
||||||
See https://github.com/LibreDMR/OpenGD77_UserGuide
|
|
||||||
|
<https://opengd77.eu/index.php?dir=MDUV380_DM1701_RT3S_RT84/R20260131/sources_and_tools/&file=OpenGD77_MDUV380_DM1701_20260130.zip>
|
||||||
|
|
||||||
# Credits
|
The original OpenGD77 project README is preserved in
|
||||||
Originally conceived by Kai DG4KLU.
|
[`README.OpenGD77.md`](README.OpenGD77.md).
|
||||||
Further development by Roger VK3KYY, latterly assisted by Daniel F1RMB, Alex DL4LEX, Colin G4EML and others.
|
|
||||||
|
## DMR / AMBE codec
|
||||||
Current lead developer and source code gatekeeper is Roger VK3KYY
|
|
||||||
|
As with OpenGD77, the source does **not** contain the AMBE codec required for DMR
|
||||||
|
audio. It is merged in from an official manufacturer firmware (V26.45) at flash
|
||||||
# Copyright
|
time by the firmware loader. See [`TOOLS.md`](TOOLS.md).
|
||||||
|
|
||||||
The firmware is copyright of the OpenGD77 developers. See individual source files for copyright information.
|
## Building, flashing & tools
|
||||||
|
|
||||||
## MCU SDK and API code:
|
See [`TOOLS.md`](TOOLS.md) for building (Docker + Arm GNU Toolchain 14), flashing
|
||||||
See license files in sub-folders
|
(`./flash.sh`), grabbing screenshots, and building language files.
|
||||||
|
|
||||||
## FreeRTOS
|
## License
|
||||||
Copyright (C) 2020 Amazon.com, Inc. or its affiliates.
|
|
||||||
All Rights Reserved.
|
FreeTRX **inherits the OpenGD77 license** — a modified BSD 3-Clause license with
|
||||||
|
an additional **non-commercial** clause. It is **not** an OSI-approved
|
||||||
|
open-source license and is **not GPL-compatible**; commercial use is prohibited.
|
||||||
# License
|
The code cannot be relicensed. See [`LICENSE.md`](LICENSE.md).
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions
|
## Credits
|
||||||
are met:
|
|
||||||
|
OpenGD77 was originally conceived by **Kai Ludwig, DG4KLU**, with further
|
||||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
development led by **Roger Clark, VK3KYY** and assisted by **Daniel
|
||||||
|
Caujolle-Bert, F1RMB**, Alex DL4LEX, Colin G4EML and many other contributors.
|
||||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
|
All original copyrights are retained (see the source file headers and
|
||||||
in the documentation and/or other materials provided with the distribution.
|
[`README.OpenGD77.md`](README.OpenGD77.md)).
|
||||||
|
|
||||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
|
FreeTRX fork maintained by **Marcus, DK1DA**.
|
||||||
from this software without specific prior written permission.
|
|
||||||
|
|
||||||
4. Use of this source code or binary releases for commercial purposes is strictly forbidden. This includes, without limitation,
|
|
||||||
incorporation in a commercial product or incorporation into a product or project which allows commercial use.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
||||||
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
||||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
||||||
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
|
|
||||||
|
|
||||||
# Special thanks
|
|
||||||
|
|
||||||
Thanks to those who have assisted the project including :
|
|
||||||
|
|
||||||
BD4VOW
|
|
||||||
CT1HSN
|
|
||||||
CT4TX
|
|
||||||
DG3GSP
|
|
||||||
DG4KLU
|
|
||||||
DJ0HF
|
|
||||||
DL4LEX
|
|
||||||
EA3BIL
|
|
||||||
EA3IGM
|
|
||||||
EA5SW
|
|
||||||
EB3AM
|
|
||||||
EW1ADG
|
|
||||||
F1CXG
|
|
||||||
F1RMB
|
|
||||||
G4ELM
|
|
||||||
IK0NWG
|
|
||||||
IU4LEG
|
|
||||||
IZ2EIB
|
|
||||||
JE4SMQ
|
|
||||||
JG1UAA
|
|
||||||
OH1E
|
|
||||||
OK2HAD
|
|
||||||
ON1HK
|
|
||||||
ON7LDS
|
|
||||||
OZ1MAX
|
|
||||||
PU4RON
|
|
||||||
SQ6SFO
|
|
||||||
SQ7PTE
|
|
||||||
TA5AYX
|
|
||||||
VK3KYY
|
|
||||||
VK4JWT
|
|
||||||
VK7JS
|
|
||||||
VK7ZCR
|
|
||||||
VK7ZJA
|
|
||||||
ZL1XE
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue