« Back to Product

Documentation

HM_WriteValueBoolean

 boolean HM_WriteValueBoolean (int $InstanceID, string $Parameter, boolean $Value) 

Parameters

InstanceID

ID of the device to be switched

Parameter

Parameter that should be set. The name of the parameter can be taken from the data point list or as "Ident" in the tab "Status Variables" in IP-Symcon.

Value

true or false

Returns

If the command succeeds, it returns TRUE, otherwise FALSE.

Description

Sets the Parameter of the device with ID InstanceID to value Value.

Warning

The Parameter value you can derive based on the name of the state variable. In the parameter list some examples are given. Based on the type of variable you can also see the needed __HM_WriteValue__ function.

Warning

Additional datapoints can be taken from the HomeMatic data point list.

Warning

If the error message Failure occurs, this is usually due to a bad wireless connection.

Example

// Switch device on
HM_WriteValueBoolean(12345, "STATE", true);
 
// Lock device
HM_WriteValueBoolean(12345, "INHIBIT", true); 
 
// Switch on display light
HM_WriteValueBoolean(12345, "BACKLIGHT", true);
Any questions?