API Reference
This page documents all public functions provided by the pymorsed library.
Encoder Module
from pymorsed.encoder import encode
encode(text, language="english")
Converts plain text into Morse code.
Parameters
| Parameter | Type | Description |
|---|---|---|
text |
str |
Text to encode into Morse code |
language |
str |
Language mapping to use ("english", "russian") |
Returns
str
Morse code representation of the input text.
Example
from pymorsed.encoder import encode
morse = encode("HELLO")
print(morse)
Output:
.... . .-.. .-.. ---
Decoder Module
from pymorsed.decoder import decode
decode(morse, language="english")
Converts Morse code back into plain text.
Parameters
| Parameter | Type | Description |
|---|---|---|
morse |
str |
Morse code string |
language |
str |
Language mapping used during decoding |
Returns
str
Decoded text.
Example
from pymorsed.decoder import decode
text = decode(".... . .-.. .-.. ---")
print(text)
Output:
HELLO
play_audio(audio)
Plays a generated Morse code waveform through the system speakers.
Parameters
| Parameter | Type |
|---|---|
audio |
numpy.ndarray |
Returns
None
Example
from pymorsed.audio_encoder import *
audio = morse_to_audio("... --- ...")
play_audio(audio)
save_audio(audio, filename, fs=44100)
Saves a Morse waveform as a WAV file.
Parameters
| Parameter | Type | Description |
|---|---|---|
audio |
numpy.ndarray |
Audio waveform |
filename |
str |
Output filename |
fs |
int |
Sample rate |
Returns
None
Example
from pymorsed.audio_encoder import *
audio = morse_to_audio("... --- ...")
save_audio(audio, "sos.wav")
plot_waveform(audio, fs=44100)
Displays the waveform using Matplotlib.
Parameters
| Parameter | Type |
|---|---|
audio |
numpy.ndarray |
fs |
int |
Returns
None
Example
from pymorsed.audio_encoder import *
audio = morse_to_audio("... --- ...")
plot_waveform(audio)
Audio Decoder Module
from pymorsed.audio_decoder import decode_from_file
decode_from_file(filepath)
Decodes Morse code from a WAV audio file.
The decoder performs:
- Audio loading
- Stereo-to-mono conversion
- Silence trimming
- Envelope extraction
- Signal smoothing
- Thresholding
- Morse symbol reconstruction
- Text decoding
Parameters
| Parameter | Type | Description |
|---|---|---|
filepath |
str |
Path to WAV file |
Returns
str
Decoded text.
Example
from pymorsed.audio_decoder import decode_from_file
text = decode_from_file("sos.wav")
print(text)
Output:
SOS
Exceptions
May raise:
FileNotFoundError
If the audio file does not exist.
RuntimeError
If decoding fails due to invalid audio data.
Top-Level Imports
The package exposes commonly used functions directly from the root package.
from pymorsed import encode
from pymorsed import decode
from pymorsed import morse_to_audio
Example
from pymorsed import encode, decode
morse = encode("HELLO")
text = decode(morse)
print(morse)
print(text)
Output:
.... . .-.. .-.. ---
HELLO
Supported Languages
Current language mappings:
| Language | Code |
|---|---|
| English | english |
| Russian | russian |
Additional language mappings may be added in future releases.