From 43a7ef144c5180568d3279ff6952ae521db78d09 Mon Sep 17 00:00:00 2001
From: Max <Hunt>
Date: Wed, 6 Jan 2021 13:09:09 +0000
Subject: [PATCH] Update

---
 README.md                                     | 58 ++++++++++++++++++-
 data_collector/Dockerfile                     |  2 +-
 ...awio => block_and_process_diagrams.drawio} |  0
 lora_nodes/master/irrigator/Dockerfile        |  3 +-
 4 files changed, 58 insertions(+), 5 deletions(-)
 rename diagrams/{ICL-IoT-diagram.drawio => block_and_process_diagrams.drawio} (100%)

diff --git a/README.md b/README.md
index 281aec8..877f41d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,57 @@
-# ICL-IoT-Weather
+# Imperial College London
+# Sensing and IoT Coursework Project
+#### Reducing water waste by automatically dispensing lower bound water amounts, calculated using a ML Model using present weather data
 
-# TODO
\ No newline at end of file
+## About
+About
+
+## Project diagram
+```TODO```
+
+## File Structure
+
+<!-- <details> -->
+<summary>This part is long, click to expand</summary>
+
+- `data_collector/` Main data collector and uploader module
+  - `secrets/` Private API keys
+    - `icl-iot-weather-firebase-adminsdk.json` Firebase key for database access
+    - `weather_api_key.txt` OpenWeather API key
+  - `data_colelctor.py` Python script for data collection
+  - `Dockerfile` Containerizing the application
+  - `requirements.txt` Python requirements for running the script
+- `data_processor/` ML on demand data processing module
+  - `firebase_python_image/` Since building a tf image takes ages, we build it once and use it for testing the ml script later
+    - `Dockerfile` Building a tensorflow image for armv7l
+  - `secrets/` Private API keys
+    - `icl-iot-weather-firebase-adminsdk.json` Firebase key for database access
+  - `watering_model.model/` Saved ML modelfor water predicitons
+  - `Dockerfile` Containerizing the application
+  - `water_predictor.py` On demand, real time watering predictor script
+- `Diagrams/` Process and block diagrams
+  - `block_and_process_diagrams.drawio` TODO
+- `lora_nodes/` Scripts running on the Pi Zero nodes
+  - `master/` Scripts running on the primary, internet connected Pi
+    - `irrigator/` Daily watering module
+      - `Dockerfile` Containerizing the application
+      - `irrigator.py` Daily watering script
+      - `requirements.txt` Python requirements for running the script
+    - `Dockerfile` Containerizing the application
+    - `main.py` Main data server, collects data from satellite over LoRa and returns over http
+    - `requirements.txt` Python requirements for running the script
+  - `satellite/` Data reading and sending module for the sensor Pi
+    - `Dockerfile` Containerizing the application
+    - `main.py` LoRa commend listener, temperature reader and pump controller
+    - `requirements.txt` Python requirements for running the script
+- `manual_data_processing/` iPython notebooks used for data processing and model training
+  - `datasets/*` Various datasets used for processing and training
+  - TODO
+- `site/*` Monitoring website, HTML+CSS+JS, hosted on Firebase
+- `.gitignore` Gitignore file preventing all my API keys from showing up online...
+- `README.md` See `README.md`
+
+<!-- </details> -->
+
+## Maintainers and Contributors
+    Max Hunt (me@maxhunt.design)
+-
diff --git a/data_collector/Dockerfile b/data_collector/Dockerfile
index fae2c88..d61c7ce 100644
--- a/data_collector/Dockerfile
+++ b/data_collector/Dockerfile
@@ -4,4 +4,4 @@ COPY . .
 RUN pip install -r requirements.txt
 EXPOSE 80
 EXPOSE 443
-CMD "/code/Data_collector.py"
+CMD "/code/data_collector.py"
diff --git a/diagrams/ICL-IoT-diagram.drawio b/diagrams/block_and_process_diagrams.drawio
similarity index 100%
rename from diagrams/ICL-IoT-diagram.drawio
rename to diagrams/block_and_process_diagrams.drawio
diff --git a/lora_nodes/master/irrigator/Dockerfile b/lora_nodes/master/irrigator/Dockerfile
index dff2ad6..d12a69b 100644
--- a/lora_nodes/master/irrigator/Dockerfile
+++ b/lora_nodes/master/irrigator/Dockerfile
@@ -3,5 +3,4 @@ WORKDIR /code
 COPY . .
 RUN pip install requests
 RUN pip install -r requirements.txt
-EXPOSE 3333
-CMD "/code/main.py"
+CMD "/code/irrigator.py"