Allows mbed to send data to an HTML5 web browser through a 4 pole mini jack.

### The Problem:

*Sending data from a microcontroller to any smartphone*

While you can use the usb interface on non-mobile devices, very few smartphones allow you to use this easily. For example iOS requires the purchasing of a 100k+ liscense.

Then there's bluetooth with its gazillions of native code libraries to hook into: OS X, Windows, Linux, iOS, Motorolla, HTC, Samsung, LG,....ew.

With HTML5's web audio API, we can create a hardware bus similar to how Square's Credit Card readers works.

I've successfully tested this with my Macbook Air with Firefox v28 and Chrome v33. IE will not work under any circumstances as it currently does not support the HTML5 Web Audio API.

### Protocol Overview

Javascript is asynchronous, and setIntervals can vary by +/- a few ms. The way around this is to create a master slave bus. Our JavaScript master dictates to the microcontroller slave when it wants data through a square wave clock signal. When the square wave goes from High (1) to low (0) (falling edge), the microcontroller should be sending the data payload. Here's a screenshot of this in action:

And here's is one of the sinusoids zoomed in:

This is a video of the bus in action:

Each data playload is a sinusoid. As of right now the library generates 16 distinct frequencies, where each frequency represents a number from 0 to 15.

The MicIO in its current form has an error rate of 5%, and transfer rate of 16bits/sec. This can easily be sped up by using a faster microcontroller, as well as modulating sinusoids in the payload. For example 0xFF would be represented by: sin(2π*1000) + sin(2π*1500) +sin(2π*2000).

HTML5's web audio api allows us to perform a mathematical operation called a Fast Fourier Transform (FFT - http:en.wikipedia.org/wiki/Fast_Fourier_transform. FFT's basically allow us to parse out the frequencies in our audio stream. Below is a table converting hex/decimal to its payload sinusoid frequency.

Hex | Sinusoid Frequency (Hz)

0x0 | 818

0x1 | 1076

0x2 | 1335

0x3 | 1335

0x4 | 1894

0x5 | 2153

0x6 | 2411

0x7 | 2670

0x8 | 2971

0x9 | 3229

0xA | 3488

0xB | 3746

0xC | 4048

0xD | 4306

0xE | 4565

0xF | 4823

NULL | < 500 or >5500

### Wiring

#### 4 pole mini jack

1. Left Music = Clock In/Out 2. Right Music = Master Data not yet implemented 3. Ground 4. Microphone In = Slave Data

Currently, MicIO does not support the sending of data to the microcontroller, but it'd be trivial to add in future versions.

Here is the actual wiring schematic with the mbed NXP LPC1768: https:www.sparkfun.com/products/9564. Do to my cad software not having a 4 pole mini jack, Its wired up to two 3 pole mini jacks. The left minijack should go to the mic prong, where-as the right minijack goes to left Music.

### Software

#### Slave - MBED

The Code repo can be found on the mbed webpage (http:mbed.org/users/cbookman3/code/MicIO/ I've also published an example micIO application http:mbed.org/users/cbookman3/code/MicIO-Example/.

Basically it takes in a string array (or number). Then micIO sends the data in half byte payloads each time the master requests more data. If there is no more data, it simply does not generate any sinusoids, aka frequency of 0.

#### Master

This code can be found on https:github.com/cobookman/HTML5.MicIO.

The HTML5 MicIO library when instantiated, will try to bind to the microphone. Upon sucessful binding, it'll begin to request for data. There's two javascript files you must include:

• js/clock.js - Generates a square wave clock for MicIO w/some helpers
• js/index.js - The MicIO library

make sure that the volume on your computer/mobile device is all the way up.

To create a new MicIO master instance you simply run:

#### Example javascript master usage

```var micIO = new MicIO(function onDataRecieved(halfByteArr) {
//do stuff with the data E.g:
var byteArr = [];
for(var i = 0; i < halfByteArr.length; ++i) {
var byteIndex = Math.floor(i/2);
if(i%2 === 0) {		      //first half of the byte
byteArr[byteIndex] = (halfByteArr[i] << 4) & 0xF0;
} else {  			//second half of the byte
byteArr[byteIndex] += halfByteArr[i] & 0x0F;
}
}
});
```

## MicIO.h

Committer:
cbookman3
Date:
2014-03-23
Revision:
3:1630409f9bd6
Parent:
2:c90f916f0b08

### File content as of revision 3:1630409f9bd6:

```/* Mbed MicIO library
* Copyright (c) 2014, Colin Bookman, cobookman [at] gmail [dot] com
*
*  This program is free software: you can redistribute it and/or modify
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  This program is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef MBED_MICIO_H
#define MBED_MICIO_H

#include "mbed.h"

/**
* @code
* #include "MicIO.h"
*
*
* int main() {
*     micIO.send("HI WORLD", 8);
*     micIO.send([0xFF, 0xFA, 0xFB, 0x00], 4);
* }
* @endcode
*/
class MicIO {
public:

/** Create a MicIO instance */
MicIO(PinName output, PinName input);
float clockPeriod;

/* Send byte array through micIO */
void send(const char * arr, int length);

/* Send just 4 bits */
void send4Bits(unsigned char byte);

/*
Read the current value of the input clock.
1 = high
0 = low
-1 = unchanged
*/
int clock();

/* Extracts the lower 4 bits of a byte */
unsigned char lower4Bits(unsigned char byte);
/* Extracts the upper 4 bits of a byte */
unsigned char upper4Bits(unsigned char byte);

protected:
AnalogOut _micOut;
float _sinTable[361]; //361 in case of overflow...not that it SHOULD happen
/*
sendSin outputs a sin wave for 1 period.
-------------------------
|Speed  |               |
|Factor | Frequency     |
|------------------------
| 4.75  |   5.73Khz     |
| 4.50  |   5.45Khz     |
| 4.25  |   5.13Khz     |
| 4.00  |   4.84Khz     |
| 3.75  |   4.54Khz     |
| 3.50  |   4.23Khz     |
| 3.25  |   3.92Khz     |
| 3.00  |   3.65-3.62Khz|
| 2.75  |   3.33Khz     |
| 2.50  |   3Khz        |
| 2.25  |   2.73Khz     |
| 2.00  |   2.41Khz     |
| 1.75  |   2.12Khz     |
| 1.50  |   1.818Khz    |
| 1.25  |   1.5Khz      |
| 1.00  |   1.2Khz      |
| 0.75  |   0.909KHz    |
| 0.5   |   0.606Khz    |
-------------------------
*/
void _sendSin(float sinSeed); //sinSeed of 1 = 5khz

/* Get the number of cycles the sin wave should run for */
int _numCycles(float sinSeed);

/* Generate a sin Table */
void _genSinTable();

/* Go from 4 bits to a sin seed */
float _getSinSeed(unsigned char bits4);

};

#endif

```