unsigned-ref/MicroModemGP
1
0
Fork 0
mirror of https://github.com/markqvist/MicroModemGP synced 2026-08-12 17:40:37 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated readme

Browse source
This commit is contained in:
Mark Qvist 2015-06-08 19:34:47 +02:00
parent a1020064c6
commit ee52e8ff77
1 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -18,17 +18,21 @@ You can buy a complete modem from [my shop](http://unsigned.io/shop), or you can
- CRC checksum on packets ensure data integrity
- Supports packets with up to 792 bytes of data
## KISS mode
## Serial connection settings
By default, the modem uses __9600 baud, 8N1__ serial. The baudrate can be modified in the "device.h" file.
## KISS mode or direct serial framing
You can configure whether to use KISS serial framing or direct serial framing in the "config.h" file.
When the modem is running in KISS mode, there's really not much more to it than connecting the modem to a computer, opening whatever program you want to use with it, and off you go.
## Direct serial connection
You can also configure the modem for direct serial framing. If using direct serial framing, the firmware uses time-sensitive input, which means that it will buffer serial data as it comes in, and when it has received no data for a few milliseconds, it will start sending whatever it has received.
If you want to use the SimpleSerial protocol, here's how to control the APRS modem over a serial connection. The modem accepts a variety of commands for setting options and sending packets. Generally a command starts with one or more characters defining the command, and then whatever data is needed to set the options for that command. Here's a list of the currently available commands:
If you're manually typing things to the modem from a terminal, you should therefore set your serial terminal program to not send data for every keystroke, but only on new-line, or pressing send or whatever. You can also compile the firmware for KISS mode serial connection, if you have a host program using KISS.
## Serial connection settings
To connect to the modem use __9600 baud, 8N1__ serial. By default, the firmware uses time-sensitive input, which means that it will buffer serial data as it comes in, and when it has received no data for a few milliseconds, it will start interpreting whatever it has received. This means you need to set your serial terminal program to not send data for every keystroke, but only on new-line, or pressing send or whatever. You can also compile the firmware for KISS mode serial connection, if you have a host program using KISS.
## Other notes
The project has been implemented in your normal C with makefile style, and uses AVR Libc. The firmware is compatible with Arduino-based products, although it was not written in the Arduino IDE.