| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
Phidget.SetProperty
Sets a property for the phidget object.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| Phidget | 13.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
MBS( "Phidget.SetProperty"; PhidgetRef; PropertyName; Value ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| PhidgetRef | The reference number for the phidget. | $phidget |
| PropertyName | The name of the property to set. | "HeatingEnabled" |
| Value | The value to pass. Depending on property, this can be a number or text. For enum properties, please pass the numeric value. |
1 |
Result
Returns OK or error.
Description
Sets a property for the phidget object.Please check phidgets documentation about what things which device has and what values are expected.
| Device | Property | Type |
| All devices | IsRemote | Boolean |
| IsLocal | Boolean | |
| IsHubPortDevice | Boolean | |
| DataInterval | UInt32 | |
| Channel | Integer | |
| HubPort | Integer | |
| DeviceSerialNumber | Integer | |
| ServerName | String | |
| DeviceLabel | String | |
| Accelerometer | AccelerationChangeTrigger | Double |
| HeatingEnabled | Boolean | |
| CurrentInput | PowerSupply | Enum |
| CurrentChangeTrigger | Double | |
| DCMotor | TargetBrakingStrength | Double |
| Acceleration | Double | |
| TargetVelocity | Double | |
| CurrentLimit | Double | |
| CurrentRegulatorGain | Double | |
| FanMode | Enum | |
| BackEMFSensingState | Integer | |
| DigitalInput | InputMode | Enum |
| PowerSupply | Enum | |
| DigitalOutput | DutyCycle | Double |
| Frequency | Double | |
| LEDCurrentLimit | Double | |
| LEDForwardVoltage | Enum | |
| State | Integer | |
| DistanceSensor | DistanceChangeTrigger | UInt32 |
| SonarQuietMode | Boolean | |
| Encoder | Enabled | Boolean |
| Position | Int64 | |
| IOMode | Enum | |
| PositionChangeTrigger | UInt32 | |
| FrequencyCounter | Enabled | Boolean |
| FilterType | Enum | |
| InputMode | Enum | |
| FrequencyCutoff | Double | |
| PowerSupply | Enum | |
| LCD | Backlight | Double |
| Contrast | Double | |
| CursorBlink | Integer | |
| CursorOn | Integer | |
| FrameBuffer | Integer | |
| ScreenSize | Enum | |
| Gyroscope | HeatingEnabled | Boolean |
| CapacitiveTouch | Sensitivity | Double |
| TouchValueChangeTrigger | Double | |
| HumiditySensor | HumidityChangeTrigger | Double |
| LightSensor | IlluminanceChangeTrigger | Double |
| Magnetometer | MagneticFieldChangeTrigger | Double |
| HeatingEnabled | Boolean | |
| PHSensor | CorrectionTemperature | Double |
| PHChangeTrigger | Double | |
| PowerGuard | OverVoltage | Double |
| FanMode | Enum | |
| PowerEnabled | Boolean | |
| PressureSensor | PressureChangeTrigger | Double |
| RCServo | Acceleration | Double |
| Engaged | Boolean | |
| MaxPosition | Double | |
| MaxPulseWidth | Double | |
| MinPosition | Double | |
| MinPulseWidth | Double | |
| SpeedRampingState | Integer | |
| TargetPosition | Double | |
| Torque | Double | |
| VelocityLimit | Double | |
| Voltage | Enum | |
| ResistanceInput | ResistanceChangeTrigger | Double |
| RTDWireSetup | Enum | |
| RFID | AntennaEnabled | Boolean |
| SoundSensor | SPLChangeTrigger | Double |
| SPLRange | Enum | |
| Spatial | AlgorithmMagnetometerGain | Double |
| Algorithm | Enum | |
| HeatingEnabled | Integer | |
| Stepper | Acceleration | Double |
| ControlMode | Enum | |
| CurrentLimit | Double | |
| Engaged | Boolean | |
| HoldingCurrentLimit | Double | |
| RescaleFactor | Double | |
| TargetPosition | Double | |
| VelocityLimit | Double | |
| TemperatureSensor | RTDType | Enum |
| RTDWireSetup | Enum | |
| TemperatureChangeTrigger | Double | |
| ThermocoupleType | Enum | |
| VoltageInput | PowerSupply | Enum |
| SensorType | Enum | |
| VoltageChangeTrigger | Double | |
| SensorValueChangeTrigger | Double | |
| VoltageRange | Enum | |
| VoltageOutput | Enabled | Boolean |
| Voltage | Double | |
| VoltageOutputRange | Enum | |
| VoltageRatioInput | BridgeEnabled | Boolean |
| BridgeGain | Enum | |
| SensorType | Enum | |
| SensorValueChangeTrigger | Double | |
| VoltageRatioChangeTrigger | Double | |
| MotorPositionController | Acceleration | Double |
| CurrentLimit | Double | |
| CurrentRegulatorGain | Double | |
| DeadBand | Double | |
| Engaged | Boolean | |
| FanMode | Enum | |
| IOMode | Enum | |
| Kd | Double | |
| Ki | Double | |
| Kp | Double | |
| RescaleFactor | Double | |
| StallVelocity | Double | |
| TargetPosition | Double | |
| VelocityLimit | Double | |
| BLDCMotor | TargetBrakingStrength | Double |
| StallVelocity | Double | |
| RescaleFactor | Double | |
| Acceleration | Double | |
| TargetVelocity | 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
Set backlight and contrast for LCD:
Set Variable [ $r ; Value: MBS( "Phidget.SetProperty"; $$phidget; "Backlight"; 1) ]
Set Variable [ $r ; Value: MBS( "Phidget.SetProperty"; $$phidget; "Contrast"; ,5) ]
Turn on a digital output by setting state to 1
# parameter is which phidget to use
Set Variable [ $index ; Value: Get(ScriptParameter) ]
If [ Length ( $$phidgets[$index] ) > 0 ]
Set Variable [ $r ; Value: MBS( "Phidget.SetProperty"; $$phidgets[$index]; "State"; 1) ]
End If
Set humidity change trigger:
Set Variable [ $r ; Value: MBS( "Phidget.SetProperty"; $$phidget; "HumidityChangeTrigger"; 1) ]
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 12nd January 2024
