Kramer K-Agent App User Manual

Kramer K-Agent App

Introduction

Welcome to K-Agent, Kramer’s next-generation touch panel management software for Kramer Control & Session Manger providing enhanced remote administration capabilities for KT-20x Series Touch Panels.

What is K-Agent?
K-Agent is a powerful software application that enables:

• Remote tablet management and monitoring
• Automated URL launching in full-screen mode
• Display policy management and power control
• Secure device locking and access control
• API-based remote administration

Key Features
Enhanced Administration

• Ping and health monitoring
• Remote URL launching
• Device reboot capabilities
• Secure PIN-based access control

Advanced Display Management

• Configurable brightness and dimming controls
• Automatic display timeout settings
• Immersive full-screen mode support

Flexible Connectivity

• HTTP and HTTPS API support
• Integration with Kramer Control Brain systems
• Support for multiple interface configurations

Device-Specific Features (KT-20x Touch Panels)

• LED sidebar control and color customization
• Enhanced brightness management
• Advanced display settings

Getting Started

System Requirements

Network Configuration

• K-Agent must be reachable on ports 9803 (HTTP) or 9804 (HTTPS)
• K-Agent must be able to reach Brain systems on ports 8000-8049 or 9000-9049 (HTTPS)
• Supported Brain systems: KC-VirtualBrain-1, 5, 25, or 50

Compatible Hardware

• KT-20x Series Touch Panels with K-Agent software installed
• Network connectivity (Ethernet or Wi-Fi)

Installation Overview

• K-Agent comes pre-installed on compatible KT-20x Series Touch Panels. For hardware installation and network setup procedures, refer to your specific touch panel hardware manual.
• K-Agent must be launched manually during the first activation to enable auto-start functionality.

K-Agent Overview

Application Interface
When you first access K-Agent, you’ll see the main Settings interface with three primary configuration areas:

Settings Panel Structure

• Left Panel: Configuration Options
• Full Screen Mode toggle
• Display Policy toggle
• Lock Tablet toggle
• Version information (bottom left)
• Right Panel: Configuration Details
• Context-sensitive settings based on selected option
• URL configuration fields
• Policy and security settings

Navigation and Access

Accessing K-Agent Settings

1. Swipe up from the center bottom of the screen
   The IPad app requires a 2 finger right to left gesture and does not support a pincode
2. Enter PIN code (default: 9428)
3. Access settings panels and configuration options

Exiting Settings
Press Apply to save changes and return to full-screen mode
Settings are automatically saved

Initial Setup and Configuration

First-Time Setup
After installing your touch panel, follow these steps for initial configuration:

1. Step 1: Launch K-Agent
   1. Locate the K-Agent icon on your touch panel home screen
   2. Tap to launch the application
   3. The settings interface will appear for first-time configuration
2. Step 2: Configure Network Access
   Ensure your touch panel can communicate with your Brain system:
   • Verify network connectivity
   • Confirm firewall settings allow required ports
   • Test connectivity to your Brain system IP address
3. Step 3: Set Up URL Configuration

Choose one of three methods to configure your interface URL:

1. Method 1: Browse and Select (Recommended)
   1. In Full Screen Mode settings, tap “Browse and select a URL”
   2. Enter your Brain IP address and port
   3.  Select from available interfaces
   4. Apply configuration
2. Method 2: API Configuration (Recommended for System Integrators)
   • Use API calls to remotely configure URLs
   • See API Reference section for details
3. Method 3: Manual Entry (Not Recommended)
   • Manually type the complete URL in the configuration field
   • Ensure exact syntax and formatting

User Interface Configuration

Full Screen Mode
Full Screen Mode is the primary operational mode for K-Agent, providing immersive interface display

Configuration Options

Tablet Full-Screen URL

• Primary interface URL for continuous display
• Supports Kramer Control Brain interfaces & Session Manager Tablet Templates
• Immersive mode available (adds “&immersive=true” parameter)
• URL Format Example: http://192.168.88.149:8000/?interface=43c286c8-ee1e-452f-b123-23afee72af1b&page=606cd9e0-9499-4d1f-8cf8-12441bee8c56

Secondary Control Address

• Optional secondary Brain IP address
• Used for backup control systems in the event of a brain Failure

Prerequisites
Before configuring a secondary control address, you must:

• Create a Reference Space
  • Access your Project in the manager
  • Navigate to Space Management
  • Create a new reference space based on your existing master space
  • Ensure all interface configurations are replicated
• Provision to Secondary Brain
  • Deploy the reference space to your backup Brain system
  • Verify the secondary Brain system is network accessible
  • Confirm the same interface and page IDs are maintained across both spaces
• Network Requirements
  • Both Brain systems must be accessible from the touch panel
  • Standard port requirements apply (8000-8049 or 9000-9049)
  • Network routing must support failover scenarios
• Failover Behavior
  • K-Agent automatically detects primary Brain unavailability
  • Transition to secondary Brain system
  • Interface state and functionality preserved during switchover if device states are used for UI Changes
  • Manual return to primary interface is required when available
• Configuration Examples
  • Primary Configuration (Tablet Full-Screen URL)  http://192.168.88.253:8000/?interface=43c286c8-ee1e-452f-b123-23afee72af1b&page=606cd9e0-9499-4d1f-8cf8-12441bee8c56
  • Secondary Configuration (Secondary Control Address) 192.168.88.254:8000
  • Result During Failover
  • The system automatically constructs the failover URL: http://192.168.88.254:8000/?interface=43c286c8-ee1e-452f-b123-23afee72af1b&page=606cd9e0-9499-4d1f-8cf8-12441bee8c56

Tablet Popup URL

• Secondary URL for overlay interfaces
• Can be triggered by API calls or interface buttons
• Supports immersive mode
• Renders the “popup” page using 80% of the touch panel canvas
• Please see the API Details Section

Immersive Mode
Immersive mode provides a true full-screen experience by removing the interface selection frame:

• Automatically appends “&immersive=true” to URLs
• Hides browser navigation elements
• Recommended for production deployments
• Users can only exit via PIN entry

Browse and Select URL Feature
The Browse and Select feature simplifies URL configuration:

Using Browse and Select

1. Access the Feature
   • In Full Screen Mode settings
   • Click “Browse and select a URL”
2. Connect to Brain
   • Enter Brain IP address and port in the embedded browser
   • Example: 192.168.88.253:8000
     
3. Select Interface
   • Browse available interfaces
   • Click desired interface
   • Click Apply to confirm selection
4. Automatic Configuration
   • URL automatically populates in settings field
   • Interface loads in full-screen mode

Advanced Settings

Display Policy
Display Policy provides comprehensive power management and display control.

Configuration Options
Set Default Brightness Level

• Percentage of maximum brightness (0-100%)
• Applied when display reactivates
• Slider control for easy adjustment

Display Timeout (Timer)

• Dimming: Minutes of inactivity before dimming to 20% brightness
• Display Off: Minutes of inactivity before turning off display
• Display Off must be longer than Dimming timeout

KT-20x Enhanced Features
For KT-20x Touch Panels, additional display controls are available via API:

• LED sidebar color control
• Advanced brightness management
• Extended display policies

Lock Tablet
Lock Tablet provides security and access control features

Security Configuration
PIN to Unlock Screen

• Default PIN: 9428
• Configurable to any numeric value
• Required to access settings or exit full-screen mode

PIN Popup Behavior

• Triggered when user swipes up from center bottom
• Available swipe directions:
  • Bottom to top
  • Top to bottom

USB Lock

• Optional USB port disable feature
• Prevents unauthorized USB device access

PIN Entry Process

When accessing settings:

1. User swipes up from center bottom (IPad 2 Finger right to left gesture – No Pin code Support)
2. PIN entry dialog appears
3. Enter correct PIN using on-screen keypad
4. Access granted to settings interface

Pause and Resume Functionality
K-Agent provides operational pause and resume capabilities:

Pause Operation

• Activated when PIN is entered and settings accessed
• Current UI is suspended
• Display returns to settings interface
• Session state preserved

Resume Operation

• UI automatically reloads when exiting settings
• All interface states restored
• Continues until next PIN entry

 

API Reference

K-Agent provides comprehensive API access for remote management and integration.

1. API Endpoints Overview
   • All API calls use the following format:
   • HTTP: http://<device_ip>:9803/<endpoint>
   • HTTPS: https://<device_ip>:9804/<endpoint>
2. Health and Status APIs
   • Health Check
   • Endpoint: /health/ Method: GET Response: {“status”:”Up”} Description: Verify K-Agent is running and responsive
   • Example: https://192.168.88.73:9804/health/
3. URL Management APIs
   • Launch URL (Non-Immersive)
   • Endpoint: /launchurl?<URL> Method: GET Description: Launch URL in standard browser mode
   • Example: https://192.168.88.73:9804/launchurl?http://192.168.88.253:8000/?interface=e84f5fb8-c5a3-4675-9006-d79d3e6cfe59&page=5913c07a-9a41-4fac-9870-e87b1ef719df
   • Launch Kramer URL (Immersive Mode)
   • Endpoint: /launchkramerurl?<URL> Method: GET Description: Launch URL in full-screen immersive mode
   • Example: https://192.168.88.73:9804/launchkramerurl?http://192.168.88.253:8000/?interface=e84f5fb8-c5a3-4675-9006-d79d3e6cfe59&page=5913c07a-9a41-4fac-9870-e87b1ef719df&immersive=true
   • Pause/Resume Auto-URL
   • Pause Endpoint: /pauselaunchautourl/ Resume Endpoint: /resumelaunchautourl/ Method: GET Description: Temporarily pause or resume URL auto-launch
   • Examples: https://192.168.88.73:9804/pauselaunchautourl/ https://192.168.88.73:9804/resumelaunchautourl/
   • Reset URL
   • Endpoint: /reseturl Method: GET Description: Clear auto-URL settings and reset password to default
   • Example: https://192.168.88.73:9804/reseturl
4. Popup Management APIs
   • Open Popup URL
   • Endpoint: /popupurl Method: GET Description: Open popup with saved URL
   • Example: https://192.168.88.73:9804/popupurl
   • Open Popup with Timer
   • Endpoint: /popupurl?time=<seconds> Method: GET Description: Open popup for specified duration
   • You Can also Close the Popup by setting the time to 0
   • Example: https://192.168.88.73:9804/popupurl?time=5
   • Open Popup with URL
   • Endpoint: /popupurl?url=<URL> Method: GET Description: Open popup with specific URL (when no URL saved)
   • Example: https://192.168.88.73:9804/popupurl?url= http://google.com
   • Open Popup with URL & Timer
   • Endpoint: /popupurl?url=<URL>&time=<seconds> Method: GET Description: Open popup with specific URL (when no URL saved) for specified duration
   • Example: https://192.168.88.73:9804/popupurl?url= http://google.com&time=20
5. Display Control APIs (KT-20x Touch Panels)
   • Enable/Disable Display Control
   • Enable: /displaysettingon/ Disable: /displaysettingoff/ Method: GET Description: Enable or disable display policy controls
   • Examples: https://192.168.88.73:9804/displaysettingon/  https://192.168.88.73:9804/displaysettingoff/
   • Display Configuration
   • Set Display Off Time: /setdisplayofftimevalue=<integer> Set Display Brightness: /setdisplaybrightnessvalue=<integer> Set Display Dimming Time: /setdisplaydimtime=<integer>
     Examples: https://192.168.88.73:9804/setdisplayofftimevalue=30 https://192.168.88.73:9804/setdisplaybrightnessvalue=75 https://192.168.88.73:9804/setdisplaydimtime=15
6. LED Control APIs (KT-20x Touch Panels)
   • Change LED Light Color
   • Endpoint: /ledlightcolor=value(rgb1,rgb2,rgb3) Method: GET Description: Set LED sidebar color using RGB values (0-255)
   • Example: https://192.168.88.73:9804/ledlightcolor=value(105,23,65)
   • Note: RGB values must be between 0-255
   • Check Full Screen Mode URL configuration
   • Use “Browse and select a URL” to verify Brain connectivity
   • Test manual URL entry if automatic detection fails

Display Policy Troubleshooting

1. Verify Display Policy is enabled
2. Check timeout values are properly configured
3. Test brightness controls via API
4. Confirm display responds to manual wake gestures

Migration from Kramer Control App

Overview
The Kramer Control App has been deprecated and replaced by K-Agent. All users should migrate to K-Agent for continued support and enhanced functionality.

Migration Process

Configuration Transfer

1. Identify Current URLs: Note existing Kramer Control App interface URLs
2. Update K-Agent: Input URLs using K-Agent configuration methods
3. Test Functionality: Verify all interfaces load correctly
4. Remove Old App: Uninstall deprecated Kramer Control App

Key Differences

Benefits of Migration

Enhanced Functionality

• Comprehensive API for remote management
• Advanced display and power policies
• Improved security and access control

Better Integration

• Seamless Brain system connectivity
• Enhanced interface selection tools
• Improved error handling and diagnostics

Future Support

• Active development and updates
• Enhanced feature roadmap
• Continued compatibility with new Brain versions

Appendix

Default Settings Reference

Port Requirements Summary

URL Format Examples

• Single Interface: http://192.168.1.100:8000/
• Multi-Interface with IDs: http://192.168.1.100:8000/?interface=43c286c8-ee1e-452f-b123-23afee72af1b&page=606cd9e0-9499-4d1f-8cf8-12441bee8c56
• Immersive Mode: http://192.168.1.100:8000/?interface=43c286c8-ee1e-452f-b123-23afee72af1b&page=606cd9e0-9499-4d1f-8cf8-12441bee8c56&immersive=true
• For the latest information on our products and a list of Kramer distributors, visit our website where updates to this user manual may be found.
• We welcome your questions, comments, and feedback.
• The terms HDMI, HDMI High-Definition Multimedia Interface, and the HDMI Logo are trademarks or registered trademarks of HDMI Licensing Administrator, Inc.
• All brand names, product names, and trademarks are the property of their respective owners.