add Project configuration options and MQTT publishing functionality

This commit is contained in:
jhartworks
2026-04-16 12:25:35 +02:00
parent 4363fd47a5
commit 2f2a0512b3
3 changed files with 90 additions and 11 deletions
+4 -9
View File
@@ -11,6 +11,9 @@
"caption": "JSON Ausgabe Variable", "caption": "JSON Ausgabe Variable",
"validVariableTypes": [3] "validVariableTypes": [3]
}, },
{ "type": "NumberSpinner", "name": "Projectyear", "caption": "Projectyear" },
{ "type": "NumberSpinner", "name": "Projectnumber", "caption": "Projectnumber" },
{ "type": "ValidationTextBox", "name": "Projectname", "caption": "Projectname" },
{ {
"type": "ExpansionPanel", "type": "ExpansionPanel",
"caption": "MQTT (optional)", "caption": "MQTT (optional)",
@@ -24,15 +27,7 @@
"type": "SelectInstance", "type": "SelectInstance",
"name": "MqttClientID", "name": "MqttClientID",
"caption": "MQTT Client", "caption": "MQTT Client",
"visible": "EnableMQTT", "visible": "EnableMQTT"
"validModules": ["{C6D2AEB3-6E1F-4B2E-8D6E-2F0A6C4C2A7F}"]
},
{
"type": "ValidationTextBox",
"name": "MqttTopic",
"caption": "MQTT Topic",
"visible": "EnableMQTT",
"placeholder": "clients/counters/json"
} }
] ]
}, },
+85 -1
View File
@@ -9,8 +9,13 @@ class CounterClient extends IPSModule
$this->RegisterPropertyInteger('CounterCategoryID', 0); $this->RegisterPropertyInteger('CounterCategoryID', 0);
$this->RegisterPropertyInteger('JsonOutputVariableID', 0); $this->RegisterPropertyInteger('JsonOutputVariableID', 0);
$this->RegisterPropertyInteger('UpdateTime', 60); $this->RegisterPropertyInteger('UpdateTime', 60);
$this->RegisterPropertyBoolean('EnableMQTT', false);
$this->RegisterPropertyInteger('MqttClientID', 0);
$this->RegisterPropertyString('Projectname', '');
$this->RegisterPropertyInteger('Projectyear', 2026);
$this->RegisterPropertyInteger('Projectnumber', 0);
$this->RegisterTimer('Update', 0, 'SECC_BuildAndStorePayload($_IPS[\'TARGET\']);'); $this->RegisterTimer('Update', 0, 'SECC_BuildAndStorePayload($id);');
} }
public function ApplyChanges() public function ApplyChanges()
@@ -38,6 +43,17 @@ class CounterClient extends IPSModule
} }
IPS_LogMessage('CounterClient', $json); IPS_LogMessage('CounterClient', $json);
if ($this->ReadPropertyBoolean('EnableMQTT')) {
$mqttClientId = $this->ReadPropertyInteger('MqttClientID');
$mqttTopic = $this->ReadPropertyInteger('Projectyear').'/'.$this->ReadPropertyInteger('Projectnumber').'/Counters';
if ($mqttClientId > 0 && IPS_InstanceExists($mqttClientId) && $mqttTopic !== '') {
$this->MqttPublish($mqttClientId, $mqttTopic, $json, true);
} else {
IPS_LogMessage('CounterClient', 'MQTT ist aktiviert, aber ungültige MQTT Client ID oder Topic.');
}
}
} }
public function BuildPayload() public function BuildPayload()
@@ -426,5 +442,73 @@ class CounterClient extends IPSModule
return $text; return $text;
} }
public function MqttPublish($server_id, $topic, $payload, $retain) {
// ensure server instance exists
if(!IPS_InstanceExists($server_id)) {
return false;
}
$ips_var_type = 3;
$module_id = "{01C00ADD-D04E-452E-B66A-D253278743FE}" /* Module ID of MQTT Server Device */;
$ident = "TempMQTTDevice";
// enter semaphore to ensure the temporary device gets used by one thread at a time
if(IPS_SemaphoreEnter($ident, 100)) {
// get temporary MQTT Server Device or create if needed
$id = @IPS_GetObjectIDByIdent($ident, $_IPS['SELF']);
if($id === false) {
$id = @IPS_CreateInstance($module_id);
if($id === false) {
return false;
}
IPS_SetParent($id, $_IPS['SELF']);
IPS_SetIdent($id, $ident);
}
// ensure the specified server instance is actually compatible
if(!IPS_IsInstanceCompatible($id, $server_id)) {
return false;
}
// ensure that the temporary device is actually connected to the correct server instance
$inst_config = IPS_GetInstance($id);
if($inst_config["ConnectionID"] != $server_id) {
IPS_DisconnectInstance($id);
if(!@IPS_ConnectInstance($id, $server_id)) {
return false;
}
}
// name object to help with debugging
IPS_SetName($id, "Temporary MQTT Device for: " . $topic);
// configure temporary device
$config_arr = array(
"Retain" => $retain,
"Topic" => $topic,
"Type" => $ips_var_type
);
$config_str = json_encode($config_arr);
IPS_SetConfiguration($id, $config_str);
IPS_SetHidden($id,true);
IPS_ApplyChanges($id);
// get Value variable and use it to publish the payload
$var_id = @IPS_GetObjectIDByIdent("Value", $id);
RequestAction($var_id, $payload);
IPS_SemaphoreLeave($ident);
} else { // semaphore timeout
return false;
}
return true;
} // MQTT_Publish
} }
?> ?>
+1 -1
View File
@@ -8,6 +8,6 @@
"date": 1491343200 "date": 1491343200
}, },
"version": "1.0", "version": "1.0",
"build": 0, "build": 1,
"date": 0 "date": 0
} }