Files
usda-vision/API Documentations/docs/README.md
Alireza Vaezi 7bc76d72f9 feat: Update camera configuration to support MP4 format with new settings
- Changed machine topic from "vibratory_conveyor" to "blower_separator" for camera1
- Updated exposure and gain settings for camera1
- Added new video recording settings: video_format, video_codec, video_quality, auto_start_recording_enabled, auto_recording_max_retries, auto_recording_retry_delay_seconds
- Enhanced documentation to reflect current configuration and API alignment
- Redesigned Camera Configuration UI to display read-only fields for system and auto-recording settings
- Improved handling of video format settings in the API and frontend
- Created CURRENT_CONFIGURATION.md for complete system configuration reference
2025-08-04 16:44:45 -04:00

3.1 KiB

USDA Vision Camera System - Documentation

This directory contains detailed documentation for the USDA Vision Camera System.

Documentation Files

🚀 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 NEW

Quick reference card for the most commonly used API endpoints with curl examples and response formats.

📋 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 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 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 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

🔧 API_CHANGES_SUMMARY.md

Summary of API changes and enhancements made to the system.

📷 CAMERA_RECOVERY_GUIDE.md

Guide for camera recovery procedures and troubleshooting camera-related issues.

📡 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 - Primary system documentation with installation, configuration, and usage instructions

Additional Resources

Demo Code

  • ../demos/ - Demo scripts and camera SDK examples

Test Files

  • ../tests/ - Test scripts and legacy test files

Jupyter Notebooks

  • ../notebooks/ - Interactive notebooks for system exploration and testing

Support

For technical support and questions, refer to the main README.md troubleshooting section or check the system logs.