Skip to content

Commit 5583776

Browse files
committed
New version v1.3.2 - bug fix for the same problem as in 1.3.1 but found in other area
1 parent d517f17 commit 5583776

File tree

49 files changed

+6881
-3118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+6881
-3118
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
- 2.x.x ?? OFDM
1010
- 2.x.x ?? Move to TypeScript
1111

12+
## v1.3.2 (2018-05-16)
13+
- 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"
14+
1215
## v1.3.1 (2018-05-10)
1316
- 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"
1417

README.md

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,39 @@
1-
Audio Network
2-
=============
1+
# Audio Network
32

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

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

12+
## News
13+
14+
- **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.
15+
16+
- **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.
17+
18+
- **2018 Feb 06** - Project looks like dead but it's not. Now I'm focusing on configuration that allows me to move
19+
entire AudioNetwork project to TypeScript, WebPack, Jest unit test with coverge, Travis etc.
20+
1321
## Self-made network stack based on Frequency-Shift Keying (>= v1.2.0)
1422

1523
Audio Network library is a hobby project in which the goal was to create simple network stack that uses sound
16-
waves to transmit data. Initialy it was using PSK modulation technique which was later changed into FSK. If you are
17-
interested in details you can read more in polish Programista magazine:
24+
waves to transmit data. Initialy it was using PSK modulation technique which was later changed into FSK.
25+
26+
Brief introduction to the topic is available as **presentation hosted on slides.com [here](https://slides.com/robertrypula/data-transmission-over-sound)**.
27+
28+
If you are interested in details you can read more in polish Programista magazine:
1829

19-
- [Data transmission over sound from scratch. Part 1: Discrete Fourier Transform](https://programistamag.pl/programista-08-2016-51/) (08/2016)
20-
- [Data transmission over sound from scratch. Part 2: Web Audio API](https://programistamag.pl/programista-2-2017-57/) (02/2017)
21-
- [Data transmission over sound from scratch. Part 3: Self-made network stack](https://programistamag.pl/programista-10-2017-65/) (10/2017)
30+
[![Part 1](https://cdn.rypula.pl/audio-network/image/programista_1.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_1.jpg)
31+
[![Part 2](https://cdn.rypula.pl/audio-network/image/programista_2.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_2.jpg)
32+
[![Part 3](https://cdn.rypula.pl/audio-network/image/programista_3.min.jpg)](https://cdn.rypula.pl/audio-network/image/programista_3.jpg)
33+
34+
- [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)
35+
- [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)
36+
- [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)
2237

2338
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:
2439

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

5166
>This library is supported by [PGS Software](https://www.pgs-soft.com/) - the place where I work as Frontend Developer
5267
53-
UPDATE 2018.02.06 - Project looks like dead but it's not. Now I'm focusing on configuration that allows me to move
54-
entire AudioNetwork project to TypeScript, WebPack, Jest unit test with coverge, Travis etc.
55-
5668
## Deprecated Phase-Shift Keying approach (last update at v1.1.0, will be removed at v2.0.0)
5769

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

74+
>**!!! 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.
75+
6276
- [Demo - simple](https://audio-network.rypula.pl/example/01-000-physical-layer-simple/physical-layer-simple.html)
6377
- [Demo - full features](https://audio-network.rypula.pl/example/01-001-physical-layer-full/physical-layer-full.html)
6478

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

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

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

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

build/audio-network-v1.3.1.min.js

Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
 (0)