Loading...
This chapter gives an overview of the members available for the Phidgets Spatial 3/3/3 device.
Please read the chapter "Phidgets - Spatial 3/3/3" if you would like to know how to add and use this device. As explained in the topic"Object and Member Notation (dot syntax)", all kinds of objects can be addressed in the scripting language by using their members which set (or return if applicable) properties or methods of that object. Please refer to the chapter "Script Language" for more details about scripting in general.
Project.Phidgets_Spatial_3_3_3(deviceName or ID) |
Example: Alternative Example: |
This gives access to all further members of the device "Phidgets_Spatial_3_3_3" from the Configuration dialog. Using the Project object is an alternative to addressing the device directly by entering its name. The Project object allows to address the device through its name or ID. Substituting the ID with a dynamic variable allows automation. Actions can be performed on many devices of the same type simultaneously, e.g. by using for-loops: |
Phidgets_Spatial_3_3_3_Name.AccelerationAxisX |
Example: Alternative Example: |
This member returns the X acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.AccelerationAxisX |
Phidgets_Spatial_3_3_3_Name.AccelerationAxisY |
Example: Alternative Example: |
This member returns the Y acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.AccelerationAxisY |
Phidgets_Spatial_3_3_3_Name.AccelerationAxisZ |
Example: Alternative Example: |
This member returns the Z acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.AccelerationAxisZ |
Phidgets_Spatial_3_3_3_Name.Bearing |
Example: Alternative Example: |
This member returns the Bearing value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.Bearing |
Phidgets_Spatial_3_3_3_Name.Channel |
Example: Alternative Example: |
This member sets and returns the channel which is displayed next to "Channel" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.Channel Example2: The second example shows, how to set the channel to a value of 2. |
Phidgets_Spatial_3_3_3_Name.CompassCorrection |
Example: Alternative Example: |
This returns the compass correction values as a list. You could also display it in the Debug Logger: DebugMessage(Phidgets_Spatial_3_3_3_1.CompassCorrection) Example2: When you are using the compass function of the Phidget Spatial device, you can perform a magnetic error correction beforehand. Follow the instructions on the product website for calibrating the device and copy/paste the parameters displayed in the text box to the Compass Correction into the WD Configuration dialog or assign the 13 values as a list using this command. |
Phidgets_Spatial_3_3_3_Name.CompassX |
Example: Alternative Example: |
This member returns the X Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.CompassX |
Phidgets_Spatial_3_3_3_Name.CompassY |
Example: Alternative Example: |
This member returns the Y Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.CompassY |
Phidgets_Spatial_3_3_3_Name.CompassZ |
Example: Alternative Example: |
This member returns the Z Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.CompassZ |
Phidgets_Spatial_3_3_3_Name.DeviceSerial |
Example: Alternative Example: |
This member sets and returns the serial number which is displayed next to "Serial" in the Configuration menu when selecting the according Phidgets device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.DeviceSerial Example2: The second example shows, how to set the serial number of the device in the Configuration menu to 530161. |
Phidgets_Spatial_3_3_3_Name.Disable |
Example: Alternative Example: |
This disables the Phidgets device in the Configuration dialog as if the "Enable" check box in the window was unchecked. Use the .Enable member to reverse this command. |
Phidgets_Spatial_3_3_3_Name.Enable |
Example: Alternative Example: |
This enables the Phidgets device in the Configuration dialog as if the "Enable" check box in the window was checked. Use the .Disable member to reverse this command. |
Phidgets_Spatial_3_3_3_Name.GetAccelerationAxisX |
Example: Alternative Example: |
This member returns the X acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetAccelerationAxisX |
Phidgets_Spatial_3_3_3_Name.GetAccelerationAxisY |
Example: Alternative Example: |
This member returns the Y acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetAccelerationAxisY |
Phidgets_Spatial_3_3_3_Name.GetAccelerationAxisZ |
Example: Alternative Example: |
This member returns the Z acceleration value of the Phidget Spatial device which is displayed next to "Acc X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetAccelerationAxisZ |
Phidgets_Spatial_3_3_3_Name.GetBearing |
Example: Alternative Example: |
This member returns the Bearing value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetBearing |
Phidgets_Spatial_3_3_3_Name.GetCompassCorrection |
Example: Alternative Example: |
This returns the compass correction values as a list. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetCompassCorrection |
Phidgets_Spatial_3_3_3_Name.GetCompassX |
Example: Alternative Example: |
This member returns the X Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetCompassX |
Phidgets_Spatial_3_3_3_Name.GetCompassY |
Example: Alternative Example: |
This member returns the Y Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetCompassY |
Phidgets_Spatial_3_3_3_Name.GetCompassZ |
Example: Alternative Example: |
This member returns the Z Compass value of the Phidget Spatial device which is displayed next to "Compass X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetCompassZ |
Phidgets_Spatial_3_3_3_Name.GetGyroscopePositionX |
Example: Alternative Example: |
This member returns the X gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetGyroscopePositionX |
Phidgets_Spatial_3_3_3_Name.GetGyroscopePositionY |
Example: Alternative Example: |
This member returns the Y gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetGyroscopePositionY |
Phidgets_Spatial_3_3_3_Name.GetGyroscopePositionZ |
Example: Alternative Example: |
This member returns the Z gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetGyroscopePositionZ |
Phidgets_Spatial_3_3_3_Name.GetInterval |
Example: Alternative Example: |
This member returns the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetInterval |
Phidgets_Spatial_3_3_3_Name.GetPitch |
Example: Alternative Example: |
This member returns the Pitch angle value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetPitch |
Phidgets_Spatial_3_3_3_Name.GetRoll |
Example: Alternative Example: |
This member returns the Roll angle value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GetRoll |
Phidgets_Spatial_3_3_3_Name.GyroscopePositionX |
Example: Alternative Example: |
This member returns the X gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GyroscopePositionX |
Phidgets_Spatial_3_3_3_Name.GyroscopePositionY |
Example: Alternative Example: |
This member returns the Y gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GyroscopePositionY |
Phidgets_Spatial_3_3_3_Name.GyroscopePositionZ |
Example: Alternative Example: |
This member returns the Z gyroscope position value of the Phidget Spatial device which is displayed next to "Gyro X,Y,Z Axis Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.GyroscopePositionZ |
Phidgets_Spatial_3_3_3_Name.HubPort |
Example: Alternative Example: |
This member sets and returns the hub port number which is displayed next to "Hub Port" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.HubPort Example2: The second example shows, how to set the hub port to a value of 2. |
Phidgets_Spatial_3_3_3_Name.Interval |
Example: Alternative Example: |
This member sets and returns the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.Interval Example2: The second example shows, how to set the interval time to a value of 500ms. |
Phidgets_Spatial_3_3_3_Name.IsConnected |
Example: Alternative Example: |
This member returns the connection status for the Phidgets device as a Boolean value. The result is "True" if the device is connected and "False" if it is currently disconnected. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.IsConnected |
Phidgets_Spatial_3_3_3_Name.IsEnabled |
Example: Alternative Example: |
This member returns the status of the check box "Enable" of the configuration dialog when selecting the according Phidget device. The result, a Boolean value (or string), is "True" if the device is enabled and "False" if it is currently not enabled. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.IsEnabled |
Phidgets_Spatial_3_3_3_Name.IsHubPortDevice |
Example: Alternative Example: |
This member returns the status of the check box "Is Hub Port Device" of the configuration dialog when selecting the according Phidget device. The result, a Boolean value (or string), is "True" if the device is a hub port device and "False" if it is not. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.IsHubPortDevice |
Phidgets_Spatial_3_3_3_Name.Pitch |
Example: Alternative Example: |
This member returns the Pitch angle value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.Pitch |
Phidgets_Spatial_3_3_3_Name.Roll |
Example: Alternative Example: |
This member returns the Roll angle value of the Phidget Spatial device which is displayed next to "Roll, Pitch, Bearing Value" in the Configuration menu when selecting the according Phidget device. You could also write it into a Widget, e.g. a Label via the script: Label1.Text = Phidgets_Spatial_3_3_3_1.Roll |
Phidgets_Spatial_3_3_3_Name.SetCompassCorrection(compassCorrectionValues) |
Example: Alternative Example: |
When you are using the compass function of the Phidget Spatial device, you can perform a magnetic error correction beforehand. Follow the instructions on the product website for calibrating the device and copy/paste the parameters displayed in the text box to the Compass Correction into the WD Configuration dialog or assign the 13 values as a list using this command. |
Phidgets_Spatial_3_3_3_Name.SetInterval(value) |
Example: Alternative Example: |
This member sets the interval time which is displayed next to "Interval (ms)" in the Configuration menu when selecting the according Phidget device. The example shows how to set the interval time to a value of 500ms. |
Phidgets_Spatial_3_3_3_Name.ZeroGyroscope |
Example: Alternative Example: |
To compensate for the drift that is inherent to all gyroscopes, execute the ZeroGyroscope method. |