« Back to Product

Documentation

ForwardData

Require: IP-Symcon >= 4.0

 string ForwardData (string $JSONString) 

Parameters

JSONString

Data packet in JSON format

Returns

Result of the function, which is returned to the calling child instance

Description

This function is called by IP-Symcon and processes sent data and forwards it to the parent instance.
Data can be sent using the SendDataToParent function.
Further information on data forwarding can be found under Dataflow.

Warning

The ForwardData function is called by IP-Symcon. It must therefore be overwritten by the base class in order to add individual extensions

Example

// Example within a gateway/splitter instance
public function ForwardData($JSONString) {

    // Received data from the device instance
    $data = json_decode($JSONString);
    IPS_LogMessage("ForwardData", utf8_decode($data->Buffer));

    // The buffer would normally be processed here
    // e.g., check CRC, partition into individual parts

    // Forward to the I/O instance
    $resultat = $this->SendDataToParent(json_encode(Array("DataID" => "{79827379-F36E-4ADA-8A95-5F8D1DC92FA9}", "Buffer" => $data->Buffer)));
    
    // Processing and passing on
    return $resultat;
    
}
Any questions?