From cfaba05770bc4517c9231545518b7d5a434f411f Mon Sep 17 00:00:00 2001 From: Sven K Date: Thu, 25 Jul 2024 16:06:38 +0200 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 46efd86..87a7438 100644 --- a/README.md +++ b/README.md @@ -34,15 +34,21 @@ interface. This is where this application differs most. *LUCIDAC endpoints* are compact URL/URI like strings similar to [VISA TCP/IP strings](https://www.ni.com/docs/de-DE/bundle/ni-visa/page/visa-resource-syntax-and-examples.html). +See also the [LUCIDAC communication protocol](https://anabrid.dev/docs/hybrid-controller/d1/d3c/md_docs_2protocol.html) +in the Firmware documentation for further details. The `lucisim` client code which is underlying the `lucigui` understands the following types of strings: -* ws://foo.bar.baz:1234/path/to/socket -* http://foo.bar.baz:1234/path/to/socket is automatically rewritten to `ws://...` -* https://foo.bar.baz:1234/path/to/socket is automatically rewritten to `wss://...`. Note that the +* `ws://foo.bar.baz:1234/path/to/socket` +* `http://foo.bar.baz:1234/path/to/socket` is automatically rewritten to `ws://...` +* `https://foo.bar.baz:1234/path/to/socket` is automatically rewritten to `wss://...`. Note that the embedded webserver does not understand HTTPS/SSL but others might do. -* ws://foo.bar.baz is automatically expanded to `ws://foo.bar.baz:80/websocket` +* `ws://foo.bar.baz` is automatically expanded to `ws://foo.bar.baz:80/websocket` -Furthermore, if you want to connect to a LUCIDAC without websocket support, you can elevate the protocol +Note that the code is primarily written with the browser environment in mind, therefore it currently cannot +connect directly to TCP or USB Serial endpoints. Connecting such targets is only possible in server +environments on nodejs or deno and code support currently not added. + +If you want to connect to a LUCIDAC without websocket support, you can elevate the protocol by yourself, for instance with [websockify](https://github.com/novnc/websockify). This works the same as a serial2tcp converter/proxy. See our https://github.com/anabrid/lucigo code for further information about proxying.