Socket
Socket
Sign inDemoInstall

ggwave

Package Overview
Dependencies
0
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    ggwave

Tiny data-over-sound library


Version published
Weekly downloads
9
decreased by-67.86%
Maintainers
1
Install size
159 kB
Created
Weekly downloads
 

Changelog

Source

[v0.4.0] - 2022-07-05

This release introduces some breaking changes in the C and C++ API!

Make sure to read the ggwave.h header for more information

  • Major refactoring in order to support microcontrollers (#65
  • Zero memory allocations during runtime
  • Do not include STL headers anymore
  • New, low-frequency, mono-tone (MT) protocols suitable for microcontrollers
  • Remove code-duplication for some of the examples
  • Better FFT implementation
  • Less memory usage
  • Bug fix in fixed-length payload decoding
  • Add Arduino and ESP32 examples
  • Support for Direct Sequence Spread (DSS)

Readme

Source

ggwave

Tiny data-over-sound library.

  • Audible and ultrasound transmissions available
  • Bandwidth of 8-16 bytes/s (depending on the transmission protocol)
  • Robust FSK modulation
  • Reed-Solomon based error correction

Example Usage

var factory = require('ggwave')

factory().then(function(ggwave) {
    // create ggwave instance with default parameters
    var parameters = ggwave.getDefaultParameters();
    var instance = ggwave.init(parameters);

    var payload = 'hello js';

    // generate audio waveform for string "hello js"
    var waveform = ggwave.encode(instance, payload, ggwave.TxProtocolId.GGWAVE_TX_PROTOCOL_AUDIBLE_FAST, 10);

    // decode the audio waveform back to text
    var res = ggwave.decode(instance, waveform);

    if (res != payload) {
        process.exit(1);
    }
});

Keywords

FAQs

Last updated on 05 Jul 2022

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc