irmc/README.md

96 lines
4.8 KiB
Markdown
Raw Normal View History

2015-01-03 22:19:29 +00:00
# What is IRMC?
2015-01-03 23:04:09 +00:00
IRMC stands for Internet Relay Morse Code. 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:39:12 +00:00
## Why morse code over IP?
Why not? A number of different approaches for CW over IP exist. An early implementation has been the CWCom protocol,
which has been the basis for Morse KOB, a ready-to-use software. Both chat programs have been written for CW exclusively and are compatible. An alternative implementation in C exists as well as a port to the ATMEL AVR Microcontroller.
2015-01-03 22:45:14 +00:00
Besides a variety of other approaches exist, for example an IRC plugin ([CWirc](http://myspace.voo.be/pcoupard/cwirc/)), a [JavaScript implementation](http://morsecode.me), a [bandwidth-eating UDP implementation](http://hans.liss.pp.se/node/343), a [chat for iOS](http://pignology.net/cwwithme.html) or a modulated CW over IP using Mumble ([iCW](https://sites.google.com/site/icwoip/)).
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-01-03 23:12:56 +00:00
For the USB serial devices you need a PL2303 driver (i.e. PL2303_Serial-USB_on_OSX_Lion.pkg).
2015-01-03 23:04:09 +00:00
2015-01-03 23:12:56 +00:00
## Testing with MorseKOB 3.0 (Java)
This [software](http://kob.sdf.org/morsekob/morsekob30/MorseKOB.jar) will run on
Linux, Windows and OSX. With the [RXTX software](http://morsekob.org/morsekob30/help.htm)
for Java (i.e. librxtxSerial.jnilib on OSX) it is even possible to connect to external hardware.
NB: before you transmit make sure you uncheck the "circuit closer".
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
## Morse KOB Servers
* faeroes.sdf.org 7890
* mtc-kob.dyndns.org 7890
2015-01-03 22:59:18 +00:00
A current list of servers if provided on the [MorseKOB Website](http://mtc-kob.dyndns.org).
## Hardware interface options
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).
2015-01-03 20:59:52 +00:00
2015-01-03 22:14:25 +00:00
2015-01-03 22:19:29 +00:00
# References
2015-01-03 20:59:52 +00:00
2015-01-03 22:39:12 +00:00
## Original post by Fernan Bolando (VE4FEB)
2015-01-03 22:19:29 +00:00
Copied on 20150103 from http://fernski.blogspot.de/2013/03/internet-relay-morsecode.html
2015-01-03 20:59:52 +00:00
2015-01-03 22:19:29 +00:00
> I have been using cwcom to practice sending morsecode, unfortunately my main computer at home is running openbsd and it has gotten harder to gain access to a reliable MS Windows machine. So I wrote my own client that works on openbsd.
> This is written in C and although not tested it should compile under other OS. If any one wants to try it and send me feedback. you can download version 0.01 here http://fernan.bitbucket.org/irmc.tgz
> Les Kerr of https://home.comcast.net/~morsekob/ has been very patient in answering my questions regarding the cwcom protocol and setting up a test server during debugging.
>
> There are few difference between this and the official cwcom client
> 1. It is a command line tool
> 2. It does not send the characters of the message to the receivers screen.
> 3. It does not translate CW for you. You can try fldigi if you just want see the transmission.
> 4. Tone pitch is currently hard coded to 650Hz
> 5. It does not have a way to show you who is listening.
>
> Bugs:
> There are a few that I am working on right now, but feel free to send me feedback if you get a chance to try it out.
>
> File(s)
> http://fernan.bitbucket.org/irmc.tgz
2015-01-03 22:28:04 +00:00
> The following people have helped me a lot to learn the protocols and setting up test servers.
> Les Kerr - https://home.comcast.net/~morsekob/
> Bob Denny - http://morse-rss-news.sourceforge.net/
> John Samin - http://www.mrx.com.au/
2015-01-03 20:59:52 +00:00
2015-01-03 22:19:29 +00:00
## Resources
2015-01-03 22:39:12 +00:00
* CWCom, John Samin (VK1EME): http://www.mrx.com.au/d_cwcom.htm
2015-01-04 01:36:57 +00:00
* Morse KOB, Les Kerr: https://sites.google.com/site/morsekob/ and http://kob.sdf.org/morsekob/
2015-01-03 22:39:12 +00:00
* Relay server for CW communicator and morse KOB: http://morsecode.dc3.com:7890
* Sources for the Relay Server: http://sourceforge.net/projects/morse-rss-news/
* MorseKOB for AT Mega, Fernan Bolando (VE4FEB): http://fernski.blogspot.de/2013/05/sending-morsecode-via-atmega.html