User Manual

Smart Automization Framework - Setup

This page is the central hub for the awaBerry Smart Automization Framework. It guides you through setting up and managing powerful automation routines on your device. You can configure your Google Gemini API key, install the automization platform, and access your project overview to create and execute scheduled tasks.

Smart Automization Framework - Setup

Summary

The Smart Automization Framework is your powerful tool to automate routines on your device. It acts as a web-based, pre-configured interface to the Google Gemini CLI, allowing you to instruct the creation of routines and schedule their execution. This page manages the initialization of the platform, ensures your device is connected, verifies your Google Gemini API key, and checks the installation status of the Smart Automization Platform.

Page Access

You can access this page by navigating to: /automization

Page Functionalities

  • Connection Status Display: The page starts by showing the current status of the connection to your device. This can be "Initializing" (connecting), "Retrying Connection" (trying to connect again), "Connected" (successfully connected), "Connection Timed Out" (connection attempt took too long), "Disconnected" (session ended), "Failed" (connection failed for other reasons), or "Unencrypted Connection Not Allowed" (your device requires a secure connection).
  • Google Gemini API Key Setup: If you haven't configured your Google Gemini API key, the page will prompt you to do so. A "Setup key" button will appear. Clicking this button opens a pop-up window where you can enter and configure your API key. This key is essential for the Smart Automization Framework to communicate with Google Gemini.
  • Smart Automization Platform Installation: If the Smart Automization Platform is not yet installed on your device, the page will inform you and provide a "Start Installation" button. Clicking this button will guide you through the installation process.
  • Platform Not Supported Message: In some cases, your device's platform might not be supported by the Smart Automization Framework. If this happens, a message indicating "Platform is not supported" will be displayed.
  • Smart Automization Project Overview: Once the platform is installed and your API key is configured, the page will display the "Smart Automization Project Overview". This is where you can manage your automation projects, create new routines, and schedule tasks.
  • Session Management: The system actively checks if your session is still active and keeps the connection alive. If the session expires or becomes invalid, the UI will update, and you might be prompted to reconnect.

Scenario Executions

Possible usage steps within this page

Scenario: Successful API Key Configuration and Platform Installed

  • Goal: Successfully configure the Google Gemini API key, install the Smart Automization Platform, and access the project overview.
  • Steps:
    1. Ensure your device is connected.
    2. Navigate to the Smart Automization Framework page.
    3. If prompted, click "Setup key" and enter a valid Google Gemini API key in the pop-up.
    4. Verify that the API key is successfully saved and the pop-up closes.
    5. If prompted, click "Start Installation" to initiate the Smart Automization Platform installation.
    6. Observe the page transitioning to the Smart Automization Project Overview upon successful installation.

Possible errors which may occur on this page

Scenario: Connection Timeout During Initialization

  • Occurring Error: The connection attempt to your device takes too long and times out.
  • Why it happens: This usually occurs due to network issues, the device being offline, or firewall restrictions preventing a timely connection.
  • Steps:
    1. Navigate to the Smart Automization Framework page when there's a connectivity issue with your device.
    2. Observe the "Initializing" state, followed by a "Connection Timed Out" message.
    3. You will be presented with an option to restart the connection attempt.

Scenario: Attempting to Use Without API Key

  • Occurring Error: The system prevents access to automization features because the Google Gemini API key is missing.
  • Why it happens: The Smart Automization Framework requires a valid Google Gemini API key to function. Without it, intelligent routines cannot be processed.
  • Steps:
    1. Navigate to the Smart Automization Framework page without a configured Google Gemini API key.
    2. Observe the prompt: "Google Gemini API key not configured" and the "Setup key" button.
    3. If you close the API key setup pop-up without providing a valid key, the prompt will remain displayed, preventing further access to automization features.

Scenario: Device Platform Not Supported

  • Occurring Error: The Smart Automization Platform cannot be installed or run on your device.
  • Why it happens: Your device's operating system or hardware architecture is not compatible with the Smart Automization Framework.
  • Steps:
    1. Navigate to the Smart Automization Framework page with a device whose platform is not supported.
    2. Observe the message "Platform is not supported" displayed prominently with a red icon, indicating incompatibility.