https://github.com/bacemhlabba/iot-platform

A repository for IoT platform project
https://github.com/bacemhlabba/iot-platform

flask humidity iot project python-framework-flask python3 raspberrypi tempurature

Last synced: about 1 year ago
JSON representation

A repository for IoT platform project

• Host: GitHub
• URL: https://github.com/bacemhlabba/iot-platform
• Owner: bacemhlabba
• Created: 2025-01-04T13:53:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-04T23:38:09.000Z (about 1 year ago)
• Last Synced: 2025-01-05T00:18:49.538Z (about 1 year ago)
• Topics: flask, humidity, iot, project, python-framework-flask, python3, raspberrypi, tempurature
• Language: HTML
• Homepage:
• Size: 88.9 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# IoT Project

This repository contains a Flask project that serves web pages to display sensor data from Firebase and a local database. The project also includes functionality to update the LED state in the local database.

## Setup Instructions

### 1. Set up and run the Flask project

1. Clone the repository:

    ```bash

    git clone https://github.com/bacemhlabba/IoT-platform.git

    cd IoT-platform

    ```

2. Create a virtual environment and activate it:

    ```bash

    python3 -m venv venv

    source venv/bin/activate

    ```

3. Install the required dependencies:

    ```bash

    pip install -r requirements.txt

    ```

4. Run the Flask app:

    ```bash

    ./run.sh

    ```

### 2. Create and configure the Firebase project

1. Go to the [Firebase Console](https://console.firebase.google.com/) and create a new project.

2. Add a new web app to the project and follow the instructions to register the app.

3. Download the `firebase.json` file from the Firebase Console and place it in the root directory of the project.

4. Update the file with the Firebase configuration details.

### 3. Set up the local database

1. Run the migration script to create the `sensor_data` table and insert initial data:

    ```bash

    python3 migrate.py

    ```

OR 

 ```bash

    ./run.sh

```

### 4. Using Docker Compose

1. Make sure Docker and Docker Compose are installed on your machine.

2. Build and start the containers:

    ```bash

    docker-compose up --build

    ```

3. Open a web browser and go to `http://127.0.0.1:5000/` to access the index page.

## Running the App

1. Make sure the virtual environment is activated and the required dependencies are installed.

2. Run the Flask app:

    ```bash

    ./run.sh

    ```

3. Open a web browser and go to `http://127.0.0.1:5000/` to access the index page.

4. Use the navigation links to go to Page 1 and Page 2 to view the sensor data and update the LED state.

## Project Structure

```

IoT-platform/

├── app/

│   ├── static/

│   ├── templates/

│   ├── __init__.py

│   ├── routes.py

│   └── models.py

├── migrations/

├── screenshots/

├── venv/

├── .gitignore

├── docker-compose.yml

├── Dockerfile

├── firebase.json

├── migrate.py

├── README.md

├── requirements.txt

└── run.sh

```

## Technologies Used

- Python

- Flask

- Firebase

- SQLite

- Docker

- Docker Compose

- HTML/CSS

- JavaScript

## Contributing

1. Fork the repository.

2. Create a new branch (`git checkout -b feature-branch`).

3. Make your changes.

4. Commit your changes (`git commit -m 'Add some feature'`).

5. Push to the branch (`git push origin feature-branch`).

6. Open a pull request.

## Screenshots

### Home Page

![Home Page](screenshots/home.jpeg)

### Page 1 - Firebase Data

![Page 1](screenshots/firebase_db.jpeg)

### Page 2 - Local Database Data

![Page 2](screenshots/local_db.jpeg)

### Submit Data to Firebase

![Submit Form](screenshots/put_data_to_firebase.jpeg)

### Submit Data to SQLite

![Submit SQLite](screenshots/put_data_to_local_db.jpeg)

### Popup for Sensor Data

![Popup](screenshots/popup.jpeg)

### LED State Update off

![LED State](screenshots/led_stat_popup_off.png)

### LED State Update on

![LED State](screenshots/led_stat_popup_on.png)

### Firebase Realtime

![Firebase Realtime](screenshots/firebase_realtimedatabase.jpeg)

### SQLite Tables

![SQLite Tables](screenshots/sqllite_tables.png)