Skip to content

Commit

Permalink
Initial Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
chabazite committed Nov 28, 2023
0 parents commit 340b303
Show file tree
Hide file tree
Showing 11 changed files with 537 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Greenhouse Monitor

on:
push:
branches:
- develop
- main
release:
types: [published]

jobs:
build:

deploy:

6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.pio
.vscode/.browse.c_cpp.db*
.vscode/c_cpp_properties.json
.vscode/launch.json
.vscode/ipch
src/hardware/secrets.h
10 changes: 10 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
// See http://go.microsoft.com/fwlink/?LinkId=827846
// for the documentation about the extensions.json format
"recommendations": [
"platformio.platformio-ide"
],
"unwantedRecommendations": [
"ms-vscode.cpptools-extension-pack"
]
}
121 changes: 121 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
**Link to Webapp**: **<a href="http://greenhouseapp.s3-website.us-east-2.amazonaws.com" target="_blank">DnD Monster Generator</a>**
==============================================
Greenhouse Real-Time Data Stream & Predictions
=============================================

## Business Case
<a name="Business_Case"></a>

## Table of Contents
<details open>
<summary>Show/Hide</summary>
<br>

1. [ File Descriptions ](#File_Description)
2. [ Technologies Used ](#Technologies_Used)
3. [ Structure ](#Structure)
4. [ Evaluation ](#Evaluation)
5. [ Future Improvements ](#Future_Improvements)

</details>


## Project Organization

<details>
<a name="File_Description"></a>
<summary>Show/Hide</summary>
<br>


├── LICENSE
├── .gitignore
├── README.md <- The top-level README for developers using this project.
├──
├── .github
│   └── workflows <- Folder for CI/CD workflows using github Actions
│   └── CI.yml <- YAML file for github Actions
├── images <- Folder for images used in README
│   └── README
├── requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
│ generated with `pip freeze > requirements.txt`
|
└── src <- Source code for use in this project.
   ├── hardware <- Scripts to run the arduino board & sensor program
| ├── secrets.h <- Location of information needed to connect to IOT and wifi
   │   └── main.cpp <- main script for sensor board written in Arduino (C++ based)
   ├── webapp <- Scripts to create a real-time websocket connection app
| ├── app.js <- Scripts to connect to websocket API and recieve data
   │   └── index.html <- Script to create the main structure of the web app in html
   └──
--------
</details>

## Technologies Used:
<details>
<a name="Technologies_Used"></a>
<summary>Show/Hide</summary>
<br>

![AWS Architecture](/images/WeatherStation.jpg)



├──AWS
├── IOT CORE
├── Kinesis Data Streams
├── Kinesis Firehose
├── S3
├── Sagemaker
├── Gateway API (Websocket)
├── Lambda
├── DynamoDB
└── CloudWatch
├──Docker
├── Arduino
├── ESP_CLIENT_MAIL
└──Tensorflow Keras
├──Python
├──Pandas
└──Tensorflow Keras
├── HTML
├── JavaScript
├── charts.js
└──Tensorflow Keras
------------
</details>

## Structure of Notebooks:
<details>
<a name="Structure"></a>
<summary>Show/Hide</summary>
<br>

1.


</details>

## Evaluation:
<a name="Evaluation"></a>
<details>
<summary>Show/Hide</summary>
<br>

</details>

## Future Improvements
<a name="Future_Improvements"></a>
<details>
<summary>Show/Hide</summary>
<br>

</details>

<p><small>Project based on the <a target="_blank" href="https://drivendata.github.io/cookiecutter-data-science/">cookiecutter data science project template</a>. #cookiecutterdatascience</small></p>
<p>README outline tailored from [awesomeahi95][]<p>
11 changes: 11 additions & 0 deletions images/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

This directory is intended for PlatformIO Test Runner and project tests.

Unit Testing is a software testing method by which individual units of
source code, sets of one or more MCU program modules together with associated
control data, usage procedures, and operating procedures, are tested to
determine whether they are fit for use. Unit testing finds problems early
in the development cycle.

More information about PlatformIO Unit Testing:
- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html
Binary file added images/WeatherStation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions platformio.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
; PlatformIO Project Configuration File
;
; Build options: build flags, source filter
; Upload options: custom upload port, speed and extra flags
; Library options: dependencies, extra library storages
; Advanced options: extra scripting
;
; Please visit documentation for the other options and examples
; https://docs.platformio.org/page/projectconf.html

[env:nodemcu-32s]
platform = espressif32
board = nodemcu-32s
framework = arduino
monitor_speed = 115200
lib_deps =
adafruit/Adafruit Unified Sensor@^1.1.14
adafruit/DHT sensor library@^1.4.6
bblanchon/ArduinoJson@^6.21.3
knolleary/PubSubClient@^2.8
arduino-libraries/NTPClient@^3.2.1
mobizt/ESP Mail Client@^3.4.15
Empty file added requirements.txt
Empty file.
Loading

0 comments on commit 340b303

Please sign in to comment.