User Manual
Add Device - how to connect
User manual page for connecting a new device to awaBerry, explaining different connection methods like shared, existing, new installation, or Docker.
Add Device - how to connect
Summary
This page guides you through the initial step of connecting a device to your awaBerry account. Connecting your device allows you to access it remotely and utilize smart automation features. You will choose from several connection methods: connecting to a shared device, integrating an existing device, setting up a completely new device, or deploying a Docker container. The page also provides an overview of available installers for various device types.
Add existing device - select operating system
This page is part of the process to connect an existing device to awaberry. Here, you will choose the operating system installed on your device. Your selection helps guide the subsequent connection steps to ensure compatibility and a smooth setup. After selecting, the system will prepare to move to the next stage of the connection, provided you have available device slots on your license.
Connect a new device from scratch
This page guides you through the initial setup process for a new AwaBerry device. You will select the installer source, specifically focusing on creating a custom, 'bespoke' installer. The system manages the display of any error messages and leads you to the next steps for connecting your device.
Connect using Docker - select operating system
This page is the first step in connecting your device to awaBerry using Docker. It allows you to choose the operating system where Docker will be installed. Once you select an operating system, the system will prepare the necessary setup to proceed with the connection.
Connect to a shared device
The 'Connect to a shared device' page enables you to establish a connection with an Awaberry Agentic device that someone else has shared. You will need an API Key and an API Secret provided by the device owner to securely access and manage the shared device. After entering these credentials, the system will verify the project details and allow you to add the shared device to your account.
Page Access
You can access this page by navigating to: /connect_steps
Page Functionalities
The page presents various options to connect your device, along with descriptive text and relevant icons to help you make an informed choice:
- awaBerry Logo: Displays the awaBerry logo at the top of the page.
- Introductory Text: A question 'How do you want to connect to a device?' followed by a summary explaining the benefits of connecting a device and an overview of the setup options.
- Connection Method Tiles:
- Connection to a shared device: Select this if your device is managed by another user and you have received an API-Key and API-Secret. Tapping this tile will direct you to the shared device connection process.
- Existing device: Choose this option for MAC, Linux, and Windows-based devices that are already accessible. Tapping this tile will guide you through running the awaBerry installation routine directly on your device.
- New device: setup a new device.: Use this for new Desktop PCs / Servers, System on a chip devices (like Raspberry Pi), or Virtual Machines. Tapping this tile will lead you to obtaining the necessary installation medium.
- Docker container: Select this to set up a new Docker container that automatically connects to awaBerry. Tapping this tile will guide you through the Docker deployment process.
- Installer Statistics: Provides information about available installers, categorized for 'For Desktop PC / Server' and 'For System on a chip' (e.g., number of known devices, available operating systems, and total installers). These statistics are loaded dynamically when the page is accessed.
Scenario Executions
Possible usage steps within this page
- Connecting to a Shared Device:
You have received credentials (API-Key and API-Secret) for a device managed by another awaBerry user. You want to connect to this device.
- On the 'Add Device - how to connect' page, locate and tap the tile titled 'Connection to a shared device'.
- The system will automatically navigate you to the dedicated page for connecting to shared devices, where you can enter your credentials.
- Connecting an Existing Device:
You have an existing MAC, Linux, or Windows device that you want to connect to awaBerry, and you have direct access to its terminal.
- On the 'Add Device - how to connect' page, tap the tile labeled 'Existing device'.
- You will be redirected to the instructions page for connecting existing devices, where you'll find guidance on running the installation routine via your device's terminal.
- Setting up a New Device:
You are setting up a completely new device, such as a Desktop PC, Server, System on a Chip (like a Raspberry Pi), or a Virtual Machine, and need the appropriate installation medium.
- From the 'Add Device - how to connect' page, tap the tile 'New device: setup a new device.'.
- The system will take you to a page where you can find and download the required installation medium for your new device.
- Deploying a Docker Container:
You want to connect a new device by deploying it as a Docker container, which will automatically connect to awaBerry.
- On the 'Add Device - how to connect' page, select the tile titled 'Docker container'.
- You will be guided to the instructions and resources for setting up your device as an awaBerry-connected Docker container.
Possible errors which may occur on this page
- System Error during Installer Data Loading:
When the page loads, it attempts to fetch information about available Desktop PC/Server and System on a Chip installers. If there are network issues or problems with the awaBerry server providing this data, the statistics might not display correctly.
- Upon loading the 'Add Device - how to connect' page, instead of seeing numbers for 'available operating systems', 'available ISO installers', 'known devices', and 'available IMG installers', you might see an error message like 'No data found.' or a specific error message if the connection fails.
- Why this error happens: This typically occurs due to temporary internet connectivity problems or an issue with the awaBerry backend services responsible for providing the installer statistics.
- What to do: Check your internet connection. If your connection is stable, try refreshing the page. If the problem persists, it may indicate a temporary service disruption on the awaBerry side.
