g0dub/irmc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

wip

Browse Source
This commit is contained in:
Gerolf Ziegenhain 2015-02-15 13:11:40 +01:00
parent 2c71fe456d
commit 67acd163b6
1 changed files with 2 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,27 +1,11 @@
irmc - Internet Relay Morse Code
================================
# What is IRMC?
IRMC stands for Internet Relay Morse Code.
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.
## 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
```
@ -71,12 +55,7 @@ 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).
@ -119,18 +98,6 @@ Copied on 20150103 from http://fernski.blogspot.de/2013/03/internet-relay-morsec
> 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
============
This is experimental code.