Skip to content

A morse code translation library written in JavaScript

License

Notifications You must be signed in to change notification settings

zero298/morsejs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

morsejs

npm version Build Status Inline docs

A morse code translation library written in JavaScript

Working implementation of morsejs

Translation

morsejs:translate will translate a given String to an Array of Numbers found in the signal enumeration (by default: -1, 0, and 1).

The return structure is formated so that it is similar to the transmission format of a morse message. This means that it includes the spacing between symbol signals, the symbols themselves, and words. See transmission of morse code on Wikipedia for a better explanation.

By default, this library transmits -1 for any padding between signals, symbols, or words. Similarly, it sends 0 for a short signal and 1 for a long signal. Really, if we were to follow the transmission format correctly, we should send 0 for padding and 1 for short or long since it would be more aking to on/off.

The rational for this is that we can compress the data from having to have 3 1's for a long to just one number but since we don't distinguish between the different paddings, we are wasting space anyway. That's why this may or may not change or maybe become a compression setting.

Consider the transmission of "SOS":

         1         2         3
123456789012345678901234567890
-_-_-___---_---_---___-_-_-

morsejs would actually return:

[ 0, -1, 0, -1, 0, -1, -1, -1, 1, -1, 1, -1, 1, -1, -1, -1, 0, -1, 0, -1, 0 ]

Installation

Binary

npm install -g morsejs

Dependency

npm install --save morsejs

Usage

CLI

morsejs hello world

JS

If you just want to plainly translate a message, you can just use translate

var message = morsejs.translate("hello world");

Plugins

There are plugins that can use the output from morsejs to render it in different ways.

About

A morse code translation library written in JavaScript

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published