101 lines
3.7 KiB
Markdown
101 lines
3.7 KiB
Markdown
# USDA Vision Camera System - Documentation
|
|
|
|
This directory contains detailed documentation for the USDA Vision Camera System.
|
|
|
|
## Documentation Files
|
|
|
|
### 🚀 [API_DOCUMENTATION.md](API_DOCUMENTATION.md) **⭐ NEW**
|
|
**Complete API reference documentation** covering all endpoints, features, and recent enhancements:
|
|
- System status and health monitoring
|
|
- Camera management and configuration
|
|
- Recording control with dynamic settings
|
|
- Auto-recording management
|
|
- MQTT and machine status
|
|
- Storage and file management
|
|
- Camera recovery and diagnostics
|
|
- Live streaming capabilities
|
|
- WebSocket real-time updates
|
|
- Quick start examples and migration notes
|
|
|
|
### ⚡ [API_QUICK_REFERENCE.md](API_QUICK_REFERENCE.md) **⭐ NEW**
|
|
**Quick reference card** for the most commonly used API endpoints with curl examples and response formats.
|
|
|
|
### 📋 [PROJECT_COMPLETE.md](PROJECT_COMPLETE.md)
|
|
Complete project overview and final status documentation. Contains:
|
|
- Project completion status
|
|
- Final system architecture
|
|
- Deployment instructions
|
|
- Production readiness checklist
|
|
|
|
### 🎥 [MP4_FORMAT_UPDATE.md](MP4_FORMAT_UPDATE.md) **⭐ NEW**
|
|
**Frontend integration guide** for the MP4 video format update:
|
|
- Video format changes from AVI to MP4
|
|
- Frontend implementation checklist
|
|
- API response updates
|
|
- Performance benefits and browser compatibility
|
|
|
|
### 🚀 [REACT_INTEGRATION_GUIDE.md](REACT_INTEGRATION_GUIDE.md) **⭐ NEW**
|
|
**Quick reference for React developers** implementing the MP4 format changes:
|
|
- Code examples and components
|
|
- File handling updates
|
|
- Configuration interface
|
|
- Testing checklist
|
|
|
|
### 📋 [CURRENT_CONFIGURATION.md](CURRENT_CONFIGURATION.md) **⭐ NEW**
|
|
**Complete current system configuration reference**:
|
|
- Exact config.json structure with all current values
|
|
- Field-by-field documentation
|
|
- Camera-specific settings comparison
|
|
- MQTT topics and machine mappings
|
|
|
|
### 🎬 [VIDEO_STREAMING.md](VIDEO_STREAMING.md) **⭐ UPDATED**
|
|
**Complete video streaming module documentation**:
|
|
- Comprehensive API endpoint documentation
|
|
- Authentication and security information
|
|
- Error handling and troubleshooting
|
|
- Performance optimization guidelines
|
|
|
|
### 🤖 [AI_AGENT_VIDEO_INTEGRATION_GUIDE.md](AI_AGENT_VIDEO_INTEGRATION_GUIDE.md) **⭐ NEW**
|
|
**Complete integration guide for AI agents and external systems**:
|
|
- Step-by-step integration workflow
|
|
- Programming language examples (Python, JavaScript)
|
|
- Error handling and debugging strategies
|
|
- Performance optimization recommendations
|
|
|
|
### 🔧 [API_CHANGES_SUMMARY.md](API_CHANGES_SUMMARY.md)
|
|
Summary of API changes and enhancements made to the system.
|
|
|
|
### 📷 [CAMERA_RECOVERY_GUIDE.md](CAMERA_RECOVERY_GUIDE.md)
|
|
Guide for camera recovery procedures and troubleshooting camera-related issues.
|
|
|
|
### 📡 [MQTT_LOGGING_GUIDE.md](MQTT_LOGGING_GUIDE.md)
|
|
Comprehensive guide for MQTT logging configuration and troubleshooting.
|
|
|
|
## Main Documentation
|
|
|
|
The main system documentation is located in the root directory:
|
|
- **[../README.md](../README.md)** - Primary system documentation with installation, configuration, and usage instructions
|
|
|
|
## Additional Resources
|
|
|
|
### Demo Code
|
|
- **[../demos/](../demos/)** - Demo scripts and camera SDK examples
|
|
|
|
### Test Files
|
|
- **[../tests/](../tests/)** - Test scripts and legacy test files
|
|
|
|
### Jupyter Notebooks
|
|
- **[../notebooks/](../notebooks/)** - Interactive notebooks for system exploration and testing
|
|
|
|
## Quick Links
|
|
|
|
- [System Installation](../README.md#installation)
|
|
- [Configuration Guide](../README.md#configuration)
|
|
- [API Documentation](../README.md#api-reference)
|
|
- [Troubleshooting](../README.md#troubleshooting)
|
|
- [Camera SDK Examples](../demos/camera_sdk_examples/)
|
|
|
|
## Support
|
|
|
|
For technical support and questions, refer to the main [README.md](../README.md) troubleshooting section or check the system logs.
|