Kramer K-Agent User Manual

1. 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.

1.1 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

1.2 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

2. Getting Started

2.1 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).

2.2 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.

3. K-Agent Overview

3.1 Application Interface

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

[Image: Main Settings panel showing Full Screen Mode, Display Policy, and Lock Tablet options. The interface has a left panel with toggles for Full Screen Mode, Display Policy, and Lock Tablet, and a right panel displaying configuration details.]

3.1.1 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

3.2 Navigation and Access

Accessing K-Agent Settings

1. Swipe up from the center bottom of the screen.
   • Note: The iPad app requires a 2-finger right-to-left gesture and does not support a passcode.
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.

4. Initial Setup and Configuration

4.1 First-Time Setup

After installing your touch panel, follow these steps for initial configuration:

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.

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.

Step 3: Set Up URL Configuration

Choose one of three methods to configure your interface URL:

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.

Method 2: API Configuration (Recommended for System Integrators)

• Use API calls to remotely configure URLs.
• See API Reference section for details.

Method 3: Manual Entry (Not Recommended)

• Manually type the complete URL in the configuration field.
• Ensure exact syntax and formatting.

5. User Interface Configuration

5.1 Full Screen Mode

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

[Image: Full Screen Mode settings showing URL configuration fields. The interface includes input fields for 'Tablet Full-Screen URL' and 'Secondary Control Address', with 'Immersive' checkboxes next to them. A 'Browse and select a URL' button is present. A 'Tablet Popup URL' field is also shown. A 'RESUME AUTO-LAUNCH-URL' button is at the bottom.]

5.1.1 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:

Secondary Control Address

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

Prerequisites for Secondary Control Address

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.

5.1.2 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.

5.2 Browse and Select URL Feature

The Browse and Select feature simplifies URL configuration:

[Image: Embedded browser showing interface selection. The interface displays a URL bar, search options, and an on-screen keyboard.]

5.2.1 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 embedded browser.
   • Example: 192.168.88.253:8000

[Image: Embedded browser showing interface selection. The interface displays a list of available interfaces like 'Desk' and 'Lounge'.]

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.

6. Advanced Settings

6.1 Display Policy

Display Policy provides comprehensive power management and display control.

[Image: Display Policy configuration panel. The interface shows a slider for 'Set Default Brightness Level' and input fields for 'Display Timeout (Timer)' including 'Dimming' and 'Display Off' durations.]

6.1.1 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.

6.1.2 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.

6.2 Lock Tablet

Lock Tablet provides security and access control features.

[Image: Lock Tablet configuration showing PIN and USB options. The interface includes a 'PIN to Unlock screen' input field and a 'USB Lock' checkbox.]

6.2.1 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.

6.2.2 PIN Entry Process

[Image: PIN entry keypad overlay. The overlay displays a prompt to 'Enter the pin to minimize the application.' with an input field and 'CANCEL'/'OK' buttons.]

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.

6.3 Pause and Resume Functionality

K-Agent provides operational pause and resume capabilities:

6.3.1 Pause Operation

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

6.3.2 Resume Operation

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

[Image: Resume Auto-Launch-URL button in settings. This shows the main settings interface with the 'RESUME AUTO-LAUNCH-URL' button highlighted.]

7. API Reference

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

7.1 API Endpoints Overview

All API calls use the following format:

• HTTP: http://<device_ip>:9803/<endpoint>
• HTTPS: https://<device_ip>:9804/<endpoint>

7.2 Health and Status APIs

Health Check

Endpoint: /health/
Method: GET
Response: {"status":"Up"}
Description: Verify K-Agent is running and responsive.

Example:

7.3 URL Management APIs

Launch URL (Non-Immersive)

Endpoint: /launchurl?<URL>
Method: GET
Description: Launch URL in standard browser mode.

Example:

Launch Kramer URL (Immersive Mode)

Endpoint: /launchkramerurl?<URL>
Method: GET
Description: Launch URL in full-screen immersive mode.

Example:

Pause/Resume Auto-URL

Pause Endpoint: /pauselaunchautourl/
Resume Endpoint: /resumelaunchautourl/
Method: GET
Description: Temporarily pause or resume URL auto-launch.

Examples:

Reset URL

Endpoint: /reseturl
Method: GET
Description: Clear auto-URL settings and reset password to default.

Example:

7.4 Popup Management APIs

Open Popup URL

Endpoint: /popupurl
Method: GET
Description: Open popup with saved URL.

Example:

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:

Open Popup with URL

Endpoint: /popupurl?url=<URL>
Method: GET
Description: Open popup with specific URL (when no URL saved).

Example:

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:

7.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:

Display Configuration

Set Display Off Time: /setdisplayofftimevalue=<integer>
Set Display Brightness: /setdisplaybrightnessvalue=<integer>
Set Display Dimming Time: /setdisplaydimtime=<integer>

Examples:

7.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:

Note: RGB values must be between 0-255.

7.7 API Response Examples

7.7.1 Successful API Response

{
    "status": "success",
    "message": "Browser will be launched with given URL"
}

7.7.2 Health Check Response

{
    "status": "Up"
}

8. Troubleshooting

8.1 Common Configuration Issues

8.1.1 Incorrect URL Syntax

Problem: Interface fails to load or displays error.

Solution:

1. Verify URL format matches example syntax.
2. Ensure Brain IP address and port are correct.
3. Confirm interface and page IDs are valid.
4. Refer to this user manual before contacting customer support.

Correct URL Format:

8.1.2 Network Connectivity Issues

Problem: API calls fail or timeout.

Solution:

1. Verify firewall settings allow required ports:
   • K-Agent: 9803 (HTTP) or 9804 (HTTPS)
   • Brain: 8000-8049 or 9000-9049 (HTTPS)
2. Confirm Brain system is online and provisioned.
3. Test network connectivity between devices.
4. Check for network routing issues.

8.1.3 Authentication and Access Issues

Problem: Cannot access settings or API responses fail.

Solution:

1. Verify correct PIN entry (default: 9428).
2. Ensure proper swipe gesture from center bottom.
3. Check if USB lock is preventing access.
4. Restart K-Agent application if needed.

8.2 Diagnostic Procedures

8.2.1 API Connectivity Test

1. Open web browser on network-connected computer.
2. Navigate to: https://[TOUCH_PANEL_IP]:9804/health/
3. Verify response: {"status":"Up"}
4. If no response, check network and firewall settings.

8.2.2 URL Configuration Verification

1. Access K-Agent settings via PIN entry.
2. Check Full Screen Mode URL configuration.
3. Use "Browse and select a URL" to verify Brain connectivity.
4. Test manual URL entry if automatic detection fails.

8.2.3 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.

9. Migration from Kramer Control App

9.1 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.

9.2 Migration Process

9.2.1 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.

9.2.2 Key Differences

9.3 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.

10. Appendix

10.1 Default Settings Reference

10.2 Port Requirements Summary

10.3 URL Format Examples

Single Interface:

Multi-Interface with IDs:

Immersive Mode: