Docs/Index
Hygate Documentation
A complete guide to managing your smart access and payment platform.
Quick Navigation
Getting Started
- Introduction — What is Hygate?
- Quick Start Guide — Get up and running in 5 minutes
- Initial Setup — Configure your workspace
User Guides
- Administrator Guide — Full admin reference
- Operator Guide — Operator reference
Module Reference
- Dashboard — Workspace overview and metrics
- Doors — Smart lock management
- Devices — IoT relay control
- Locations — Multi-location organization
- Payments — Payment history and reporting
- Reports — Revenue and usage analytics
- Sessions — Active session monitoring
- Audit Logs — Activity tracking
- Settings — System configuration
Integrations
- TTLock Integration — Smart lock setup
- Shelly Integration — IoT device setup
- Stripe Integration — Payment processing
- Email Provider — OTP configuration
Guides & Resources
- Guest Access Flow — How guests interact with your system
- Common Workflows — Day-to-day operations
- Recommended Setup — Best practices
- Security Best Practices — Hardening your platform
Help
- Troubleshooting — Fix common issues
- FAQ — Frequently asked questions
- Glossary — Terms and definitions
System Architecture
Hygate connects three layers into a unified smart access platform:
Smart Lock (TTLock) IoT Device (Shelly) Payment (Stripe)
| | |
v v v
QR Access Device Sessions Card Payments
Passage Mode Power Control Revenue Tracking
Lock/Unlock Usage Plans Invoices
Core capabilities:
- Sell access to smart locks via QR code with Stripe
- Control IoT devices (washers, dryers, chargers) with time-based plans
- Manage multiple locations from one dashboard
- Track all activity with complete audit logs
Role Overview
| Capability | Administrator | Operator |
|---|---|---|
| Full system access | Yes | No |
| Configure integrations | Yes | No |
| Manage team members | Yes | No |
| Manage doors and devices | Yes | Yes (edit only) |
| Manage locations | Yes (full) | Yes (rename only) |
| View payments and reports | Yes | Yes |
| Access audit logs | Yes | No |
| Change security settings | Yes | No |
Getting Help
If you need assistance, check:
- Troubleshooting guide — Common issues and fixes
- FAQ — Quick answers
- Your audit logs — Recent actions and errors
Still need help? Contact your system administrator.