Symcon_Belevo_Energiemanagement_testing/VGT_Sub/module.php

<?php

declare(strict_types=1);
class VGT_Sub extends IPSModule
{
    public function Create()
    {
        parent::Create();
        $this->RegisterPropertyString('DeviceID', '');
        /** -------------------------------------------
         *  STATUS Variablen (schreibbar)
         * ------------------------------------------*/
        $this->RegisterVariableInteger('PowerProduction', 'Power Production', '', 10);
        $this->EnableAction('PowerProduction');
        $this->RegisterVariableBoolean('IsReady', 'Is Ready', '', 11);
        $this->EnableAction('IsReady');
        $this->RegisterVariableBoolean('IsRunning', 'Is Running', '', 12);
        $this->EnableAction('IsRunning');
        $this->RegisterVariableInteger('StateOfCharge', 'State of Charge', '', 13);
        $this->EnableAction('StateOfCharge');
        $this->RegisterVariableInteger('MinSOC', 'Min SOC', '', 14);
        $this->EnableAction('MinSOC');
        $this->RegisterVariableInteger('MaxSOC', 'Max SOC', '', 15);
        $this->EnableAction('MaxSOC');

        /** -------------------------------------------
         *  REMOTE CONTROL Variablen (read-only)
         * ------------------------------------------*/
        $this->RegisterVariableInteger('PowerSetpoint', 'Power Setpoint', '', 20);
        $this->RegisterVariableString('Strategy', 'Strategy', '', 21);
        // Debug
        $this->RegisterVariableString('RemoteControlPayload', 'Remote Control Payload', '', 30);

        /** -------------------------------------------
         *  FEEDBACK REQUEST Variablen (read-only)
         * ------------------------------------------*/
        $this->RegisterVariableString('FeedbackRequestPayload', 'Feedback Request Payload', '', 40);
    }

    public function ApplyChanges()
    {
        parent::ApplyChanges();
        $device = $this->ReadPropertyString('DeviceID');
        if ($device === '') {
            return;
        }
        // READ: Topics abonnieren
        $this->Subscribe("feedback-request/$device");
        // WRITE: Remote-Control-Requests ebenfalls abonnieren
        $this->Subscribe("remote-control-request/$device");
    }

    /** -------------------------------------------
     *  VARIABLE WRITE SUPPORT
     * ------------------------------------------*/
    public function RequestAction($Ident, $Value)
    {
        $this->SetValue($Ident, $Value);
        $device = $this->ReadPropertyString('DeviceID');
        if ($device !== '') {
            switch ($Ident) {
                case 'PowerProduction':
                case 'IsReady':
                case 'IsRunning':
                case 'StateOfCharge':
                case 'MinSOC':
                case 'MaxSOC':
                    $payload = json_encode([
                        'power_production' => $this->GetValue('PowerProduction'),
                        'is_ready'         => $this->GetValue('IsReady'),
                        'is_running'       => $this->GetValue('IsRunning'),
                        'state_of_charge'  => $this->GetValue('StateOfCharge'),
                        'min_soc'          => $this->GetValue('MinSOC'),
                        'max_soc'          => $this->GetValue('MaxSOC')
                    ]);
                    $this->Publish("status/$device", $payload);
                    break;
            }
        }
    }

    /** -------------------------------------------
     *  MQTT SUBSCRIBE
     * ------------------------------------------*/
    private function Subscribe(string $topic): void
    {
        if (!$this->HasActiveParent()) {
            $this->SendDebug('MQTT', 'Subscribe ohne aktiven Parent: ' . $topic, 0);
            return;
        }
        $packet = [
            'PacketType'       => 8,   // SUBSCRIBE
            'QualityOfService' => 0,
            'Retain'           => false,
            'Topic'            => $topic,
            'Payload'          => ''
        ];
        $this->SendDataToParent(json_encode([
            'DataID' => '{043EA491-0325-4ADD-8FC2-A30C8EEB4D3F}'
        ] + $packet));
    }

    /** -------------------------------------------
     *  MQTT PUBLISH
     * ------------------------------------------*/
    private function Publish(string $topic, string $payload): void
    {
        if (!$this->HasActiveParent()) {
            $this->SendDebug('MQTT', 'Publish ohne aktiven Parent: ' . $topic, 0);
            return;
        }
        $packet = [
            'PacketType'       => 3,   // PUBLISH
            'QualityOfService' => 0,
            'Retain'           => false,
            'Topic'            => $topic,
            'Payload'          => $payload
        ];
        $this->SendDataToParent(json_encode([
            'DataID' => '{043EA491-0325-4ADD-8FC2-A30C8EEB4D3F}'
        ] + $packet));
    }

    /** -------------------------------------------
     *  RECEIVE DATA
     * ------------------------------------------*/
    public function ReceiveData($JSONString)
    {
        $data = json_decode($JSONString, true);
        if (!is_array($data)) {
            return;
        }
        $topic   = $data['Topic']   ?? '';
        $payload = $data['Payload'] ?? '';
        $this->SendDebug('MQTT', 'Receive: Topic=' . $topic . ' Payload=' . $payload, 0);
        $device = $this->ReadPropertyString('DeviceID');
        if ($device === '') {
            return;
        }
        /** -------------------------------------------
         * 1️⃣ FEEDBACK REQUEST
         * ------------------------------------------*/
        if ($topic === "feedback-request/$device") {
            $this->SetValue('FeedbackRequestPayload', $payload);
            $json = json_decode($payload, true);
            if (!is_array($json)) {
                $json = [];
            }
            $response = array_merge($json, [
                "power_production" => $this->GetValue('PowerProduction'),
                "is_ready"         => $this->GetValue('IsReady'),
                "is_running"       => $this->GetValue('IsRunning'),
                "state_of_charge"  => $this->GetValue('StateOfCharge'),
                "min_soc"          => $this->GetValue('MinSOC'),
                "max_soc"          => $this->GetValue('MaxSOC')
            ]);
            $this->Publish("feedback-response/$device", json_encode($response));
            return;
        }
        /** -------------------------------------------
         * 2️⃣ REMOTE CONTROL REQUEST
         * ------------------------------------------*/
        if ($topic === "remote-control-request/$device") {
            $this->SetValue('RemoteControlPayload', $payload);
            $json = json_decode($payload, true);
            if (is_array($json)) {
                if (array_key_exists('power_setpoint', $json)) {
                    $this->SetValue('PowerSetpoint', (int)$json['power_setpoint']);
                }
                if (array_key_exists('strategy', $json)) {
                    $this->SetValue('Strategy', (string)$json['strategy']);
                }
            }
            $this->Publish("remote-control-response/$device", $payload);
            return;
        }
    }
}