https://github.com/reblox01/morse-decoder
Not only translates Morse code into text and vice versa but also features audio playback for seamless decoding. Dive into the world of communication history or sharpen your skills with practical applications. Decode, translate, and immerse yourself in the rhythmic language of Morse code.
https://github.com/reblox01/morse-decoder
audio-player hacktoberfest javascript morse-code morse-code-translator morse-learning morse-translator typescript
Last synced: 2 months ago
JSON representation
Not only translates Morse code into text and vice versa but also features audio playback for seamless decoding. Dive into the world of communication history or sharpen your skills with practical applications. Decode, translate, and immerse yourself in the rhythmic language of Morse code.
- Host: GitHub
- URL: https://github.com/reblox01/morse-decoder
- Owner: reblox01
- License: mit
- Created: 2023-05-23T19:18:36.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-10T18:53:15.000Z (almost 2 years ago)
- Last Synced: 2025-01-19T10:42:22.999Z (4 months ago)
- Topics: audio-player, hacktoberfest, javascript, morse-code, morse-code-translator, morse-learning, morse-translator, typescript
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [Morse Code Translator](#) with Audio - Morse Decoder
[![npm-version]][npm] [![npm-downloads]][npm]
Morse code encoder and decoder with no dependencies. It supports Latin, Cyrillic, Greek, Hebrew, Arabic,
Persian, Japanese, Korean, and Thai, with audio-generation functionality using the [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API).
## Installation
### npm
```bash
$ npm install morse-decoder --save
```
### yarn
```bash
$ yarn add morse-decoder
```
## Usage
```js
const morse = require('morse-decoder');
const encoded = morse.encode('SOS'); // ... --- ...
const decoded = morse.decode('... --- ...'); // SOS
const characters = morse.characters(); // {'1': {'A': '.-', ...}, ..., '11': {'ㄱ': '.-..', ...}}
const audio = morse.audio('SOS');
audio.play(); // play audio
audio.stop(); // stop audio
audio.exportWave(); // download audio wave file (promise)
const url = await audio.getWaveUrl(); // get audio wave url (promise)
const blob = await audio.getWaveBlob(); // get audio wave blob (promise)
```
### Options and localization
You can customize the dash, dot, or space characters and specify the alphabet with the priority option for
an accurate encoding and decoding.
The priority option gives direction to the plugin to start searching for the given character set first.
Set the priority option according to the list below.
- 1 => ASCII (Default)
- 2 => Numbers
- 3 => Punctuation
- 4 => Latin Extended (Turkish, Polish etc.)
- 5 => Cyrillic
- 6 => Greek
- 7 => Hebrew
- 8 => Arabic
- 9 => Persian
- 10 => Japanese
- 11 => Korean
- 12 => Thai
```js
const cyrillic = morse.encode('Ленинград', { priority: 5 }); // .-.. . -. .. -. --. .-. .- -..
const greek = morse.decode('... .- --. .- .--. .--', { priority: 6 }); // ΣΑΓΑΠΩ
const hebrew = morse.decode('.. ––– . –––', { dash: '–', dot: '.', priority: 7 }); // יהוה
const japanese = morse.encode('NEWS', { priority: 10, dash: '－', dot: '・', separator: ' ' }); // －・ ・ ・－－ ・・・
const characters = morse.characters({ dash: '–', dot: '•' }); // {'1': {'A': '•–', ...}, ..., '11': {'ㄱ': '•–••', ...}}
const arabicAudio = morse.audio('البراق', { // generates the Morse .- .-.. -... .-. .- --.- then generates the audio from it
unit: 0.1, // period of one unit, in seconds, 1.2 / c where c is speed of transmission, in words per minute
fwUnit: 0.1, // period of one Farnsworth unit to control intercharacter and interword gaps
oscillator: {
type: 'sine', // sine, square, sawtooth, triangle
frequency: 500, // value in hertz
onended: function () { // event that fires when the tone stops playing
console.log('ended');
}
}
});
const oscillator = arabicAudio.oscillator; // OscillatorNode
const context = arabicAudio.context; // AudioContext;
const gainNode = arabicAudio.gainNode; // GainNode
arabicAudio.play(); // will start playing Morse audio
arabicAudio.stop(); // will stop playing Morse audio
```
## Contributing and Known Issues
Contributions are welcome.
## Generating Minified Files
Install node and npm and run the commands below.
``` bash
$ npm install
# generate `index.js` inside `src`
$ npm run build
# generate `morse-decoder.min.js` (minified) inside `dist`
$ npm run build-rel
```
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
[npm-version]: https://img.shields.io/npm/v/morse-decoder.svg?style=flat-square
[npm-downloads]: https://img.shields.io/npm/dm/morse-decoder.svg?style=flat-square
[npm]: https://www.npmjs.com/package/morse-decoder