Loading...

Adding a New Sound Phidget

To add a Sound Phidget device, open the Devices menu and select Phidgets Device > Sound Phidget Device. This will open the Configuration dialog. Alternatively, you can add a new device in the Configuration dialog with the "+" button when the dialog is already open.

On the right side, you can name, dis-/enable the device or configure it as explained in the next paragraph.

The Type informs you about the type of device or connection. The Groups lists the groups to which this device belongs. The Name is the unique identifier for this Sound Phidget object in WD and the general rules for naming objects apply here as well: only letters, numbers and underscores are allowed; the first symbol must be a letter. It is possible to change the default name to a more descriptive one. When scripting, enter this Name to access available members or use the Project object and device Type instead; examples are shown further down.

The Id offers an alternative way to address the device when scripting.

The "Enable" check box is ticked per default. On the left side, you should see that the icon in front of your Sound Phidget is a filled blue circle. An empty blue circle indicates an enabled device which is not connected. A filled gray circle indicates a disabled device.

You can close the dialog at any time. The newly created device will also be added to the Devices menu > Phidgets Device > Sound Phidget Device and can be opened from here or with Devices menu > Configuration.

The Phidgets Sound Phidget Settings

Using the Device in Regular Scripting

After adding a Sound Phidget, it can also be scripted which allows to perform actions on the device as well as retrieve information from it.

To send commands to the device, create a CustomScript button or anything with a scripting field. Enter the device's identifier name into the script field (per default that is e.g. "Phidgets_SoundPhidget1") and Script Assist will offer a list of all available members.

You can for example enable the device using scripting:
Phidgets_SoundPhidget1.Enable

You can also retrieve the current measurement in dB A:
vdouble = Phidgets_SoundPhidget1.Dba

The scripting structure for Phidgets provides two different approaches for setting and retrieving values.
If you are already familiar with the object-based notation and using properties, all device properties can be used like any other object property you have already encountered:
Phidgets_SoundPhidget1.Interval = 100
Label5.Text = "Current Update Interval: " + Phidgets_SoundPhidget1.Interval

If you prefer a command structure that distinctly implies the action to be performed, you can use the "Set..." and "Get..." members:
Phidgets_SoundPhidget1.SetInterval(100)
Label5.Text = "Current Update Interval: " + Phidgets_SoundPhidget1.GetInterval

Both approaches can be used interchangeably.

Please keep in mind that some properties are read-only properties, e.g. the measured decibel values or "Octaves", and do not provide a "Set..." member.
Furthermore, the higher-level properties of the device itself, like the Serial number or the Enabled state, need to be scripted as properties and do not provide the "Set..." and "Get..." members.

For a list with all available members and commands with examples and descriptions, please refer to the chapter Phidgets Sound Phidget Members.

As an alternative to explicitly naming the device, the "Project" object can be used. Choose the device type and address the device by entering its ID or name. Script Assist then offers you the same list of members. This is the alternative for the first example from above:
Project.Phidgets_SoundPhidget(1).Enable

Substituting the ID with a dynamic variable allows automation. Actions can be performed on many connections of the same type simultaneously, e.g. by using for-loops:
For i = 1 to 10 {

 Project.Phidgets_SoundPhidget(i).Enable

}

The chapter "Project and Context Member" shows more examples with for-loops and if-clauses; of course, normal variables can also be used.

Using the Device with Event Listener and Group Event Listener

Event Listeners can be added in the Configuration dialog and provide a simple way of listening to triggers from connected devices.

Please see the chapter Event Listener and Group Event Listener for a detailed description of its functionality and the Phidgets Sound Phidget Events chapter for a list (with examples and description) of the possible events raised by this device type.