initial docs
This commit is contained in:
Gerolf Ziegenhain
parent
49e78b0472
commit
fa20fc800b
136
README.md
136
README.md
@ -1,7 +1,141 @@
|
|||||||
http://8ch9azbsfifz.github.io/moip/
|
MoIP - Morse over IP
|
||||||
|
====================
|
||||||
|
|
||||||
|
irmc - Internet Relay Morse Code
|
||||||
|
|
||||||
|
# What is IRMC?
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
||||||
|
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/)).
|
||||||
|
|
||||||
|
|
||||||
|
# How to build?
|
||||||
|
## Install dependency: morse keyer library
|
||||||
|
```
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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)
|
||||||
|
Compilation with make :)
|
||||||
|
|
||||||
|
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/)).
|
||||||
|
|
||||||
|
## 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](http://blog.brianhemeryck.me/installing-rxtx-on-mac-os-mountain-lion/) on OSX) it is even possible to connect to external hardware.
|
||||||
|
NB: before you transmit make sure you uncheck the "circuit closer".
|
||||||
|
|
||||||
|
Or you may want to use tcpdump, i.e.:
|
||||||
|
```
|
||||||
|
sudo tcpdump -i all -vvvv "host faeroes.sdf.org"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# How to use:
|
||||||
|
|
||||||
|
The usage is: `irmc [hostname] [port] [channel] [id] [serialport`
|
||||||
|
|
||||||
|
For example:
|
||||||
|
`./irmc mtc-kob.dyndns.org 7890 103 MyID /dev/tty.usbserial´
|
||||||
|
|
||||||
|
## Morse KOB Servers
|
||||||
|
* faeroes.sdf.org 7890
|
||||||
|
* morsecode.dyndns.org 7890
|
||||||
|
* mtc-kob.dyndns.org 7890
|
||||||
|
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).
|
||||||
|
|
||||||
|
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 :)
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
|
# References
|
||||||
|
|
||||||
|
## Original post by Fernan Bolando (VE4FEB)
|
||||||
|
Copied on 20150103 from http://fernski.blogspot.de/2013/03/internet-relay-morsecode.html
|
||||||
|
|
||||||
|
> 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
|
||||||
|
> 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/
|
||||||
|
|
||||||
|
|
||||||
|
## Resources
|
||||||
|
* CWCom, John Samin (VK1EME): http://www.mrx.com.au/d_cwcom.htm
|
||||||
|
* Morse KOB, Les Kerr: https://sites.google.com/site/morsekob/ and http://kob.sdf.org/morsekob/
|
||||||
|
* 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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
A number of different approaches for CW over IP exist. An early implementation has been the CWCom protocol<ref>CWCom, John Samin (VK1EME): http://www.mrx.com.au/d_cwcom.htm</ref>, which has been the basis for Morse KOB<ref>Morse KOB, Less Kerr: http://kob.sdf.org/morsekob/</ref><ref>Morse KOB 4.0, Less Kerr: https://sites.google.com/site/morsekob/</ref>, a ready-to-use software. Both chat programs have been written for CW exclusively and are compatible<ref>Relay server for CW communicator and morse KOB: http://morsecode.dc3.com:7890</ref><ref>Sources for the Relay Server: http://sourceforge.net/projects/morse-rss-news/</ref>. An alternative implementation in C exists<ref>IRMC (Morse KOB): http://fernski.blogspot.de/2013/03/internet-relay-morsecode.html</ref> as well as a port to the ATMEL AVR Microcontroller<ref>MorseKOB for AT Mega: http://fernski.blogspot.de/2013/05/sending-morsecode-via-atmega.html</ref>. Besides a variety of other approaches exist, for example an IRC plugin<ref>CWirc, Pierre-Philippe Coupard: http://myspace.voo.be/pcoupard/cwirc/</ref>, a JavaScript implementation<ref>Burak Kanber: http://morsecode.me</ref>, a bandwidth-eating UDP implementation<ref>Morse over IP, Hans Liss: http://hans.liss.pp.se/node/343</ref>, a chat for iOS<ref>CW with me (iOS), Nick Garner: http://pignology.net/cwwithme.html</ref> or a modulated CW over IP using Mumble<ref>iCW: https://sites.google.com/site/icwoip/</ref>.
|
||||||
|
|
||||||
|
|
||||||
Code Quality
|
Code Quality
|
||||||
============
|
============
|
||||||
This is experimental code.
|
This is experimental code.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user