| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Phidget.GetProperty
Queries a property for a phidget device.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Phidget | 13.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
MBS( "Phidget.GetProperty"; PhidgetRef; PropertyName ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| PhidgetRef | The reference number for the phidget. | $phidget |
| PropertyName | The name of the property to set. | "HeatingEnabled" |
Result
Returns value or error.
Description
Queries a property for a phidget device.Please check phidgets documentation about what things which device has and what values are returned.
| All devices | Attached | Boolean |
| IsLocal | Boolean | |
| IsChannel | Boolean | |
| IsRemote | Boolean | |
| IsHubPortDevice | Boolean | |
| Channel | Integer | |
| HubPort | Integer | |
| HubPortCount | Integer | |
| DeviceVersion | Integer | |
| DeviceID | Enum | |
| ChannelClass | Enum | |
| ChannelSubclass | Enum | |
| DeviceClass | Enum | |
| ServerName | String | |
| ServerUniqueName | String | |
| ServerPeerName | String | |
| ServerHostname | String | |
| ChannelClassName | String | |
| ChannelName | String | |
| DeviceClassName | String | |
| DeviceName | String | |
| DeviceSKU | String | |
| DeviceLabel | String | |
| DataInterval | UInt32 | |
| DeviceSerialNumber | Int32 | |
| Parent | Device Reference Number | |
| Hub | Device Reference Number | |
| Accelerometer | Timestamp | Double |
| AccelerationChangeTrigger | Double | |
| MinAccelerationChangeTrigger | Double | |
| MaxAccelerationChangeTrigger | Double | |
| HeatingEnabled | Boolean | |
| MinDataInterval | UInt32 | |
| MaxDataInterval | UInt32 | |
| AxisCount | Integer | |
| Acceleration | DoubleArray | |
| MinAcceleration | DoubleArray | |
| MaxAcceleration | DoubleArray | |
| CurrentInput | CurrentChangeTrigger | Double |
| MaxCurrentChangeTrigger | Double | |
| MinCurrentChangeTrigger | Double | |
| Current | Double | |
| MinCurrent | Double | |
| MaxCurrent | Double | |
| MinDataInterval | UInt32 | |
| PowerSupply | Enum | |
| DCMotor | Acceleration | Double |
| BackEMF | Double | |
| BackEMFSensingState | Integer | |
| BrakingStrength | Double | |
| CurrentLimit | Double | |
| CurrentRegulatorGain | Double | |
| FanMode | Enum | |
| MaxAcceleration | Double | |
| MaxBrakingStrength | Double | |
| MaxCurrentLimit | Double | |
| MaxCurrentRegulatorGain | Double | |
| MaxDataInterval | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| MaxVelocity | Double | |
| MinAcceleration | Double | |
| MinBrakingStrength | Double | |
| MinCurrentLimit | Double | |
| MinCurrentRegulatorGain | Double | |
| MinDataInterval | UInt32 | |
| MinFailsafeTime | UInt32 | |
| MinVelocity | Double | |
| TargetBrakingStrength | Double | |
| TargetVelocity | Double | |
| Velocity | Double | |
| DigitalInput | InputMode | Enum |
| PowerSupply | Enum | |
| State | Integer | |
| DigitalOutput | DutyCycle | Double |
| Frequency | Double | |
| LEDCurrentLimit | Double | |
| LEDForwardVoltage | Enum | |
| MaxDutyCycle | Double | |
| MaxFailsafeTime | UInt32 | |
| MaxFrequency | Double | |
| MaxLEDCurrentLimit | Double | |
| MinDutyCycle | Double | |
| MinFailsafeTime | UInt32 | |
| MinFrequency | Double | |
| MinLEDCurrentLimit | Double | |
| State | Integer | |
| DistanceSensor | SonarQuietMode | Boolean |
| DistanceChangeTrigger | UInt32 | |
| Distance | UInt32 | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| MaxDistanceChangeTrigger | UInt32 | |
| MinDistanceChangeTrigger | UInt32 | |
| MaxDistance | UInt32 | |
| MinDistance | UInt32 | |
| Encoder | Enabled | Boolean |
| MinDataInterval | UInt32 | |
| MaxDataInterval | UInt32 | |
| IndexPosition | Int64 | |
| Position | Int64 | |
| IOMode | Enum | |
| PositionChangeTrigger | UInt32 | |
| MinPositionChangeTrigger | UInt32 | |
| MaxPositionChangeTrigger | UInt32 | |
| FrequencyCounter | Count | UInt64 |
| Enabled | Boolean | |
| FilterType | Enum | |
| FrequencyCutoff | Double | |
| Frequency | Double | |
| InputMode | Enum | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| MaxFrequency | Double | |
| MinFrequencyCutoff | Double | |
| MaxFrequencyCutoff | Double | |
| TimeElapsed | Double | |
| PowerSupply | Enum | |
| GPS | Altitude | Double |
| Heading | Double | |
| Latitude | Double | |
| Longitude | Double | |
| LCD | Backlight | Double |
| MinBacklight | Double | |
| MaxBacklight | Double | |
| Contrast | Double | |
| MinContrast | Double | |
| MaxContrast | Double | |
| CursorBlink | Integer | |
| CursorOn | Integer | |
| FrameBuffer | Integer | |
| Width | Integer | |
| Height | Integer | |
| Sleeping | Integer | |
| ScreenSize | Enum | |
| Gyroscope | AngularRate | DoubleArray |
| MinAngularRate | DoubleArray | |
| MaxAngularRate | DoubleArray | |
| AxisCount | Integer | |
| MinDataInterval | UInt32 | |
| MaxDataInterval | UInt32 | |
| HeatingEnabled | Boolean | |
| Timestamp | Double | |
| CapacitiveTouch | MaxDataInterval | UInt32 |
| MinDataInterval | UInt32 | |
| Sensitivity | Double | |
| MinSensitivity | Double | |
| MaxSensitivity | Double | |
| IsTouched | Boolean | |
| TouchValue | Double | |
| MinTouchValue | Double | |
| MaxTouchValue | Double | |
| TouchValueChangeTrigger | Double | |
| MinTouchValueChangeTrigger | Double | |
| MaxTouchValueChangeTrigger | Double | |
| HumiditySensor | Humidity | Double |
| MinHumidity | Double | |
| MaxHumidity | Double | |
| HumidityChangeTrigger | Double | |
| MinHumidityChangeTrigger | Double | |
| MaxHumidityChangeTrigger | Double | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| LightSensor | Illuminance | Double |
| MaxIlluminance | Double | |
| MinIlluminance | Double | |
| IlluminanceChangeTrigger | Double | |
| MaxIlluminanceChangeTrigger | Double | |
| MinIlluminanceChangeTrigger | Double | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| Magnetometer | AxisCount | Integer |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| HeatingEnabled | Boolean | |
| MagneticField | DoubleArray | |
| MinMagneticField | DoubleArray | |
| MaxMagneticField | DoubleArray | |
| MagneticFieldChangeTrigger | Double | |
| MinMagneticFieldChangeTrigger | Double | |
| MaxMagneticFieldChangeTrigger | Double | |
| Timestamp | Double | |
| PHSensor | CorrectionTemperature | Double |
| MinCorrectionTemperature | Double | |
| MaxCorrectionTemperature | Double | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| PH | Double | |
| MinPH | Double | |
| MaxPH | Double | |
| PHChangeTrigger | Double | |
| MinPHChangeTrigger | Double | |
| MaxPHChangeTrigger | Double | |
| PowerGuard | OverVoltage | Double |
| MaxOverVoltage | Double | |
| MinOverVoltage | Double | |
| FanMode | Enum | |
| PowerEnabled | Boolean | |
| MaxFailsafeTime | UInt32 | |
| MinFailsafeTime | UInt32 | |
| PressureSensor | Pressure | Double |
| MinPressure | Double | |
| MaxPressure | Double | |
| PressureChangeTrigger | Double | |
| MinPressureChangeTrigger | Double | |
| MaxPressureChangeTrigger | Double | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| RCServo | Acceleration | Double |
| MaxAcceleration | Double | |
| MaxPosition | Double | |
| MaxPulseWidthLimit | Double | |
| MaxPulseWidth | Double | |
| MaxTorque | Double | |
| MaxVelocityLimit | Double | |
| MinAcceleration | Double | |
| MinPosition | Double | |
| MinPulseWidthLimit | Double | |
| MinPulseWidth | Double | |
| MinTorque | Double | |
| MinVelocityLimit | Double | |
| Position | Double | |
| TargetPosition | Double | |
| Torque | Double | |
| VelocityLimit | Double | |
| Velocity | Double | |
| SpeedRampingState | Integer | |
| Voltage | Enum | |
| Engaged | Boolean | |
| IsMoving | Boolean | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| MinFailsafeTime | UInt32 | |
| ResistanceInput | MaxDataInterval | UInt32 |
| MinDataInterval | UInt32 | |
| Resistance | Double | |
| MinResistance | Double | |
| MaxResistance | Double | |
| ResistanceChangeTrigger | Double | |
| MinResistanceChangeTrigger | Double | |
| MaxResistanceChangeTrigger | Double | |
| RTDWireSetup | Enum | |
| RFID | AntennaEnabled | Boolean |
| TagPresent | Boolean | |
| SoundSensor | MaxDataInterval | UInt32 |
| MinDataInterval | UInt32 | |
| dB | Double | |
| MaxdB | Double | |
| dBA | Double | |
| dBC | Double | |
| NoiseFloor | Double | |
| SPLChangeTrigger | Double | |
| MinSPLChangeTrigger | Double | |
| MaxSPLChangeTrigger | Double | |
| SPLRange | Enum | |
| Spatial | AlgorithmMagnetometerGain | Double |
| Algorithm | Enum | |
| HeatingEnabled | Integer | |
| MaxDataInterval | UInt32 | |
| MinDataInterval | UInt32 | |
| Stepper | Acceleration | Double |
| ControlMode | Enum | |
| CurrentLimit | Double | |
| Engaged | Boolean | |
| HoldingCurrentLimit | Double | |
| IsMoving | Boolean | |
| MaxAcceleration | Double | |
| MaxCurrentLimit | Double | |
| MaxDataInterval | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| MaxPosition | Double | |
| MaxVelocityLimit | Double | |
| MinAcceleration | Double | |
| MinCurrentLimit | Double | |
| MinDataInterval | UInt32 | |
| MinFailsafeTime | UInt32 | |
| MinPosition | Double | |
| MinVelocityLimit | Double | |
| Position | Double | |
| RescaleFactor | Double | |
| TargetPosition | Double | |
| VelocityLimit | Double | |
| Velocity | Double | |
| TemperatureSensor | MaxDataInterval | UInt32 |
| MinDataInterval | UInt32 | |
| RTDType | Enum | |
| RTDWireSetup | Enum | |
| Temperature | Double | |
| MinTemperature | Double | |
| MaxTemperature | Double | |
| TemperatureChangeTrigger | Double | |
| MinTemperatureChangeTrigger | Double | |
| MaxTemperatureChangeTrigger | Double | |
| ThermocoupleType | Enum | |
| VoltageInput | MinDataInterval | UInt32 |
| MaxDataInterval | UInt32 | |
| PowerSupply | Enum | |
| SensorType | Enum | |
| SensorValue | Double | |
| Voltage | Double | |
| MinVoltage | Double | |
| MaxVoltage | Double | |
| VoltageChangeTrigger | Double | |
| MinVoltageChangeTrigger | Double | |
| MaxVoltageChangeTrigger | Double | |
| VoltageRange | Enum | |
| SensorValueChangeTrigger | Double | |
| SensorUnit | SensorUnit | |
| VoltageOutput | Enabled | Boolean |
| MinFailsafeTime | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| Voltage | Double | |
| MinVoltage | Double | |
| MaxVoltage | Double | |
| VoltageOutputRange | Enum | |
| VoltageRatioInput | BridgeEnabled | Boolean |
| BridgeGain | Enum | |
| MaxDataInterval | UInt32 | |
| MaxVoltageRatioChangeTrigger | Double | |
| MaxVoltageRatio | Double | |
| MinDataInterval | UInt32 | |
| MinVoltageRatioChangeTrigger | Double | |
| MinVoltageRatio | Double | |
| SensorType | Enum | |
| SensorUnit | SensorUnit | |
| SensorValueChangeTrigger | Double | |
| SensorValue | Double | |
| VoltageRatioChangeTrigger | Double | |
| VoltageRatio | Double | |
| MotorPositionController | Acceleration | Double |
| CurrentLimit | Double | |
| CurrentRegulatorGain | Double | |
| DeadBand | Double | |
| DutyCycle | Double | |
| Engaged | Boolean | |
| FanMode | Enum | |
| IOMode | Enum | |
| Kd | Double | |
| Ki | Double | |
| Kp | Double | |
| MaxAcceleration | Double | |
| MaxCurrentLimit | Double | |
| MaxCurrentRegulatorGain | Double | |
| MaxDataInterval | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| MaxPosition | Double | |
| MaxStallVelocity | Double | |
| MaxVelocityLimit | Double | |
| MinAcceleration | Double | |
| MinCurrentLimit | Double | |
| MinCurrentRegulatorGain | Double | |
| MinDataInterval | UInt32 | |
| MinFailsafeTime | UInt32 | |
| MinPosition | Double | |
| MinStallVelocity | Double | |
| MinVelocityLimit | Double | |
| Position | Double | |
| RescaleFactor | Double | |
| StallVelocity | Double | |
| TargetPosition | Double | |
| VelocityLimit | Double | |
| BLDCMotor | Acceleration | Double |
| MinAcceleration | Double | |
| MaxAcceleration | Double | |
| BrakingStrength | Double | |
| MinBrakingStrength | Double | |
| MaxBrakingStrength | Double | |
| MinDataInterval | UInt32 | |
| MaxDataInterval | UInt32 | |
| MinFailsafeTime | UInt32 | |
| MaxFailsafeTime | UInt32 | |
| Position | Double | |
| MinPosition | Double | |
| MaxPosition | Double | |
| RescaleFactor | Double | |
| StallVelocity | Double | |
| MinStallVelocity | Double | |
| MaxStallVelocity | Double | |
| TargetVelocity | Double | |
| TargetBrakingStrength | Double | |
| MinVelocity | Double | |
| MaxVelocity | Double |
Integer: Number
UInt32 and UInt64: unsigned number >= 0
Double: Floating point Number
String: Some text
Enum: Numeric value with special meaning.
Boolean: Value 1 for true and 0 for false.
Examples
Query backlight and contrast for LCD device:
Set Field [ Phidget LCD::BackLight ; MBS("Phidget.GetProperty"; $$phidget; "Backlight") ]
Set Field [ Phidget LCD::Contrast ; MBS("Phidget.GetProperty"; $$phidget; "Contrast") ]
Query device name:
Set Variabel [ $DeviceName; MBS( "Phidget.GetProperty"; $Phidget; "DeviceName" ) ]
See also
Example Databases
- Phidgets/Phidget Barometer
- Phidgets/Phidget Digital Outputs
- Phidgets/Phidget Distance Sensor
- Phidgets/Phidget IR Receiver
- Phidgets/Phidget LCD
- Phidgets/Phidget Light Sensor
- Phidgets/Phidget Temperator Sensor
- Phidgets/Phidget Voltage Input
Blog Entries
Created 16th August 2023, last changed 25th September 2023
