A JavaScript library for sending and receiving data using high-frequency audio tones, similar to dial-up modems. Supports redundancy and compatibility with older and newer devices.
A JavaScript library for sending and receiving data using high-frequency audio tones, similar to dial-up modems. It supports redundancy for reliable transmission, real-time communication, and automatic exclusion of own transmitted data for multi-device scenarios.
npm install boop-share
Or include directly in HTML:
<script src="https://unpkg.com/boop-share@latest/dist/boop-share.js"></script>
import BoopShare from 'boop-share';
// Create instance with unique ID
const boopShare = new BoopShare({ deviceId: 1 });
// Send a message
await boopShare.send('Hello, World!');
// Receive messages
boopShare.startReceiving((data, senderId) => {
console.log(`Received from device ${senderId}:`, new TextDecoder().decode(data));
});
Boop-Share uses Frequency Shift Keying (FSK) to encode binary data into audio tones:
Data transmission includes:
[Preamble] [DeviceID] [Data] [Checksum]
6 bits 8 bits Variable 1 bit
const boopShare = new BoopShare(options);
| Option | Type | Default | Description |
|---|---|---|---|
freq0 | number | 18000 | Frequency for bit 0 (Hz) |
freq1 | number | 19000 | Frequency for bit 1 (Hz) |
highFreq0 | number | 20000 | High frequency for bit 0 (Hz) |
highFreq1 | number | 21000 | High frequency for bit 1 (Hz) |
useHighFreq | boolean | false | Use ultrasonic frequencies |
redundancy | number | 3 | Number of transmission repetitions |
bitDuration | number | 0.1 | Duration per bit (seconds) |
preamble | array | [1,0,1,0,1,0] | Sync sequence |
deviceId | number | 0 | Unique device identifier (0-255) |
send(data)Sends data asynchronously.
await boopShare.send('Hello'); // String
await boopShare.send(new Uint8Array([72, 101, 108, 108, 111])); // Binary
startReceiving(callback)Starts continuous reception mode.
boopShare.startReceiving((data, senderId) => {
// data: Uint8Array
// senderId: number (0-255)
console.log(`From device ${senderId}:`, data);
});
stopReceiving()Stops continuous reception.
boopShare.stopReceiving();
receive(callback) (Legacy)Single-message reception (for backward compatibility).
await boopShare.receive((data) => {
console.log('Received:', data);
});
const device1 = new BoopShare({ deviceId: 1 });
const device2 = new BoopShare({ deviceId: 2 });
// Device 1 sends
await device1.send('Ping');
// Device 2 receives
device2.startReceiving((data, senderId) => {
console.log(`Device ${senderId} says:`, new TextDecoder().decode(data));
// Output: "Device 1 says: Ping"
});
const chat = new BoopShare({ deviceId: 1 });
// Start listening
chat.startReceiving((data, senderId) => {
const message = new TextDecoder().decode(data);
console.log(`[${senderId}] ${message}`);
});
// Send messages
setInterval(() => {
chat.send(`Hello from device 1 at ${Date.now()}`);
}, 2000);
const ultrasonic = new BoopShare({
useHighFreq: true, // Use 20-21kHz
bitDuration: 0.05, // Faster transmission
redundancy: 5 // More reliable
});
| Browser | Version | Notes |
|---|---|---|
| Chrome | 14+ | Full support |
| Firefox | 25+ | Full support |
| Safari | 6+ | Full support |
| Edge | 12+ | Full support |
Requires:
AudioContext or webkitAudioContextgetUserMedia or webkitGetUserMediabitDuration for slower, more reliable transmission// Handle microphone permission
try {
await boopShare.startReceiving(callback);
} catch (err) {
console.error('Microphone access denied:', err);
}
# Install dependencies
npm install
# Build
npm run build
# Run tests
npm test
# Development with watch
npm run dev
Apache License 2.0 - see LICENSE file for details.
npm install boop-share
import BoopShare from 'boop-share';
// Create instance
const boopShare = new BoopShare();
// Send data
await boopShare.send('Hello, World!');
// Receive data
boopShare.receive((data) => {
console.log('Received:', new TextDecoder().decode(data));
});
const boopShare = new BoopShare({
useHighFreq: true, // Use ultrasonic frequencies for newer devices
redundancy: 5, // Send data 5 times for better reliability
bitDuration: 0.05, // Faster transmission (50ms per bit)
deviceId: 1 // Unique ID for this device
});
// Send data
await boopShare.send(new Uint8Array([72, 101, 108, 108, 111])); // "Hello"
const boopShare = new BoopShare({ deviceId: 1 });
// Start continuous receiving
boopShare.startReceiving((data, senderId) => {
console.log(`Received from device ${senderId}:`, new TextDecoder().decode(data));
});
// Send messages in real-time
setInterval(() => {
boopShare.send('Ping from device 1');
}, 2000);
// Stop when done
// boopShare.stopReceiving();
freq0: Frequency for bit 0 (default: 18000 Hz)freq1: Frequency for bit 1 (default: 19000 Hz)highFreq0: High frequency for bit 0 (default: 20000 Hz)highFreq1: High frequency for bit 1 (default: 21000 Hz)useHighFreq: Use high frequencies if true (default: false)redundancy: Number of times to send data (default: 3)bitDuration: Duration per bit in seconds (default: 0.1)preamble: Sync sequence array (default: [1,0,1,0,1,0])deviceId: Unique device identifier (0-255, default: 0)send(data): Send string or Uint8Array datastartReceiving(callback(data, deviceId)): Start continuous receiving, callback receives data and sender deviceIdstopReceiving(): Stop continuous receivingreceive(callback): Legacy method for single message reception (backward compatibility)Boop-Share uses Frequency Shift Keying (FSK) to encode binary data into audio tones. Each bit is represented by a different frequency, and data is transmitted with a preamble for synchronization. Redundancy is achieved by sending the data multiple times, allowing the receiver to use error correction.
For older devices, it uses frequencies around 18-19kHz. For newer devices with better audio hardware, it can use ultrasonic frequencies above 20kHz.
Requires Web Audio API and getUserMedia for microphone access. Works in modern browsers that support these APIs.
MIT
FAQs
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
Socket uncovered four malicious NuGet packages targeting ASP.NET apps, using a typosquatted dropper and localhost proxy to steal Identity data and backdoor apps.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.