A radio module for Baofeng UV-5R series ham radios, compatible with the Springfield Ham Radio Registry.
This module provides support for programming and managing Baofeng UV-5R and UV-5RE Plus ham radios. It includes:
- Memory read/write capabilities
- Channel programming with CTCSS/DCS tones
- Radio settings configuration
- Complete protocol implementation for the UV-5R series
- Memory Management: Read and write radio memory segments
- Channel Programming: Program up to 128 channels with frequencies, tones, and power settings
- Tone Support: Full CTCSS and DCS tone encoding/decoding
- Settings Configuration: Configure radio settings like squelch, step size, and scan modes
- Protocol Support: Complete implementation of the Baofeng UV-5R communication protocol
yarn add radio-module-baofengimport { CodecFactory } from 'radio-module-baofeng';
import { MockLogLayer } from 'loglayer';
const factory = new CodecFactory();
const logger = new MockLogLayer();
const modelId = {
model: 'baofeng-uv5r',
name: 'Baofeng UV-5R',
manufacturer: 'Baofeng'
};
const codec = await factory.createCodec(modelId, config, logger);
// Encode a radio program
const program = {
channels: [
{
channelNumber: 0,
radioChannel: {
name: 'REPEAT',
receiveFrequency: 146520000,
transmitFrequency: 146520000,
receiveTone: { type: 'CTCSS', tone: 100.0 },
transmitTone: { type: 'CTCSS', tone: 100.0 },
},
settings: { transmitPower: 5 },
},
],
settings: {},
};
const memory = codec.encode(program);
// Decode radio memory
const decodedProgram = codec.decode(memory);The module uses the configuration from configs/baofeng-uv5r.json which includes:
- Serial communication settings (9600 baud, 8N1)
- Memory layout and segment definitions
- Protocol commands for read/write operations
- Codec configuration with memory offsets
- Baofeng UV-5R
- Baofeng UV-5RE Plus
- Node.js 18+
- Yarn package manager
yarn install# Run unit tests
yarn test
# Run integration tests
yarn test:integrationyarn buildradio-module-baofeng/
├── configs/ # Radio configuration files
│ └── baofeng-uv5r.json # UV-5R configuration
├── src/ # Module source code
│ ├── shared/ # Shared components
│ │ ├── schemas/ # JSON schemas
│ │ │ ├── channel-schema.json
│ │ │ └── settings-schema.json
│ │ └── codecs/ # Codec implementations
│ │ ├── baofeng-codec.ts
│ │ ├── baofeng-decoder.ts
│ │ ├── baofeng-encoder.ts
│ │ └── baofeng-dcs-tones.ts
│ ├── index.ts # Main entry point
│ └── codec-factory.ts # Codec factory
├── test/ # Tests
│ ├── unit/
│ └── integration/
└── package.json
The module implements the Baofeng UV-5R communication protocol:
-
Magic Number:
[80, 187, 255, 32, 18, 7, 37] - Baud Rate: 9600
- Data Format: 8 data bits, 1 stop bit, no parity
-
Memory Segments:
- Channels: 0x0000 - 0x17FF (6144 bytes)
- Settings: 0x1EC0 - 0x1FFF (320 bytes)
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests for new functionality
- Run the test suite
- Submit a pull request
MIT License - see LICENSE file for details.
For issues and questions:
- Create an issue in the GitLab repository
- Check the Springfield Ham Radio documentation
- Initial release
- Support for Baofeng UV-5R and UV-5RE Plus
- Complete memory read/write functionality
- Channel programming with CTCSS/DCS tones
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!
- [ ] Create or upload files
- [ ] Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin https://gitlab.com/springfield-ham-radio/drivers/radio-module-baofeng.git
git branch -M main
git push -uf origin main
- [ ] Invite team members and collaborators
- [ ] Create a new merge request
- [ ] Automatically close issues from merge requests
- [ ] Enable merge request approvals
- [ ] Set auto-merge
Use the built-in continuous integration in GitLab.
- [ ] Get started with GitLab CI/CD
- [ ] Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)
- [ ] Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
- [ ] Use pull-based deployments for improved Kubernetes management
- [ ] Set up protected environments
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to makeareadme.com for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Choose a self-explaining name for your project.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.