Skip to content

Commit

Permalink
add RBA peripherals
Browse files Browse the repository at this point in the history
  • Loading branch information
funke-32 committed Oct 11, 2024
1 parent c3f0191 commit dbfd03c
Show file tree
Hide file tree
Showing 15 changed files with 115 additions and 104 deletions.
2 changes: 1 addition & 1 deletion docs/workspaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Macrometa Cloud Workspaces redefines the digital workplace by delivering secure,
/>
</grid>

## Cloud Workspaces Toolbox
## Cloud Workspaces toolbox

At its core, Cloud Workspaces integrates the following advanced technologies:

Expand Down
56 changes: 0 additions & 56 deletions docs/workspaces/peripheral-validator.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/workspaces/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The Workspaces homepage displays the different tools available in the service, a

## Validating Peripheral Devices

Workspaces offers its [Peripheral Validator](./peripheral-validator.md), a feature that allows your peripheral devices connect to it successfully to ensure a smooth and productive experience. This feature enhances the user experience by allowing the use of essential hardware in virtual environments. Cloud Workspaces currently supports the following peripheral devices:
Workspaces offers its [Peripheral Validator](./remote-browser-accelerator/rba-peripheral-validator.md), a feature that allows your peripheral devices connect to it successfully to ensure a smooth and productive experience. This feature enhances the user experience by allowing the use of essential hardware in virtual environments. Cloud Workspaces currently supports the following peripheral devices:

- Signature pad
- Card reader
Expand Down
46 changes: 0 additions & 46 deletions docs/workspaces/remote-browser-accelerator/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,49 +36,3 @@ With the installer now successfully installed:
1. Navigate to the Workspaces homepage
1. Click on the web app you wish to use. By default, the selected application or service will open in a tab within the remote browser. A control bar icon `>` appears on the left side of the screen, allowing you to easily manage and interact with the remote browser.

## Optimize RBA with the RBA control bar

The Remote Browser Acceleration (RBA) control bar provides a comprehensive interface for managing and optimizing your remote browsing experience. It includes options to toggle fullscreen mode, manage keyboard inputs, and access the clipboard. Additionally, users can configure display settings and customize various other settings to tailor the remote browser environment to their specific needs.

To access the RBA control bar,

- Click the control bar icon on the left side of the browser to access the menu.

![RBA Control Bar](/img/workspaces/control-bar.png)

Below is an overview of each menu on the control bar and how to use them to enhance your browsing experience.

1. **Drag viewport**: This setting allows you to move the remote browser window around the screen when minimized.

2. **Keys**: The keys menu provides on-screen buttons for essential control keys such as **Control**, **Alt**, **Tab**, and the **Esc** key. This functionality is especially handy for mobile device users who don't have access to a full keyboard.

3. **Clipboard**: The clipboard feature allows text transfer between your local device and the remote browser. Text copied within the remote browser appears in this panel for easy access. This is not compulsory for the Chrome browser, as it has native clipboard integration that handles text efficiently.

4. **Fullscreen**: Full screen maximizes the remote browser to fill your entire screen, providing an immersive and distraction-free browsing experience. Use the **Esc** key to exit fullscreen mode.

5. **USB**: The USB menu displays all devices connected to your local device via USB. To connect a device to the remote browser, select it from the list and click **Connect**.

6. **Display:** This menu allows you to manage multiple monitors efficiently. Click the **Display** menu to add, remove, and arrange screens. New screens open in separate browser windows, which you can position on your local monitors. Use the Display menu to match the on-screen arrangement to your physical setup and adjust positions and sizes as needed.

![Display Menu](/img/workspaces/display-menu.png)
7. **Settings:** The Settings menu lets you customize your remote browser further. Here, you can adjust various aspects to tailor the browser to your preferences and optimize your user experience.

![Settings Menu](/img/workspaces/rba-settings.png)

a. **View-only**: This option restricts the remote browser to a read-only mode, preventing any write operations. Users can browse and view content without being able to modify or interact with elements.

b. **Clipboard Up**: Allows users to copy text from their local device and paste it into the remote browser.

c. **Clipboard Down**: Enables copying content from the remote browser and pasting it onto your local device.

d. **Clipboard Seamless**: This feature facilitates copying and pasting between your local device and the remote browser without noticeable delays or additional steps.

e. **Prefer Local Cursor**: Prioritizes using the local machine's cursor for display and interaction, providing a more consistent user experience.

f. **Translate keyboard shortcuts**: Automatically converts local keyboard shortcuts to the corresponding shortcuts in the remote browser, ensuring they function correctly within the remote environment.

g. **Enable Performance Stats**: This option displays real-time performance metrics of the remote browser at the top right corner of the screen. These metrics include an FPS counter, along with network and CPU stats, where each stat shows the current value and an averaged value over time. A lower value indicates higher resource constraints, helping to identify if performance bottlenecks are due to server-side CPU or network issues.

h. **Enable Pointer Lock:** Constrains the cursor within the remote browser window, providing better control during use. To release the cursor, press the escape key.

8. **Audio:** Click the audio icon ![Audio Icon](/img/workspaces/audio-icon.png) to enable or disable audio output from the remote browser.
49 changes: 49 additions & 0 deletions docs/workspaces/remote-browser-accelerator/rba-control-bar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 5
title: Optimize RBA with the Control Bar
---

The Remote Browser Acceleration (RBA) control bar provides a comprehensive interface for managing and optimizing your remote browsing experience. It includes options to toggle fullscreen mode, manage keyboard inputs, and access the clipboard. Additionally, users can configure display settings and customize various other settings to tailor the remote browser environment to their specific needs.

To access the RBA control bar,

- Click the control bar icon on the left side of the browser to access the menu.

![RBA Control Bar](/img/workspaces/control-bar.png)

Below is an overview of each menu on the control bar and how to use them to enhance your browsing experience.

1. **Drag viewport**: This setting allows you to move the remote browser window around the screen when minimized.

2. **Keys**: The keys menu provides on-screen buttons for essential control keys such as **Control**, **Alt**, **Tab**, and the **Esc** key. This functionality is especially handy for mobile device users who don't have access to a full keyboard.

3. **Clipboard**: The clipboard feature allows text transfer between your local device and the remote browser. Text copied within the remote browser appears in this panel for easy access. This is not compulsory for the Chrome browser, as it has native clipboard integration that handles text efficiently.

4. **Fullscreen**: Full screen maximizes the remote browser to fill your entire screen, providing an immersive and distraction-free browsing experience. Use the **Esc** key to exit fullscreen mode.

5. **USB**: The USB menu displays all devices connected to your local device via USB. To connect a device to the remote browser, select it from the list and click **Connect**.

6. **Display:** This menu allows you to manage multiple monitors efficiently. Click the **Display** menu to add, remove, and arrange screens. New screens open in separate browser windows, which you can position on your local monitors. Use the Display menu to match the on-screen arrangement to your physical setup and adjust positions and sizes as needed.

![Display Menu](/img/workspaces/display-menu.png)
7. **Settings:** The Settings menu lets you customize your remote browser further. Here, you can adjust various aspects to tailor the browser to your preferences and optimize your user experience.

![Settings Menu](/img/workspaces/rba-settings.png)

- **View-only**: This option restricts the remote browser to a read-only mode, preventing any write operations. Users can browse and view content without being able to modify or interact with elements.

- **Clipboard Up**: Allows users to copy text from their local device and paste it into the remote browser.

- **Clipboard Down**: Enables copying content from the remote browser and pasting it onto your local device.

- **Clipboard Seamless**: This feature facilitates copying and pasting between your local device and the remote browser without noticeable delays or additional steps.

- **Prefer Local Cursor**: Prioritizes using the local machine's cursor for display and interaction, providing a more consistent user experience.

- **Translate keyboard shortcuts**: Automatically converts local keyboard shortcuts to the corresponding shortcuts in the remote browser, ensuring they function correctly within the remote environment.

- **Enable Performance Stats**: This option displays real-time performance metrics of the remote browser at the top right corner of the screen. These metrics include an FPS counter, along with network and CPU stats, where each stat shows the current value and an averaged value over time. A lower value indicates higher resource constraints, helping to identify if performance bottlenecks are due to server-side CPU or network issues.

- **Enable Pointer Lock:** Constrains the cursor within the remote browser window, providing better control during use. To release the cursor, press the escape key.

8. **Audio:** Click the audio icon to enable or disable audio output from the remote browser. ![Audio Icon](/img/workspaces/audio-icon.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
sidebar_position: 4
title: Validating Peripheral Devices
---

RBA supports the following peripheral devices when accessing web apps from the remote browser:

1. **Signature pad**
2. **Webcam**
3. **Thermal printer**
4. **Image scanner**
5. **Card reader**
6. **Pin pad**

To verify the functionality of your connected devices, use the **Peripheral Validator**. From the homepage, click the **Connect** button under **Peripherals** to begin the validation process for each device. The validator displays all supported peripherals available for testing.

![peripherals](/img/workspaces/peripherals-validator.png)

### **Printer**

To validate the printer:
1. Click the **Test** button for **Printer** from the **Peripherals** screen. It displays a colored page to test the printer.

![test-printer](/img/workspaces/validate-printer.png)

3. Click on **Test Printer** and add a virtual PDF printer to verify that it is accessible from the remote browser.
4. Select “**See more**..” from the **Destination** options on the print screen to check if the printer (Peripheral1-Printer) is listed.

![save-printer](/img/workspaces/printer-save.png)

5. Select the printer and print the test page.
6. Alternatively, connect your printer device and confirm that it shows in the list of printers. Select the printer and print the test page.


### **Signature Pad**

To validate the signature pad:
1. Click the **Test** button for **Signature Pad** from the **Peripherals** screen. It displays a signature pad validator.

![sig-pad](/img/workspaces/signature-pad.png)

2. Connect your signature pad device and start signing. The Signature Capture window displays the signature as you sign.

![sig-capture](/img/workspaces/signature-capture.png)

3. After signing, Click **OK** from the Signature Capture window. The signature is displayed on the validator screen.
4. Click the **Erase** button to remove the existing signature.


### **Card Reader**

To validate the card reader, continue with the following steps:
1. Click the **Test** button for **Card Reader** from the **Peripherals** screen. It displays a card reader validator with an input box.

![card-reader](/img/workspaces/card-reader.png)

3. Connect your card reader device. Set your cursor on the input box and swipe your card. The card details are displayed on the screen.

### **Image Scanner**

To validate the image scanner, continue with the following steps:
1. Click the **Test** button for **Image Scanner** from the **Peripherals** screen. It displays the image scanner validator.

After validating these peripherals, you can start using it in your web apps!
Binary file added static/img/workspaces/card-reader.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/workspaces/control-bar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/workspaces/display-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/workspaces/peripherals-validator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/workspaces/printer-save.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/workspaces/rba-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/workspaces/signature-capture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/workspaces/signature-pad (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/workspaces/validate-printer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dbfd03c

Please sign in to comment.