Technical Documentation

Project Repository

Link to MorteSense, Group 28, project repository

DIY Security.

Microwave Motion Detector Sensor

View Demo · Report Bug · Request Feature

Table of Contents

2. About The Project
3. Inspiration
4. Challenges we ran into
5. Accomplishments we're proud of
• Built With
6. Getting Started
   • Prerequisites and Installation
7. Usage
8. Roadmap
9. Acknowledgments
10. Citation
11. License

About The Project

This is the comprehensive project for CMPE 195 at San Jose State University, during 2023. This project is a multi-tiered, end-to-end system comprised of several elements:

• A web-based application enabling customers to oversee their sensor' data
• A MorteSense API responsible for processing requests coming from the client app
• A database designed to maintain records of users and sensors

Inspiration

• State of the Art: Passive Infrared (PIR) Motion Sensor Systems

Challenges we ran into

• Power Delivery
• Enclosure Design and Prototyping

Accomplishments we are proud of

• Learning LaTeX to create the final project report
• Using CAD to design a high-fidelity rendition of microcontroller for reference

Architecture

(back to top)

Built With

(back to top)

Getting Started

Prerequisites and Installation

Hardware

• Raspberry Pi Pico W Microcontroller
• CQRobot 5.8GHz Microwave Motion Sensor
• Red and Green Bulbs
• 100 Ohm Resistors
• Fritzing Circuit Design Software
• Solidworks (or any CAD Program)

Backend

• Requirements.txt
• Redis server
• Python Flask
• MySQL
• AWS
• Twilio API

Frontend

• NodeJS
• ReactJS
• Tailwind CSS

API Tooling

• Postman

  • filename

• AWS RDS connection

1. Command to get into MySQL CLI

mysql -h [DATABASE_NAME].[HOST] -P 3306 -u admin -p

2. Password to get into MySQL CLI

your password

Installing Dependencies

In the root directory:

Run the following command:

npm i

In backend folder:

Run the following command using pip:

pip3 install -r requirements.txt

Usage

Here is the basic process of running the system

• Run Redis server with before running backend
• Run backend with flask run run --host=0.0.0.0 before running frontend
• Run frontend with npm start

Test backend API

To test the backend API, the end user can use the json files provided in the postman directory.

(back to top)

Roadmap

• Project Planning (Spring 2023)

  • Created Project Schedule
  • Created Software Specifications/Requirements Document
  • Created Semi-Formal Project Progress Report
  • Created GANTT Chart for Project Development Progress
  • Peformed basic hardware interfacing and diagnostics

• Released Beta (Summer 2023)

  • Create Initial Pages for web app client
  • Create CAD for Microcontroller
  • Created low-fidelity enclosure (changed because of modified form factor)

• Product Launch (Fall 2023)

  • Test full-fledged prototype
  • Perform final revisions on product
  • Prepare product for public release with Project Report

(back to top)

(back to top)

Acknowledgments

Here are some resources we made use of while developing, for those who wish to build on our work:

• Flask Documentation
• ReactJS Documentation
• React Router Documentation
• Raspberry Pi Pico W Documentation
• Raspberry Pi Pico W SDK
• TailwindCSS Documentation
• Redis Documentation
• Axios Documentation

(back to top)

Citation

@misc{MorteSense-2023,
  author       = {{S. Abdulkhamidov} and {D. Cruz} and {D. G. Carrasco} and {S. Gevorgyan}},
  title        = {MorteSense: DIY Home Security},
  howpublished = {\url{https://github.com/diego-ruben-cruz/MorteSense}},
  year         = {2023},
}

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE.txt for more information.