Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Start the AWE Server on your Target. This can either be a local AWE Server on another PC or something like AWE_command_line. Make sure you know the IP or hostname of your target that’s running the server.

    Image RemovedImage Added

  2. Open the Global Preferences window from the file dropdown menu

    Image RemovedImage Added

  3. Switch the “Connection Type” dropdown from Local Server to Remote Server.

  4. Enter the IP or hostname of your remote target. The click “Reconnect to Server”

    Image RemovedImage Added

  5. If a successful connection is made, you will see a “Connected” string appear under your remote connection string. You will also notice that the default Audio File path has changed to your target’s filesystem.

    Image RemovedImage Added

  6. Now you can run your Designer layout on your remote target as if you were connected to a local target.

...

Note: This feature is currently supported only for AWE Core based targets and is not supported on Native or AWE Core OS targets.

Interpreted Modules

As mentioned in Audio-Weaver—Module-Developers-Guide.pdf, you can create custom Audio Weaver modules using the Pro Edition. While traditionally these modules could only be shared with other Pro users due to technical limitations, Interpreted Modules allow custom module authors a way to share their modules with other Designer users, regardless of Edition used. By following the creation steps below, a Pro user can create an Interpreted Module using the familiar MATLAB API that will behave similarly to other Audio Weaver modules, but importantly will be installable by Pro and Standard Designer using the Setting Search Paths functionality.

Creating an Interpreted Module

These steps assume you are familiar with creating a custom Audio Weaver module as discussed in Creating Custom Modules. The creation steps below are supplemental to the custom module creation process.

  1. Start by creating a Traditional Module to get the required files and folder structure of an Audio Weaver Module.

    1. The Custom Module Pack Wizard in Designer is a great starting point for getting started with the required module files and folder structure.

  2. As you edit the module’s MATLAB (.m) file, add the following line of code in the function:

    1. M.isInterpreted = 1;

    2. Switching this flag to 0 will force the module to be executed as a typical MATLAB module. While this makes the module inaccessible for Standard Designer users, the Module Author may do this in order to use the MATLAB debugging infrastructure to help resolve issues with their module.

  3. Follow the Module Creation steps as stated to get a properly functioning module, including the Module Generation MATLAB script e.g., make_module_pack(1) in Designer Pro Edition.

  4. Open the Interpreted Module’s Visual Studio solution and build the project. Make sure the built DLL is successfully created and in the Interpreted Module’s folder.

  5. Share the entire folder of the Interpreted Module (including the DLL) with other Designer users.

    1. Once shared, any user must copy the Interpreted Module’s DLL to the same directory as their AWE_Server.exe
      (for example, C:\DSP Concepts\AWE Designer 8.C.2.4 Standard\Bin\win32-vc142-rel\)

  6. Once Designer and Server are running, install the Interpreted Module to the Module Path using the Setting Search Paths functionality.

  7. The Interpreted Module can now be dragged out from the Module Palette to Designer’s canvas, with all the same capabilities as other Audio Weaver modules.

    1. The default location for a new Custom Module is in the “Third Party” folder. This can be changed in the MATLAB script by updating the M.moduleBrowser.path value.

Known Limitations

To make this feature compatible with both Pro and Standard Designer, there are several limitations that the module author will need to consider if this feature is right for their use case. All these limitations aim to address technical limitations without compromising the important functionality for most users.

The module must not make any references to any MATLAB functions not provided by Designer builds already. This primarily applies to functions that are not on the MATLAB path, function pointers to non-compiled MATLAB files, and external library functions not provided in Designer’s required toolboxes. An exception is made for certain custom module functions that extend the Interpreted Module’s functionality past default module behavior. The supported custom module functions for Interpreted Modules are:

  • copyVarFunc

  • preBuildFunc

  • prepareToSaveFunc

  • propagateChannelNamesFunc

  • postBuildFunc

  • setFunc

  • textLabelFunc

Any additional custom module functions available for Audio Weaver modules are not supported for Interpreted Modules at this time. Thus, they must not be defined in the Interpreted Module’s MATLAB file as it will make the whole module unusable in Designer. If you do have unsupported custom module functions in your Interpreted Module (for example, testHarnessFunc), make sure to comment the function assignment before using the module.

Because of internal technical dependencies, an Interpreted Module cannot contain any local, nested, or anonymous functions. This means that the custom module functions mentioned above must be defined in their own file, in the same directory of the module’s main MATLAB file.

Interpreted Module cannot have any variables that start with IMODAWE_. This is to avoid a potential variable namespace collision when interpreting the module’s MATLAB code.

...

.