374 lines
12 KiB
PHP
374 lines
12 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
require_once __DIR__ . '/libs/ShellyParser.php';
|
|
|
|
class Shelly_Parser_MQTT extends IPSModule
|
|
{
|
|
public function Create()
|
|
{
|
|
parent::Create();
|
|
|
|
// MQTT-Server verbinden
|
|
$this->ConnectParent('{C6D2AEB3-6E1F-4B2E-8E69-3A1A00246850}');
|
|
|
|
// alle Topics hören
|
|
$this->Subscribe('#');
|
|
|
|
// Debug
|
|
}
|
|
|
|
public function ApplyChanges()
|
|
{
|
|
parent::ApplyChanges();
|
|
|
|
$this->ConnectParent('{C6D2AEB3-6E1F-4B2E-8E69-3A1A00246850}');
|
|
$this->Subscribe('#');
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* DEBUG WRAPPER
|
|
* ---------------------------------------------------------*/
|
|
private function Log($title, $msg)
|
|
|
|
|
|
IPS_LogMessage("ShellyMQTT - $title", $msg);
|
|
$this->SendDebug($title, $msg, 0);
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* MQTT SUBSCRIBE
|
|
* ---------------------------------------------------------*/
|
|
private function Subscribe(string $topic): void
|
|
{
|
|
$packet = [
|
|
'PacketType' => 8,
|
|
'QualityOfService' => 0,
|
|
'Retain' => false,
|
|
'Topic' => $topic,
|
|
'Payload' => ''
|
|
];
|
|
|
|
$this->SendDataToParent(json_encode([
|
|
'DataID' => '{043EA491-0325-4ADD-8FC2-A30C8EEB4D3F}'
|
|
] + $packet));
|
|
|
|
$this->Log("Subscribe", "Topic: $topic");
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* MQTT PUBLISH
|
|
* ---------------------------------------------------------*/
|
|
private function Publish(string $topic, string $payload): void
|
|
{
|
|
$packet = [
|
|
'PacketType' => 3,
|
|
'QualityOfService' => 0,
|
|
'Retain' => false,
|
|
'Topic' => $topic,
|
|
'Payload' => $payload
|
|
];
|
|
|
|
$this->SendDataToParent(json_encode([
|
|
'DataID' => '{043EA491-0325-4ADD-8FC2-A30C8EEB4D3F}'
|
|
] + $packet));
|
|
|
|
$this->Log("Publish", "$topic → $payload");
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* REQUEST ACTION (Shelly schalten)
|
|
* ---------------------------------------------------------*/
|
|
public function RequestAction($Ident, $Value)
|
|
{
|
|
$this->Log('RequestAction', "$Ident → " . json_encode($Value));
|
|
|
|
if (!str_contains($Ident, '_output_')) {
|
|
throw new Exception("Unknown Ident: " . $Ident);
|
|
}
|
|
|
|
// lokale Variable setzen
|
|
$varID = $this->FindVariableByIdent($Ident);
|
|
if ($varID) {
|
|
SetValue($varID, $Value);
|
|
}
|
|
|
|
// device + index extrahieren
|
|
[$deviceID, $suffix] = explode('_output_', $Ident, 2);
|
|
$index = intval($suffix);
|
|
|
|
// RPC Topic
|
|
$topic = $deviceID . '/rpc';
|
|
|
|
// RPC JSON Payload
|
|
$payload = json_encode([
|
|
'id' => 1,
|
|
'src' => 'ips',
|
|
'method' => 'Switch.Set',
|
|
'params' => [
|
|
'id' => $index,
|
|
'on' => (bool)$Value
|
|
]
|
|
]);
|
|
|
|
$this->Log('MQTT SEND', "$topic : $payload");
|
|
|
|
// absenden
|
|
$this->Publish($topic, $payload);
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* MQTT RECEIVE
|
|
* ---------------------------------------------------------*/
|
|
public function ReceiveData($JSONString)
|
|
{
|
|
$this->Log('ReceiveData', $JSONString);
|
|
|
|
$data = json_decode($JSONString, true);
|
|
if (!is_array($data)) {
|
|
return;
|
|
}
|
|
|
|
$topic = $data['Topic'] ?? '';
|
|
$payload = $data['Payload'] ?? '';
|
|
|
|
if ($topic === '') return;
|
|
|
|
$this->Log('ReceiveTopic', "$topic → $payload");
|
|
|
|
$parts = explode('/', $topic);
|
|
$deviceID = $parts[0] ?? '';
|
|
|
|
if ($deviceID === '') return;
|
|
|
|
// <deviceID>/online
|
|
if (($parts[1] ?? '') === 'online') {
|
|
$this->HandleOnline($deviceID, $payload);
|
|
return;
|
|
}
|
|
|
|
// <deviceID>/events/rpc
|
|
if (($parts[1] ?? '') === 'events' &&
|
|
($parts[2] ?? '') === 'rpc') {
|
|
$this->HandleRPC($deviceID, $payload);
|
|
return;
|
|
}
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* ONLINE STATUS
|
|
* ---------------------------------------------------------*/
|
|
private function HandleOnline(string $deviceID, string $payload): void
|
|
{
|
|
$value = ($payload === 'true' || $payload === '1');
|
|
|
|
$this->Log("DeviceOnline", "$deviceID = " . json_encode($value));
|
|
|
|
$varID = $this->EnsureBooleanVariable($deviceID, $deviceID . '_online', 'Online');
|
|
SetValue($varID, $value);
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* RPC DATA
|
|
* ---------------------------------------------------------*/
|
|
private function HandleRPC(string $deviceID, string $payload): void
|
|
{
|
|
$this->Log("HandleRPC", "$deviceID : $payload");
|
|
|
|
$json = json_decode($payload, true);
|
|
if (!is_array($json)) return;
|
|
|
|
$src = $json['src'] ?? '';
|
|
if (!str_starts_with($src, 'shelly')) return;
|
|
|
|
// Gerätetyp merken
|
|
$type = ShellyParser::ExtractType($src);
|
|
$typeID = $this->EnsureStringVariable($deviceID, $deviceID . '_type', 'Typ');
|
|
SetValue($typeID, $type);
|
|
|
|
// params mappen
|
|
$params = $json['params'] ?? [];
|
|
$mapped = ShellyParser::MapParams($params);
|
|
|
|
/* -------------------------
|
|
* OUTPUTS
|
|
* -------------------------*/
|
|
foreach ($mapped['outputs'] as $index => $value) {
|
|
$ident = $deviceID . '_output_' . $index;
|
|
$name = "Output $index";
|
|
|
|
$this->Log("RPC Output", "$ident = " . json_encode($value));
|
|
|
|
$varID = $this->EnsureBooleanVariable($deviceID, $ident, $name);
|
|
SetValue($varID, $value);
|
|
}
|
|
|
|
/* -------------------------
|
|
* INPUTS
|
|
* -------------------------*/
|
|
foreach ($mapped['inputs'] as $index => $value) {
|
|
$ident = $deviceID . '_input_' . $index;
|
|
$name = "Input $index";
|
|
|
|
$this->Log("RPC Input", "$ident = " . json_encode($value));
|
|
|
|
$varID = $this->EnsureBooleanVariable($deviceID, $ident, $name);
|
|
SetValue($varID, $value);
|
|
}
|
|
|
|
/* -------------------------
|
|
* TEMPERATUR
|
|
* -------------------------*/
|
|
if ($mapped['temperature'] !== null) {
|
|
$this->Log("RPC Temperature", json_encode($mapped['temperature']));
|
|
|
|
$tempID = $this->EnsureFloatVariable($deviceID, $deviceID . '_temperature', 'Temperatur');
|
|
SetValue($tempID, $mapped['temperature']);
|
|
}
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* AUTOMATISCHES ACTION-SCRIPT
|
|
* ---------------------------------------------------------*/
|
|
private function EnsureActionScript(): int
|
|
{
|
|
$scriptName = "ShellyMQTT_Action_" . $this->InstanceID;
|
|
|
|
// existiert bereits?
|
|
foreach (IPS_GetChildrenIDs($this->InstanceID) as $cid) {
|
|
$obj = IPS_GetObject($cid);
|
|
if ($obj['ObjectType'] === OBJECTTYPE_SCRIPT && $obj['ObjectName'] === $scriptName) {
|
|
return $cid;
|
|
}
|
|
}
|
|
|
|
// neues Script erzeugen
|
|
$scriptID = IPS_CreateScript(0);
|
|
IPS_SetName($scriptID, $scriptName);
|
|
IPS_SetParent($scriptID, $this->InstanceID);
|
|
|
|
$php = '<?php
|
|
$inst = ' . $this->InstanceID . ';
|
|
$ident = IPS_GetObject($_IPS["VARIABLE"])["ObjectIdent"];
|
|
$value = $_IPS["VALUE"];
|
|
IPS_RequestAction($inst, $ident, $value);
|
|
?>';
|
|
|
|
IPS_SetScriptContent($scriptID, $php);
|
|
|
|
return $scriptID;
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* BOOLEAN VARIABLE
|
|
* ---------------------------------------------------------*/
|
|
private function EnsureBooleanVariable(string $deviceID, string $ident, string $name): int
|
|
{
|
|
$folderID = $this->GetDeviceFolder($deviceID);
|
|
|
|
foreach (IPS_GetChildrenIDs($folderID) as $cid) {
|
|
$o = IPS_GetObject($cid);
|
|
if ($o['ObjectIdent'] === $ident) {
|
|
|
|
if (str_contains($ident, '_output_')) {
|
|
$actionScript = $this->EnsureActionScript();
|
|
IPS_SetVariableCustomAction($cid, $actionScript);
|
|
|
|
$var = IPS_GetVariable($cid);
|
|
if ($var['VariableProfile'] === '' && $var['VariableCustomProfile'] === '') {
|
|
IPS_SetVariableCustomProfile($cid, '~Switch');
|
|
}
|
|
}
|
|
|
|
return $cid;
|
|
}
|
|
}
|
|
|
|
// neu
|
|
$varID = IPS_CreateVariable(0);
|
|
IPS_SetIdent($varID, $ident);
|
|
IPS_SetName($varID, $name);
|
|
IPS_SetParent($varID, $folderID);
|
|
|
|
if (str_contains($ident, '_output_')) {
|
|
$actionScript = $this->EnsureActionScript();
|
|
IPS_SetVariableCustomAction($varID, $actionScript);
|
|
IPS_SetVariableCustomProfile($varID, '~Switch');
|
|
}
|
|
|
|
return $varID;
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* FLOAT VARIABLE
|
|
* ---------------------------------------------------------*/
|
|
private function EnsureFloatVariable(string $deviceID, string $ident, string $name): int
|
|
{
|
|
$folderID = $this->GetDeviceFolder($deviceID);
|
|
|
|
foreach (IPS_GetChildrenIDs($folderID) as $cid) {
|
|
if (IPS_GetObject($cid)['ObjectIdent'] === $ident)
|
|
return $cid;
|
|
}
|
|
|
|
$id = $this->RegisterVariableFloat($ident, $name);
|
|
IPS_SetParent($id, $folderID);
|
|
return $id;
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* STRING VARIABLE
|
|
* ---------------------------------------------------------*/
|
|
private function EnsureStringVariable(string $deviceID, string $ident, string $name): int
|
|
{
|
|
$folderID = $this->GetDeviceFolder($deviceID);
|
|
|
|
foreach (IPS_GetChildrenIDs($folderID) as $cid) {
|
|
if (IPS_GetObject($cid)['ObjectIdent'] === $ident)
|
|
return $cid;
|
|
}
|
|
|
|
$id = $this->RegisterVariableString($ident, $name);
|
|
IPS_SetParent($id, $folderID);
|
|
return $id;
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* GERÄTE-ORDNER
|
|
* ---------------------------------------------------------*/
|
|
private function GetDeviceFolder(string $deviceID): int
|
|
{
|
|
$folderIdent = 'folder_' . $deviceID;
|
|
|
|
foreach (IPS_GetChildrenIDs($this->InstanceID) as $cid) {
|
|
if (IPS_GetObject($cid)['ObjectIdent'] === $folderIdent)
|
|
return $cid;
|
|
}
|
|
|
|
$folderID = IPS_CreateCategory();
|
|
IPS_SetParent($folderID, $this->InstanceID);
|
|
IPS_SetName($folderID, $deviceID);
|
|
IPS_SetIdent($folderID, $folderIdent);
|
|
|
|
return $folderID;
|
|
}
|
|
|
|
/* ---------------------------------------------------------
|
|
* VARIABLE FINDEN
|
|
* ---------------------------------------------------------*/
|
|
private function FindVariableByIdent(string $Ident)
|
|
{
|
|
foreach (IPS_GetChildrenIDs($this->InstanceID) as $folder) {
|
|
foreach (IPS_GetChildrenIDs($folder) as $cid) {
|
|
if (IPS_GetObject($cid)['ObjectIdent'] === $Ident) {
|
|
return $cid;
|
|
}
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
?>
|