Skip to content

Commit 1748d15

Browse files
committed
Updated README.md
1 parent 9160cf1 commit 1748d15

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

README.md

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,65 +3,69 @@
33
<img src="https://andersonquigley.com/content/uploads/2022/11/ljmu_logo.png" alt="LJMU Banner Logo" width="100%" />
44

55
## Project Objective
6-
The aim of this project is to develop an embedded system for operating as a garden cold frame monitoring system.
6+
7+
The aim of this project is to develop an embedded system for operating as a garden cold frame monitoring system.
78

89
## Hardware
10+
911
The system is developed using the **ESP-32 microcontroller**. The user interface is facilitated through an **Adafruit TFT display**, which provides real-time feedback on the current environment and system status.
1012

1113
## Operating Modes
14+
1215
The system features multiple operating modes tailored to various stages of plant development:
13-
- **Winter**
14-
- **Germinating**
15-
- **Vegetative**
16-
- **Fruiting**
17-
- **Night**
18-
- **User Editable Mode**
16+
17+
- **Winter**
18+
- **Germinating**
19+
- **Vegetative**
20+
- **Fruiting**
21+
- **Night**
22+
- **User Editable Mode**
1923

2024
## Features
2125

2226
### Implemented Features
2327

2428
#### Basic Loop & Data Logging
25-
- Reads sensors as fast as possible.
26-
- Outputs a debug string to the Serial output every 5 seconds.
27-
- The debug string includes the latest values for all sensor readings and system statuses, detailing whether sensors are either above, within, or below the set range.
29+
30+
- Reads sensors as fast as possible.
31+
- Outputs a debug string to the Serial output every 5 seconds.
32+
- The debug string includes the latest values for all sensor readings and system statuses, detailing whether sensors are either above, within, or below the set range.
2833

2934
#### User Output Display
30-
- Integrated output display screen that reports current sensor values and statuses.
31-
- Displays minimum and maximum temperature/humidity over the last 24 hours.
35+
36+
- Integrated output display screen that reports current sensor values and statuses.
37+
- Displays minimum and maximum temperature/humidity over the last 24 hours.
3238

3339
#### Mode Selection
34-
- Through the use of a rotary encoder, the user is now able to change the operating mode of the system.
35-
- Display has been updated to show value states using colour indicators , with values being printed in red if they are out of the defined range of the current operating mode, and green if they are within.
3640

41+
- Through the use of a rotary encoder, the user is now able to change the operating mode of the system.
42+
- Display has been updated to show value states using colour indicators , with values being printed in red if they are out of the defined range of the current operating mode, and green if they are within.
3743

3844
#### Custom User Mode
39-
- User is now able to create their custom operating mode and select it in the mode list.
40-
- Double buffering has now been added for a smoother display, eliminating flickering when the screen updates.
41-
42-
#### Data Visualisation + Online Storage
43-
- Every 5 minutes readings are now sent to a server and stored in a MongoDB database; Using Grafana this data is now visualised in a dashboard.
4445

45-
![dashboard](img/PXL_20240628_105215880.jpg)
46-
47-
### Features Not Yet Implemented
48-
- **Responsive HVAC Control**
49-
- **Remote Storage**
50-
- **Alerts**
51-
- **Remote Control and OTA Updates**
52-
- **NVM Storage**
53-
- **Power Management**
46+
- User is now able to create their custom operating mode and select it in the mode list.
47+
- Double buffering has now been added for a smoother display, eliminating flickering when the screen updates.
5448

55-
### Setup Images
56-
V.1
49+
#### Data Visualisation + Online Storage
5750

58-
![PXL_20240327_142814390](https://github.com/LJMU-SE/Cold-Frame-Project/assets/150610221/50ae2483-8dfc-4a61-834f-6fdcb3a53ad6)
51+
- Every 5 minutes readings are now sent to a server and stored in a MongoDB database; Using Grafana this data is now visualised in a dashboard.
5952

60-
V.2
61-
![PXL_20240530_111212887](img/PXL_20240627_142806816.MP.jpg)
53+
![dashboard](img/ColdFrame-dash.jpg)
6254

55+
### Features Not Yet Implemented
6356

57+
- **Responsive HVAC Control**
58+
- **Remote Storage**
59+
- **Alerts**
60+
- **Remote Control and OTA Updates**
61+
- **NVM Storage**
62+
- **Power Management**
6463

64+
### Setup Images
6565

66+
V.1
6667

68+
![PXL_20240327_142814390](img/ColdFrame-v1.jpg)
6769

70+
V.2
71+
![PXL_20240530_111212887](img/ColdFrame-v2.jpg)

0 commit comments

Comments
 (0)