Network Web Socket

Allows the communication between Usine and a Web Browser, for example to send commands to Usine from a web page or create a Web server inside Usine.

Settings

port

Web Socket port, 80 by default.

Send to a remote web page

string to send

String to send to the connected Web page.

send

Process the send operation.

Receive from a remote web page

received string

String received from the Web page.

receive

Sends a trigger when a string is received.

response file

Optional, file sent as a response of the Web Socket. Can be an html, php, js, etc. For example you can create a script to communicate with Usine, like the file webSocketExample.html:

<!DOCTYPE HTML>
<html>
    <head>
        <title>WebSocket demo</title>
        <script type="text/javascript">
        var ws;
        function log(s) 
        {
            document.getElementById("log").innerHTML += s + "\n";
        }
        function sendMessage(s) 
        {
            log(">> " + s);
            ws.send(s);
        }
        function send() 
        {
            sendMessage(document.getElementById("text").value);            
        }
        function init() 
        {
            ws = new WebSocket("ws://localhost:8000"); // should be the IP address of Usine
            ws.onopen = function() 
                {
                log("WebSocket opened");
                sendMessage("Hello ?");
                }
            ws.onclose = function() 
                {
                log("WebSocket closed")
                }
            ws.onmessage = function(e) 
                {
                log("<< " + e.data)
                }
        }
        </script>
    </head>
    <body onLoad="init()">
        <input type="text" id="text"> 
        <button onclick="send()">Send</button>
        <pre id="log"></pre>
    </body>
</html>

See webSocketExample.html.

This file is optional because it can be stored on the distant server.

response string

Response as string of the Web Socket on connection.

connected

Sends 1 when the socket is connected.

trace received msg

Display all received messages in the trace-panel.

test local host

Opens the localhost page (http://127.0.0.1:80 by default) in the Web Browser in order to test the communication and the response file.

Common Settings

info

show manual

Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.

For more details about information/help creation, see create-help-file.

description

Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.

Object Remote Address

absolute

Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.

See also

version 7.0.250121

Edit All Pages