irmc/README.md

89 lines
2.8 KiB
Markdown
Raw Normal View History

2015-01-04 09:06:40 +00:00
irmc - Internet Relay Morse Code
================================
2015-02-15 12:13:22 +00:00
IRMC stands for Internet Relay Morse Code and is an implementation of [MOIP](https://github.com/8cH9azbsFifZ/moip).
It implements the [CWCom protocol](http://kob.sdf.org/morsekob/docs/cwcom.pdf)
as adopted by [MorseKOB](http://kob.sdf.org/morsekob/docs/history.pdf).
You can try out the software in a [browser](http://kob.sdf.org/morsekob/morsekob30/index.htm) using Java.
2015-01-03 22:19:29 +00:00
2015-04-29 19:37:50 +00:00
![Screenshot on OSX](/doc/screenshot.png?raw=true "Screenshot")
2015-01-03 22:19:29 +00:00
# How to build?
2015-01-03 22:26:01 +00:00
## Install dependency: morse keyer library
```
2015-01-03 22:15:12 +00:00
wget https://github.com/8cH9azbsFifZ/morse/archive/v0.1.tar.gz
tar xzf v0.1.tar.gz
cd morse-0.1
libtoolize
./autogen.sh
./configure --with-portaudio
make
sudo make install
2015-01-03 22:26:01 +00:00
```
2015-01-03 22:15:12 +00:00
2015-01-03 22:26:01 +00:00
## Debian (Wheezy)
Some dependencies have to be installed:
```
apt-get install -y alsa-oss oss-compat build-essential autoconf libao-dev libtool
```
Afterwards compilation with `make` should work. If something went wrong, you may have
to adjust your `LD_LIBRARY_PATH`. Alternatively try:
```
LD_LIBRARY_PATH=/usr/local/lib ./irmc mtc-kob.dyndns.org 7890 33 123
```
## OSX (Yosemite)
2015-01-03 23:12:56 +00:00
Compilation with make :)
2015-01-03 22:15:12 +00:00
2015-02-15 12:13:22 +00:00
For the USB serial devices you need a PL2303 driver
(i.e. [PL2303_Serial-USB_on_OSX_Lion.pkg](http://changux.co/osx-installer-to-pl2303-serial-usb-on-osx-lio/)).
2015-01-03 23:04:09 +00:00
2015-04-29 19:37:50 +00:00
## Testing
./irmc morsecode.dyndns.org 7890 2348 test
2015-01-03 22:15:12 +00:00
2015-02-15 12:13:22 +00:00
Or you may want to use tcpdump, i.e.:
```
sudo tcpdump -i all -vvvv "host faeroes.sdf.org"
```
2015-01-03 22:15:12 +00:00
2015-01-03 22:19:29 +00:00
# How to use:
2015-01-03 20:59:52 +00:00
2015-01-03 22:26:48 +00:00
The usage is: `irmc [hostname] [port] [channel] [id] [serialport`
For example:
`./irmc mtc-kob.dyndns.org 7890 103 MyID /dev/tty.usbserial´
2015-01-03 22:26:01 +00:00
2015-02-15 12:13:22 +00:00
2015-01-03 22:59:18 +00:00
## Hardware interface options
2015-02-15 12:13:22 +00:00
A good description on how to build differnt interfaces (telegraph key, sounder or both)
is given on the [MorseKOB Website](http://kob.sdf.org/morsekob/interface.htm).
Landline telegraphs use "closed circuits" for communications; if you have built one at home,
you may also use the [loop interface](http://kob.sdf.org/morsekob/docs/loopinterface.pdf).
Connection of a morse key:
Serial PIN: 4 & 6
[layout of pins](http://techpubs.sgi.com/library/dynaweb_docs/0650/SGI_Admin/books/MUX_IG/sgi_html/figures/4-2.serial.port.con.gif)
Connecting the palm radio: keep an eye on the grounding :)
2015-01-03 20:59:52 +00:00
2015-01-03 22:14:25 +00:00
2015-04-29 19:37:50 +00:00
http://kob.sdf.org/morsekob/interface.htm#portpins
RS232 DB9 Function
DTR 4 Manual Key / paddle common
DSR 6 Manual key / dot paddle
CTS 8 Dash paddle
RTS 7 Sounder output
SG 5 Sounder ground
2015-01-03 20:59:52 +00:00
2015-04-29 19:37:50 +00:00
# Changelog
* v0.2 [zip](https://github.com/8cH9azbsFifZ/irmc/archive/v0.2.zip) - ported to debian wheezy and osx yosemite, DG6FL
* v0.1 [zip](https://github.com/8cH9azbsFifZ/irmc/archive/v0.1.zip) - original version, VE7FEB
2015-01-03 20:59:52 +00:00
2015-02-15 12:13:22 +00:00
Code Quality
============
This is experimental code.