Using the Task Scheduler
This document describes how to use the Task Scheduler option in AudioTools.
The Scheduler can
be used to set up a group of tests to be run sequentially,
automatically. Results are stored at the end of each test using a
common file name convention.
Scheduler cannot run every AudioTools module. For one thing, the module must be able to store data. Also, some modules require hardware interaction, and are not suitable for automatic test runs.
In this document,
we will call a "test" a complete test run, which may include many
individual audio measurements, which we will call "tasks".
The Scheduler Screen
When you first enter the Scheduler, you will see the main Scheduler screen.
Tests are stored in files, in the public/test folder on the iOS device, and on your Dropbox, if you have it linked. Each test file contains information about the test, and a list of tasks to run.
The test files present are shown in a table on the Scheduler screen. You can add tests with the + button, delete a test by swiping across it, edit a test by tapping the "i" or arrow disclosure button, or tap on the test table cell to start the test running.
After tapping the "+" button to create a new test, or tapping the disclosure button, you can edit the test file.
Editing a Test
To create a new test schedule, tap the + on the Scheduler screen. This will bring up the Test screen.
The Test
These are the parameters fro the Test:
Test Name
To change the name of the test, just edit the text field on the top of the Test screen. A new test will be created using the new name, and the old test (if already saved) will not be changed or deleted.
Start Time
You can set an optional start
time in hours and minutes for a test. This is the time of day that the
test will start, if the Start Time switch is turned on.
Since iOS does not let us run in the background, the app must be open and be displaying the main Scheduler list for the task to start at the specified time. You can turn the screen off, but the app must be the primary running app.
Also, a new test will only start if no other test is already running.
If you leave the app running, any tasks with a Start Time (and switch turned on) will run each day when that time is reached.
If you are using this with SPL
Graph, you do not need to set a Run Limit, and you do not need to turn
on Auto Save Data at End of Timed Run, since the scheduler will handle
these details. Do set the Email Data switches and email fields, if you
would like the results or image emailed to you.
Start Delay
Set an optional time to wait
before the test begins. This allows you to move the iOS device, or to
setup the testing environment before the test run starts. Time is shown
in minutes and seconds.
Time Between Tests
Set an optional time to wait in between each task. This can allow time for the room to quiet down between tasks, for example. Time is shown in minutes and seconds.Prompt for Next Test
Normally, each task starts
automatically, after the Time Between Tests. Turning this option on
allows you to control when the next task will start manually. The
Scheduler will wait for you to tap a button before it continues on to
the next task.
Lockout Local Control
When a task is running, you can
interact with the screen, which could affect the outcome of the
measurement results. Turning on this option ensures that the task will
run undisturbed.
Note:
It is possible to create a scenario where a task is running, and you
can't interrupt it, for example by setting a very long task run time
with lockout turned on. The only way to exit the app would be by
force-quitting it. To do this, double-click the menu button, and follow
the iOS procedure for force-quitting an app, to end the app operation.
Task List
Below the test settings is the list of tasks. This list will be empty until you add a task, using the "+" button. You can also delete a task by swiping across the table cell, or reorder the tasks after tapping the Edit button and moving them by touching the control on the right and dragging the cell to a new position in the list.
After you tap the "+" button, or when you tap the task table cell, the Task editing screen appears.
The Automated Task
Task Parameters
The individual task settings, such as octave banding, weightings, decay times, and graph parameters are all set locally in the module. These settings are automatically saved, and will be in effect when the automated task runs. Make sure your tasks are setup the way that you want them before you start the test schedule.
The run time parameters for the
task are set on the Task Screen. These include the length of time that
the task will run, whether it will turn on the generator, and the task
itself.
Generator
Set up the generator for this task using the Generator panel. You can turn on the generator, select the signal type, and for sine or square waves, the frequency. You can also select the balanced / mono signal mode.
Note that some tasks, such as STIPA, will always use their special signal. You still have to turn on the generator switch if you want the signal to play.
Surround Signals
Surround signals may be
selected, if you have the Surround Generator module unlocked. When a
surround signal is selected, the channel designator will be added to
the file, just before the date, so that you can run a number of
surround tests in the same test run without the files overwriting.
Run TIme
Set the time that you wish the
task to run in this field. Note that you will have to take into account
any special considerations for the actual task. For example, if the
Amplitude Sweep module is set to run a 30 second sweep, make sure you
allow enough task run time for the sweep to complete. The same thing
applies to STIPA, which requires a certain test length to complete.
Select Task
Select the task from the list of
available tasks. If a measurement is not included in this list, it is
not supported for automated tests.