# Knowledge Base

**URL:** https://mworks.discourse.group/c/kb/6.md

[Latest](https://mworks.discourse.group/latest.md) · [Categories](https://mworks.discourse.group/categories.md) · [Tags](https://mworks.discourse.group/tags.md)

---

## [About the Knowledge Base category](https://mworks.discourse.group/t/about-the-knowledge-base-category/21)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [July 18, 2022, 3:11pm UTC](https://mworks.discourse.group/t/about-the-knowledge-base-category/21 "2022-07-18T15:11:12Z")

</div>

Help articles on select topics. Supplement to the MWorks User Manual.

---

## [Creating a stimulus group from a folder of images](https://mworks.discourse.group/t/creating-a-stimulus-group-from-a-folder-of-images/35)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 3:04pm UTC](https://mworks.discourse.group/t/creating-a-stimulus-group-from-a-folder-of-images/35 "2018-04-30T15:04:24Z")

</div>

Many experiments involve displaying a sequence of image stimuli. If the images you want to use are in a folder on disk, you can easily create a group of image stimuli using a replicator. Range replicator Suppose you ha…

---

## [Installing MWorks](https://mworks.discourse.group/t/installing-mworks/36)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 2:53pm UTC](https://mworks.discourse.group/t/installing-mworks/36 "2018-04-30T14:53:26Z")

</div>

Basic Installation To learn the basics of installing MWorks, see Installation in the user manual. Additional Post-installation Steps Depending on your needs, there are some additional steps you may need to take after in…

---

## [Setting up an Arduino or compatible microcontroller as a Firmata device](https://mworks.discourse.group/t/setting-up-an-arduino-or-compatible-microcontroller-as-a-firmata-device/57)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [August 18, 2020, 7:24pm UTC](https://mworks.discourse.group/t/setting-up-an-arduino-or-compatible-microcontroller-as-a-firmata-device/57 "2020-08-18T19:24:11Z")

</div>

In order to be used with MWorks’ Firmata interface, an Arduino board or Arduino-compatible device must first be configured to support the Firmata protocol. To do this, follow these steps: Install and launch the Ardui…

---

## [Setting up an Adafruit Feather M0 Bluefruit LE as a Firmata device](https://mworks.discourse.group/t/setting-up-an-adafruit-feather-m0-bluefruit-le-as-a-firmata-device/59)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [August 18, 2020, 7:29pm UTC](https://mworks.discourse.group/t/setting-up-an-adafruit-feather-m0-bluefruit-le-as-a-firmata-device/59 "2020-08-18T19:29:11Z")

</div>

The Adafruit Feather M0 Bluefruit LE is a good choice for use with MWorks’ Firmata interface, particularly if you need to connect via Bluetooth Low Energy (BLE). The following steps detail how to prepare your board for …

---

## [Using the MATLAB window](https://mworks.discourse.group/t/using-the-matlab-window/45)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [November 29, 2016, 7:19pm UTC](https://mworks.discourse.group/t/using-the-matlab-window/45 "2016-11-29T19:19:35Z")

</div>

With MWClient’s MATLAB window, you can monitor and analyze the results of your experiment as it runs, using a user-defined MATLAB function. To help you understand and make use of this powerful feature, we’ll first walk …

---

## [MWorks release notes](https://mworks.discourse.group/t/mworks-release-notes/60)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [September 8, 2020, 9:11pm UTC](https://mworks.discourse.group/t/mworks-release-notes/60 "2020-09-08T21:11:27Z")

</div>

Recent Releases 0.13 0.12.2 0.12.1 0.12 0.11 0.10 0.9 0.8 0.7 0.6 0.5.1 0.5 0.4.5 0.4.4 Legacy Releases “0.4.3” Bug Fixes Fix memory leak in eye window Make parsing of data to eye window a bit cleaner Fix server liste…

---

## [Building MWorks from source](https://mworks.discourse.group/t/building-mworks-from-source/34)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [March 7, 2022, 3:47pm UTC](https://mworks.discourse.group/t/building-mworks-from-source/34 "2022-03-07T15:47:03Z")

</div>

Most users, including those developing custom plugins, do not need to compile MWorks themselves. However, for developers working on MWorks’ internals or users interested in modifying core components, the following steps…

---

## [Installing the iOS App](https://mworks.discourse.group/t/installing-the-ios-app/38)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [February 16, 2022, 2:18pm UTC](https://mworks.discourse.group/t/installing-the-ios-app/38 "2022-02-16T14:18:03Z")

</div>

MWorks for iOS is available on the App Store. To install it, use the App Store app on your device.

---

## [Setup for using the EyeLink 1000](https://mworks.discourse.group/t/setup-for-using-the-eyelink-1000/39)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [June 1, 2021, 4:15pm UTC](https://mworks.discourse.group/t/setup-for-using-the-eyelink-1000/39 "2021-06-01T16:15:57Z")

</div>

Before you can use an EyeLink 1000/1000 Plus eye tracker with MWorks, you must install the required interface software. First, if you have not already done so, register for access to the SR Research Support Site. Once …

---

## [Setup for using MATLAB](https://mworks.discourse.group/t/setup-for-using-matlab/37)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [November 9, 2020, 2:58pm UTC](https://mworks.discourse.group/t/setup-for-using-matlab/37 "2020-11-09T14:58:22Z")

</div>

In order to use MWClient’s MATLAB interface window, you need to tell MWorks the location of your MATLAB installation. To do this, you must create a symbolic link named MATLAB in the Applications directory that points t…

---

## [Recommended device settings](https://mworks.discourse.group/t/recommended-device-settings/53)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [February 10, 2020, 7:17pm UTC](https://mworks.discourse.group/t/recommended-device-settings/53 "2020-02-10T19:17:33Z")

</div>

To ensure that your experiments run smoothly and without unwanted interruptions, we recommend making the following changes in the Settings app of your iOS device: Do Not Disturb Enable “Do Not Disturb” Set “Silence”…

---

## [Accessing data files](https://mworks.discourse.group/t/accessing-data-files/61)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [June 24, 2019, 3:23pm UTC](https://mworks.discourse.group/t/accessing-data-files/61 "2019-06-24T15:23:00Z")

</div>

Event files created by MWorks for iOS are stored locally on the iOS device. To access them, open the Files app and navigate to On My iPad ➝ MWorks ➝ MWorks ➝ Data. From here, you can share one or more event files with …

---

## [Input/output devices](https://mworks.discourse.group/t/input-output-devices/58)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [June 11, 2018, 6:15pm UTC](https://mworks.discourse.group/t/input-output-devices/58 "2018-06-11T18:15:38Z")

</div>

MWorks for iOS supports most of the component types available on macOS. However, due to operating system restrictions, lack of iOS drivers, and other considerations, only a subset of MWorks’ input/output (I/O) devices a…

---

## [Loading and running experiments](https://mworks.discourse.group/t/loading-and-running-experiments/55)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [June 11, 2018, 5:03pm UTC](https://mworks.discourse.group/t/loading-and-running-experiments/55 "2018-06-11T17:03:23Z")

</div>

Using MWClient The primary (and recommended) way to load, run, and monitor experiments on an iOS device is via MWClient running on a Mac. When used in this way, MWorks’ iOS app plays the same role as MWServer on macOS. …

---

## [Configuration](https://mworks.discourse.group/t/configuration/46)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [June 11, 2018, 2:49pm UTC](https://mworks.discourse.group/t/configuration/46 "2018-06-11T14:49:11Z")

</div>

To configure MWorks for iOS, use the system Settings app. You can find all of MWorks’ settings in the section titled “MWorks”. The iOS version of MWorks supports most of the configuration options available in the Mac v…

---

## [Setup for using NI-DAQ devices](https://mworks.discourse.group/t/setup-for-using-ni-daq-devices/40)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 3:18pm UTC](https://mworks.discourse.group/t/setup-for-using-ni-daq-devices/40 "2018-04-30T15:18:32Z")

</div>

Note: As of MWorks 0.12, NI-DAQ devices are no longer supported. The following information applies only to MWorks 0.11 and earlier. MWorks can interface with National Instruments data acquisition (NI-DAQ) devices via th…

---

## [Understanding display update time stamps](https://mworks.discourse.group/t/understanding-display-update-time-stamps/42)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 3:16pm UTC](https://mworks.discourse.group/t/understanding-display-update-time-stamps/42 "2018-04-30T15:16:16Z")

</div>

Whenever the stimulus displayed is updated, MWorks generates a #stimDisplayUpdate event. Like all MWorks events, display update announcements include an event time (indicating microseconds elapsed since the server start…

---

## [Image stimulus memory usage](https://mworks.discourse.group/t/image-stimulus-memory-usage/43)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 3:11pm UTC](https://mworks.discourse.group/t/image-stimulus-memory-usage/43 "2018-04-30T15:11:29Z")

</div>

The memory requirements of an experiment that loads a large number of image stimuli can exceed available main memory (RAM) or video memory (VRAM). When this happens, there are a number of steps you can take to reduce yo…

---

## [Setting up a client-server connection over the network](https://mworks.discourse.group/t/setting-up-a-client-server-connection-over-the-network/48)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 3:00pm UTC](https://mworks.discourse.group/t/setting-up-a-client-server-connection-over-the-network/48 "2018-04-30T15:00:48Z")

</div>

MWorks allows you to run the MWClient and MWServer applications on separate machines, with communication between the two processes taking place over the network. The instructions below describe how to establish such a c…

---

## [Expression syntax](https://mworks.discourse.group/t/expression-syntax/32)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 2:58pm UTC](https://mworks.discourse.group/t/expression-syntax/32 "2018-04-30T14:58:54Z")

</div>

To learn about MWorks’ expression syntax, see Expressions in the user manual.

---

## [Uninstalling MWorks](https://mworks.discourse.group/t/uninstalling-mworks/50)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 2:57pm UTC](https://mworks.discourse.group/t/uninstalling-mworks/50 "2018-04-30T14:57:32Z")

</div>

To learn how to uninstall MWorks, see Uninstall or Revert in the user manual.

---

## [Configuring MWorks](https://mworks.discourse.group/t/configuring-mworks/44)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [April 30, 2018, 2:55pm UTC](https://mworks.discourse.group/t/configuring-mworks/44 "2018-04-30T14:55:33Z")

</div>

To learn about configuring MWorks, see Configuration in the user manual.

---

## [Saving and restoring client state](https://mworks.discourse.group/t/saving-and-restoring-client-state/51)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [November 29, 2016, 4:20pm UTC](https://mworks.discourse.group/t/saving-and-restoring-client-state/51 "2016-11-29T16:20:33Z")

</div>

There are several ways to recall desired states of MWClient. MWorks has the ability to: Save variable sets into .xml files. Save and restore client plugin windows between sessions. Save entire client configuration to a…

---

## [MWorks philosophy](https://mworks.discourse.group/t/mworks-philosophy/33)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [November 29, 2016, 3:33pm UTC](https://mworks.discourse.group/t/mworks-philosophy/33 "2016-11-29T15:33:57Z")

</div>

MWorks is a suite of applications that is intended to allow users to quickly design and execute neurophysiological or psychophysical experiments. MWorks was conceived and developed in response to the limitations of curre…

---

## [MWorks applications](https://mworks.discourse.group/t/mworks-applications/41)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [October 13, 2015, 4:51pm UTC](https://mworks.discourse.group/t/mworks-applications/41 "2015-10-13T16:51:49Z")

</div>

MWorks consists of a suite of three applications: the editor (MWEditor), the client (MWClient), and the server (MWServer). The editor is used to construct an experiment via a graphical user interface. This is the too…

---

## [Setup for using the ITC-18](https://mworks.discourse.group/t/setup-for-using-the-itc-18/52)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [March 30, 2015, 1:32pm UTC](https://mworks.discourse.group/t/setup-for-using-the-itc-18/52 "2015-03-30T13:32:35Z")

</div>

Note: As of MWorks 0.12, the ITC-18 is no longer supported. The following information applies only to MWorks 0.11 and earlier. Before you can use an ITC-18 in your experiments, you must install the ITC-18 drivers. To d…

---

## [Using the file hash to verify an image stimulus](https://mworks.discourse.group/t/using-the-file-hash-to-verify-an-image-stimulus/49)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [February 13, 2014, 5:06pm UTC](https://mworks.discourse.group/t/using-the-file-hash-to-verify-an-image-stimulus/49 "2014-02-13T17:06:47Z")

</div>

Available in post-0.4.4 releases of MWorks, including nightly builds since January 25, 2011 Whenever MWorks displays an image stimulus, information about the image is logged to the data file in a #stimDisplayUpdate even…

---

## [Updating plugins for 0.5](https://mworks.discourse.group/t/updating-plugins-for-0-5/47)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [March 8, 2013, 8:39pm UTC](https://mworks.discourse.group/t/updating-plugins-for-0-5/47 "2013-03-08T20:39:15Z")

</div>

In order to be compatible with MWorks 0.5, plugins developed for earlier releases need some minor updates. The exact changes required depend on the type of plugin and are described below. All plugins All MWorks plugins…

---

## [Upgrading to 0.5](https://mworks.discourse.group/t/upgrading-to-0-5/54)

<div class="topic-metadata">

**Author:** [@cstawarz](https://mworks.discourse.group/u/cstawarz)\
**Replies:** 0\
**Last updated:** [March 8, 2013, 7:31pm UTC](https://mworks.discourse.group/t/upgrading-to-0-5/54 "2013-03-08T19:31:00Z")

</div>

In MWorks 0.5, the experiment parser has become more rigorous about validating component parameters. In particular, if a component definition includes unrecognized parameters, the experiment will now fail to load. This…

[Next page](https://mworks.discourse.group/c/kb/6.md?page=1)
