Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
panelIconId1f6a7
panelIcon:construction:
panelIconText🚧
bgColor#FFF0B3

This page is a work in progress. Improvements to content and formatting are underway.

Overview

As shown below, there are 3 main components of an Audio Weaver system that require communication in order to tune an audio system. The Designer GUI will generate text based tuning commands (AWS) based on the layout and any user tuning commands. These commands are sent to AWE Server, which in turn compiles the AWS commands into binary commands (AWB) that can be sent to the target running the AWE Core. The target processes the AWB commands and then generates a reply message that is sent back to the AWE Server.

...

Expand
titleClick to expand

Command

Description

add_module

Adds one or more modules to a given layout.

add_symbol_id

Defines a new entry in the symbol table based on the unique ID of the object.

audio_pump

Run the layout using either WAV/MP3 files, or audio line input as the source (BSP)

audio_stop

Stop the audio pump if running (BSP)

bind_wire

Binds a named wire to an input or output pin

close_input

Close an audio device used for combined input, giving zero samples in its place

close_output

Close an audio device used for combined output

cmd

Generic command handler (advanced).

compile

Compiles an AWS script file to AWB binary form (BSP)

connect

Initiates a connection from a client (backward compatibility, ignored, BSP)

clear_credentials

Removes credentials from the INI file

clear_symbols

Empty the server symbol table. (Windows, Linux)

create_active

Creates a control to display 4 radio buttons of module state (BSP, GUI only)

create_bitmap

Creates an image control on a dialog (BSP, GUI only)

create_button

Creates a button on a dialog (BSP, GUI only)

create_checkbox

Creates a checkbox on a dialog (BSP, GUI only)

create_dialog

Creates a named dialog (BSP, GUI only)

create_droplist

Creates a drop list control on a dialog (BSP, GUI only)

create_awslist

Creates a drop list control specifying AWS script files allowing the user to select and run presets from the list (BSP, GUI only)

create_edit

Creates an edit box control on a dialog (BSP, GUI only)

create_filelist

Creates a file list control on a dialog.  Used for streaming files to the target (BSP, GUI only)

create_graph

Creates a graph control that represents array elements as bar graphs (BSP, GUI only)

create_grid

Creates a grid control operating as as small spreadsheet for manipulating one or two dimensional arrays (BSP, GUI only)

create_layout

Creates a layout with the specified properties

create_led

Creates an LED style control on a dialog (BSP, GUI only)

create_lookup

Creates an O(1) ID lookup table

create_meter

Creates a meter control on a dialog (BSP, GUI only)

create_module

Creates a module with the specified properties

create_slider

Creates a slider or knob control on a dialog (BSP, GUI only)

create_spline

Creates an X-Y spline control on a dialog (BSP, GUI only)

create_text

Creates a static text control on a dialog (BSP, GUI only)

create_wire

Creates a wire with specified properties

deferred_process

Cause deferred commands to be executed.

delete_file

Deletes a file (BSP)

destroy

Unconditionally destroys all created objects (BSP)

destroy_dialog

Destroys a dialog (BSP, GUI only)

dialog_state

Toggles between normal and expanded views (BSP, GUI only)

end_binary

Stops logging of binary commands sent to the target (BSP)

erase_all

Erases all files in the target file system (BSP)

exists_dialog

Checks if a dialog with a specified name exists (BSP, GUI only)

exit

Causes the server to exit (BSP)

fast_audio_pump

Run a layout using only files at the greatest possible speed. Intended for test (BSP)

fast_read

Reads float arrays of binary data (Matlab)

fast_read_int

Reads integer arrays of binary data (Matlab)

fast_write

Writes arrays of binary float data (Matlab)

fast_write_int

Writes arrays of binary integer data (Matlab)

fast_write_partial

Writes arrays of binary float data without performing a set call (Matlab)

fast_write_int_partial

Writes arrays of binary integer data without performing a set call (Matlab)

file_exists

Report if a specified file exists (BSP)

file_logging

Specifies whether to log commands and replies to a file (BSP)

file_to_pin

Bind a WAV file to an input pin as a file player (BSP)
THE COMMAND IS NOT IMPLEMENTED.

foreground

Brings all Audio Weaver windows to the foreground thus making them visible (BSP, GUI only)

framework

Change the connected target (BSP)

getini

Returns an entry from the AWE_Server.ini file (BSP)

get_call

Calls the get_call function of a module

get_cores

Returns the number of cores or instances.

get_core_list

Returns the number of cores or instances, and their IDs.

get_executable_dir

Returns the directory containing the AWE_Server.exe executable (BSP)

get_extended_info

Returns the target’s extended info.

get_filesystem_info

Returns information about the target file system (BSP)

get_first_core

Return info on the first (and possibly only) core (BSP)

get_first_file

Returns the properties of the first file (BSP)

get_first_io

Returns the properties of the first I/O object

get_first_object

Returns the properties of the first object instance

get_heap_count

Returns the number of framework heaps

get_heap_size

Returns the free space and sizes of the heaps

get_instance_table

Returns the number of cores or instances and their IDs.

get_moduleclass_count

Returns the number of module classes

get_moduleclass_info

Returns information about the specified module class

get_module_state

Returns the muted etc. state of the given module

get_next_core

Return info on cores after the first (BSP)

get_next_file

Returns the properties of the next file, or fails if no more (BSP)

get_next_io

Returns the properties of the next I/O object, or fails of no more

get_next_object

Returns the properties of the next object, or fails if no more objects

get_object_byname

Returns the properties of the named object

get_rate

Returns the properties of an audio file

get_schema

Returns the schema for a class (BSP)

get_target_info

Returns the detailed info for an AWE instance.

get_type

Report the type of an expression (int, float, ...) (BSP)

get_value

Returns the value of a symbolically specified location

get_version

Returns the current version number of Audio Weaver (BSP)

gui_logging

Controls whether commands and replies are logged on the server control panel (BSP)

kill_pump

Cause the audio pump to die

make_binary

Starts logging of binary target commands to a named file (BSP)

open_web_page

Launches a browser and displayed a specified page (BSP, GUI only)

pin_to_file

Bind a file writer to an output pin
THE COMMAND IS NOT IMPLEMENTED.

pump

Pump the entire framework once

pump_layout

Pumps the given layout once

pump_module

Executes the pump function of the given module

query_pin

Queries a named pin for its properties

query_pump

Test if the audio pump is running

query_wire

Queries a named wire for its properties

read_file

Reads from a file (BSP)

read_float_array

Reads values from an array as floats

read_fract_array

Reads values from an array as fracts reported is floating values

read_int_array

Reads values from an array as integers

reboot_target

Cause an embedded target to reboot. Ignored by Windows and Linux

rename_pin

Change the name of a pin
THE COMMAND IS NOT IMPLEMENTED.

reopen_input

Reopen an input device previously closed with close_input

reopen_output

Reopen an output device previously closed with close_output

script

Executes a script file containing commands (BSP)

select_core

Choose which core to report on (BSP, GUI only)

setini

Writes a specified INI file entry with a value (BSP)

set_call

Calls the set_call function of a module

set_core_description

Sets a description file used for target emulation

set_cores

For multicore SMP systems you can specify how many cores to use (BSP)

set_instance_id

Change the ID of some module to the specified ID

set_module_state

Sets a given module to muted, activated, bypass, or disabled

set_path

Set the path to search for audio files used by audio_pump

set_pointer

Assigns a symbolically specified location a pointer value

set_value

Assigns a symbolically specified location a value

show

Allows the server dialog to be hidden while child dialogs are up (BSP, GUI only)

target_execute

Cause an embedded target to run an AWB file from its local file system

trace

Cause a target to echo a message to stdout.

update_lookup

Updates the O(1) ID lookup table after IDs have been changed by assignment (legacy support only, ignored)

write_file

Write to a target file system file (BSP)

write_float_array

Writes values to a float array

write_float_array_partial

As write_float_array, but no set call.

write_fract_array

Writes values to a fract array

write_fract_array_partial

As write_fract_array, but no set call.

write_int_array

Writes values to an integer array

write_int_array_partial

As write_int_array, but no set call.

write_pump_read

Write input wire, pump, layout, read output wire. Intended for test

...

Returns the number of cores (or instances) defined by the target, and all their IDs. See also get_instance_table below which is an alias.

success,number of cores, <list of core IDs>

...

Returns the next object in the forms described in get_first_object, or:

failed, no more objects

...

Any attempt to set the description file currently in use reports success,no change. If the command succeeded in loading a new file (or reverting to SMP) the reply is success.

set_cores (BSP,

...

Windows, Linux)

Syntax:

set_cores,N

For SMP targets only, destroys all existing core objects, and creates N new ones. The allowed range is 1-16. The number of cores on server start is 2. The current number of cores can be found using get_cores. Embedded targets with multiple cores have a fixed number of physical cares and do not implement this command.

...

expression is as described in get_value,

value is a number to be assigned to the location described by expression

...

For more about binary packets, including a detailed list of available commands, see AWE Core Tuning Command Syntax and Protocol .