Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quiet/quietmodemkit
iOS framework for the Quiet Modem (data over sound)
https://github.com/quiet/quietmodemkit
ios modem transmit-data ultrasonic
Last synced: 2 days ago
JSON representation
iOS framework for the Quiet Modem (data over sound)
- Host: GitHub
- URL: https://github.com/quiet/quietmodemkit
- Owner: quiet
- License: bsd-3-clause
- Created: 2017-03-05T06:03:06.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T07:50:10.000Z (over 3 years ago)
- Last Synced: 2024-08-15T17:57:51.315Z (3 months ago)
- Topics: ios, modem, transmit-data, ultrasonic
- Language: Objective-C
- Homepage:
- Size: 74.2 KB
- Stars: 451
- Watchers: 19
- Forks: 49
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
```objc
#import
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:
```objc
#import
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](https://github.com/quiet/QuietModemKit/blob/master/quiet-profiles.json).
License
--------------
3-Claused BSD, plus third-party licenses (mix of MIT and BSD, see licenses/)