Device Automation -> Smart Automization Framework - Setup

Smart Automization Framework - Setup

Summary

The Smart Automization Setup page is your starting point for using intelligent automation with your connected devices. It ensures a secure connection, verifies your API key for Google Gemini, and helps you install the necessary platform on your device. You'll see different screens depending on your connection status and setup progress, guiding you through each step.

Project Overview

The Project Overview page is your central hub for managing all your Smart Automation projects. Here, you can get a quick glance at all your automation tasks, create new ones, make changes to existing projects, enable or disable them, and monitor their recent activity. You can also quickly access your overall automation summary in a web portal and adjust application settings.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

1. Connection Status Display

  • Initializing/Reconnecting: Shows an animated loading indicator while the app attempts to establish or re-establish a secure connection to your device.
  • Connected: Once successfully connected, the main setup or overview page for Smart Automization will appear.
  • Connection Timeout: If the connection takes too long, an error message will inform you, offering a button to retry.
  • Session Expired: If your secure session ends due to inactivity or other reasons, a message will appear, offering a button to reconnect.
  • Connection Failed: A general error message indicating a problem with connecting, providing links to troubleshoot or configure your device.
  • Unencrypted Connection Not Allowed: If the device or network settings prevent a secure connection, a specific error will appear, guiding you to review security configurations.

2. Google Gemini API Key Configuration

  • Prompt: If your Google Gemini API key is not set up, a message will appear explaining that it's required for smart automization.
  • "Setup key" Button: Clicking this button opens a pop-up window where you can enter and configure your Google Gemini API key. After entering the key, the system will verify it.

3. Smart Automization Platform Installation

  • Prompt: If the Smart Automization platform is not yet installed on your connected device, a message will appear, prompting you to begin the installation.
  • "Start Installation" Button: Clicking this button will guide you through the full-screen installation process on your device. Once complete, you will return to this page.

4. Smart Automization Project Overview

  • Once your device is connected, the API key is configured, and the platform is installed, you will see the main overview of your Smart Automization projects.

Scenario Executions

Possible usage steps within this page

Scenario 1: Full Setup and Access

  1. The page starts initializing the connection.
  2. The connection successfully establishes.
  3. The system checks for your Google Gemini API key. If not configured, you are prompted to set it up.
  4. You click "Setup key", enter your API key in the pop-up, and save it. The pop-up closes.
  5. The system then checks if the Smart Automization Platform is installed on your device. If not, you are prompted to install it.
  6. You click "Start Installation" and follow the on-screen instructions in the full-screen installer.
  7. Upon successful installation, you are returned to this page, which now displays your Smart Automization project overview.

Goal: Successfully connect, configure API key, install platform, and view projects.

Scenario 2: Already Configured, Platform Not Installed

  1. The page starts initializing the connection.
  2. The connection successfully establishes.
  3. The system finds that your Google Gemini API key is already configured.
  4. The system checks if the Smart Automization Platform is installed on your device. If not, you are prompted to install it.
  5. You click "Start Installation" and complete the installation process.
  6. Upon returning, the page displays your Smart Automization project overview.

Goal: Connect, install platform, and view projects.

Scenario 3: All Setup Complete, Direct Access to Projects

  1. The page starts initializing the connection.
  2. The connection successfully establishes.
  3. The system verifies that your Google Gemini API key is configured and the Smart Automization Platform is installed.
  4. The page immediately displays your Smart Automization project overview.

Goal: Directly access Smart Automization projects.

Possible errors which may occur on this page

Error: "Connection Timeout"

Why it happens: The application tried to connect to your device but didn't receive a response within the expected time. This could be due to network issues, your device being offline, or a slow connection.

User Action: A "Restart Terminal" button will appear, allowing you to try connecting again. Check your device's network connection and ensure it's online if the issue persists.

Error: "Session Expired"

Why it happens: Your secure connection to the device was active but has now ended, possibly due to inactivity or a logout.

User Action: A "Restart Terminal" button will appear to re-establish your session.

Error: "Connection Failed"

Why it happens: A general error prevented the secure connection from being established. This could stem from various issues, such as incorrect device credentials, firewall blocks, or other network problems.

User Action: The page will offer links to a Frequently Asked Questions (FAQ) section for troubleshooting or a button to navigate back to the device configuration page to review settings.

Error: "Unencrypted SSH Connection Not Allowed"

Why it happens: The system detected an attempt to connect to your device using an unencrypted method, which is not permitted for security reasons. Your device or network might be configured to disallow secure (encrypted) SSH connections.

User Action: The page will display a button to go to "Security Settings" for your device, where you can adjust its SSH connection security.

Error: "Platform is not supported"

Why it happens: The Smart Automization Platform cannot be installed or run on your specific device's operating system or hardware.

User Action: This indicates a fundamental incompatibility. You may need to use a different device or check the platform requirements.

Error: "Error loading installation status" or "No data"

Why it happens: The application encountered a problem when trying to determine if the Smart Automization Platform is installed on your device. This could be a temporary issue, a communication problem with the device, or an unexpected response.

User Action: The page might automatically retry. If not, refreshing the page or navigating away and back could resolve a temporary glitch. If the problem persists, ensure your device is properly connected and functioning.

Up to User Manual Main Page