User Manual

Web-Based File Browser

This page allows you to manage files and folders on your connected device directly from your web browser, including creating, editing, uploading, downloading, renaming, and deleting items.

Web-Based File Browser

Summary

The Web-Based File Browser provides a comprehensive interface for interacting with the file system of your connected device. You can navigate through directories, perform various file and folder operations, and even manage administrative access. Special considerations apply for demo devices, where certain operations are restricted.

Page Access

You can access this page by navigating to: /devices_filebrowser

Page Functionalities

  • Current Folder Display: At the top of the browser, you will see the name of the folder you are currently viewing. Hovering your mouse over this name will reveal the full path of the directory.
  • Level Up Button: An up-arrow icon allows you to move one level up in the directory structure, returning to the parent folder.
  • Admin User Toggle: A shield icon is available to activate or deactivate administrator privileges for file system operations. When activated, you may be able to perform actions in restricted areas.
  • Create New File Button: A file with a pencil icon opens a dialog where you can name and choose the type of a new empty file. Upon creation, the file content editor will open for you to start typing.
  • Create New Folder Button: A folder with a plus icon opens a dialog for creating a new empty folder within the current directory.
  • Upload Button: An upload icon opens a dialog, allowing you to select and upload files from your local computer to the currently displayed directory on the device.
  • File/Folder List: The main area of the browser displays a list of all files and folders present in the current directory.
    • Folders: Clicking on a folder will navigate you inside it, displaying its contents. Next to each folder, a three-dots menu offers options:
      • Download Directory (Zip): Downloads the entire folder and its contents as a compressed .zip file to your computer.
      • Rename Directory: Allows you to change the name of the folder.
      • Delete Directory: Permanently removes the folder and all files and subfolders within it.
    • Files: Clicking on an editable file (like a text file or configuration file) will open it directly within the browser for editing. Next to each file, a three-dots menu offers options:
      • Edit: Opens the file for editing (same as clicking the file).
      • Download: Downloads the selected file to your local computer.
      • Rename File: Allows you to change the name of the file.
      • Delete File: Permanently removes the file from the device.
  • Web-To-Local Recommendation: A dedicated section at the bottom may appear, suggesting the use of the "Web-To-Local" feature for larger file uploads or for advanced users. This section provides a button to initiate the setup for this feature and can be hidden if not needed.
  • Permission Error Message: If you attempt to access a folder without the necessary permissions, a message like "Folder is not readable (permission issue)" will be displayed.
  • Demo Device Restrictions: When you are connected to a demo device, a banner will appear, informing you that file browser functionalities are limited, and most file/folder operations will be disabled to prevent unauthorized changes.

Scenario Executions

Possible usage steps within this page

  1. Navigating to a subfolder:
    • Start: You are in the root directory.
    • Action: Click on a folder named my_documents.
    • End: The file browser now displays the contents of the my_documents folder. The folder name display at the top changes to my_documents.
  2. Creating a new text file:
    • Start: You are in any accessible folder.
    • Action: Click the "Create New File" icon. A dialog appears. Enter "report" as the file name and select "txt" as the file type. Confirm creation.
    • End: A new file named report.txt is created in the current folder, and the file content editor opens, allowing you to type in the file.
  3. Uploading a file:
    • Start: You are in the /home/user directory.
    • Action: Click the "Upload" icon. A file upload dialog appears. Select a file from your computer, e.g., my_script.sh.
    • End: The my_script.sh file is uploaded to the /home/user directory on your connected device.
  4. Renaming a folder:
    • Start: You are in a directory containing a folder named old_logs.
    • Action: Click the three-dots menu next to old_logs, then select "Rename Directory". In the dialog, change the name to archived_logs.
    • End: The folder's name is updated to archived_logs.
  5. Downloading a file:
    • Start: You are in a directory containing a file named config.json.
    • Action: Click the three-dots menu next to config.json, then select "Download".
    • End: The config.json file is downloaded to your local computer through your web browser.
  6. Activating administrator user:
    • Start: You are in the file browser with standard user permissions.
    • Action: Click the "Activate / deactivate administrator user" shield icon. You might be prompted for credentials.
    • End: Your session now has administrator privileges, allowing you to perform operations in restricted areas (if allowed by device configuration).

Possible errors which may occur on this page

  1. Permission problem when changing directory:
    • Error: When attempting to navigate into a folder, a message "Permission problem: could not change to [folder_name]" appears.
    • Why: This happens if your current user does not have the necessary permissions to read or access the contents of that specific folder on the connected device.
    • Solution: You may need to activate the administrator user (if available and you have credentials) or contact your device administrator to grant appropriate permissions.
  2. Folder is not readable:
    • Error: A banner displays "Folder is not readable (permission issue)" at the top of the file list.
    • Why: This indicates that the current folder you are in, or have navigated to, cannot be read by your current user due to insufficient permissions. While you might be able to see the folder name, its contents cannot be displayed.
    • Solution: Similar to the above, try activating the administrator user or seeking permission adjustments.
  3. Error loading file browser:
    • Error: Instead of the file list, a message "Error loading file browser" appears with a "Try again" button.
    • Why: This usually occurs if there's a temporary network issue, the device connection was lost, or an unexpected error happened while trying to retrieve the file system information from the device.
    • Solution: Click the "Try again" button. If the problem persists, check your device's network connection and the overall connection status to your device.
  4. Session expired:
    • Error: The file browser closes unexpectedly, and a message "Your session has expired" appears briefly.
    • Why: For security reasons, your connection session to the device has a time limit. If you remain inactive for too long or the session limit is reached, it will automatically disconnect.
    • Solution: You will need to re-establish your connection to the device to continue using the file browser.
  5. Actions disabled on demo device:
    • Error: When connected to a "demo device", most interactive elements (buttons, file/folder options) are grayed out or unresponsive, and a banner states "You are connected to a demo device - file browser only works for real devices."
    • Why: Demo devices are often read-only or have limited functionality to prevent accidental changes or for demonstration purposes.
    • Solution: To perform full file system operations, you must connect to a real, configured device.