The AI-Native Device Platform
User Manual

Device Main Page

This user manual page provides a comprehensive guide to the Device Main Page within the awaBerry connect application. Learn how to monitor your device, manage applications, connect remotely, browse files, and configure various settings.

Device Main Page

Summary

The Device Main Page is your central hub for managing and interacting with your connected awaBerry device. From here, you can view essential device information, rename your device, and access various functionalities like System Monitoring, Application management, Remote Desktop (VNC), Web-to-Local port configurations, File Browsing, and SSH access. The page adapts its available features based on whether you are accessing your own device or a shared device.

awaBerry Anywhere: Remote Desktop Access

awaBerry Anywhere provides secure and efficient remote desktop access to your devices, supporting VNC and RDP connections without the need for open ports or VPNs. This page offers comprehensive guidance on setting up remote desktop functionality, connecting via browser or dedicated VNC clients, and managing VNC server sessions, including scheduling automated starts and monitoring daily usage. awaBerry also offers zero trust device access, SSH, a file browser, and an agentic API for device automation.

awaBerry: Secure Zero Trust Device Access (Web-to-Local)

awaBerry provides secure, zero-trust device access through web-to-local port forwarding, enabling seamless connections to applications like RDP, SSH, and file browsers on remote devices. This eliminates the need for open firewall ports or VPNs, ensuring your devices remain secure. It also supports agentic API for device automization.

Smart Terminal

The Smart Terminal is your primary interface for interacting with connected devices. It provides an intelligent chat-like environment where you can enter commands, receive clear results, and even review proposed actions. You can manage your terminal session, activate special permissions, and switch between an intelligent view and a raw SSH console. The terminal assists you by highlighting commands that require special attention, such as administrator privileges or user input, and allows for automated execution sequences.

Web-Based SSH Terminal

The Web-Based SSH Terminal offers a powerful way to directly control your connected device using SSH (Secure Shell) commands. This interface allows you to send commands, view real-time output, manage multiple terminal sessions, and access various tools for efficient device interaction, all within your web browser.

Web-Based File Browser

The Web-Based File Browser provides a comprehensive interface for interacting with the file system of your connected device. You can navigate through directories, perform various file and folder operations, and even manage administrative access. Special considerations apply for demo devices, where certain operations are restricted.

Device Security Settings

This page allows you to manage the security settings of your awaBerry device. You can configure various aspects of device security, including end-to-end encryption, firewall rules, SSH (Secure Shell) port access, and administrator access. These settings are crucial for protecting your device and ensuring its smooth operation within the awaBerry ecosystem.

Device Monitoring

This page provides a detailed overview of your device's current operational status. It displays critical information such as when the data was last updated, how long the system has been running, and granular details about CPU, memory, network interfaces, and currently active processes. CPU and memory usage are visually indicated with colors (green for low, orange for medium, red for high) for quick assessment of system health. This allows you to monitor your device's performance and identify potential issues efficiently.

Page Access

You can access this page by navigating to: /devices_configure

Page Functionalities

  • Device Information Display: At the top, you will see a summary of your device's hardware, including its operating system, number of CPUs, and amount of RAM. This provides a quick overview of your device's capabilities.
  • Rename Device: Adjacent to the device information, there is an 'Edit' icon (). Clicking this icon allows you to change the name of your connected device through a simple dialog box. This helps you personalize and identify your devices easily.
  • Shared Device Banner: If you are connected to a device that has been shared with you, a blue banner will appear at the top, indicating "Connection to a shared device". This banner reminds you that certain functionalities might be restricted.
  • Device Hub Description: A grey box provides a brief description of the 'Device Hub', explaining the various access methods and automation capabilities available for your device, such as Remote Desktop (VNC), zero-trust web-to-local, browser-based SSH, and the Smart Automation Framework.
  • Interactive Functionality Tiles: The main part of the page consists of a grid of tiles, each representing a specific functionality. These tiles allow you to:
    • System Monitor: View real-time performance data and health metrics of your device.
    • Applications: Manage installed applications and services on your device.
    • Connect to Device (Session): Establish a secure session to interact with your device. (Note: May have license time limits).
    • Remote Desktop (VNC): Access your device's graphical user interface remotely. The tile indicates if VNC is configured.
    • Web-To-Local: Configure and manage secure tunnels for web services running on your device. The tile shows the number of configured ports.
    • File Browser: Access and manage files and folders on your device.
    • Smart Automation: Utilize the Smart Automation Framework for task automation. The tile shows if the framework is installed and the number of projects.
    • SSH: Establish a secure shell connection to your device. The tile indicates the status of the SSH port.
  • Tile States and Tooltips:
    • Hover Effect: When you move your mouse over a tile, its border changes color, indicating it is interactive.
    • Disabled Tiles: Some tiles may appear greyed out if they are "Not available in 'Shared device' view." Clicking these will display an alert explaining the restriction.
    • Locked Tiles: Certain functionalities, especially in a shared device context (e.g., VNC, Web-To-Local), may be locked by the device owner's project setup. These tiles will show a small lock icon () in the top-left corner and will also be greyed out. Clicking them will display an alert stating "Access not allowed via shared project setup."
    • Tooltips: Hovering over any tile will display a helpful tooltip message, providing more context about its function or why it might be disabled/locked.

Scenario Executions

Possible usage steps within this page

Scenario 1: Viewing Device Information and Renaming a Device

This scenario guides you through checking your device's basic information and personalizing its name.

  • Step 1: Access the Device Main Page. Observe the displayed CPU, RAM, and Operating System details for your connected device.
  • Step 2: Locate and click the 'Edit' icon () next to your device's name.
  • Step 3: In the 'Rename Device' dialog that appears, enter a new, descriptive name for your device.
  • Step 4: Click the 'Save' button in the dialog. The page will refresh, and your device will now display its new name.
  • Goal: Successfully view device hardware information and rename your device.

Scenario 2: Navigating to Device Functionalities (e.g., System Monitor)

This scenario demonstrates how to navigate to one of the device's functionalities.

  • Step 1: On the Device Main Page, locate the 'System Monitor' tile.
  • Step 2: Click on the 'System Monitor' tile.
  • Step 3: The application will navigate you to the System Monitor view, where you can observe your device's performance.
  • Goal: Successfully navigate to the System Monitor page.

Scenario 3: Initiating a Remote Desktop (VNC) Connection

This scenario describes connecting to your device via Remote Desktop, assuming it's configured.

  • Step 1: On the Device Main Page, ensure your device shows "Remote Desktop is ready for remote desktop connections" under the VNC tile.
  • Step 2: Click on the 'Remote Desktop (VNC)' tile.
  • Step 3: The application will initiate the process to connect you to your device's graphical desktop.
  • Goal: Successfully initiate a Remote Desktop session to your device.

Scenario 4: Managing Smart Automation Projects

This scenario shows how to access and manage your automation projects.

  • Step 1: On the Device Main Page, locate the 'Smart Automation' tile. It should display "X projects are available" (where X is a number).
  • Step 2: Click on the 'Smart Automation' tile.
  • Step 3: You will be directed to the Smart Automation section to manage your projects.
  • Goal: Successfully access the Smart Automation project management area.

Possible errors which may occur on this page

Error 1: Accessing Restricted Functionality on a Shared Device

When connected to a shared device, some functionalities might be intentionally blocked by the device owner or are generally not available. This prevents unauthorized access or actions.

  • Cause: You are using a 'Shared device' connection, and the specific functionality (e.g., Applications, Smart Automation, Web-To-Local port configuration, or SSH) is either not available in shared view or has been explicitly locked by the device owner through their project settings.
  • Execution: You click on a greyed-out tile (e.g., 'Applications' or a locked 'VNC' tile with a lock icon).
  • Result: An alert dialog appears, stating either "Not available in 'Shared device' view" or "Access not allowed via shared project setup," and you are unable to proceed to that functionality.
  • Resolution: You cannot access this functionality under the current connection type or permissions. If you require access, contact the device owner.

Error 2: Session Time Limit Reached for 'Connect to Device'

Your license may have a limit on the total time you can connect to a device.

  • Cause: You have reached the maximum allowed session time for 'Connect to Device' under your current license plan.
  • Execution: You click on the 'Connect to Device (Session)' tile.
  • Result: Instead of connecting, the application navigates you to a page asking you to upgrade your license.
  • Resolution: Upgrade your license to extend your session time limits, or wait for your session time to reset if applicable.

Error 3: Page Redirects to Devices List (Missing Device Information)

If essential information about the connected device cannot be loaded, the page cannot function correctly.

  • Cause: The application failed to load critical information for the currently selected device, possibly due to a data corruption or network issue, or the device was de-selected.
  • Execution: The Device Main Page attempts to load.
  • Result: The page automatically redirects you back to the main '/devices' list, preventing you from interacting with an unconfigured or unknown device.
  • Resolution: Ensure your device is properly configured and selected. Try refreshing the application or re-selecting your device from the devices list.
Navigate ← Devices Overview Details ← Devices Overview ← awaBerry Device Management ← awaBerry User Manual Main Page