User Manual
Devices Overview Details
This page provides a comprehensive overview of all devices connected to your awaBerry account, including both your personally configured devices and those shared with you. From here, you can manage your devices, connect to them, and set up new connections.
Devices Overview Details
Summary
The Devices Overview page is your central hub for managing all your awaBerry devices. It displays a clear list of devices you've connected yourself and any devices that have been shared with you by others. You can use this page to configure your existing devices, add new ones, and remove connections when they are no longer needed.
Device Main Page
The Device Main Page is your central hub for managing and interacting with your connected awaBerry device. From here, you can view essential device information, rename your device, and access various functionalities like System Monitoring, Application management, Remote Desktop (VNC), Web-to-Local port configurations, File Browsing, and SSH access. The page adapts its available features based on whether you are accessing your own device or a shared device.
Page Access
You can access this page by navigating to: /devices
Page Functionalities
The Devices Overview page offers the following key functionalities to help you manage your awaBerry devices:- View Your Connected Devices: See a list of all devices you have personally set up with awaBerry Anywhere access. Each device card displays essential information like its name, operating system, local IP address, and connection status.
- Access Device Configuration: Click on any of your connected device cards to navigate to its dedicated configuration page. Here, you can manage settings, access remote desktop, use web-to-local port forwarding, and utilize a browser-based terminal or file browser.
- Delete Your Connected Devices: Remove a device from your account by clicking the 'Delete' icon on its card. You will be asked to type 'delete' to confirm, ensuring accidental removals are prevented.
- Add New Devices: Easily initiate the setup process for new devices through several dedicated options:
- Add Raspberry Pi, Orange Pi, Banana Pi, SOC with headless connect: For single-board computers.
- Setup remote connection MAC, Windows or Linux: For connecting to standard desktop or server systems.
- Setup a docker image: To integrate devices running in Docker containers.
- Connect to a shared device: To add a connection to a device shared by another awaBerry user.
- View Shared Devices: A separate section displays devices that have been shared with your account. These are organized by 'Shared Project' cards, showing the project name, description, and the devices accessible within that project.
- Connect to Shared Devices: Click on a device listed within a 'Shared Project' card to connect to it. This grants you browser-based terminal access and other functionalities as permitted by the shared project settings.
- Remove Shared Device Connections: Disconnect from a shared project by clicking the 'Delete' icon on the 'Shared Project' card. A confirmation dialog will ensure you genuinely wish to remove the connection.
- Refresh Device List: Use the 'Refresh' button to update both your connected and shared device lists, ensuring you see the most current information.
- Demo Device Banner: If you're new and have no shared devices, a demo shared device might be automatically added, accompanied by a banner that you can dismiss.
Scenario Executions
Possible usage steps within this page
Here are some common ways you'll use the Devices Overview page:
Adding Your First Device
- Goal: Successfully connect your first device to awaBerry.
- Steps:
- On the Devices Overview page, locate and click the 'Add a new device' button or card.
- You will be redirected to the device connection setup page where you can choose your device type and follow the guided installation steps.
Configuring an Existing Device
- Goal: Access the settings and remote control options for one of your connected devices.
- Steps:
- On the Devices Overview page, simply click anywhere on the card of the device you wish to configure.
- You will be taken to that device's specific configuration page, offering various tools and controls.
Removing a Connected Device
- Goal: Permanently remove one of your personally connected devices from your awaBerry account.
- Steps:
- Find the device card you want to remove on the Devices Overview page.
- Click the small trash can (delete) icon located on the device card.
- A confirmation window will appear. To proceed, carefully type the word 'delete' into the provided text field.
- Click the 'Delete' button in the confirmation window. The device will then be removed from your list, and a success message will appear briefly.
Connecting to a Shared Device
- Goal: Access a device that has been shared with you by another awaBerry user.
- Steps:
- Scroll down to the 'Shared Devices' section on the Devices Overview page.
- Within a 'Shared Project' card, locate the specific device you wish to connect to.
- Click on the device name or its associated icon.
- After a brief loading period, you will be directed to the configuration page for that shared device, gaining access as permitted by the sharer.
Disconnecting from a Shared Device Project
- Goal: Remove your access to an entire shared project and all its associated devices.
- Steps:
- In the 'Shared Devices' section, find the 'Shared Project' card you wish to remove.
- Click the small trash can (delete) icon located next to the project name.
- A confirmation dialog will appear. Click 'Yes' to confirm the removal. The shared project will be removed from your list, and a success message will be displayed.
Possible errors which may occur on this page
While using the Devices Overview page, you might encounter the following situations:
Incorrect Deletion Confirmation for Your Own Device
- Scenario: You attempt to delete one of your connected devices, but you mistype the confirmation word.
- Why it happens: This is a security feature. The system requires you to accurately type 'delete' to prevent accidental removal of your devices. If you type anything else, the system will not proceed with the deletion.
- What you'll see: After clicking 'Delete' in the confirmation window, a small message will appear at the bottom of the screen, stating, 'Please type 'delete' to confirm device deletion.'
- How to fix: Simply reopen the deletion confirmation, type 'delete' precisely, and confirm again.
Failure to Load Devices or Shared Projects
- Scenario: When you open the Devices Overview page, or after clicking 'Refresh', instead of seeing your device lists, you see an error message like 'Error loading shared devices' or 'Error loading projects'.
- Why it happens: This usually indicates a temporary problem with your internet connection or with the awaBerry service. The application couldn't retrieve the necessary device information from our servers.
- What you'll see: An error message, often accompanied by a red icon, and a 'Retry' button.
- How to fix: First, check your internet connection. If it's working, click the 'Retry' button. If the problem persists, it might be a temporary service issue; try again after a few minutes.
