Morse lets you turn text into Morse code. It provides one main function, send, for encoding text
and several auxiliary functions that change how the code is generated.
I wrote the library not because I was interested in Morse code, but because I wanted something to exercise luablink. If you happen to have a blink(1), you should take a look at luablink.
If you're not changing the signalling mechanism, there's not much to it:
morse = require 'morse'
morse.send 'a patient waiter is no loser'
Take a look at Smiley Morse or this gist for details on changing the signalling mechanism.
This project uses semantic versioning. See semver.org for more information.
The library was developed and tested using Lua 5.2.3. However it should run on other versions of Lua with little or no modification.
If you have downloaded the github repository, you can install the library by copying the files in the src subdirectory to
your Lua library (/usr/local/share/lua/5.2 or similar). Alternatively, you can install it via luarocks
luarocks install morse
Morse is based on the conventional timing of Morse Code (or, rather, my understanding of it). There are five durations that are important:
- a short mark, dot, is one time unit long
- a long mark, dash, is three time units long
- between dots and dashes, but with a character, there should be one time unit
- between letters there should be three time units
- between words there should be seven time units
Morse enforces this timing by means of the blank generator function. Whatever this function does should be considered the equivalent of 'one time unit'. (For example,
the default implementation prints a space.) The send function calls the blank generator seven times between words, three times between letters, etc.
More documentation (than this dirt simple library requires) can be found in the doc subdirectory.
The best way to contact me regarding this library is to post an issue at the github repository.
Morse is free software distributed under the terms of the MIT license. It may be used for any purpose, including commercial purposes, at absolutely no cost without having to ask. The only requirement is that if you do use Morse, then you should give me credit by including the appropriate copyright notice somewhere in your product or its documentation. For details, see LICENSE.