@e04/ft8ts 0.0.6 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,16 +18,12 @@ https://e04.github.io/ft8ts/example/browser/index.html
18
18
 
19
19
  ### CLI
20
20
 
21
- #### Encode
22
-
23
21
  ```bash
24
- npx tsx example/generate-ft8-wav.ts "CQ JK1IFA PM95" [--out output.wav] [--df 1000]
25
- ```
26
-
27
- #### Decode
22
+ # Decode WAV file
23
+ npx @e04/ft8ts decode foo.wav [--low 200] [--high 3000] [--depth 2]
28
24
 
29
- ```bash
30
- npx tsx example/decode-ft8-wav.ts ./src/__test__/190227_155815.wav [--low 200] [--high 3000] [--depth 2]
25
+ # Encode message to WAV file
26
+ npx @e04/ft8ts encode "CQ JK1IFA PM95" [--out output.wav] [--df 1000]
31
27
  ```
32
28
 
33
29
  ## Benchmark
@@ -81,7 +77,8 @@ const samples = encodeFT8("CQ JK1IFA PM95", {
81
77
  const book = new HashCallBook();
82
78
 
83
79
  // Decode audio samples to messages
84
- const decoded = decodeFT8(samples, 12000, {
80
+ const decoded = decodeFT8(samples, {
81
+ sampleRate: 12000,
85
82
  freqLow: 200,
86
83
  freqHigh: 3000,
87
84
  depth: 2,
@@ -97,6 +94,7 @@ for (const d of decoded) {
97
94
 
98
95
  | Option | Default | Description |
99
96
  |--------|---------|-------------|
97
+ | `sampleRate` | 12000 | Input audio sample rate (Hz) |
100
98
  | `freqLow` | 200 | Lower frequency bound (Hz) |
101
99
  | `freqHigh` | 3000 | Upper frequency bound (Hz) |
102
100
  | `syncMin` | 1.2 | Minimum sync threshold |