QuietModemKit
This is the iOS framework for https://github.com/quiet/quiet
With this library, you can send data through sound.
Live demo: https://quiet.github.io/quiet-js/
Other platforms:
- Javascript: https://github.com/quiet/quiet-js
- Android: https://github.com/quiet/org.quietmodem.Quiet
Why sound? Isn't that outdated?
If you are old enough, you may remember using dial-up modems to connect to the internet. In a sense, this package brings that back. While it's true that this is somewhat of a retro approach, consider the advantages of using sound.
-
Highly cross-platform. Any device with speakers and a microphone and sufficient computational power can use this medium to communicate.
-
No pairing. Unlike Bluetooth, sound can be used instantly without the need to pair devices. This reduces the friction and improves the user experience.
-
Embeddable content. Similar to a QR code, short packets of data can be encoded into streaming or recorded audio and can then be later decoded by this package.
What does it sound like?
The answer to this depends on which operating mode you choose. Quiet provides audible and near-ultrasonic modes. Audible modes sound something like a puff of air. The near-ultrasonic modes run at 17+kHz and are virtually inaudible to adults. Either mode can operate at relatively low volumes as long as there isn't too much background noise.
How fast does it go?
Quiet's provided audible mode transfers at approximately 7kbps. In cases where two devices are connected over a cable (via 3.5mm jack) it can run in cable mode, which transfers at approximately 64kbps.
Building
CMake is required to build QuietModemKit. If you aren't sure if you have CMake installed, run brew install cmake.
It is recommended that you use Carthage to build QuietModemKit. Simply run brew install cmake and then add github "Quiet/QuietModemKit" to your Cartfile and run carthage update.
Example
Transmitter:
#import <QuietModemKit/QuietModemKit.h>
int main(int argc, char * argv[]) {
QMTransmitterConfig *txConf = [[QMTransmitterConfig alloc] initWithKey:@"ultrasonic-experimental"];
QMFrameTransmitter *tx = [[QMFrameTransmitter alloc] initWithConfig:txConf];
NSString *frame_str = @"Hello, World!";
NSData *frame = [frame_str dataUsingEncoding:NSUTF8StringEncoding];
[tx send:frame];
CFRunLoopRun();
[tx close];
return 0;
}
Receiver:
#import <QuietModemKit/QuietModemKit.h>
static QMFrameReceiver *rx;
void (^recv_callback)(NSData*) = ^(NSData *frame){
printf("%s\n", [frame bytes]);
};
void (^request_callback)(BOOL) = ^(BOOL granted){
QMReceiverConfig *rxConf = [[QMReceiverConfig alloc] initWithKey:@"ultrasonic-experimental"];
rx = [[QMFrameReceiver alloc] initWithConfig:rxConf];
[rx setReceiveCallback:recv_callback];
};
int main(int argc, char * argv[]) {
[[AVAudioSession sharedInstance] requestRecordPermission:request_callback];
CFRunLoopRun();
if (rx != nil) {
[rx close];
}
return 0;
}
Note that we ask for the Record permission. This is required to use the receiver.
Profiles
The modem can be used audibly or via ultrasonic sound. QMTransmitterConfig and QMReceiverConfig are used to select modem configuration. For a full list of valid keys, refer to the top-level keys of quiet-profiles.json.
License
3-Claused BSD, plus third-party licenses (mix of MIT and BSD, see licenses/)
0 Feb 12, 2022
500 Dec 27, 2022
23 Nov 27, 2022
18 Dec 26, 2022
676 Dec 25, 2022
5 Oct 17, 2022
17 Oct 16, 2022
11 Nov 5, 2022
4.9k Jan 2, 2023
523 Nov 12, 2022
20 Aug 4, 2022
591 Oct 18, 2022
297 Dec 17, 2022
3 Jan 5, 2022
16 Nov 5, 2022
32 Dec 28, 2022
4 Dec 15, 2022
3 Dec 22, 2022