« Back to Product

Documentation

IPS_SetConfiguration

Require: Symcon >= 2.7

 bool IPS_SetConfiguration (int $InstanceID, string $Configuration) 

Parameters

InstanceID

ID of the instance

Configuration

The configuration as a string

Returns

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

Description

This function sets the planned configuration for InstanceID to Configuration.
It needs to be applied via IPS_ApplyChanges to affect the instance.

Example

// Set the configuration for the ModBus instance with the ID 12345
IPS_SetConfiguration(12345, '{"DataType":3,"WriteAddress":1,"ReadAddress":0,"Poller":3600000,"ReadOnly":false,"EmulateStatus":true,"Factor":0.0}');
IPS_ApplyChanges(12345); // Apply new configuration
Any questions?