Multi User Custom Experiments

For server change SightLab instance to:

sightlab = sl.SightLabServer()

For client:

sightlab = sl.SightLabClient()

For both, use this code for the main experiment template (with custom code in the sightLabExperiment). Triggers to start and stop trial will be set in the GUI on the server side.  Make sure when converting single user GUI scripts that the start and end conditions are not set to "None"

def sightLabExperiment(): 
 viztask.waitEvent(EXPERIMENT_START)

 for trial in range(sightlab.getTrialCount()):
  yield viztask.waitEvent(TRIAL_START)
  yield viztask.waitEvent(TRIAL_END)

At end add this code for server:

viztask.schedule(sightlab.runServer)
viztask.schedule(sightLabExperiment)
viz.callback(viz.getEventID('ResetPosition'), sightlab.resetViewPoint)

And for client:

viztask.schedule(sightlab.runClient)
viztask.schedule(sightLabExperiment)
viz.callback(viz.getEventID("ResetPosition"), sightlab.resetViewPoint)

To check for a vizconnect condition on server:

if sightlab.getConfig() in["Desktop","Desktop Server"]:

To trigger events from the server to the clients you will need to first create an event ID and then use that for the callback, similar to the following code: 

Add this to both server and client: 

import viznet

def id(name):
    """Generate unique ID for use over viznet"""
    return f"viznet:{name}"

YOUR_EVENT = id("YOUR_EVENT")

Create function on server side: 

def doSomething():
    print("something happened")

viznet.server.send(YOUR_EVENT, client=viz.net.getName())
vizact.onkeydown("1", doSomething)

Create function on client side that is triggered by the event sent from the server: 

def somethingHappened(e):
    print("received trigger")

viz.callback(YOUR_EVENT, somethingHappened)

For sending from the client use this code:

viznet.client.sendAll(SPEAK_EVENT, client=viz.net.getName())

To get access to the client name (on the client script)

sightlab.getClientName()

To run a client with auto-start

sightlab = sl.SightLabClient(configpath = 'sightlab_configs/recent_config_client.stlb', hardwareconfig = "Vive Focus Vision", server = "COMPUTER-NAME")