Symcon_Belevo_Energiemanagement_testing/MQTTBatterySDL/module.php

<?php

class MQTTBatterySDL extends IPSModule
{
    public function Create()
    {
        parent::Create();

        $this->RegisterPropertyString('TopicSuffix', '');

        $this->RegisterPropertyInteger('ReqActionID', 0);

        $this->RegisterPropertyInteger('TargetSoC', 50);
        $this->RegisterPropertyInteger('ChargePower', 2500);
        $this->RegisterPropertyInteger('DischargePower', 2500);
        $this->RegisterPropertyInteger('MaxPowerSetpoint', 10000);

        $this->RegisterVariableFloat('PowerProduction', 'Power Production', '', 10);
        $this->RegisterVariableBoolean('IsReady', 'Is Ready', '', 20);
        $this->RegisterVariableBoolean('IsRunning', 'Is Running', '', 30);
        $this->RegisterVariableFloat('StateOfCharge', 'State of Charge', '', 40);
        $this->RegisterVariableFloat('MinSoC', 'Min SoC', '', 50);
        $this->RegisterVariableFloat('MaxSoC', 'Max SoC', '', 60);

        $this->RegisterVariableInteger('PowerSetpoint', 'Power Setpoint', '', 70);
        $this->EnableAction('PowerSetpoint');

        $this->RegisterVariableString('Strategy', 'Strategy', '', 80);
        $this->EnableAction('Strategy');

        $this->RegisterVariableString('LastReadResponse', 'Letzte Lese-Antwort', '', 90);
        $this->RegisterVariableString('LastWriteResponse', 'Letzte Steuer-Antwort', '', 100);

        $this->ConnectParent('{C6D2AEB3-6E1F-4B2E-8E69-3A1A00246850}');
    }

    public function ApplyChanges()
    {
        parent::ApplyChanges();

        if ($this->ReadPropertyString('TopicSuffix') == '') {
            $this->SetStatus(102);
            return;
        }

        if ($this->ReadPropertyInteger('ReqActionID') <= 0) {
            $this->SetStatus(103);
            return;
        }

        $this->SetStatus(101);
        $this->Subscribe();
    }

    public function RequestAction($Ident, $Value)
    {
        switch ($Ident) {
            case 'PowerSetpoint':
                $max = $this->ReadPropertyInteger('MaxPowerSetpoint');

                if ($Value > $max) {
                    $Value = $max;
                }

                if ($Value < ($max * -1)) {
                    $Value = $max * -1;
                }

                SetValue($this->GetIDForIdent('PowerSetpoint'), $Value);
                $this->RunBatteryControl();
                break;

            case 'Strategy':
                SetValueString($this->GetIDForIdent('Strategy'), $Value);
                $this->RunBatteryControl();
                break;
        }
    }

    public function Subscribe()
    {
        $suffix = $this->ReadPropertyString('TopicSuffix');

        if ($suffix == '') {
            return;
        }

        $topics = [
            'feedback-request/' . $suffix,
            'remote-control-request/' . $suffix
        ];

        foreach ($topics as $topic) {
            $this->SendDataToParent(json_encode([
                'DataID'     => '{D6F8C9A1-2A3B-4C5D-9E0F-333333333333}',
                'PacketType' => 8,
                'Topic'      => $topic,
                'QoS'        => 0
            ]));
        }
    }

    public function ReceiveData($JSONString)
    {
        $data = json_decode($JSONString, true);

        if (!is_array($data)) {
            return;
        }

        $topic = $data['Topic'] ?? '';
        $payload = $data['Buffer'] ?? '';

        $suffix = $this->ReadPropertyString('TopicSuffix');

        if ($topic == 'feedback-request/' . $suffix) {
            $this->HandleReadRequest();
            return;
        }

        if ($topic == 'remote-control-request/' . $suffix) {
            $this->HandleRemoteControlRequest($payload);
            return;
        }
    }

    private function Publish(string $topic, string $payload)
    {
        $this->SendDataToParent(json_encode([
            'DataID'     => '{D6F8C9A1-2A3B-4C5D-9E0F-333333333333}',
            'PacketType' => 3,
            'Topic'      => $topic,
            'Payload'    => $payload,
            'QoS'        => 0,
            'Retain'     => false
        ]));
    }

    private function HandleReadRequest()
    {
        $suffix = $this->ReadPropertyString('TopicSuffix');

        $data = [
            'power_production' => GetValue($this->GetIDForIdent('PowerProduction')),
            'is_ready'         => GetValue($this->GetIDForIdent('IsReady')),
            'is_running'       => GetValue($this->GetIDForIdent('IsRunning')),
            'state_of_charge'  => GetValue($this->GetIDForIdent('StateOfCharge')),
            'min_soc'          => GetValue($this->GetIDForIdent('MinSoC')),
            'max_soc'          => GetValue($this->GetIDForIdent('MaxSoC'))
        ];

        $json = json_encode($data, JSON_PRETTY_PRINT);

        SetValueString($this->GetIDForIdent('LastReadResponse'), $json);

        $this->Publish('feedback-response/' . $suffix, $json);
    }

    private function HandleRemoteControlRequest(string $payload)
    {
        if ($payload == '') {
            return;
        }

        $data = json_decode($payload, true);

        if (!is_array($data)) {
            return;
        }

        if (isset($data['power_setpoint'])) {
            $max = $this->ReadPropertyInteger('MaxPowerSetpoint');
            $val = (int)$data['power_setpoint'];

            if ($val > $max) {
                $val = $max;
            }

            if ($val < ($max * -1)) {
                $val = $max * -1;
            }

            SetValue($this->GetIDForIdent('PowerSetpoint'), $val);
        }

        if (isset($data['strategy'])) {
            SetValueString($this->GetIDForIdent('Strategy'), (string)$data['strategy']);
        }

        $this->RunBatteryControl();

        $suffix = $this->ReadPropertyString('TopicSuffix');

        $output = [
            'power_setpoint' => GetValue($this->GetIDForIdent('PowerSetpoint')),
            'strategy'       => GetValueString($this->GetIDForIdent('Strategy'))
        ];

        $json = json_encode($output, JSON_PRETTY_PRINT);

        SetValueString($this->GetIDForIdent('LastWriteResponse'), $json);

        $this->Publish('remote-control-response/' . $suffix, $json);
    }

    private function RunBatteryControl()
    {
        $strategy = GetValueString($this->GetIDForIdent('Strategy'));
        $setpoint = GetValue($this->GetIDForIdent('PowerSetpoint'));
        $soc      = GetValue($this->GetIDForIdent('StateOfCharge'));

        $targetSoC      = $this->ReadPropertyInteger('TargetSoC');
        $chargePower    = $this->ReadPropertyInteger('ChargePower');
        $dischargePower = $this->ReadPropertyInteger('DischargePower');
        $reqActionID    = $this->ReadPropertyInteger('ReqActionID');

        if ($reqActionID <= 0 || !IPS_ObjectExists($reqActionID)) {
            $this->SendDebug('RunBatteryControl', 'Keine gültige ReqActionID gewählt', 0);
            return;
        }

        if ($strategy == 'activate') {
            RequestAction($reqActionID, $setpoint * -1);
            return;
        }

        if ($strategy == 'stop') {
            RequestAction($reqActionID, 0);
            SetValue($this->GetIDForIdent('PowerProduction'), 0);
            return;
        }

        if ((int)$soc == $targetSoC) {
            RequestAction($reqActionID, 0);
            return;
        }

        if ($soc < $targetSoC) {
            RequestAction($reqActionID, abs($chargePower));
            return;
        }

        if ($soc > $targetSoC) {
            RequestAction($reqActionID, abs($dischargePower) * -1);
            return;
        }
    }
}

?>