141 lines
4.4 KiB
Markdown
141 lines
4.4 KiB
Markdown
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
### Added
|
|
- GitHub CI/CD workflows for automated testing and deployment
|
|
- Comprehensive documentation structure with cross-references
|
|
- Security scanning with Bandit integration
|
|
- Docker containerization support
|
|
- PyPI package distribution
|
|
- Dependency vulnerability scanning
|
|
|
|
### Changed
|
|
- Improved project structure and organization
|
|
- Enhanced documentation with visual elements and flow diagrams
|
|
- Updated build scripts for better cross-platform support
|
|
|
|
### Fixed
|
|
- Documentation gaps and missing links
|
|
- Build process improvements
|
|
- Code quality and linting standards
|
|
|
|
## [1.0.0] - 2024-01-15
|
|
|
|
### Added
|
|
- Initial release of NowYouSeeMe holodeck environment
|
|
- Real-time 6DOF tracking with <20ms latency
|
|
- RF-vision sensor fusion for robust mapping
|
|
- Neural enhancement with NeRF integration
|
|
- Unity/Unreal export for VR/AR applications
|
|
- Projection mapping support for physical installations
|
|
- Auto-calibration and drift compensation
|
|
- Multi-device connectivity and management
|
|
- Azure integration for GPU computing and AI Foundry
|
|
- Comprehensive PyQt6-based user interface
|
|
|
|
### Features
|
|
- **Camera Capture**: OpenCV/GStreamer integration for real-time video
|
|
- **Wi-Fi CSI Capture**: Intel 5300/Nexmon support for RF sensing
|
|
- **Calibration Store**: Intrinsic/extrinsic camera calibration
|
|
- **Sensor Fusion**: RF point cloud & occupancy grid + Vision pose graph
|
|
- **Export Engine**: Unity/UE4 integration for VR/AR
|
|
- **Rendering Engine**: VR/Projection mapping support
|
|
- **Device Management**: Multi-device discovery and connection
|
|
- **Azure Integration**: GPU resource provisioning and AI workspace management
|
|
|
|
### Technical Specifications
|
|
- **Latency**: <20ms end-to-end
|
|
- **Accuracy**: <10cm spatial fidelity
|
|
- **Frame Rate**: 30-60 FPS
|
|
- **CSI Rate**: ≥100 packets/second
|
|
- **Supported Platforms**: Ubuntu 20.04+, Windows 10+
|
|
- **Hardware Requirements**: CUDA-capable GPU (NVIDIA GTX 1060+), Intel 5300 WiFi card
|
|
|
|
## [0.9.0] - 2023-12-01
|
|
|
|
### Added
|
|
- Beta release with core SLAM functionality
|
|
- Basic camera calibration system
|
|
- Initial RF processing pipeline
|
|
- Simple 3D visualization interface
|
|
|
|
### Changed
|
|
- Improved sensor fusion algorithms
|
|
- Enhanced error handling and recovery
|
|
- Optimized performance for real-time operation
|
|
|
|
## [0.8.0] - 2023-11-15
|
|
|
|
### Added
|
|
- Alpha release with fundamental components
|
|
- Camera data ingestion pipeline
|
|
- CSI data acquisition system
|
|
- Basic pose estimation algorithms
|
|
|
|
### Fixed
|
|
- Memory leaks in data processing
|
|
- Threading issues in sensor fusion
|
|
- Calibration accuracy improvements
|
|
|
|
## [0.7.0] - 2023-10-01
|
|
|
|
### Added
|
|
- Initial project structure
|
|
- Core C++ and Python modules
|
|
- Basic build system with CMake
|
|
- Development environment setup
|
|
|
|
---
|
|
|
|
## Release Process
|
|
|
|
### Version Numbering
|
|
- **MAJOR**: Incompatible API changes
|
|
- **MINOR**: New functionality (backward compatible)
|
|
- **PATCH**: Bug fixes (backward compatible)
|
|
|
|
### Release Checklist
|
|
- [ ] All tests pass
|
|
- [ ] Documentation updated
|
|
- [ ] Changelog updated
|
|
- [ ] Version numbers updated
|
|
- [ ] Release notes written
|
|
- [ ] Binaries built and tested
|
|
- [ ] Docker images built and pushed
|
|
- [ ] PyPI package published
|
|
|
|
### Breaking Changes
|
|
Breaking changes will be clearly marked in the changelog and will trigger a major version increment. Migration guides will be provided for significant changes.
|
|
|
|
### Deprecation Policy
|
|
- Deprecated features will be marked in the changelog
|
|
- Deprecated features will be removed after 2 major versions
|
|
- Migration guides will be provided for deprecated features
|
|
|
|
---
|
|
|
|
## Contributing to Changelog
|
|
|
|
When contributing to this project, please update the changelog by adding entries under the [Unreleased] section following the format above. Your entry should include:
|
|
|
|
1. **Type of change**: Added, Changed, Deprecated, Removed, Fixed, or Security
|
|
2. **Description**: Brief description of the change
|
|
3. **Issue reference**: Link to related issue or pull request
|
|
|
|
Example:
|
|
```markdown
|
|
### Added
|
|
- New feature for improved sensor fusion (#123)
|
|
```
|
|
|
|
## Links
|
|
|
|
- [GitHub Releases](https://github.com/your-org/NowYouSeeMe/releases)
|
|
- [PyPI Package](https://pypi.org/project/nowyouseeme/)
|
|
- [Docker Hub](https://hub.docker.com/r/nowyouseeme/nowyouseeme) |