doc: update readme

README.md

@@ -1,90 +1,131 @@
 
-[How to run hello world example](HowToRunHello.md)
 
+<a name="readme-top"></a>
 <p align="center">
   <img src="./images/logo_Logo.png" width="400"/>
 </p>
 
-# sense
+<!-- TABLE OF CONTENTS -->
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
 End to end IOT system which collects sensor data and visualize on cloud
 
 ![High Level Architecture](./images/Architecture.png)
-## Hardware
 
-### Sensor Node 
+<!-- BUILT WITH -->
+
+## Built With
+
+This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
+
+* [![Next][Next.js]][Next-url]
+* [![React][React.js]][React-url]
+* [![Vue][Vue.js]][Vue-url]
+* [![Angular][Angular.io]][Angular-url]
+* [![Svelte][Svelte.dev]][Svelte-url]
+* [![Laravel][Laravel.com]][Laravel-url]
+* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
+* [![JQuery][JQuery.com]][JQuery-url]
+
+  <p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+### Sensor Node
+
 We are using IoT-Lab M3 type boards. We are currently focusing on **LPS331AP** sensor and **AT86RF231** wireless radio module. Both of them are connected to two separate interfaces allowing us to access them simultaneously. Sensors are accessed via I2c interface and wireless module via SPI.
 
  ![IOT test bed m3 architecture | 500](./images/m3-archi.png)
  [IoT-LAB M3 · FIT IoT-LAB](https://www.iot-lab.info/docs/boards/iot-lab-m3/)
-
 
 ## IOT Connectivity - Feature Comparison
+
 Taken from the reference list of a slide in Communication Networks 1 - 521340S module in university of Oulu.
 
 ![Node to Node](./images/node-to-node.jpeg)
 
 [https://www.electronicspecifier.com/products/wearables/building-wearables-that-sense-think-and-communicate-part-2](https://www.electronicspecifier.com/products/wearables/building-wearables-that-sense-think-and-communicate-part-2)
 
-
-
-
 ![Power of Bluetooth tech](./images/power_bluethooth_tech.jpg)
 
 [https://www.rfidjournal.com/rfid-powered-sensors-can-play-a-big-role-in-the-internet-of-things-2](https://www.rfidjournal.com/rfid-powered-sensors-can-play-a-big-role-in-the-internet-of-things-2)
 
-
-
-
 ![Feature Comparison](./images/zbw4.webp)
 
 [https://www.slideshare.net/aviiandevil7/security-protocols-platform-for-wsn-based-medical-applications-37863943](https://www.slideshare.net/aviiandevil7/security-protocols-platform-for-wsn-based-medical-applications-37863943)
 
-
-
 ## Sensor Layer
 
 ### Sensors
 
 #### M3 - [IoT-LAB M3 · FIT IoT-LAB](https://www.iot-lab.info/docs/boards/iot-lab-m3/)
+
 4 sensors connected to the MCU via the **I2C** bus are embedded into the IoT-LAB M3 board:
 
 - the **light** sensor: this measures ambient light intensity in lux.  [ISL29020](https://www.iot-lab.info/assets/misc/docs/iot-lab-m3/ISL29020.pdf)
-	[ISL29020 light sensor driver](https://doc.riot-os.org/group__drivers__isl29020.html)
-	
+    [ISL29020 light sensor driver](https://doc.riot-os.org/group__drivers__isl29020.html)
+
 - the **pressure** and **temperature** sensor: this measures atmospheric pressure in hPa.  [LPS331AP](https://www.iot-lab.info/assets/misc/docs/iot-lab-m3/LPS331AP.pdf)
-	[LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
+    [LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
+
 - the **accelerometer/magnetometer**: this provides feedback on an object’s acceleration, and can be used to detect movement. By determining a threshold, it generates a change of state on one of the MCU’s digital inputs/outputs in order to create an interrupt, which can be used to bring the MCU out of standby mode.  [LSM303DLHC](https://www.iot-lab.info/assets/misc/docs/iot-lab-m3/LSM303DLHC.pdf)
-	[LSM303DLHC 3D accelerometer/magnetometer driver](https://doc.riot-os.org/group__drivers__lsm303dlhc.html)
+    [LSM303DLHC 3D accelerometer/magnetometer driver](https://doc.riot-os.org/group__drivers__lsm303dlhc.html)
+
 - the **gyroscope**: this measures the orientation of an object in space and can be used, for example, to determine the orientation of the screen of a tablet or a smartphone.  [L3G4200D](https://www.iot-lab.info/assets/misc/docs/iot-lab-m3/L3G4200D.pdf)
-	[L3G4200D gyroscope driver](https://doc.riot-os.org/group__drivers__l3g4200d.html)
-
+    [L3G4200D gyroscope driver](https://doc.riot-os.org/group__drivers__l3g4200d.html)
 
 #### Board - # Nordic [Nordic nRF52840DK · FIT IoT-LAB](https://www.iot-lab.info/docs/boards/nordic-nrf52840dk/) -
+
 - temperature and humidity sensor - [HTS221](https://www.st.com/resource/en/datasheet/hts221.pdf)
-	[ST HTS221 digital Humidity Sensor driver](https://doc.riot-os.org/group__drivers__hts221.html)
+    [ST HTS221 digital Humidity Sensor driver](https://doc.riot-os.org/group__drivers__hts221.html)
 - an atmospheric pressure sensor  [LPS22HB](https://www.st.com/resource/en/datasheet/dm00140895.pdf)
-	[LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
+    [LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
 - an accelerometer sensor  [LSM6DSL](https://www.st.com/resource/en/datasheet/lsm6dsl.pdf)
-	[LSM6DSL 3D accelerometer/gyroscope driver](https://doc.riot-os.org/group__drivers__lsm6dsl.html)
+    [LSM6DSL 3D accelerometer/gyroscope driver](https://doc.riot-os.org/group__drivers__lsm6dsl.html)
 - an accelerometer sensor  [LSM303AGR](https://www.st.com/resource/en/datasheet/lsm303agr.pdf)
-	[LSM303AGR 3D accelerometer/magnetometer driver](https://doc.riot-os.org/group__drivers__lsm303agr.html)
+    [LSM303AGR 3D accelerometer/magnetometer driver](https://doc.riot-os.org/group__drivers__lsm303agr.html)
 
 #### ST B-L475E-IOT01A - [ST B-L475E-IOT01A · FIT IoT-LAB](https://www.iot-lab.info/docs/boards/st-b-l475e-iot01a/)
 
 - temperature and humidity sensor - [HTS221](https://www.st.com/resource/en/datasheet/hts221.pdf)
-	[ST HTS221 digital Humidity Sensor driver](https://doc.riot-os.org/group__drivers__hts221.html)
+    [ST HTS221 digital Humidity Sensor driver](https://doc.riot-os.org/group__drivers__hts221.html)
 - an atmospheric pressure sensor  [LPS22HB](https://www.st.com/resource/en/datasheet/dm00140895.pdf)
-	[LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
+    [LPS331AP/LPS25HB/LPS22HB Pressure Sensors Driver](https://doc.riot-os.org/group__drivers__lpsxxx.html)
 - an accelerometer sensor  [LSM6DSL](https://www.st.com/resource/en/datasheet/lsm6dsl.pdf)
-	[LSM6DSL 3D accelerometer/gyroscope driver](https://doc.riot-os.org/group__drivers__lsm6dsl.html)
-
+    [LSM6DSL 3D accelerometer/gyroscope driver](https://doc.riot-os.org/group__drivers__lsm6dsl.html)
 
 ## Network Layer
 
+### Websocket
 
-
-### Websocket 
 ### Publish Subscriber channel - phase 2
+
 [MQTT · FIT IoT-LAB](https://www.iot-lab.info/docs/tools/mqtt-broker/)
 
 ### Test server
@@ -93,13 +134,14 @@ Taken from the reference list of a slide in Communication Networks 1 - 521340S m
 
 AWS
 
-## Data 
+## Data
 
->[!WARNING]
->not sure if accelerometer, gyroscopes have a meaning. 
->I can see some boards may be connected to robots or moving platforms.. But not sure if we have access to those yet.
+> [!WARNING]
+> not sure if accelerometer, gyroscopes have a meaning. 
+> I can see some boards may be connected to robots or moving platforms.. But not sure if we have access to those yet.
 
 #### Sensor data
+
 - temperature
 - humidity
 - atmospheric pressure