Skip to content

Commit

Permalink
New version v1.3.2 - bug fix for the same problem as in 1.3.1 but fou…
Browse files Browse the repository at this point in the history
…nd in other area
  • Loading branch information
robertrypula committed May 16, 2018
1 parent d517f17 commit 5583776
Show file tree
Hide file tree
Showing 49 changed files with 6,881 additions and 3,118 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
- 2.x.x ?? OFDM
- 2.x.x ?? Move to TypeScript

## v1.3.2 (2018-05-16)
- BugFix for the same issue in other area: "The AudioContext was not allowed to start. It must be resume (or created) after a user gesture on the page. https://goo.gl/7K7WLu"

## v1.3.1 (2018-05-10)
- BugFix: "The AudioContext was not allowed to start. It must be resume (or created) after a user gesture on the page. https://goo.gl/7K7WLu"

Expand Down
44 changes: 27 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,39 @@
Audio Network
=============
# Audio Network

Data transmission over sound waves written in JavaScript without any dependencies. All you need is just
Data transmission over sound waves written in <strike>JavaScript</strike>TypeScript without any dependencies. All you need is just
microphone, speakers and the browser!

- [Physical Layer](https://audio-network.rypula.pl/physical-layer)
- [Data Link Layer](https://audio-network.rypula.pl/data-link-layer)
- [Transport Layer (comming soon, almost ready!)](https://audio-network.rypula.pl/transport-layer)
- [Transport Layer (comming soon)](https://audio-network.rypula.pl/transport-layer)
- [Audio Chat (comming soon)](https://audio-network.rypula.pl/audio-chat)
- [Full example List](https://github.com/robertrypula/AudioNetwork/tree/master/example)

## News

- **2018 May 11** - [PR#4](https://github.com/robertrypula/AudioNetwork/pull/4) was merged with master. Important: migration process from ES5 to TypeScript is still NOT finished. It will just continue on the master branch.

- **2018 May 10** - Thanks to [Programista](https://programistamag.pl) magazine, all 3 parts of my articles about *data transmission over sound in JavaScript* are now available as PDFs. Please find links in the next section.

- **2018 Feb 06** - Project looks like dead but it's not. Now I'm focusing on configuration that allows me to move
entire AudioNetwork project to TypeScript, WebPack, Jest unit test with coverge, Travis etc.

## Self-made network stack based on Frequency-Shift Keying (>= v1.2.0)

Audio Network library is a hobby project in which the goal was to create simple network stack that uses sound
waves to transmit data. Initialy it was using PSK modulation technique which was later changed into FSK. If you are
interested in details you can read more in polish Programista magazine:
waves to transmit data. Initialy it was using PSK modulation technique which was later changed into FSK.

Brief introduction to the topic is available as **presentation hosted on slides.com [here](https://slides.com/robertrypula/data-transmission-over-sound)**.

If you are interested in details you can read more in polish Programista magazine:

- [Data transmission over sound from scratch. Part 1: Discrete Fourier Transform](https://programistamag.pl/programista-08-2016-51/) (08/2016)
- [Data transmission over sound from scratch. Part 2: Web Audio API](https://programistamag.pl/programista-2-2017-57/) (02/2017)
- [Data transmission over sound from scratch. Part 3: Self-made network stack](https://programistamag.pl/programista-10-2017-65/) (10/2017)
[![Part 1](https://cdn.rypula.pl/audio-network/image/programista_1.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_1.jpg)
[![Part 2](https://cdn.rypula.pl/audio-network/image/programista_2.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_2.jpg)
[![Part 3](https://cdn.rypula.pl/audio-network/image/programista_3.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_3.jpg)

- [Data transmission over sound from scratch. Part 1: Discrete Fourier Transform](https://programistamag.pl/programista-08-2016-51/) (08/2016) [**Download PDF**](https://cdn.rypula.pl/audio-network/pdf/TransmisjaDanychDzwiekiemJs_czesc1z3_DyskretnaTransformataFouriera.pdf)
- [Data transmission over sound from scratch. Part 2: Web Audio API](https://programistamag.pl/programista-2-2017-57/) (02/2017) [**Download PDF**](https://cdn.rypula.pl/audio-network/pdf/TransmisjaDanychDzwiekiemJs_czesc2z3_WebAudioAPI.pdf)
- [Data transmission over sound from scratch. Part 3: Self-made network stack](https://programistamag.pl/programista-10-2017-65/) (10/2017) [**Download PDF**](https://cdn.rypula.pl/audio-network/pdf/TransmisjaDanychDzwiekiemJs_czesc3z3_WlasnyStosSieciowy.pdf)

Part 3 of the article was the last one. It means that more focus will go to this website and Audio Network releases. If you can't wait please go trought some of the examples:

Expand All @@ -32,7 +47,7 @@ Part 3 of the article was the last one. It means that more focus will go to this
[(source)](https://audio-network.rypula.pl/physical-layer-src)
- [Data Link Layer simple (comming soon)](https://audio-network.rypula.pl/data-link-layer-simple)
[(source)](https://audio-network.rypula.pl/data-link-layer-simple-src)
- [Data Link Layer listenters demo](https://audio-network.rypula.pl/data-link-layer-listeners-demo)
- [Data Link Layer listeners demo](https://audio-network.rypula.pl/data-link-layer-listeners-demo)
[(source)](https://audio-network.rypula.pl/data-link-layer-listeners-demo-src)
- [Data Link Layer](https://audio-network.rypula.pl/data-link-layer)
[(source)](https://audio-network.rypula.pl/data-link-layer-src)
Expand All @@ -50,27 +65,23 @@ Note: some of the modules are not yet in main NPM package. Please verify [roadma

>This library is supported by [PGS Software](https://www.pgs-soft.com/) - the place where I work as Frontend Developer
UPDATE 2018.02.06 - Project looks like dead but it's not. Now I'm focusing on configuration that allows me to move
entire AudioNetwork project to TypeScript, WebPack, Jest unit test with coverge, Travis etc.

## Deprecated Phase-Shift Keying approach (last update at v1.1.0, will be removed at v2.0.0)

Initial versions of this lib were based on Phase-Shift Keying modulation technique. Unfortunatelly after some tests
in turned out that this implementation was not working reliable on mobile devices. Starting from v1.2.0 this part of the
lib will be marked as deprecated.

>**!!! IMPORTANT NOTE !!!** - Everything described **below (up to Licence)** might be outdated or not working properly. Project is now in a phase of big technical changes. Entire v1.x was created mostly to learn DSP and share this knowledge in the 'Programista' magazine articles. Version 2.x will have more stable and simpler API and will be better consumable as npm package.
- [Demo - simple](https://audio-network.rypula.pl/example/01-000-physical-layer-simple/physical-layer-simple.html)
- [Demo - full features](https://audio-network.rypula.pl/example/01-001-physical-layer-full/physical-layer-full.html)


If you want to try AudioNetwork by yourself I would recommend to first open `Demo - simple` because `Demo - full
features` might be little scary for the first time. You can also watch YouTube video that shows how to transmit
data over sound between two laptops:

[![Data transmission over sound waves (AudioNetwork)](https://audio-network.rypula.pl/asset/image/yt.png)](https://www.youtube.com/watch?v=TjjyLaXd1Ro)

>This project is still under development. Documentation is also planned but... little later :)
### How can I transmit something over sound?

First of all you need to have two devices. One for sending, one for receiving data. It should work with any
Expand Down Expand Up @@ -285,4 +296,3 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

24 changes: 0 additions & 24 deletions build/audio-network-v1.3.1.min.js

This file was deleted.

Loading

0 comments on commit 5583776

Please sign in to comment.