-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexample-usage.ts
More file actions
257 lines (204 loc) · 6.36 KB
/
example-usage.ts
File metadata and controls
257 lines (204 loc) · 6.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/* eslint-disable no-console */
/**
* Plugin System Usage Example
*
* This example demonstrates how to use the rad.io plugin system
* in a real application context.
*/
import {
pluginRegistry,
FMDemodulatorPlugin,
WaterfallVisualizationPlugin,
PluginType,
} from "./index";
import type { PluginEventData } from "../types/plugin";
/**
* Initialize and use plugins in your application
*/
async function initializePlugins(): Promise<void> {
console.log("=== Plugin System Example ===\n");
// 1. Create and register plugins
console.log("1. Registering plugins...");
const fmDemod = new FMDemodulatorPlugin();
const waterfallViz = new WaterfallVisualizationPlugin();
await pluginRegistry.register(fmDemod);
await pluginRegistry.register(waterfallViz);
console.log(` Registered: ${fmDemod.metadata.name}`);
console.log(` Registered: ${waterfallViz.metadata.name}\n`);
// 2. Listen to plugin events
console.log("2. Setting up event listeners...");
pluginRegistry.addEventListener((event: PluginEventData) => {
console.log(
` Event: ${event.event} - Plugin: ${event.plugin.metadata.name}`,
);
});
// 3. Activate plugins
console.log("\n3. Activating plugins...");
await fmDemod.activate();
await waterfallViz.activate();
console.log(` ${fmDemod.metadata.name} is now active`);
console.log(` ${waterfallViz.metadata.name} is now active\n`);
// 4. Discover plugins
console.log("4. Discovering available plugins...");
const allPlugins = pluginRegistry.getAllPlugins();
console.log(` Total plugins: ${allPlugins.length}`);
const demodulators = pluginRegistry.getPluginsByType(PluginType.DEMODULATOR);
console.log(` Demodulators: ${demodulators.length}`);
const visualizations = pluginRegistry.getPluginsByType(
PluginType.VISUALIZATION,
);
console.log(` Visualizations: ${visualizations.length}\n`);
// 5. Use plugin functionality
console.log("5. Using plugin functionality...");
// Configure demodulator
const modes = fmDemod.getSupportedModes();
console.log(` Supported demodulation modes: ${modes.join(", ")}`);
fmDemod.setMode("wbfm");
fmDemod.setParameters({ bandwidth: 200000, squelch: 10 });
// Use demodulator (with sample data)
const iqSamples = [
{ I: 0.5, Q: 0.5 },
{ I: 0.3, Q: 0.7 },
{ I: -0.2, Q: 0.8 },
];
const audioSamples = fmDemod.demodulate(iqSamples);
console.log(` Demodulated ${audioSamples.length} audio samples`);
// Use visualization (would render to canvas in real app)
const capabilities = waterfallViz.getCapabilities();
console.log(
` Visualization supports realtime: ${capabilities.supportsRealtime}`,
);
console.log(
` Update rate range: ${capabilities.minUpdateRate}-${capabilities.maxUpdateRate} Hz\n`,
);
// 6. Configure plugins
console.log("6. Configuring plugins...");
const schema = fmDemod.getConfigSchema();
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
if (schema) {
console.log(
` Available config options: ${Object.keys(schema.properties).join(", ")}`,
);
}
await fmDemod.updateConfig({
mode: "nbfm",
bandwidth: 12500,
});
console.log(" Updated demodulator configuration\n");
// 7. Deactivate and cleanup
console.log("7. Cleaning up...");
await fmDemod.deactivate();
await waterfallViz.deactivate();
await pluginRegistry.unregister(fmDemod.metadata.id);
await pluginRegistry.unregister(waterfallViz.metadata.id);
console.log(" Plugins deactivated and unregistered\n");
console.log("=== Example Complete ===");
}
/**
* Example: Using plugins in a React component
*/
/*
import { useEffect, useState } from 'react';
import { pluginRegistry, FMDemodulatorPlugin } from './plugins';
function DemodulatorComponent() {
const [plugin, setPlugin] = useState<FMDemodulatorPlugin | null>(null);
useEffect(() => {
// Initialize plugin
const demod = new FMDemodulatorPlugin();
pluginRegistry.register(demod).then(() => {
demod.activate().then(() => {
setPlugin(demod);
});
});
// Cleanup
return () => {
void (async () => {
if (plugin) {
await plugin.deactivate();
await pluginRegistry.unregister(plugin.metadata.id);
}
})();
};
}, [plugin]);
const handleDemodulate = (samples: IQSample[]) => {
if (!plugin) return;
const audio = plugin.demodulate(samples);
// Use audio samples...
};
return (
<div>
<h2>Demodulator Status</h2>
<p>Plugin: {plugin?.metadata.name}</p>
<p>State: {plugin?.state}</p>
<button onClick={() => handleDemodulate(testSamples)}>
Demodulate
</button>
</div>
);
}
*/
/**
* Example: Creating a custom plugin
*/
/*
import { BasePlugin } from './lib/BasePlugin';
import type { DemodulatorPlugin, PluginMetadata } from './types/plugin';
class AMDemodulatorPlugin extends BasePlugin implements DemodulatorPlugin {
constructor() {
super({
id: 'am-demodulator',
name: 'AM Demodulator',
version: '1.0.0',
author: 'Your Name',
description: 'Amplitude Modulation demodulator',
type: PluginType.DEMODULATOR,
});
}
protected onInitialize(): void {
// Initialize plugin state
}
protected onActivate(): void {
// Start plugin
}
protected onDeactivate(): void {
// Stop plugin
}
protected onDispose(): void {
// Cleanup resources
}
demodulate(samples: IQSample[]): Float32Array {
const output = new Float32Array(samples.length);
for (let i = 0; i < samples.length; i++) {
const sample = samples[i];
if (!sample) continue;
// AM demodulation: calculate magnitude
output[i] = Math.sqrt(sample.I ** 2 + sample.Q ** 2);
}
return output;
}
getSupportedModes(): string[] {
return ['am', 'dsb', 'usb', 'lsb'];
}
setMode(mode: string): void {
// Implement mode switching
}
getParameters(): DemodulatorParameters {
return {
audioSampleRate: 48000,
bandwidth: 10000,
};
}
setParameters(params: Partial<DemodulatorParameters>): void {
// Update parameters
}
}
// Usage
const amPlugin = new AMDemodulatorPlugin();
await pluginRegistry.register(amPlugin);
await amPlugin.activate();
*/
// Run the example if this file is executed directly
if (require.main === module) {
void initializePlugins();
}
export { initializePlugins };