├── Logitech_G_Bridge_SDK_License_Agreement.pdf ├── README.md ├── documentation ├── Adapter │ └── bridge_adapter.stl ├── BRIDGE_SDK_user_manual_2.0.pdf └── pictures │ ├── BRIGESDKdescription.png │ ├── Bridge_SDK_components.jpg │ ├── Logitech_G_Bridge_VR_Keyboard_Hands_A.gif │ ├── Logitech_G_Bridge_VR_Keyboard_Skins_A.gif │ ├── align_0.PNG │ ├── align_1.PNG │ ├── align_2.PNG │ ├── align_3.PNG │ ├── console.PNG │ ├── folder_structure.PNG │ ├── hands_1.jpg │ ├── logitech-bridge-mid.jpg │ ├── logitech-bridge-sm.jpg │ ├── logitech-bridge-small.jpg │ ├── overlay_steamvr_homebeta.jpg │ ├── skin_rocks_G810.PNG │ ├── steamVRdashboard.PNG │ ├── vives_logos.png │ ├── webUI.PNG │ ├── webUI_u.PNG │ └── webUIfolder.PNG └── software ├── BRIDGE_ThirdPartyNotices.txt └── README.md /Logitech_G_Bridge_SDK_License_Agreement.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/Logitech_G_Bridge_SDK_License_Agreement.pdf -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Logitech G BridgeSDK 2 | 3 | - Beta version [**2.0**](https://github.com/Logitech/logi_bridge_sdk/blob/master/software/README.md) (released on Aug 22th 2018) 4 | - Contact: supportsdk@logitech.com 5 | - Instructions [wiki](https://github.com/Logitech/logi_bridge_sdk/wiki) 6 |
7 | 8 | ## Platforms 9 | Supports **HTC Vive** and **Vive PRO** (NEW since version 2.0) 10 |

11 | 12 |

13 | 14 |
15 | 16 | ## Introduction 17 | The Bridge SDK is a Development kit that aims at helping app makers and other SW developers to solve some of the issues arising whenever a person needs to use a Keyboard in VR. 18 | 19 |

20 | 21 |

22 | 23 |
24 | 25 | ## Motivation 26 | The motivation comes from the belief that in some situations the user still needs to use a keyboard to interact with applications, especially in productivity-driven scenarios but also in games, chat and content browsing. We believe that that keyboard has to be physically present, since it delivers the traditional tactile experience and feedback that people value. 27 | 28 |
29 | 30 | ## The Pieces 31 | The Bridge SDK is composed of the following elements: 32 | 33 | - A Logitech G810 Orion Spark Keyboard (off-the-shelf) 34 | - A Logitech G BRIDGE 35 | - A HTC Vive tracker 36 | - A SW component that enables an “overlay” of a 3D VR keyboard 37 | 38 |

39 | 40 |

41 | 42 |
43 | 44 | ## Interested in the SDK? 45 | Unfortunately we already have run out of Bridge adapters but we have been amazed to see the interest that this little experiment has sparked. 46 | We don't plan to pursue this initial avenue but we are currently working on new implementations of keyboard and tools in VR. 47 | 48 | If you are interested in knowing more about those, please subscribe [here](https://goo.gl/forms/WPb5uWU0NGPgZorP2). 49 | 50 |
51 | 52 | ## License Agreement 53 | Downloading this SDK indicates that you have read and accept the terms of the License Agreement for the Logitech G Bridge in [here](https://goo.gl/sReQAk). 54 | 55 | ### Disclaimer 56 | Please be aware that this is a BETA version of this SDK and in this current iteration it is purely a Proof of Concept to spark discussions and generate feedback from you, the development community. You can expect to see bugs and robustness issues, but we are working continuously to fix them. 57 | 58 | By downloading or using the Logitech G Bridge SDK, developers accept the SDK License Agreement and agree that Logitech automatically collects anonymous diagnostic and usage data about the software, the Logitech Hardware and developers' computer with a purpose to facilitate the provisions of updates and to improve Logitech products. 59 | 60 |
61 | 62 | ## Setup instructions 63 | There is no need for an installer, so you can simply download the latest releases's [zip file](https://github.com/Logitech/logi_bridge_sdk/releases) and unzip it on your machine (in any folder you like). In order to launch/activate the Bridge Overlay SW, you simply launch `Logitech_Bridge.exe` from the extracted folder (inside /vX.X.X_Logitech_BridgeSDK). 64 | 65 | Have a look at those setup [instructions](software/README.md) or read the supplied [documentation](documentation/) for more detailed instructions. 66 | 67 |
68 | 69 | ## Functionality 70 | 71 | ### Keyboard Model Overlay 72 | 73 | The overlay package is fully compatible with all applications that are developed based on STEAM VR (©Valve). To launch it, double click on Logitech_Bridge.exe contained in the previously unzipped folder. 74 | 75 | After launching it will add a system tray icon. You can open it by clicking on it. This UI is an easy wrapper to the main core Bridge SDK (running behind the scenes) and allows to overlay a virtual representation of the keyboard in any VR application game: It acts in fact as an additional “virtual” Headset that has his own view that is virtually placed right in front of the user’s HMD’s view. 76 | 77 |

78 | 79 |
Keyboard Model ovelay in Virtual Desktop 80 |

81 | 82 | The keyboard will appear as soon as the associated HTC tracker is turned on (options to toggle visibility are available) and the user will be able to see it "floating" above any app. It will render a 3D representation of a G810 keyboard, complete with animations when the keys are pressed. Some different skins are also included. 83 | 84 | The BridgeSDK also includes the ability to overlay your hands on top of the 3D keyboard model. We believe this is a much needed feature to allow any person to type in VR (touchtypist & non). Please read the related chapter in the documentation file. 85 | 86 | 87 |
88 |
89 | 90 | ## Feedback & Bugs 91 | We strongly suggest to use our private GitHub repository for bug reports and features requests. Follow this [link](https://github.com/Logitech/logi_bridge_sdk/issues) and post it there. This will allow easier tracking and followup. 92 | 93 | If you have any other generic questions or comments, please feel free to contact us on supportsdk@logitech.com. 94 | 95 |
96 | 97 | ## Changelog 98 | ### 2.0 (Aug 22th 2018) 99 | - brand-new reprojection, better stability and alignement 100 | - overlay supports stereo images 101 | - supports also Vive Pro 102 | - simplified UI (WebUI) 103 | 104 | ### 1.2.24 (Mar 29th 2018) 105 | - Multiple stability fixes 106 | - Fix Windows 10 Insider preview compatibility issues 107 | - Improved rendering of the keyboard (shaders) 108 | - Camera lag compensation 109 | - Stereo rendering mode (hands not included yet) 110 | - Revamped align mode with in-VR tooltips 111 | - Experimental web control interface 112 | - Added LEDs VR SDK 113 | - pressing modifier (shift) key now modifies the printings on some keys 114 | - Refreshed UI and VR Setup 115 | - Updated developer samples 116 | - Ability to opt out of analytics 117 | 118 | ### 1.1.15 (Nov 30th 2017) 119 | - Bug fix 120 | 121 | ### 1.1.11 (Nov 22th 2017) 122 | - Bug fixes 123 | - Robustness improvements to detect when HMD is not present 124 | 125 | ### 1.1.8 (Nov 10th 2017) 126 | - Many robustness improvements 127 | - New align procedure 128 | - Bridge VR setup wizard app 129 | - New hands segmentation methods 130 | 131 | ### 1.0.1 (Aug 16th 2017) 132 | - Added splash screen (while loading) 133 | - Fixed some stability issues when SteamVR is not running 134 | - Added autosave of Settings (included alignment) when app is being closed 135 | - Automatic lookup for open port for websocket interface 136 | 137 | ### 1.0.0 (Jul 28th 2017) 138 | - Added Hands support (based on HTC vive camera) 139 | - Added API support 140 | 141 | ### 0.8.3 (May 11th 2017) 142 | - Intial release (no hands support) 143 | -------------------------------------------------------------------------------- /documentation/Adapter/bridge_adapter.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/Adapter/bridge_adapter.stl -------------------------------------------------------------------------------- /documentation/BRIDGE_SDK_user_manual_2.0.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/BRIDGE_SDK_user_manual_2.0.pdf -------------------------------------------------------------------------------- /documentation/pictures/BRIGESDKdescription.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/BRIGESDKdescription.png -------------------------------------------------------------------------------- /documentation/pictures/Bridge_SDK_components.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/Bridge_SDK_components.jpg -------------------------------------------------------------------------------- /documentation/pictures/Logitech_G_Bridge_VR_Keyboard_Hands_A.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/Logitech_G_Bridge_VR_Keyboard_Hands_A.gif -------------------------------------------------------------------------------- /documentation/pictures/Logitech_G_Bridge_VR_Keyboard_Skins_A.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/Logitech_G_Bridge_VR_Keyboard_Skins_A.gif -------------------------------------------------------------------------------- /documentation/pictures/align_0.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/align_0.PNG -------------------------------------------------------------------------------- /documentation/pictures/align_1.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/align_1.PNG -------------------------------------------------------------------------------- /documentation/pictures/align_2.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/align_2.PNG -------------------------------------------------------------------------------- /documentation/pictures/align_3.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/align_3.PNG -------------------------------------------------------------------------------- /documentation/pictures/console.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/console.PNG -------------------------------------------------------------------------------- /documentation/pictures/folder_structure.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/folder_structure.PNG -------------------------------------------------------------------------------- /documentation/pictures/hands_1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/hands_1.jpg -------------------------------------------------------------------------------- /documentation/pictures/logitech-bridge-mid.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/logitech-bridge-mid.jpg -------------------------------------------------------------------------------- /documentation/pictures/logitech-bridge-sm.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/logitech-bridge-sm.jpg -------------------------------------------------------------------------------- /documentation/pictures/logitech-bridge-small.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/logitech-bridge-small.jpg -------------------------------------------------------------------------------- /documentation/pictures/overlay_steamvr_homebeta.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/overlay_steamvr_homebeta.jpg -------------------------------------------------------------------------------- /documentation/pictures/skin_rocks_G810.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/skin_rocks_G810.PNG -------------------------------------------------------------------------------- /documentation/pictures/steamVRdashboard.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/steamVRdashboard.PNG -------------------------------------------------------------------------------- /documentation/pictures/vives_logos.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/vives_logos.png -------------------------------------------------------------------------------- /documentation/pictures/webUI.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/webUI.PNG -------------------------------------------------------------------------------- /documentation/pictures/webUI_u.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/webUI_u.PNG -------------------------------------------------------------------------------- /documentation/pictures/webUIfolder.PNG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Logitech/logi_bridge_sdk/7699ab3a7df4e4554b77355b0b4f2ced5f697612/documentation/pictures/webUIfolder.PNG -------------------------------------------------------------------------------- /software/README.md: -------------------------------------------------------------------------------- 1 | # Software releases 2 | 3 | GitHub advises to keep large binary files out of source control, especially if those are intended to be part of a release package. This is the reason why we have removed the binary/exe/dll files from this software folder and moved it to the releases tab of this repository. 4 | 5 | - get the latest release [here](https://github.com/Logitech/logi_bridge_sdk/releases) 6 | 7 | # Prerequisites 8 | Make sure you have gone through these preparation steps beforehand: 9 | 10 | - you are on Microsoft Windows 10 (64bits) 11 | - you have installed Steam and SteamVR 12 | - you have a working Vive (1 or Pro) setup with at least one lighthouse (2 are preferred) 13 | - in the steamVR settings (`SteamVR -> Settings -> Camera -> Test Camera Rate`) you have made sure the HMD's camera is enabled and working. 14 | - you already have a paired HTC tracker to the system, so your steamVR dashboard should look like that: 15 | 16 |

17 | 18 |

19 | 20 | # Download and run 21 | Once you've downloaded the zip file, you can decompress it where you want, open the latest version folder (`vX.X_Logitech_BridgeSDK`) and then you'll have the following structure: 22 | 23 |

24 | 25 |

26 | 27 | 28 | 29 | In order to run the software, simply double click on Logitech_Bridge.exe. A console window will appear with some debug information, you should leave it there. 30 | 31 |

32 | 33 |

34 | 35 | ## Software UI 36 | We have provided a simplified UI in the form of a Web UI (can be loaded using a browser) Head to the folder containing the Logitech_Bridge.exe you just launched , enter the WebUI folder, and double click on BridgeUI.html 37 | 38 |

39 | 40 |

41 | 42 | The Web UI should look similarly to this: 43 | 44 |

45 | 46 |

47 | 48 | ## Fine tuning 49 | With the WebUI you can tweak your settings, such as toggling the visibility of the keyboard and hands, changing the skin (appeareance) of the keyboard. 50 | You can also fine tune the settings for the visualisation of your hands such as the `Hands transparency` level, the `Hands Visibility`'s' filtering amount and the `Noise Reduction` to remove some smaller particles/blobs from the video feed. 51 | 52 | ## Alignment 53 | The system should already be quite well aligned, once you correctly attach the tracker to the adapter and at the keyboard. But if you feel that **your hands are not perfectly aligned** to the keys (in our experience a mis-alignment of 5mm is already quite unconfortable!) you should: 54 | 55 | - in the `Hands Visualisation` mode, change the mode to `passthrough` 56 | - use the `Tracker-Keyboard position` panel to adjust the X, Y and Z position of the video feed making sure it is **aligned with the borders of the viewing window** (which is the keyboard 3D model) 57 | - switch back to `Luminance segmentation` in `Hands Visualisation` mode 58 | - test that what you **see** matches to what you **feel** (ie your fingers feeling the correct keys below them). 59 | 60 | If you still have issues or any other feedback, please reach out to us at supportsdk@logitech.com. 61 |
62 | --------------------------------------------------------------------------------