kopia lustrzana https://github.com/OpenRTX/OpenRTX
Improvements to README.md
- Fixed typos - Fixed grammar - Fixed style - Added info about the Matrix spacepull/105/head
DC7IA
GitHub
rodzic
4a3bc93fa4
commit
2214b305db
60
README.md
60
README.md
|
|
@ -1,7 +1,7 @@
|
|||
# OpenRTX
|
||||
## Modular Open Source Radio Firmware
|
||||
|
||||
OpenRTX is a free and open source firmware for digital ham radios, top-down designed
|
||||
OpenRTX is a free and open source firmware for digital amateur radio devices, top-down designed
|
||||
with modularity, flexibility and performance in mind.
|
||||
|
||||
Currently OpenRTX is being actively developed for the following radios:
|
||||
|
|
@ -12,60 +12,60 @@ Currently OpenRTX is being actively developed for the following radios:
|
|||
- Radioddity GD77 and Baofeng DM-1801
|
||||
|
||||
This firmware is *highly experimental* and currently under development, this means
|
||||
that it may not have all the expected functionalities. Contributions and testing
|
||||
are anyway warmly welcome and accepted!
|
||||
that it may not have all the expected functionalities. Anyway, contributions and testing will be warmly welcomed and accepted!
|
||||
|
||||
For information on currently supported radios and features, see the [Supported Platforms](https://openrtx.org/#/platforms) page on our website.
|
||||
For information on the radios that are currently supported and their features, see the [Supported Platforms](https://openrtx.org/#/platforms) page on our website.
|
||||
|
||||
For hardware and software documentation visit [openrtx.org](https://openrtx.org/)
|
||||
|
||||
## Obtaining the firmware
|
||||
|
||||
**Warning: read the Disclaimer section first!**
|
||||
**Warning: Read the disclaimer section first!**
|
||||
|
||||
Pre-built binary images of the OpenRTX firmware for each one of the supported devices are available on [the releases page](https://github.com/OpenRTX/OpenRTX/releases): to flash them on your radio you can use the OEM firmware upgrade tool or, alternatively and for TYT MD-3x0 and MD-UV3x0 radios only, you can also use the [radio_tool](https://github.com/v0l/radio_tool) program or tarxvf's web based flashing tool [dmr.tools](https://dmr.tools).
|
||||
Pre-built binary images of the OpenRTX firmware for each one of the supported devices are available on [the releases page](https://github.com/OpenRTX/OpenRTX/releases): to flash them to your radio, you can use the OEM firmware upgrade tool or — alternatively and for TYT MD-3x0 and MD-UV3x0 radios only — you can also use the [radio_tool](https://github.com/v0l/radio_tool) program or tarxvf's web based flashing tool [dmr.tools](https://dmr.tools).
|
||||
|
||||
Between releases, pre-built binary images containing the latest firmware updates are available through nightly builds from the master branch.
|
||||
The nightly builds are available here:
|
||||
- on [Phil DF5PMF's page](https://openrtx.schinken-radio.de/nightly/)
|
||||
- on the [OpenRTX nightly builds page](https://files.openrtx.org/nightly/)
|
||||
|
||||
Finally, the instructions on how to compile the OpenRTX firmware, also in its emulator version on Linux, are available on the [compilation instructions](https://openrtx.org/#/compiling) page on our website.
|
||||
Finally, the instructions on how to compile the OpenRTX firmware for hardware as well as emulation on Linux, are available on the [compilation instructions](https://openrtx.org/#/compiling) page on our website.
|
||||
|
||||
If you need detailed instructions on how to flash the firmware to your radio look at the [dedicated page](https://openrtx.org/#/user_guide) on OpenRTX's website or reach us on our channels!
|
||||
Have a look at the the [dedicated page](https://openrtx.org/#/user_guide) for detailed instructions on flashing the firmware to your radio, look at the OpenRTX website or reach out to us on our channels!
|
||||
|
||||
## M17 support
|
||||
|
||||
From the release version 0.3.3 the OpenRTX firmware provides experimental support for the M17 digital voice mode.
|
||||
From the release version 0.3.3 onwards the OpenRTX firmware provides experimental support for the M17 digital voice mode.
|
||||
|
||||
Currently the radios supporting this digital mode are the following:
|
||||
- MD-380, MD-390 and RT3 **UHF version** support both modulation and demodulation.
|
||||
- MD-380, MD-390 and RT3 **VHF version** support **only** demodulation, modulation is a work in progress.
|
||||
- MD-UV380 and MD-UV390 support support both modulation and demodulation.
|
||||
- GD77 and DM-1801 currently **do not support** the new digital voice mode.
|
||||
The following radios are currently supported for use with this digital mode:
|
||||
- MD-380, MD-390 and RT3 **UHF version** are supported for both modulation and demodulation.
|
||||
- MD-380, MD-390 and RT3 **VHF version** are supported for demodulation **only**, modulation is a work in progress.
|
||||
- MD-UV380 and MD-UV390 are supported for both modulation and demodulation.
|
||||
- GD77 and DM-1801 currently **are not supported** for the new digital voice mode.
|
||||
|
||||
To make the digital mode work, some modding is required: refer to the [dedicated page](https://openrtx.org/#/M17/m17?id=hardware-modifications) on our website for the details.
|
||||
To make the digital mode work, some modding is required: Refer to the [dedicated page](https://openrtx.org/#/M17/m17?id=hardware-modifications) on our website for the details on that.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This project was created for research and amateur radio use only, we are not
|
||||
responsible for improper uses of this code which might lead to unauthorized
|
||||
transmission, reception or patent infringments.
|
||||
responsible for improper use of this code which might lead to unauthorized
|
||||
transmission, reception or any patent infringments.
|
||||
|
||||
The OpenRTX firmware is released WITHOUT ANY WARRANTY: anyone flashing a binary
|
||||
image obtained from the sources made available through this repository does it
|
||||
at its own risk. We always test all the code on our devices before publishing it
|
||||
on the repository, however we cannot guarantee the absolute absence of bugs and
|
||||
The OpenRTX firmware is released WITHOUT ANY WARRANTY: Anyone flashing a binary
|
||||
image obtained from the sources made available through this repository does so at
|
||||
their own risk. We always test all the code on our devices before publishing it
|
||||
on the repository, however we cannot guarantee the absolute absence of bugs nor of
|
||||
potential side effects.
|
||||
|
||||
## Contact
|
||||
|
||||
To reach out, come to our [M17 Reflector](https://m17.openrtx.org) or into our [Discord Server](https://discord.gg/TbR2FVtMya).
|
||||
To reach out, visit our [M17 Reflector](https://m17.openrtx.org) or join our Matrix room for general discussion [#openrtx_general:matrix.org
|
||||
](https://matrix.to/#/#openrtx_general:matrix.org) or the Matrix space [#openrtx:matrix.org](https://matrix.to/#/#openrtx:matrix.org) which contains many additional rooms or our [Discord Server](https://discord.gg/TbR2FVtMya).
|
||||
|
||||
## Donate
|
||||
|
||||
To support the development of OpenRTX you can make us a donation using [Liberapay](https://liberapay.com/OpenRTX/donate). \
|
||||
If you want to donate some hardware to facilitate OpenRTX porting and development, [contact us](https://github.com/OpenRTX/OpenRTX#contact).
|
||||
To support the development of OpenRTX you can donate using [Liberapay](https://liberapay.com/OpenRTX/donate). \
|
||||
If you want to donate hardware to facilitate porting and development of OpenRTX, please [contact us](https://github.com/OpenRTX/OpenRTX#contact).
|
||||
|
||||
## License
|
||||
|
||||
|
|
@ -77,24 +77,24 @@ Code for STM32F405 USB driver is released under the MCD-ST Liberty SW License Ag
|
|||
|
||||
## Credits
|
||||
|
||||
OpenRTX was created by:
|
||||
OpenRTX is being made by:
|
||||
|
||||
- Niccolò Izzo IU2KIN <n@izzo.sh>
|
||||
- Silvano Seva IU2KWO <silseva@fastwebnet.it>
|
||||
- Federico Amedeo Izzo IU2NUO <federico@izzo.pro>
|
||||
- Frederik Saraci IU2NRO <frederik.saraci@gmail.com>
|
||||
|
||||
Our wholehearted thanks to the contributions from the community:
|
||||
Our wholehearted thanks go to the following contributors from the community:
|
||||
|
||||
- Joseph Stephen VK7JS, which implemented voice prompts
|
||||
- Joseph Stephen VK7JS, who implemented voice prompts
|
||||
|
||||
All this was made possible by the huge reverse engineering effort of Travis Goodspeed and all the contributors of [md380tools](https://github.com/travisgoodspeed/md380tools).
|
||||
All this is possible by the huge reverse engineering effort of Travis Goodspeed and all the contributors of the [md380tools](https://github.com/travisgoodspeed/md380tools).
|
||||
|
||||
A huge thank goes to Roger Clark, and his [OpenGD77](https://github.com/rogerclarkmelbourne/OpenGD77) which not only inspired this project, but as a precursor, provided a working code example for the GD77 radio family.
|
||||
A huge thanks goes to Roger Clark, and his [OpenGD77](https://github.com/rogerclarkmelbourne/OpenGD77) (repo no longer available) which not only inspired this project, but as a precursor, provided a working code example for the GD77 radio family.
|
||||
|
||||
A warm thank you goes to SP5WWP and the [M17](https://m17project.org) community for bringing their libre protocol into our obscure undocumented hardware.
|
||||
|
||||
Also thank you for donating hardware to the project:
|
||||
Also, a thank you for donating hardware to this project goes to:
|
||||
* M17 Project
|
||||
* laurivosandi
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue