Welcome to the comprehensive documentation for the PepperDash Essentials Web Config App - a powerful web-based tool for configuring, debugging, and managing PepperDash Essentials systems.
This documentation follows the Diataxis framework to provide you with the right information at the right time:
🎯 Tutorials - Learning-oriented
"Take me by the hand and teach me"
Step-by-step guides that take you through your first experiences with the application. Perfect for newcomers who want to get started quickly.
- Getting Started Tutorial - Your first steps with the web config app
- Debug Console Tutorial - Learn to use the debug console effectively
- Device Management Tutorial - Basic device inspection and management
🔧 How-to Guides - Problem-oriented
"Show me how to solve this specific problem"
Practical guides that solve specific problems you might encounter. These assume you have basic familiarity with the system.
- Troubleshooting Connection Issues
- Filter and Search Debug Messages
- Export and Analyze Configuration
- Monitor System Performance
- Restart and Reload Configuration
📚 Reference - Information-oriented
"Tell me the facts"
Complete technical information about all features, APIs, and components. Organized for easy lookup.
- UI Components Reference - Complete component documentation
- API Endpoints - All available REST endpoints
- Configuration Schema - Configuration file structure
- Device Types - Supported device types and properties
- Log Levels and Filters - Complete logging reference
💡 Explanation - Understanding-oriented
"Help me understand why and how this works"
Background information and design decisions that help you understand the system's architecture and concepts.
- System Architecture - How the web app integrates with Essentials
- Debug Console Design - How real-time debugging works
- Configuration Management - How configuration is handled
- Security Considerations - Security model and best practices
If you're new to the application, start with the Getting Started Tutorial.
If you need to solve a specific problem, check the How-to Guides.
For detailed technical information, consult the Reference section.
To understand the underlying concepts, read the Explanation articles.
The PepperDash Essentials Web Config App provides several key features:
- � Authentication: Secure login required before accessing any app data
- 🔍 Debug Console: Real-time log monitoring with per-device minimum log level filtering
- ⚙️ Device Management: Inspect and interact with connected devices
- 📄 Configuration Viewer: View and analyze merged configuration files
- 📦 Version Information: Check loaded assemblies and versions
- 🔀 Routing: Visual signal routing diagram between devices and tie lines
- 📱 Mobile Control: Mobile control interface management
- 🗺️ API Paths: Browse all available REST API routes on the processor
- 🏷️ Type Registry: Browse supported device types and their properties
The app supports up to 10 simultaneous PepperDash Essentials program slots (app01 through app10). After logging in, available program slots are automatically discovered and populated in the application selector dropdown in the top navigation bar. Navigating between app slots does not require re-authentication.
- Modern web browser (Chrome, Firefox, Safari, Edge)
- Network access to your PepperDash Essentials processor
- PepperDash Essentials framework running on target device
For technical support and questions:
- Check the How-to Guides for common solutions
- Review the Reference documentation for technical details
- Consult the Explanation articles for deeper understanding
This documentation is organized using the Diataxis framework to ensure you get the right type of information for your needs.