Mirrors
/
OpenModem
mirror of https://github.com/markqvist/OpenModem.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated readme

This commit is contained in:
Mark Qvist 2014-06-18 15:24:19 +02:00
parent b1eed9b058
commit b9eb76b85d
2 changed files with 41 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -5,10 +5,49 @@ MicroAPRS is the APRS fork of [MicroModem](https://github.com/markqvist/MicroMod
Please read the "Quickstart.pdf" in the Documentation folder for some pointers on building the modem!
Right now the APRS specific documentation is lacking, so all the docs included in this repository is directly from MicroModem, but it should still offer good pointers on building the modem, and getting started. The only difference is the firmware, and I will include instructions for communicating with the modem over serial shortly.
Right now the APRS specific documentation is lacking, so all the docs included in this repository is directly from MicroModem, but it should still offer good pointers on building the modem, and getting started. The only difference is the firmware.
Currently a simple serial control protocol is implemented, while full KISS TNC functionality will be implemented soon.
## Modem control
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:
### Sending data
!<message> = send text packet
### Setting callsigns
c<callsign> = set your callsign (default NOCALL)
d<callsign> = set destination callsign (default APZMDM)
1<callsign> = set first path via (default WIDE1)
2<callsign> = set second path via (default WIDE2)
sc<SSID> = set your ssid (default 0)
sd<SSID> = set destination ssid (default 0)
s1<SSID> = set first path via ssid (default 1)
s2<SSID> = set second path via ssid (default 2)
### Setting serial output options
ps<1/0> = turn on/off printing SRC (example "ps0" to turn off, "ps1" to turn on)
pd<1/0> = turn on/off printing DST
pp<1/0> = turn on/off printing path
pm<1/0> = turn on/off printing data
pi<1/0> = turn on/off printing info
### Examples
#### To set your callsign to XX1YYY-5, send these two commands:
cXX1YYY
sc5
#### To send an APRS message to ZZ5ABC-0 with the content "Hi there!", send this command:
!:ZZ5ABC-0 :Hi there!{01}
#### Here's an example of how to send a location update with power, height and gain information:
!=5530.70N/01143.70E-PHG2410Arduino MicroAPRS
### Serial connection
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. If you do not want this behaviour, you can compile the firmware with the DEBUG flag set, which will make the modem wait for a new-line character before interpreting the received data. I would generally advise against this though, since it means that you cannot have newline characters in whatever data you want to send!
![MicroModem](https://raw.githubusercontent.com/markqvist/MicroModem/master/Design/Images/1.jpg)

2
buildrev.h
View File

@ -1,2 +1,2 @@
#define VERS_BUILD 1935
#define VERS_BUILD 1937
#define VERS_HOST "shard"