Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 078c5d8

Browse files
ruvnetruvnet
committed
minor updates
1 parent fe5e3d1 commit 078c5d8

17 files changed

Lines changed: 745 additions & 105 deletions

‎CHANGELOG.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.1.0] - 2025-06-07
9+
10+
### Added
11+
- Multi-column table of contents in README.md for improved navigation
12+
- Enhanced documentation structure with better organization
13+
- Improved visual layout for better user experience
14+
15+
### Changed
16+
- Updated README.md table of contents to use a two-column layout
17+
- Reorganized documentation sections for better logical flow
18+
- Enhanced readability of navigation structure
19+
20+
### Documentation
21+
- Restructured table of contents for better accessibility
22+
- Improved visual hierarchy in documentation
23+
- Enhanced user experience for documentation navigation
24+
25+
## [1.0.0] - 2024-12-01
26+
27+
### Added
28+
- Initial release of WiFi DensePose
29+
- Real-time WiFi-based human pose estimation using CSI data
30+
- DensePose neural network integration
31+
- RESTful API with comprehensive endpoints
32+
- WebSocket streaming for real-time data
33+
- Multi-person tracking capabilities
34+
- Fall detection and activity recognition
35+
- Healthcare, fitness, smart home, and security domain configurations
36+
- Comprehensive CLI interface
37+
- Docker and Kubernetes deployment support
38+
- 100% test coverage
39+
- Production-ready monitoring and logging
40+
- Hardware abstraction layer for multiple WiFi devices
41+
- Phase sanitization and signal processing
42+
- Authentication and rate limiting
43+
- Background task management
44+
- Database integration with PostgreSQL and Redis
45+
- Prometheus metrics and Grafana dashboards
46+
- Comprehensive documentation and examples
47+
48+
### Features
49+
- Privacy-preserving pose detection without cameras
50+
- Sub-50ms latency with 30 FPS processing
51+
- Support for up to 10 simultaneous person tracking
52+
- Enterprise-grade security and scalability
53+
- Cross-platform compatibility (Linux, macOS, Windows)
54+
- GPU acceleration support
55+
- Real-time analytics and alerting
56+
- Configurable confidence thresholds
57+
- Zone-based occupancy monitoring
58+
- Historical data analysis
59+
- Performance optimization tools
60+
- Load testing capabilities
61+
- Infrastructure as Code (Terraform, Ansible)
62+
- CI/CD pipeline integration
63+
- Comprehensive error handling and logging
64+
65+
### Documentation
66+
- Complete user guide and API reference
67+
- Deployment and troubleshooting guides
68+
- Hardware setup and calibration instructions
69+
- Performance benchmarks and optimization tips
70+
- Contributing guidelines and code standards
71+
- Security best practices
72+
- Example configurations and use cases

‎README.md‎

Lines changed: 69 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -24,60 +24,75 @@ A cutting-edge WiFi-based human pose estimation system that leverages Channel St
2424

2525
## 📋 Table of Contents
2626

27-
1. [🚀 Key Features](#-key-features)
28-
2. [🏗️ System Architecture](#️-system-architecture)
29-
- [Core Components](#core-components)
30-
3. [📦 Installation](#-installation)
31-
- [Using pip (Recommended)](#using-pip-recommended)
32-
- [From Source](#from-source)
33-
- [Using Docker](#using-docker)
34-
- [System Requirements](#system-requirements)
35-
4. [🚀 Quick Start](#-quick-start)
36-
- [Basic Setup](#1-basic-setup)
37-
- [Start the System](#2-start-the-system)
38-
- [Using the REST API](#3-using-the-rest-api)
39-
- [Real-time Streaming](#4-real-time-streaming)
40-
5. [🖥️ CLI Usage](#️-cli-usage)
41-
- [Installation](#cli-installation)
42-
- [Basic Commands](#basic-commands)
43-
- [Configuration Commands](#configuration-commands)
44-
- [Monitoring Commands](#monitoring-commands)
45-
- [Examples](#cli-examples)
46-
6. [📚 Documentation](#-documentation)
47-
- [Core Documentation](#-core-documentation)
48-
- [Quick Links](#-quick-links)
49-
- [API Overview](#-api-overview)
50-
7. [🔧 Hardware Setup](#-hardware-setup)
51-
- [Supported Hardware](#supported-hardware)
52-
- [Physical Setup](#physical-setup)
53-
- [Network Configuration](#network-configuration)
54-
- [Environment Calibration](#environment-calibration)
55-
8. [⚙️ Configuration](#️-configuration)
56-
- [Environment Variables](#environment-variables)
57-
- [Domain-Specific Configurations](#domain-specific-configurations)
58-
- [Advanced Configuration](#advanced-configuration)
59-
9. [🧪 Testing](#-testing)
60-
- [Running Tests](#running-tests)
61-
- [Test Categories](#test-categories)
62-
- [Mock Testing](#mock-testing)
63-
- [Continuous Integration](#continuous-integration)
64-
10. [🚀 Deployment](#-deployment)
65-
- [Production Deployment](#production-deployment)
66-
- [Infrastructure as Code](#infrastructure-as-code)
67-
- [Monitoring and Logging](#monitoring-and-logging)
68-
11. [📊 Performance Metrics](#-performance-metrics)
69-
- [Benchmark Results](#benchmark-results)
70-
- [Performance Optimization](#performance-optimization)
71-
- [Load Testing](#load-testing)
72-
12. [🤝 Contributing](#-contributing)
73-
- [Development Setup](#development-setup)
74-
- [Code Standards](#code-standards)
75-
- [Contribution Process](#contribution-process)
76-
- [Code Review Checklist](#code-review-checklist)
77-
- [Issue Templates](#issue-templates)
78-
13. [📄 License](#-license)
79-
14. [🙏 Acknowledgments](#-acknowledgments)
80-
15. [📞 Support](#-support)
27+
<table>
28+
<tr>
29+
<td width="50%">
30+
31+
**🚀 Getting Started**
32+
- [Key Features](#-key-features)
33+
- [System Architecture](#️-system-architecture)
34+
- [Installation](#-installation)
35+
- [Using pip (Recommended)](#using-pip-recommended)
36+
- [From Source](#from-source)
37+
- [Using Docker](#using-docker)
38+
- [System Requirements](#system-requirements)
39+
- [Quick Start](#-quick-start)
40+
- [Basic Setup](#1-basic-setup)
41+
- [Start the System](#2-start-the-system)
42+
- [Using the REST API](#3-using-the-rest-api)
43+
- [Real-time Streaming](#4-real-time-streaming)
44+
45+
**🖥️ Usage & Configuration**
46+
- [CLI Usage](#️-cli-usage)
47+
- [Installation](#cli-installation)
48+
- [Basic Commands](#basic-commands)
49+
- [Configuration Commands](#configuration-commands)
50+
- [Examples](#cli-examples)
51+
- [Documentation](#-documentation)
52+
- [Core Documentation](#-core-documentation)
53+
- [Quick Links](#-quick-links)
54+
- [API Overview](#-api-overview)
55+
- [Hardware Setup](#-hardware-setup)
56+
- [Supported Hardware](#supported-hardware)
57+
- [Physical Setup](#physical-setup)
58+
- [Network Configuration](#network-configuration)
59+
- [Environment Calibration](#environment-calibration)
60+
61+
</td>
62+
<td width="50%">
63+
64+
**⚙️ Advanced Topics**
65+
- [Configuration](#️-configuration)
66+
- [Environment Variables](#environment-variables)
67+
- [Domain-Specific Configurations](#domain-specific-configurations)
68+
- [Advanced Configuration](#advanced-configuration)
69+
- [Testing](#-testing)
70+
- [Running Tests](#running-tests)
71+
- [Test Categories](#test-categories)
72+
- [Mock Testing](#mock-testing)
73+
- [Continuous Integration](#continuous-integration)
74+
- [Deployment](#-deployment)
75+
- [Production Deployment](#production-deployment)
76+
- [Infrastructure as Code](#infrastructure-as-code)
77+
- [Monitoring and Logging](#monitoring-and-logging)
78+
79+
**📊 Performance & Community**
80+
- [Performance Metrics](#-performance-metrics)
81+
- [Benchmark Results](#benchmark-results)
82+
- [Performance Optimization](#performance-optimization)
83+
- [Load Testing](#load-testing)
84+
- [Contributing](#-contributing)
85+
- [Development Setup](#development-setup)
86+
- [Code Standards](#code-standards)
87+
- [Contribution Process](#contribution-process)
88+
- [Code Review Checklist](#code-review-checklist)
89+
- [License](#-license)
90+
- [Acknowledgments](#-acknowledgments)
91+
- [Support](#-support)
92+
93+
</td>
94+
</tr>
95+
</table>
8196

8297
## 🏗️ System Architecture
8398

‎alembic.ini‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# A generic, single database configuration.
2+
3+
[alembic]
4+
# path to migration scripts
5+
script_location = src/database/migrations
6+
7+
# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
8+
# Uncomment the line below if you want the files to be prepended with date and time
9+
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
10+
11+
# sys.path path, will be prepended to sys.path if present.
12+
# defaults to the current working directory.
13+
prepend_sys_path = .
14+
15+
# timezone to use when rendering the date within the migration file
16+
# as well as the filename.
17+
# If specified, requires the python-dateutil library that can be
18+
# installed by adding `alembic[tz]` to the pip requirements
19+
# string value is passed to dateutil.tz.gettz()
20+
# leave blank for localtime
21+
# timezone =
22+
23+
# max length of characters to apply to the
24+
# "slug" field
25+
# truncate_slug_length = 40
26+
27+
# set to 'true' to run the environment during
28+
# the 'revision' command, regardless of autogenerate
29+
# revision_environment = false
30+
31+
# set to 'true' to allow .pyc and .pyo files without
32+
# a source .py file to be detected as revisions in the
33+
# versions/ directory
34+
# sourceless = false
35+
36+
# version number format
37+
version_num_format = %04d
38+
39+
# version path separator; As mentioned above, this is the character used to split
40+
# version_locations. The default within new alembic.ini files is "os", which uses
41+
# os.pathsep. If this key is omitted entirely, it falls back to the legacy
42+
# behavior of splitting on spaces and/or commas.
43+
# Valid values for version_path_separator are:
44+
#
45+
# version_path_separator = :
46+
# version_path_separator = ;
47+
# version_path_separator = space
48+
version_path_separator = os
49+
50+
# set to 'true' to search source files recursively
51+
# in each "version_locations" directory
52+
# new in Alembic version 1.10
53+
# recursive_version_locations = false
54+
55+
# the output encoding used when revision files
56+
# are written from script.py.mako
57+
# output_encoding = utf-8
58+
59+
sqlalchemy.url = sqlite:///./data/wifi_densepose_fallback.db
60+
61+
62+
[post_write_hooks]
63+
# post_write_hooks defines scripts or Python functions that are run
64+
# on newly generated revision scripts. See the documentation for further
65+
# detail and examples
66+
67+
# format using "black" - use the console_scripts runner, against the "black" entrypoint
68+
# hooks = black
69+
# black.type = console_scripts
70+
# black.entrypoint = black
71+
# black.options = -l 79 REVISION_SCRIPT_FILENAME
72+
73+
# lint with attempts to fix using "ruff" - use the exec runner, execute a binary
74+
# hooks = ruff
75+
# ruff.type = exec
76+
# ruff.executable = %(here)s/.venv/bin/ruff
77+
# ruff.options = --fix REVISION_SCRIPT_FILENAME
78+
79+
# Logging configuration
80+
[loggers]
81+
keys = root,sqlalchemy,alembic
82+
83+
[handlers]
84+
keys = console
85+
86+
[formatters]
87+
keys = generic
88+
89+
[logger_root]
90+
level = WARN
91+
handlers = console
92+
qualname =
93+
94+
[logger_sqlalchemy]
95+
level = WARN
96+
handlers =
97+
qualname = sqlalchemy.engine
98+
99+
[logger_alembic]
100+
level = INFO
101+
handlers =
102+
qualname = alembic
103+
104+
[handler_console]
105+
class = StreamHandler
106+
args = (sys.stderr,)
107+
level = NOTSET
108+
formatter = generic
109+
110+
[formatter_generic]
111+
format = %(levelname)-5.5s [%(name)s] %(message)s
112+
datefmt = %H:%M:%S

‎data/wifi_densepose_fallback.db‎

Whitespace-only changes.

‎example.env‎

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,40 @@ CORS_ORIGINS=* # Use specific origins in production: https://example.com,https:
4141
# =============================================================================
4242

4343
# Database connection (optional - defaults to SQLite in development)
44-
# DATABASE_URL=postgresql://user:password@localhost:5432/wifi_densepose
45-
# DATABASE_POOL_SIZE=10
46-
# DATABASE_MAX_OVERFLOW=20
44+
# For PostgreSQL (recommended for production):
45+
DATABASE_URL=postgresql://wifi_user:wifi_password@localhost:5432/wifi_densepose
46+
DATABASE_POOL_SIZE=10
47+
DATABASE_MAX_OVERFLOW=20
48+
49+
# Alternative: Individual database connection parameters
50+
# DB_HOST=localhost
51+
# DB_PORT=5432
52+
# DB_NAME=wifi_densepose
53+
# DB_USER=wifi_user
54+
# DB_PASSWORD=wifi_password
55+
56+
# Database failsafe settings
57+
ENABLE_DATABASE_FAILSAFE=true
58+
SQLITE_FALLBACK_PATH=./data/wifi_densepose_fallback.db
4759

4860
# =============================================================================
4961
# REDIS SETTINGS (Optional - for caching and rate limiting)
5062
# =============================================================================
5163

5264
# Redis connection (optional - defaults to localhost in development)
53-
# REDIS_URL=redis://localhost:6379/0
65+
REDIS_URL=redis://localhost:6379/0
5466
# REDIS_PASSWORD=your-redis-password
55-
# REDIS_DB=0
67+
REDIS_DB=0
68+
REDIS_ENABLED=true
69+
REDIS_REQUIRED=false
70+
ENABLE_REDIS_FAILSAFE=true
71+
72+
# Redis connection settings
73+
REDIS_HOST=localhost
74+
REDIS_PORT=6379
75+
REDIS_MAX_CONNECTIONS=10
76+
REDIS_SOCKET_TIMEOUT=5
77+
REDIS_CONNECT_TIMEOUT=5
5678

5779
# =============================================================================
5880
# HARDWARE SETTINGS

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "wifi-densepose"
7-
version = "1.0.0"
7+
version = "1.1.0"
88
description = "WiFi-based human pose estimation using CSI data and DensePose neural networks"
99
readme = "README.md"
1010
license = "MIT"

‎requirements.txt‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ python-jose[cryptography]>=3.3.0
2121
python-multipart>=0.0.6
2222
passlib[bcrypt]>=1.7.4
2323

24+
# Database dependencies
25+
sqlalchemy>=2.0.0
26+
asyncpg>=0.28.0
27+
aiosqlite>=0.19.0
28+
redis>=4.5.0
29+
30+
# CLI dependencies
31+
click>=8.0.0
32+
alembic>=1.10.0
33+
2434
# Hardware interface dependencies
2535
asyncio-mqtt>=0.11.0
2636
aiohttp>=3.8.0

‎src/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
License: MIT
3030
"""
3131

32-
__version__ = "1.0.0"
32+
__version__ = "1.1.0"
3333
__author__ = "WiFi-DensePose Team"
3434
__email__ = "[email protected]"
3535
__license__ = "MIT"

0 commit comments

Comments
 (0)