Skip to content

Latest commit

 

History

History
131 lines (84 loc) · 6.1 KB

README.md

File metadata and controls

131 lines (84 loc) · 6.1 KB

Retail Store Customer Traffic Analysis System

Advanced real-time insights for retail store optimization

About • Key Features • Tech Stack • Getting Started • Troubleshooting • Contributors

Retail Store Customer Traffic Analysis System

  • This project leverages a Raspberry Pi with a camera module to develop an advanced system for tracking and analyzing customer traffic in retail environments. Using computer vision and deep learning technologies, the system provides real-time insights into store performance, helping store owners optimize both operations and customer experience.

Project Motivation

  • In the competitive retail market, understanding customer behavior is key to success. Traditional methods of customer tracking often fail to provide the depth of data needed to make informed decisions. This project addresses this gap by employing sophisticated technologies to enhance data accuracy and provide actionable insights, ultimately aiming to improve store profitability and customer satisfaction.

System Overview

The system integrates several technologies and components:

  • Raspberry Pi with Camera Module: Captures video footage for real-time people detection and counting.
  • Python with OpenCV and PyTorch: Processes the video to detect and track people.
  • WebSocket (FastAPI): Facilitates real-time data transmission between the Raspberry Pi and the analytics dashboard.
  • Streamlit: Provides a user-friendly dashboard for real-time and historical data visualization.
  • Packet Sniffer: Enhances people counting accuracy by analyzing WiFi probe requests to estimate the number of nearby devices.

Key Features

  • Real-Time Analytics: Monitors customer entry and exit in real time, with data refreshed instantaneously on the dashboard.
  • Data Visualization: Provides graphs and statistics through an interactive dashboard, aiding in quick decision-making.
  • Scalable Architecture: Designed to be easily scalable, supporting increased load and additional cameras without significant changes to the core system.
  • Security and Privacy: Ensures data is processed and stored securely, with measures to protect against unauthorized access.

Tech Stack

Raspberry Pi Python OpenCV PyTorch FastAPI Streamlit

Prerequisites

Before running the system, ensure you have the following installed:

  • Python 3.8+
  • Raspberry Pi OS or compatible Unix/Linux OS
  • Docker (for Docker-based setup)

How to Run

  • This application can be run either directly on your local machine using Python or using Docker for containerization, which simplifies setup and deployment. Follow the steps below based on your preferred method.

Running Without Docker

  • Ensure you have Python 3.8+ installed before you begin.
  1. Clone the repository:
  • cd into project repo and then cd into src

Set up and activate the Python virtual environment:

python3 -m venv myenv
source myenv/bin/activate

Install required dependencies:

pip3 install -r requirements.txt

Start the WebSocket server to handle real-time data:

uvicorn websocket_server:app --reload --host 0.0.0.0 --port 8000

Run the main application script:

python3 main.py

Launch the Streamlit dashboard to view the analytics:

streamlit run app.py

Running With Docker

  • Ensure you have Docker and Docker Compose installed.
  • Navigate to the project's root directory where the docker-compose.yml file is located. Build and run the containers:
docker-compose build
docker-compose up

Application Layout

System Dashboard

  • Here is a look at the system dashboard which provides real-time analytics:

Dashboard

Graphical User Interface

  • This is the graphical user interface of the application, showing the main control elements:

GUI

Navigation Panel

  • Below is the navigation panel used in our system:

Navigation Panel

Data Download Example

Below is an example of how the data looks when downloaded as a CSV file from the system:

Data CSV Example

Additional Notes

  • Ensure that the Raspberry Pi and camera are correctly set up and that the Raspberry Pi's IP address is correctly configured in the application settings if running remotely.
  • Check the firewall settings on your network to ensure that the required ports are open (especially port 8501 for Streamlit and port 8000 for the WebSocket server).

Troubleshooting

  • WebSocket Connection Issues: Ensure the WebSocket server address in the client configuration matches the server's IP and port.
  • Camera Not Detected: Verify that the Raspberry Pi's camera is properly connected and enabled.
  • Dependency Errors: Check that all Python dependencies are correctly installed in the virtual environment.

Contributors

  • Ahmed Elfarra
  • Ammar Alzureiqi