add fibre-js

2026-09-22 08:04:07 +08:00 · 2020-11-03 11:27:13 +01:00
parent ee410e2891
commit cef55e9036
8 changed files with 5959 additions and 0 deletions
@@ -0,0 +1,83 @@
+# fibre-js
+
+This directory provides JavaScript bindings for [Fibre](https://github.com/samuelsadok/fibre). Its home is located [here](https://github.com/samuelsadok/fibre/tree/master/js). There's also a standalone repository for this directory [here](https://github.com/samuelsadok/fibre-js).
+
+## Current Status
+
+So far fibre-js was only tested to run in Chrome but it should work in any browser that [supports WebAssembly](https://caniuse.com/wasm).
+
+fibre-js currently supports the following transport providers:
+
+ - WebUSB ([Chrome and Edge only](https://caniuse.com/webusb))
+
+## How to use
+
+So you want your website or Electron App to connect to some resource(s) using Fibre. Let's start with a simple HTML scaffolding.
+
+```HTML
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>fibre-js Test</title>
+    </head>
+    <body>
+        <h1 id="statusText">not connected</h1>
+        <button id="connectBtn" disabled>Connect...</button>
+    </body>
+</html>
+```
+
+Now, right before the closing `</body>`, insert a script tag to load and open fibre-js:
+
+```HTML
+<script type="module">
+    import { fibreOpen } from './fibre.js';
+    fibreOpen().then((libfibre) => {
+        // fibre-js is ready to use!
+    });
+</script>
+```
+
+This will load the files `fibre.js`, `libfibre-wasm.js` and `libfibre-wasm.wasm` from the same directory the HTML file comes from so make sure those files exist.
+
+Now that fibre-js is ready to use we can start discovering remote objects. For this we need to specify a filter string which tells Fibre where to look for objects. In this example we want to talk to a USB device that runs Fibre (more specfically an [ODrive](https://odriverobotics.com/)). The parameters we use here are something you can find out from reading the docs of your USB device or inspecting the device by using `lsusb` on a Linux or macOS computer.
+
+```JS
+const filter = 'usb:idVendor=0x1209,idProduct=0x0D32,bInterfaceClass=0,bInterfaceSubClass=1,bInterfaceProtocol=0';
+const onFoundObject = async (obj) => {
+    console.log("found an object!", obj);
+    // TODO: do something with obj
+}
+libfibre.startDiscovery(filter, onFoundObject);
+```
+
+Now that we have the object we can start calling functions on it. Let's assume our object has the property `vbus_voltage`. In the `onFoundObject` handle, add:
+
+```JS
+while (true) {
+    document.getElementById("statusText").innerHTML = "vbus_voltage: " + (await obj.vbus_voltage.read());
+    await new Promise((resolve) => setTimeout(resolve, 100));
+}
+```
+
+This will read the `vbus_voltage` property every 100ms and display the value on the web page.
+
+Optionally you could add a callback to the `obj._onLost` promise in order to gracefully stop polling when the device disconnects.
+
+Since we're using WebUSB in this example, there's one more thing left to do: The user needs to authorize the website (only once) to access the USB device. This must happen on a user gesture, which is why earlier we put a Connect-button into our HTML.
+
+So directly after the call to `libfibre.startDiscovery()`, add:
+
+```JS
+document.getElementById("connectBtn").onclick = libfibre.usbDiscoverer.showDialog;
+document.getElementById("connectBtn").removeAttribute('disabled');
+```
+
+That's it! You can now open the HTML page in the browser and should see something like this (using Chrome 86 on Linux):
+
+![Example](example.gif)
+
+Note how the user doesn't need to manually reselect the device after the website is reloaded. The website is now already authorized to access the device so Fibre immediately connects to it. The same is true when the device is unpluggend and replugged to the computer.
+
+You can find the complete example code [here](example.html). A more elaborate example which can connect to multiple objects can be found here [here](multidevice_example.html).
@@ -0,0 +1,28 @@
+<!doctype html>
+<html>
+    <head>
+        <meta charset="utf-8">
+        <title>fibre-js Test</title>
+    </head>
+    <body>
+        <h1 id="statusText">not connected</h1>
+        <button id="connectBtn" disabled>Connect...</button>
+        <script type="module">
+            import { fibreOpen } from './fibre.js';
+            fibreOpen().then((libfibre) => {
+               const filter = 'usb:idVendor=0x1209,idProduct=0x0D32,bInterfaceClass=0,bInterfaceSubClass=1,bInterfaceProtocol=0';
+               const onFoundObject = async (obj) => {
+                  console.log("found an object!", obj);
+                  while (true) {
+                     document.getElementById("statusText").innerHTML = "vbus_voltage: " + (await obj.vbus_voltage.read());
+                     await new Promise((resolve) => setTimeout(resolve, 100));
+                  }
+               }
+               libfibre.startDiscovery(filter, onFoundObject);
+
+               document.getElementById("connectBtn").onclick = libfibre.usbDiscoverer.showDialog;
+               document.getElementById("connectBtn").removeAttribute('disabled');
+            });
+        </script>
+    </body>
+</html>
@@ -0,0 +1,47 @@
+<!doctype html>
+<html>
+   <head>
+      <meta charset="utf-8">
+      <title>WebAssembly Test</title>
+      <style>
+         div {
+            font-size : 30px; text-align : left; color:darkblue;
+         }
+      </style>
+   </head>
+   <body>
+      <div id="textcontent">loading...</div>
+      <script src="fibre.js"></script>
+      <script async>
+         const filter = 'usb:idVendor=0x1209,idProduct=0x0D32,bInterfaceClass=0,bInterfaceSubClass=1,bInterfaceProtocol=0';
+         let showStatus = (status) => document.getElementById("textcontent").innerHTML = status;
+         var connectedObjects = [];
+
+         displayLoop = async () => {
+            while (connectedObjects.length) {
+               console.log(connectedObjects.length);
+               let results = await Promise.all(connectedObjects.map(async (dev) => await dev.vbus_voltage.read()));
+               showStatus('connected to ' + results.length + ' devices' + results.map((x) => "<br>vbus_voltage: " + x + "V").join());
+               await new Promise((resolve) => setTimeout(resolve, 100));
+            }
+            showStatus("no devices connected");
+         }
+
+         let onFoundObject = async (obj) => {
+            connectedObjects.push(obj);
+            obj._onLost.then(() => connectedObjects.splice(connectedObjects.indexOf(obj), 1));
+            if (connectedObjects.length == 1) {
+               displayLoop();
+            }
+         }
+
+         fibreOpen().then((libfibre) => {
+            libfibre.startDiscovery(filter, onFoundObject);
+            document.getElementById("connectBtn").onclick = libfibre.usbDiscoverer.showDialog;
+            document.getElementById("connectBtn").removeAttribute('disabled');
+            showStatus("loaded WASM libfibre version " + libfibre.version.major + "." + libfibre.version.minor + "." + libfibre.version.patch);
+         });
+      </script>
+      <button id="connectBtn" disabled>Connect</button>
+   </body>
+</html>
@@ -0,0 +1,19 @@
+{
+  "name": "fibre-js",
+  "version": "0.1.0",
+  "eslintConfig":  {
+    "rules": {
+      "no-empty": "off",
+      "no-unused-vars": "off",
+      "no-undef": "off",
+      "no-constant-condition": "off",
+      "no-extra-semi": "off",
+      "no-async-promise-executor": "off",
+      "no-redeclare": "off",
+      "no-prototype-builtins": "off",
+      "no-global-assign": "off",
+      "no-useless-escape": "off",
+      "no-useless-catch": "off"
+    }
+  }
+}