User Manual
Connect to a shared device
This page allows you to connect to an Awaberry Agentic device that has been shared with you by entering an API Key and API Secret.
Connect to a shared device
Summary
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_shared
Page Functionalities
- Information Text: At the top, you will see a message guiding you to "Please provide the api key and secret" to connect to a shared device.
- API Key Field: An input field labeled "API Key" where you enter the unique key provided for accessing the shared device. This field is required.
- API Secret Field: An input field labeled "API Secret" where you enter the secret code associated with the API Key. This field is also required.
- Continue Button: After entering both the API Key and API Secret, click this button to proceed. The system will attempt to load the shared project details. While loading, a spinning indicator will show.
- Error Message Area: If there are any issues (e.g., missing credentials, invalid credentials, project not found, project not allowing terminal access), an error message will be displayed in a red box, informing you about the problem.
- Loaded Project Details (after successful lookup): If the API Key and Secret are valid, this section will appear, showing:
- Project Name: The name of the shared project.
- Description: A brief description of the shared project.
- Accessible Devices: A list of device names that are part of this shared project and that you can access. If no devices are configured, it will state "No devices configured".
- Back Button: Allows you to return to the input form to re-enter credentials or search for another project.
- Add shared device(s) Button: Click this button to finalize the connection and add the shared device(s) to your Awaberry account. While adding, a spinning indicator will show.
Scenario Executions
Possible usage steps within this page
Scenario: Successfully connect a shared device
- Step 1: Enter a valid API Key into the "API Key" field.
- Step 2: Enter a valid API Secret into the "API Secret" field.
- Step 3: Click the "Continue" button.
- Step 4: The page will display the "Loaded API Project" section, showing the project name, description, and accessible devices.
- Step 5: Click the "Add shared device(s)" button.
- Result: The shared device(s) are successfully added, and you are navigated to the "Shared Devices" page.
Possible errors which may occur on this page
Scenario: Attempt to continue with empty API Key
- Error: An error message "Please enter API key" appears below the API Key field.
- Reason: The API Key field was left blank when attempting to continue.
Scenario: Attempt to continue with empty API Secret
- Error: An error message "Please enter API secret" appears below the API Secret field.
- Reason: The API Secret field was left blank when attempting to continue.
Scenario: Attempt to load project with invalid API Key/Secret
- Error: A red error box appears with a message like "Failed to load project: Exception: Failed to load project: [specific error details]" or "Failed to parse project: [specific error details]".
- Reason: The provided API Key and/or API Secret were incorrect, or there was a network issue preventing the project from being loaded.
Scenario: Loaded project does not allow terminal access
- Error: A red error box appears with the message "Project does not allow terminal access".
- Reason: The project associated with the API Key and Secret is valid, but its configuration explicitly prevents terminal access, which is required for this connection type.
Scenario: Failure to add the shared device after loading
- Error: A red error box appears within the loaded project details, displaying "Failed to add shared device".
- Reason: An issue occurred while trying to save the shared device information to your local database or connect it to your account after the project details were successfully loaded.
