diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ab869f6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +__pycache__/ +*.pyc +.venv/ +.env +.vscode/ +.idea/ +reports/ +*.log +*.csv +*.sqlite +.DS_Store diff --git a/README.md b/README.md index ec3b49b..2f6a559 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -# ECE490_officesense \ No newline at end of file +# ECE490 Team Project Repository + +## Team Information +- Team name: OfficeSense +- Team members: + - Kostas Drakontidis + +## Project Title +Smart Office Presence + +## Project Summary +This project presents the design and implementation of a Smart Office Presence system based on Bluetooth Low Energy (BLE) technology. The system aims to detect user presence at room level using pseudonymized BLE tags, while ensuring privacy through a privacy-by-design approach. The proposed architecture integrates BLE scanners and tags with edge computing capabilities to enable real-time presence detection and decision-making without relying entirely on cloud processing. + +## Objectives + +## Repository Structure +- `src/` → source code +- `docs/` → architecture, setup, extra documentation +- `data/` → datasets, logs, exported measurements +- `tests/` → tests +- `progress.md` → weekly progress log +- `milestones.md` → milestone evidence map +- `demo-evidence/` → screenshots, output snapshots, demo proof + +## Required Workflow +1. Create an Issue before starting a task +2. Work in a branch +3. Commit regularly with meaningful messages +4. Open a Pull Request +5. Merge into `main` +6. Update `progress.md` + +## Deliverables to maintain +- complete `README.md` +- weekly `progress.md` +- `docs/architecture.md` +- `milestones.md` +- demo evidence in `demo-evidence/` + +## Current Status +Update this section with a one-paragraph summary each week. diff --git a/docs/architecture.md b/docs/architecture.md new file mode 100644 index 0000000..d8fe5b4 --- /dev/null +++ b/docs/architecture.md @@ -0,0 +1,21 @@ +# System Architecture + +## Overview +Describe the project at a high level. + +## Components +- sensors / input devices +- processing node +- communication +- storage +- dashboard / app +- actuators / notifications + +## Data Flow +Describe how data moves through the system. + +## Decisions and Tradeoffs +Explain key design choices. + +## Validation Plan +Describe how you will test the system. diff --git a/docs/setup.md b/docs/setup.md new file mode 100644 index 0000000..9c19ae9 --- /dev/null +++ b/docs/setup.md @@ -0,0 +1,21 @@ +# Setup Guide + +## Prerequisites +List required hardware, software, services, and package versions. + +## Installation +```bash +python -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +``` + +## Run +```bash +python src/main.py +``` + +## Test +```bash +pytest +``` diff --git a/docs/ssh_test.png b/docs/ssh_test.png new file mode 100644 index 0000000..65cbf1e Binary files /dev/null and b/docs/ssh_test.png differ diff --git a/milestones.md b/milestones.md new file mode 100644 index 0000000..342545c --- /dev/null +++ b/milestones.md @@ -0,0 +1,14 @@ +# Milestone Evidence Tracker + +| Week | Expected Deliverable | Evidence Link | Status | +|---|---|---|---| +| 1 | Repo setup, roles, architecture draft | | | +| 2 | Initial sensing / input handling | | | +| 3 | Communication layer | | | +| 4 | Data storage / logging | | | +| 5 | Basic analytics | | | +| 6 | Trend / state logic | | | +| 7 | Alerts / automation | | | +| 8 | Integration | | | +| 9 | Testing / optimization | | | +| 10 | Final demo-ready system | | | diff --git a/progress.md b/progress.md new file mode 100644 index 0000000..23ebf53 --- /dev/null +++ b/progress.md @@ -0,0 +1,36 @@ +# Weekly Progress Log + +Update this file every week. + +## Week 1 +### Completed +- Repository created +- Initial planning completed + +### In Progress +- Architecture draft +- Task assignment + +### Problems / Risks +- Example: hardware delay + +### Next Steps +- Finalize architecture +- Create first Issues + +### Team Contribution +- Student 1: +- Student 2: + +## Week 2 +### Completed + +### In Progress + +### Problems / Risks + +### Next Steps + +### Team Contribution +- Student 1: +- Student 2: