Connect New Devices Mainpage -> Add Device - how to connect
Add Device - how to connect
Summary
The 'Add Device - how to connect' page is your starting point for integrating new or existing awaBerry devices into your system. Here, you choose the type of connection that best suits your device setup, whether it's a shared device, an existing local installation, a new installation on various hardware, or a Docker container. This page also provides an overview of available awaBerry installation options.
Add existing device - select operating system
This page is the first step in connecting an existing AwaBerry device to your account. Here, you will select the operating system of the device you wish to connect. This choice helps the system prepare the correct installation instructions for the next steps.
Connect using Docker - select operating system
This page allows you to select the operating system you are using for your Docker installation. This is the first step in connecting your device to the AwaBerry platform, ensuring that the necessary installation files are prepared correctly based on your chosen operating system.
Connect a new device from scratch
This page helps you set up a new AwaBerry device by choosing how you will install the necessary software. You can either opt to create a personalized installer tailored to your needs or select an option for an installer you've already obtained. The page provides important information about different device types and connection methods, ensuring a smooth start for your new device.
Connect to a shared device
This page allows you to connect to an Awaberry Agentic device that has been shared with you. You will need an API Key and an API Secret provided by the person who shared the device. Once you enter these, the system will verify the project and allow you to add it to your list of connected devices.
Page Access
You can access this page by navigating to: /connect_steps
Page Functionalities
Connecting Your Device
At the top of the page, you'll see a clear prompt asking: "How do you want to connect to a device?" Below this, you are presented with several tile-like options, each representing a different way to connect your device:
- Shared devices: Select this if your device is managed by another user and you have received an API-Key and API-Secret to access it. Clicking this option will take you to the next steps for connecting a shared device.
- Existing device: Choose this if you have an awaBerry device already installed and accessible. This option will guide you through connecting to an existing installation by starting a routine in your device's terminal.
- New device: setup a new device: If you are setting up awaBerry on a new Desktop PC, Server, System on a Chip (like a Raspberry Pi), or a Virtual Machine, select this option. It will lead you to the process of obtaining the necessary installation medium.
- Docker container: Opt for this if you intend to set up awaBerry within a new Docker container. This choice streamlines the process for automatically connecting the container to awaBerry.
awaBerry Installation Overview
Below the connection options, you'll find an informational section titled "My Devices", which provides statistics on available awaBerry installation builds:
- For Desktop PC / Server: This section displays the number of known operating systems and available ISO installers for traditional computers and servers.
- For System on a chip: This section shows the number of known board identifiers and available IMG installers for single-board computers like Raspberry Pi or similar devices.
During the loading of these statistics, you might see a spinning circle indicator. If the data cannot be loaded, an error message will be displayed in this area.
Scenario Executions
Possible usage steps within this page
Here are typical ways users interact with this page to successfully connect a device:
- Connecting a Shared Device:
- User navigates to the 'Add Device - how to connect' page.
- The user intends to connect a device that is already set up and shared by another user.
- The user clicks on the "Shared devices" tile.
- The page successfully transitions to the 'Connect Steps Shared Device' page, where the user can enter their API-Key and API-Secret.
- Connecting an Existing Local Device:
- User navigates to the 'Add Device - how to connect' page.
- The user has an awaBerry device already running locally and wishes to connect it.
- The user clicks on the "Existing device" tile.
- The page successfully transitions to the 'Connect Steps Existing Device' page, providing instructions for terminal-based setup.
- Setting Up a New Device (PC/Server/SoC):
- User navigates to the 'Add Device - how to connect' page.
- The user wants to install awaBerry on a brand new Desktop PC, Server, or a System on a Chip.
- The user clicks on the "New device: setup a new device." tile.
- The page successfully transitions to the 'Connect Steps New Device' page, guiding the user to obtain the installation medium.
- Deploying via Docker:
- User navigates to the 'Add Device - how to connect' page.
- The user prefers to deploy awaBerry within a Docker container.
- The user clicks on the "Docker container" tile.
- The page successfully transitions to the 'Connect Steps Docker' page, detailing the Docker container setup process.
Possible errors which may occur on this page
While the primary actions lead to other pages, certain situations can lead to display errors:
- Failure to Load Device Installation Statistics:
- Error: Instead of seeing statistics for "For Desktop PC / Server" and "For System on a chip", an error message is displayed (e.g., "Failed to load data").
- Why it happens: This typically occurs if there's a problem with your internet connection or if the awaBerry server providing this information is temporarily unavailable. The page attempts to fetch the latest installation build statistics, and if this process fails, it will inform you of the issue.
- No Device Installation Statistics Data:
- Error: The 'My Devices' section shows a message like "No data available" where the statistics for installers and operating systems should be.
- Why it happens: This indicates that while the page could connect to the server, no specific build data was returned. This might be a temporary issue with the data source or a configuration problem.
