Web Based Light Controler

Directory Structure

The Light Control IoT Project is structured with two Django applications.

The API application handles all data related elements of the project. It is served on the '/api/' URL and provides an accessible interface for GET and PUT data operations used in the project. The app utilizes viewsets to generate the implementation of these requests.

The dashboard application controls the front-end as well as the interface with the lights and sensors. The app provides a dashboard hosted at the '/' (root) directory of the project to provide a responsive WebUI allowing users to control the lights and sensors. The dashboard page routes post requests through the API to update database values.

A detailed breakdown of all relevant files can be found below:

├── lightController                     # Django Project Root
│   ├── api                             # API interface, handles all data related functions of project
│   |    ├── management/commands               # Used for initializing data in models
|   |    ├── migrations                        # Migrations created for database creation
│   |    ├── apps.py                           # Definition of app for Django Project
│   |    ├── models.py                         # Definition of data tables used in application
│   |    ├── serializers.py                    # Provide definition for serialization
│   |    ├── urls.py                           # Map API models to URLS, uses routers
│   |    └── views.py                          # Creates viewset API interfaces for models, utilizes serializers
|   | 
│   ├── dashboard                       # Dashboard, provides front end GUI and mapping of requests through API
│   |    ├── migrations                        # Migrations created for database creation
|   |    ├── templates                         # Stores the HTML template for web UI                         
│   |    ├── apps.py                           # Definition of app for Django Project
│   |    ├── gpio.py                           # Controls GPIO functions of project
│   |    ├── models.py                         # Stores models for application | not used
│   |    ├── urls.py                           # Maps light control to front facing URL
│   |    └── views.py                          # Handles request logic and displaying of template
|   |  
│   ├── lightController                 # Django project settings
│   |    ├── asgi.py                           # Used for deployment | not used
|   |    ├── settings.py                       # Settings for Django project, includes apps configured, allowed hosts, etc.                         
│   |    ├── urls.py                           # URLs for project, maps app urls to mount point
│   |    └── wsgi.py                           # Used for deployment | not used
|   |  
│   ├── db.sqlite3                      # Project database
│   └── manage.py                       # used to invoke project functions

How to run

Build Circuit

In order to run the light controller application, the circuit must be built as shown in below image:

Install dependencies

Install python dependencies for project. (Suggest running in virtual environment).

cd lightController
pip install -r requirements.txt

Create Databases

From Django Project directory, run the following commands to create the tables required

python manage.py makemigrations
python manage.py migrate

Once tables have been created instantiate data for initial mode and state.

*Note these values can be changed via UI within application

python manage.py initalize_data

Run Server

Prior to running server, update the IP address of device in dashboard/views.py with IP address of local device. This allows accessibility from all devices on network.

To run Django server on port 8000, execute command:

python manage.py runserver 0.0.0.0:8000

Demo Video

iot_ass3.mp4