LS360 Terminal Documentation Index
Welcome to the LS360 Terminal documentation. This comprehensive guide covers everything you need to know about the platform.
📚 Documentation Sections
1. Overview
Introduction to LS360 Terminal, key features, and system overview.
Topics covered:
- Platform capabilities
- System architecture at-a-glance
- Quick start guide
- Feature highlights
Detailed system architecture and design patterns.
Topics covered:
- Service architecture (UI, Agent, Session Service)
- Communication protocols (WebSocket, gRPC, HTTP)
- Data flow diagrams
- Component interactions
- Security architecture
- Scalability considerations
Installation and initial setup guide.
Topics covered:
- Prerequisites and requirements
- Installation steps
- Service startup
- First capture workflow
- Project structure overview
- Common issues and solutions
Comprehensive configuration reference.
Topics covered:
- Environment variables
- Agent configuration (appsettings.json)
- UI configuration
- Database setup (Supabase)
- Hardware configuration
- Security settings
- Logging configuration
- Feature flags
Complete API documentation for all protocols.
Topics covered:
- WebSocket protocol (UI ↔ Agent)
- HTTP API (REST endpoints)
- gRPC service definitions
- Protocol Buffers (proto definitions)
- TypeScript types
- Error codes and handling
- Rate limits
Hardware SDK integration guide.
Topics covered:
- RealScan SDK setup
- Device Gateway SDK (GSdk)
- SDK adapter architecture
- P/Invoke for native libraries
- Quality scoring (NIST)
- Custom SDK integration
- Performance tuning
- Troubleshooting hardware
Production deployment guide.
Topics covered:
- Deployment architectures
- Installation methods
- Windows service setup
- SSL/TLS configuration
- Backup and recovery
- Monitoring and logging
- Security hardening
- Rollback procedures
Comprehensive troubleshooting guide.
Topics covered:
- Service status issues
- Hardware/scanner problems
- Capture quality issues
- WebSocket connection problems
- Database/data issues
- Performance optimization
- Build/development issues
- Diagnostic commands
🚀 Quick Navigation
| I want to... | Go to... |
|---|---|
| Understand the system | |
| Install the platform | |
| Configure settings | |
| Integrate hardware | |
| Deploy to production | |
| Fix a problem | |
| See API details |
🎯 Common Tasks
First Time Setup
- Read
- Install prerequisites
- Configure
- Start services and test
Adding Hardware
- Review
- Install RealScan SDK
- Configure SDK path
- Test in Troubleshooting
Going to Production
- Review
- Configure SSL/TLS
- Set up monitoring
- Implement backup strategy
API Development
- Review
- Check WebSocket protocol
- See TypeScript types
- Test with browser DevTools
📖 Document Conventions
Code Examples
- Shell commands: Use PowerShell (Windows) or Bash (Linux/Mac)
- Configuration: JSON, TypeScript, or C# as appropriate
- Paths: Use forward slashes or escaped backslashes for Windows
Terminology
- Agent: The .NET service handling hardware (port 5002)
- Session Service: The Node.js API service (port 5003)
- UI: Next.js frontend (port 3000)
- SDK: Software Development Kit (RealScan or Device Gateway)
- EBTS: Electronic Biometric Transmission Specification (FBI format)
- WSQ: Wavelet Scalar Quantization (FBI image compression)
- Slap: 4-4-2 fingerprint capture (right 4, left 4, 2 thumbs)
- Roll: Individual finger roll capture
🔗 External Resources
- Xperix/RealScan: https://www.xperix.com/ - Fingerprint scanner vendor
- FBI EBTS Spec: https://www.fbibiospecs.org/ - Biometric specifications
- NIST Quality: https://www.nist.gov/itl/iad/image-group - Image quality standards
- Supabase: https://supabase.com/ - Database and authentication
- Next.js: https://nextjs.org/ - React framework
- .NET: https://dotnet.microsoft.com/ - Agent framework
🆘 Getting Help
Documentation Issues
- Documentation unclear? Create an issue
- Missing topic? Request additions
Technical Support
- Check guide
- Review relevant documentation section
- Gather diagnostic information
- Contact support with diagnostic bundle
Community
- GitHub Discussions: discussions page
- Stack Overflow: Tag with
ls360-terminal
📝 Document Version
- Version: 1.0.0
- Last Updated: February 26, 2026
- Applies to: LS360 Terminal 1.0.x
🤝 Contributing to Documentation
We welcome documentation improvements!
- Fork the repository
- Make changes in
/documentation - Submit pull request
- Follow existing formatting conventions
Documentation Standards
- Use Markdown format
- Include code examples where helpful
- Keep language clear and concise
- Update INDEX.md for new sections
Ready to get started? →