SAGE2: server

Method handling a file save request from a SAGE2_App

• wsio <Object>

  The websocket

• data <Object>

  The data

Used to get the full path of an app starting with appName in the FileName.

• appName <Object>
  • Folder name to check for the app.

Send a message to all clients using websocket

• name <String>

  name of the message

• data <Object>

  data of the message

Remove all partitions and all applications

Callback when a client closes

• wsio <Websocket>

  websocket of the client

Create a new partition with a given set of dimensions and a color

• dims <Object>
  • The dimensions of a partition in top, left, width, height
• color <String>
  • The color of the partition

Create a new partition with a given set of dimensions and a color

• id <String>
  • The id of the partition to be deleted

Close all the applications

Remove all the partitions and keep the applications

Test if two rectangles overlap (axis-aligned)

• x_1 <Integer>

  x coordinate first rectangle

• y_1 <Integer>

  y coordinate first rectangle

• width_1 <Integer>

  width first rectangle

• height_1 <Integer>

  height first rectangle

• x_2 <Integer>

  x coordinate second rectangle

• y_2 <Integer>

  y coordinate second rectangle

• width_2 <Integer>

  width second rectangle

• height_2 <Integer>

  height second rectangle

Print a message to all the web consoles

• data <Object>

  object to print

Given a context menu, will fill with appropriate share sites.

• contextMenu <Object>
  • The context menu of the application.
• appId <String>
  • Unique string to get app, SAGE2Items.applications.list[appId].

Hides radial menu and enables interactivity

• uniqueID <Integer>

  radial menu ID

Ensures that new audioManager instances get metadata about all existing apps

• wsio <Websocket>

  client's websocket

Rebuilds the application widgets for a given client

• wsio <Websocket>

  client's websocket

Rebuilds the pointers for a given client

• wsio <Websocket>

  client's websocket

Rebuilds the wall radial menu for a given client

• wsio <Websocket>

  client's websocket

initialize the SAGE2 server

Sends the first messages when client built

• wsio <Websocket>

  client's websocket

• reqConfig <Bool>

  client requests configuration

• reqVersion <Bool>

  client requests version

• reqTime <Bool>

  client requests time information

• reqConsole <Bool>

  client requests console messages

Translates position of a radial menu by an offset

• uniqueID <Integer>

  radial menu ID

• pointerX <Float>

  offset x position

• pointerY <Float>

  offset y position

Callback when a client connects

• wsio <Websocket>

  The websocket for this client

Cause all apps to be associated with a partition if it is above one

Calculate if we have enough screenshot-capable display clients and send message to UI clients to enable the screenshot menu

Sets the absolute position of a radial menu

• uniqueID <Integer>

  radial menu ID

• pointerX <Float>

  x position

• pointerY <Float>

  y position

Installs all the message callbacks on a websocket

• wsio <Websocket>

  concerned websocket

Shares an application with a remote site

• uniqueID <String>
  • The wsio.id.
• app <Object>
  • The app object to share. Usually: {application: SAGE2Items.applications.list[data.app]}
• remote <Object>
  • Remote site. Usually: remoteSites[data.parameters.remoteSiteIndex]

Shows radial menu and enables interactivity

• uniqueID <Integer>

  radial menu ID

Callback that configures a new client

• wsio <Websocket>

  client's websocket

• data <Object>

  initialization data

Received from a display client, apps will send their context menu after completing their initialization.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • app <String>
    • App id that this menu is for.
  • entries <Array>
    • Array of objects describing the entries.

Will call a function on each display client's app that matches id. Expected usage with context menu. But can be used in other cases. There are some special functionality cases like: SAGE2DeleteElement, SAGE2SendToBack, SAGE2Maximize These do not send message to app.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • x <Integer>
    • Pointer x, corresponds to on entire wall.
  • y <Integer>
    • Pointer y, corresponds to on entire wall.
  • app <String>
    • App id, which function should be activated.
  • func <String>
    • Name of function to activate
  • parameters <Object>
    • Object to send to the app as parameter.

Create a new screen partition with dimensions specified in data

• data <Object>
  • The dimensions of the partition to be created

Remove all applications

Remove all partitions

Receive data from Electron display client about their hardware

• wsio <>

  The wsio

• data <>

  The data

Will launch app with specified name and call the given function after. The function doesn't need to be called to give the parameters.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • appName <String>
    • Folder name to check for the app.
  • params <Object>
    • Will be passed to the app. Function too, it is specified.
  • func <String>
    • Optional, if specified, will also call this funciton and pass parameters.

Create a new screen partition with dimensions specified in data

• data <Object>
  • Contains the layout specificiation with which partitions will be created

Cause all apps to be associated with a partition if it is above one (WebSocket method)

Receive data from Electron display client about their hardware

• wsio <>

  The wsio

• data <>

  The data

Asks server for the context menu of an app. Server will send the current known menu. Menus must be sumitted by app, or the default "Not yet loaded" will be displayed. To use context menu an app MUST have been loaded on a master display.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object needed to get menu, properties described below.
  • x <Integer>
    • Pointer x, corresponds to on entire wall.
  • y <Integer>
    • Pointer y, corresponds to on entire wall.
  • xClick <Integer>
    • Where client clicked on their screen, because this is async.
  • yClick <Integer>
    • Where client clicked on their screen, because this is async.

Used to write files into the media folders. Writes to a joined location of mainFolder.path(~/Documents/SAGE2_media)

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • fileName <String>
    • Name of the file.
  • fileType <String>
    • Extension of the file.
  • fileContent <String>
    • To be written in the file.

Sends data to a specific client or set.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • clientDest <String>
    • Unique identifier of client

Will respond back once to the app giving the func an array of tracked descriptions. They will be in an array of objects with properties nameOfValue and description.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • app <String>
    • App that requested.
  • func <String>
    • Name of the function on the app to give value to.

Will respond back once to the app giving the func an array of tracked values. They will be in an array of objects with properties nameOfValue and value. NOTE: the values in the array could be huge.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • app <String>
    • App that requested.
  • func <String>
    • Name of the function on the app to give value to.

Checks if there is a value, and if so will send the value. If the value doesn't exist, it will not return anything.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.

Removes variable from server. Expected usage is this is called when an app closes. Made for the sake of cleanup as apps open and close.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.

Sets the value of specified server data. If it doesn't exist, will create it.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.

Will add the websocket to subscriber list of new value notifications. The subscriber will get an object with nameOfValue and description.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • app <String>
    • App that requested.
  • func <String>
    • Name of the function on the app to give value to.

Add the app to the named values a subscriber. If the value doesn't exist, it will create a "blank" value and subscribe to it.

• wsio <Object>
  • The websocket of sender.
• data <Object>
  • The object properties described below.
  • nameOfValue <String>
    • Name of value to subscribe to.
  • app <String>
    • App that requested.
  • func <String>
    • Name of the function on the app to give value to.

Start a jupyter connection

• wsio <Object>

  The websocket

• data <Object>

  The data

Sent from UI, server gets it and tells displays to send back screenshots. Only happens if a screenshot is not already in progress to prevent spam. The masterDisplay check in array is reset (discarded) and rebuilt.

• wsio <Object>

  The websocket

• data <Object>

  The data

Will attempt to take a transcript and use best case to activate a context menu item. All logic is performed within the src/voiceToAction.js file.

• wsio <Object>
  • ws to originator.
• data <Object>
  • should contain words.

Called when displays are sending screenshots. Displays that are not capable of screenshots will report back saying so. Performs the following: if not display, stop if display is not capable, mark status, stop get all displays in array save the current display's screenshot mark this display in the correct check in position if display has width and height, mark those locations too if all display tiles screenshots have been submitted OR all displays have submitted a screenshot or are incapable then make a screenshot done with mosaic and offset tiles based on config information stitching is done in tmp folder to avoid problems caused by the folder monitor finally reset variable to allow another screenshot

• wsio <Object>

  The websocket

• data <Object>

  The data