Add docs for streaming mode

Author: protocentralashwin

.DS_Store

@@ -56,7 +56,7 @@ If the flashing is successful, you should see something similar to the below scr
 
 **ECG STREAMING**
 
-The folder `heatypatch-stream-tcp` contains the code for streaming ECG. 
+The folder `heartypatch-stream-tcp` contains the code for streaming ECG. 
 
 Before flashing this code, enable wifi, TCP and mdns through `makemenuconfig` similar to the process described in the previous section.
 
@@ -86,4 +86,4 @@ You can open the IDF monitor to see the debug messages by using the command:
 
 Once the heartypatch is connected with the wifi, open the gui from the project folder and you should be able see the ECG stream.  
 
-More information about this process and the ESP32 framework is available in the [ESP32 Get Started Guide](http://esp-idf.readthedocs.io/en/latest/get-started/).
+More information about this process and the ESP32 framework is available in the [ESP32 Get Started Guide](http://esp-idf.readthedocs.io/en/latest/get-started/).

docs/.DS_Store

@@ -6,18 +6,10 @@ If you don't already have one, you can buy one on [Crowd Supply](https://www.cro
 
 # Getting Started with HeartyPatch
 
-If you just want to use the HeartyPatch with the pre-loaded firmware, it comes ready to go. You do not have to do any programming to get it working.
-
-With the preloaded firmware, the HeartyPatch will do heart-rate and R-R interval measurement and send it over BLE through a standard [Heart-rate BLE service](https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.service.heart_rate.xml), as well as a separate custom HRV service that will provide parameters used for HRV analysis such as SD, Mean RR, PNN50 and SDNN.
+If you just want to use the HeartyPatch with the pre-loaded firmware, it comes ready to go. You do not have to do any programming to get it working. The pre-loaded firmware send HRV values over BLE.
 
 **HeartyPatch can be used with any Android app that supports the heart-rate profile.**
 
-### Parts of the HeartyPatch
-
-![HeartyPatch Parts](images/heartypatch-parts.png)
-
-<iframe src="https://player.vimeo.com/video/249182147" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
-
 ## The HeartyPatch App for Android - BETA
 
 An android app for HeartyPatch is now available that receives and displays the real-time heart rate as well as HRV trends and variables. The app scans for any HeartyPatch devices in the vicinity and shows a list of devices accessible through Bluetooth Low Energy (BLE). Please note that you would need an Android device with BLE support to use this app.
@@ -28,6 +20,28 @@ You can download and install the app from the [Google Play Store](https://play.g
 
 *Note: The android app for HeartyPatch is still in BETA and there might be some instability as a result.*
 
+## Modes of operation
+
+### Bluetooth LE Mode
+With the preloaded firmware, the HeartyPatch will do heart-rate and R-R interval measurement and send it over BLE through a standard [Heart-rate BLE service](https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.service.heart_rate.xml), as well as a separate custom HRV service that will provide parameters used for HRV analysis such as SD, Mean RR, PNN50 and SDNN.
+
+### Continuous ECG Streaming mode over WiFi/TCP
+
+The HeartyPatch can also do live ECG streaming from the chest. This works similar to a heart-rate monitor. Below is a screen capture of the device working in ECG mode. The data is sent over a TCP socket over WiFi.
+
+![HeartyPatch Streaming ECG](images/streaming-tcp.gif)
+
+**To get the WiFi mode turned on, you will have to flash the firmware onto the device. The following link provides detailed step-by-step instructions about how to reprogram the HeartyPatch.**
+
+### [Programming HeartyPatch for ECG streaming over WiFi/TCP](streaming-ecg-tcp-mode.md)
+
+### Parts of the HeartyPatch
+
+![HeartyPatch Parts](images/heartypatch-parts.png)
+
+<iframe src="https://player.vimeo.com/video/249182147" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+
+
 # Updating the firmware
 
 To install new firmware and/or compile your own firmware, check out **[Guide to Firmware Upgrades](firmware-upgrades.md).**

docs/firmware-upgrades.md

@@ -0,0 +1,52 @@
+## Getting live ECG data from HeartyPatch over WiFi/TCP
+
+The firmware for the HeartyPatch's on-board Espressif ESP32 chip uses the [esp-idf framework](https://github.com/espressif/esp-idf)
+ for development. You will need to install and configure the following components to setup a development environment:
+
+* The Xtensa ESP32 toolchain
+* The v2.1 release of esp-idf
+* Supporting software such as Python and pyserial
+
+**Please make sure all of the above tools are properly installed before proceeding.**
+
+Setup guides for these components are available on the [ESP-IDF documentation site](https://esp-idf.readthedocs.io/en/latest/get-started/index.html).
+
+You can then clone our [Github repository](https://github.com/Protocentral/protocentral_heartypatch) of code for the ESP32:
+
+`git clone https://github.com/Protocentral/protocentral_heartypatch.git`
+
+[or download a zip file of the latest master branch](https://github.com/Protocentral/protocentral_heartypatch/archive/master.zip).
+
+Download this zip file, rename it to whatever you want to. Change to this directory and then start building.
+
+The folder `heatypatch-stream-tcp` contains the code for streaming ECG.
+
+Before flashing this code, enable wifi, TCP and mdns through `makemenuconfig` similar to the process described in the previous section.
+
+* Start makemenuconfig and navigate to *Heartypatch configuration*, set your wifi ssid and password, enable mdns and TCP:
+![Heartypatch config](images/heartypatch-config-tcp.png)
+
+* Configure the serial port under Serial flasher config -> Default serial port
+* Navigate to *Component config -> esp32-specific ->main XTAL frequency* and select 26 MHz as the board crystal
+
+Run the makefile (assuming previous steps are done correctly):
+
+`make` or `make -j5`
+
+To flash the firmware on to the board, just use:
+
+`make flash`
+
+If the flashing is successful, you should see something similar to the below screen:
+
+![ESP Success](images/esp-flash-success.png)
+
+You can open the IDF monitor to see the debug messages by using the command:
+
+`make monitor`
+
+![idf-monitor](images/idf-monitor-tcp-connection.png)
+
+Once the heartypatch is connected with the wifi, open the gui from the project folder and you should be able see the ECG stream.  
+
+More information about this process and the ESP32 framework is available in the [ESP32 Get Started Guide](http://esp-idf.readthedocs.io/en/latest/get-started/).