--- a/features.py Wed Jun 05 15:18:15 2024 +0200
+++ b/features.py Wed Jun 12 11:45:09 2024 +0200
@@ -15,6 +15,7 @@
('SVGHMI', 'svghmi.SVGHMILibrary', 'svghmi')]
+ ('mqtt', _('MQTT client'), _('Map MQTT topics as located variables'), 'mqtt.MQTTClient'), ('opcua', _('OPC-UA client'), _('Map OPC-UA server as located variables'), 'opc_ua.OPCUAClient'),
# FIXME ('canfestival', _('CANopen support'), _('Map located variables over CANopen'), 'canfestival.canfestival.RootClass'),
('bacnet', _('Bacnet support'), _('Map located variables over Bacnet'), 'bacnet.bacnet.RootClass'),
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/mqtt/mqtt_client_gen.py Wed Jun 12 11:45:09 2024 +0200
@@ -0,0 +1,639 @@
+from __future__ import print_function +from __future__ import absolute_import +from threading import Thread +import wx.dataview as dv + BOOL = ("uint8_t" , "X"), + SINT = ("int8_t" , "B"), + USINT = ("uint8_t" , "B"), + INT = ("int16_t" , "W"), + UINT = ("uint16_t", "W"), + DINT = ("uint32_t", "D"), + UDINT = ("int32_t" , "D"), + LINT = ("int64_t" , "L"), + ULINT = ("uint64_t", "L"), + REAL = ("float" , "D"), + LREAL = ("double" , "L"), + QoS - Quality of Service + 0 : "At most one delivery" + 1 : "At least one delivery" + 2 : "Exactly one delivery" +lstcolnames = [ "Topic", "QoS", "Type", "Location"] +lstcolwidths = [ 100, 50, 100, 50] +lstcoltypess = [ str, int, str, int] +lstcoldeflts = [ "a/b/c", "1", "DINT", "0"] +Location_column = lstcolnames.index("Location") +directions = ["input", "output"] + ("Certificate", "certificate.der"), + ("PrivateKey", "private_key.pem")], +class MQTTSubListModel(dv.PyDataViewIndexListModel): + def __init__(self, data, log): + dv.PyDataViewIndexListModel.__init__(self, len(data)) + def GetColumnType(self, col): + def GetValueByRow(self, row, col): + return str(self.data[row][col]) + # This method is called when the user edits a data item in the view. + def SetValueByRow(self, value, row, col): + expectedtype = lstcoltypess[col] + v = expectedtype(value) + self.log("String {} is invalid for type {}\n".format(value,expectedtype.__name__)) + if col == lstcolnames.index("QoS") and v not in QoS_values: + self.log("{} is invalid for IdType\n".format(value)) + self.data[row][col] = v + # Report how many columns this model provides data for. + def GetColumnCount(self): + return len(lstcolnames) + # Report the number of rows in the model + #self.log.write('GetCount') + # Called to check if non-standard attributes should be used in the + def GetAttrByRow(self, row, col, attr): + if col == Location_column: + def DeleteRows(self, rows): + # make a copy since we'll be sorting(mutating) the list + # use reverse order so the indexes don't change as we remove items + rows = sorted(rows, reverse=True) + # remove it from our data structure + # notify the view(s) using this model that it has been removed + def AddRow(self, value): + if self.data.append(value): + def InsertDefaultRow(self, row): + self.data.insert(row, lstcoldeflts[:]) + self.Reset(len(self.data)) +class MQTTSubListPanel(wx.Panel): + def __init__(self, parent, log, model, direction): + wx.Panel.__init__(self, parent, -1) + self.dvc = dv.DataViewCtrl(self, + self.dvc.AssociateModel(self.model) + for idx,(colname,width) in enumerate(zip(lstcolnames,lstcolwidths)): + self.dvc.AppendTextColumn(colname, idx, width=width, mode=dv.DATAVIEW_CELL_EDITABLE) + self.Sizer = wx.BoxSizer(wx.VERTICAL) + self.direction = direction + titlestr = direction + " variables" + title = wx.StaticText(self, label = titlestr) + addbt = wx.Button(self, label="Add") + self.Bind(wx.EVT_BUTTON, self.OnAddRow, addbt) + delbt = wx.Button(self, label="Delete") + self.Bind(wx.EVT_BUTTON, self.OnDeleteRows, delbt) + topsizer = wx.BoxSizer(wx.HORIZONTAL) + topsizer.Add(title, 1, wx.ALIGN_CENTER_VERTICAL|wx.LEFT|wx.RIGHT, 5) + topsizer.Add(addbt, 0, wx.LEFT|wx.RIGHT, 5) + topsizer.Add(delbt, 0, wx.LEFT|wx.RIGHT, 5) + self.Sizer.Add(topsizer, 0, wx.EXPAND|wx.TOP|wx.BOTTOM, 5) + self.Sizer.Add(self.dvc, 1, wx.EXPAND) + def OnAddRow(self, evt): + items = self.dvc.GetSelections() + row = self.model.GetRow(items[0]) if items else 0 + self.model.InsertDefaultRow(row) + def OnDeleteRows(self, evt): + items = self.dvc.GetSelections() + rows = [self.model.GetRow(item) for item in items] + self.model.DeleteRows(rows) +class MQTTClientPanel(wx.Panel): + def __init__(self, parent, modeldata, log, config_getter): + wx.Panel.__init__(self, parent) + # TODO replace FlexGridSizer with a simpler one + self.inout_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0) + self.inout_sizer.AddGrowableCol(0) + self.inout_sizer.AddGrowableRow(0) + self.config_getter = config_getter + self.selected_splitter = wx.SplitterWindow(self, style=wx.SUNKEN_BORDER | wx.SP_3D) + self.selected_datas = modeldata + self.selected_models = { direction:MQTTSubListModel(self.selected_datas[direction], log) for direction in directions } + self.selected_lists = { direction:MQTTSubListPanel( + self.selected_splitter, log, + self.selected_models[direction], direction) + for direction in directions } + self.selected_splitter.SplitHorizontally(*[self.selected_lists[direction] for direction in directions]+[300]) + self.inout_sizer.Add(self.selected_splitter, flag=wx.GROW) + self.inout_sizer.Layout() + self.SetAutoLayout(True) + self.SetSizer(self.inout_sizer) + for direction in directions: + self.selected_models[direction].ResetData() +class MQTTClientList(list): + def __init__(self, log, change_callback): + super(MQTTClientList, self).__init__(self) + self.change_callback = change_callback + def append(self, value): + v = dict(list(zip(lstcolnames, value))) + if type(v["Location"]) != int: + iecnums = set(zip(*self)[Location_column]) + greatest = max(iecnums) + holes = set(range(greatest)) - iecnums + v["Location"] = min(holes) if holes else greatest+1 + if v["QoS"] not in QoS_values: + self.log("Unknown QoS\n".format(value)) + for t,n in zip(lstcoltypess, lstcolnames): + self.log("MQTT topic {} (Location={}) has invalid type\n".format(v["Topic"],v["Location"])) + if len(self)>0 and v["Topic"] in list(zip(*self))[lstcolnames.index("Topic")]: + self.log("MQTT topic {} (Location={}) already in the list\n".format(v["Topic"],v["Location"])) + list.append(self, [v[n] for n in lstcolnames]) + def __delitem__(self, index): + list.__delitem__(self, index) +class MQTTClientModel(dict): + def __init__(self, log, change_callback = lambda : None): + super(MQTTClientModel, self).__init__() + for direction in directions: + self[direction] = MQTTClientList(log, change_callback) + def LoadCSV(self,path): + with open(path, 'r') as csvfile: + reader = csv.reader(csvfile, delimiter=',', quotechar='"') + buf = {direction:[] for direction, _model in self.iteritems()} + for direction, model in self.iteritems(): + self[direction][:] = [] + # avoids calling change callback when loading CSV + list.append(self[direction],row[1:]) + def SaveCSV(self,path): + with open(path, 'w') as csvfile: + for direction, data in self.items(): + writer = csv.writer(csvfile, delimiter=',', + quotechar='"', quoting=csv.QUOTE_MINIMAL) + writer.writerow([direction] + row) + def GenerateC(self, path, locstr, config): + template = """/* code generated by beremiz MQTT extension */ +#include <open62541/client_config_default.h> +#include <open62541/client_highlevel.h> +#include <open62541/plugin/log_stdout.h> +#include <open62541/plugin/securitypolicy.h> +#include <open62541/plugin/securitypolicy_default.h> +#include <open62541/types.h> +#include <open62541/types_generated_handling.h> +#define _Log(level, ...) \\ + snprintf(mstr, 255, __VA_ARGS__); \\ + LogMessage(level, mstr, strlen(mstr)); \\ +#define LogInfo(...) _Log(LOG_INFO, __VA_ARGS__); +#define LogError(...) _Log(LOG_CRITICAL, __VA_ARGS__); +#define LogWarning(...) _Log(LOG_WARNING, __VA_ARGS__); +static MQTT_INLINE MQTT_ByteString +loadFile(const char *const path) {{ + MQTT_ByteString fileContents = MQTT_STRING_NULL; + FILE *fp = fopen(path, "rb"); + LogError("OPC-MQTT could not open %s", path); + fseek(fp, 0, SEEK_END); + fileContents.length = (size_t)ftell(fp); + fileContents.data = (MQTT_Byte *)MQTT_malloc(fileContents.length * sizeof(MQTT_Byte)); + if(fileContents.data) {{ + fseek(fp, 0, SEEK_SET); + size_t read = fread(fileContents.data, sizeof(MQTT_Byte), fileContents.length, fp); + if(read != fileContents.length){{ + MQTT_ByteString_clear(&fileContents); + LogError("OPC-MQTT could not read %s", path); + fileContents.length = 0; + LogError("OPC-MQTT Not enough memoty to load %s", path); +static MQTT_Client *client; +static MQTT_ClientConfig *cc; +#define DECL_VAR(ua_type, C_type, c_loc_name) \\ +static MQTT_Variant c_loc_name##_variant; \\ +static C_type c_loc_name##_buf = 0; \\ +C_type *c_loc_name = &c_loc_name##_buf; +void __cleanup_{locstr}(void) + MQTT_Client_disconnect(client); + MQTT_Client_delete(client); +#define INIT_NoAuth() \\ + LogInfo("OPC-MQTT Init no auth"); \\ + MQTT_ClientConfig_setDefault(cc); \\ + retval = MQTT_Client_connect(client, uri); +/* Note : Single policy is enforced here, by default open62541 client supports all policies */ +#define INIT_x509(Policy, UpperCaseMode, PrivateKey, Certificate) \\ + LogInfo("OPC-MQTT Init x509 %s,%s,%s,%s", #Policy, #UpperCaseMode, PrivateKey, Certificate); \\ + MQTT_ByteString certificate = loadFile(Certificate); \\ + MQTT_ByteString privateKey = loadFile(PrivateKey); \\ + cc->securityMode = MQTT_MESSAGESECURITYMODE_##UpperCaseMode; \\ + /* replacement for default behaviour */ \\ + /* MQTT_ClientConfig_setDefaultEncryption(cc, certificate, privateKey, NULL, 0, NULL, 0); */ \\ + retval = MQTT_ClientConfig_setDefault(cc); \\ + if(retval != MQTT_STATUSCODE_GOOD) \\ + MQTT_SecurityPolicy *sp = (MQTT_SecurityPolicy*) \\ + MQTT_realloc(cc->securityPolicies, sizeof(MQTT_SecurityPolicy) * 2); \\ + retval = MQTT_STATUSCODE_BADOUTOFMEMORY; \\ + cc->securityPolicies = sp; \\ + retval = MQTT_SecurityPolicy_##Policy(&cc->securityPolicies[cc->securityPoliciesSize], \\ + certificate, privateKey, &cc->logger); \\ + if(retval != MQTT_STATUSCODE_GOOD) {{ \\ + MQTT_LOG_WARNING(&cc->logger, MQTT_LOGCATEGORY_USERLAND, \\ + "Could not add SecurityPolicy Policy with error code %s", \\ + MQTT_StatusCode_name(retval)); \\ + MQTT_free(cc->securityPolicies); \\ + cc->securityPolicies = NULL; \\ + ++cc->securityPoliciesSize; \\ + retval = MQTT_Client_connect(client, uri); \\ + MQTT_ByteString_clear(&certificate); \\ + MQTT_ByteString_clear(&privateKey); +#define INIT_UserPassword(User, Password) \\ + LogInfo("OPC-MQTT Init UserPassword %s,%s", User, Password); \\ + MQTT_ClientConfig_setDefault(cc); \\ + retval = MQTT_Client_connectUsername(client, uri, User, Password); +#define INIT_READ_VARIANT(ua_type, c_loc_name) \\ + MQTT_Variant_init(&c_loc_name##_variant); +#define INIT_WRITE_VARIANT(ua_type, ua_type_enum, c_loc_name) \\ + MQTT_Variant_setScalar(&c_loc_name##_variant, (ua_type*)c_loc_name, &MQTT_TYPES[ua_type_enum]); +int __init_{locstr}(int argc,char **argv) + MQTT_StatusCode retval; + client = MQTT_Client_new(); + cc = MQTT_Client_getConfig(client); + if(retval != MQTT_STATUSCODE_GOOD) {{ + LogError("OPC-MQTT Init Failed %d", retval); + MQTT_Client_delete(client); +#define READ_VALUE(ua_type, ua_type_enum, c_loc_name, ua_nodeid_type, ua_nsidx, ua_node_id) \\ + retval = MQTT_Client_readValueAttribute( \\ + client, ua_nodeid_type(ua_nsidx, ua_node_id), &c_loc_name##_variant); \\ + if(retval == MQTT_STATUSCODE_GOOD && MQTT_Variant_isScalar(&c_loc_name##_variant) && \\ + c_loc_name##_variant.type == &MQTT_TYPES[ua_type_enum]) {{ \\ + c_loc_name##_buf = *(ua_type*)c_loc_name##_variant.data; \\ + MQTT_Variant_clear(&c_loc_name##_variant); /* Unalloc requiered on each read ! */ \\ +void __retrieve_{locstr}(void) + MQTT_StatusCode retval; +#define WRITE_VALUE(ua_type, c_loc_name, ua_nodeid_type, ua_nsidx, ua_node_id) \\ + MQTT_Client_writeValueAttribute( \\ + client, ua_nodeid_type(ua_nsidx, ua_node_id), &c_loc_name##_variant); +void __publish_{locstr}(void) + AuthType = config["AuthType"] + formatdict["init"] += """ + INIT_x509("{PrivateKey}", "{Certificate}")""".format(**config) + elif AuthType == "UserPassword": + formatdict["init"] += """ + INIT_UserPassword("{User}", "{Password}")""".format(**config) + formatdict["init"] += """ + for direction, data in self.items(): + iec_direction_prefix = {"input": "__I", "output": "__Q"}[direction] +# name, ua_nsidx, ua_nodeid_type, _ua_node_id, ua_type, iec_number = row +# iec_type, C_type, iec_size_prefix, ua_type_enum, ua_type = MQTT_IEC_types[ua_type] +# c_loc_name = iec_direction_prefix + iec_size_prefix + locstr + "_" + str(iec_number) +# ua_nodeid_type, id_formating = MQTT_NODE_ID_types[ua_nodeid_type] +# ua_node_id = id_formating.format(_ua_node_id) +# formatdict["decl"] += """ +#DECL_VAR({ua_type}, {C_type}, {c_loc_name})""".format(**locals()) +# if direction == "input": +# formatdict["init"] += """ +# INIT_READ_VARIANT({ua_type}, {c_loc_name})""".format(**locals()) +# formatdict["retrieve"] += """ +# READ_VALUE({ua_type}, {ua_type_enum}, {c_loc_name}, {ua_nodeid_type}, {ua_nsidx}, {ua_node_id})""".format(**locals()) +# if direction == "output": +# formatdict["init"] += """ +# INIT_WRITE_VARIANT({ua_type}, {ua_type_enum}, {c_loc_name})""".format(**locals()) +# formatdict["publish"] += """ +# WRITE_VALUE({ua_type}, {c_loc_name}, {ua_nodeid_type}, {ua_nsidx}, {ua_node_id})""".format(**locals()) + Ccode = template.format(**formatdict) +if __name__ == "__main__": + import wx.lib.mixins.inspection as wit + app = wit.InspectableApp() + frame = wx.Frame(None, -1, "MQTT Client Test App", size=(800,600)) + config["URI"] = sys.argv[1] if argc>1 else "opc.tcp://localhost:4840" + config["AuthType"] = None + config["AuthType"] = AuthType + for (name, default), value in zip_longest(authParams[AuthType], sys.argv[3:]): + raise Exception(name+" param expected") + test_panel = wx.Panel(frame) + test_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0) + test_sizer.AddGrowableCol(0) + test_sizer.AddGrowableRow(0) + modeldata = MQTTClientModel(print) + mqtttestpanel = MQTTClientPanel(test_panel, modeldata, print, lambda:config) + frame, message="Generate file as ...", defaultDir=os.getcwd(), + wildcard="C (*.c)|*.c", style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT + if dlg.ShowModal() == wx.ID_OK: +In case open62541 was built just aside beremiz, you can build this test with: + -I ../../open62541/plugins/include/ \\ + -I ../../open62541/build/src_generated/ \\ + -I ../../open62541/include/ \\ + -I ../../open62541/arch/ ../../open62541/build/bin/libopen62541.a +"""%(path, path[:-2]) + modeldata.GenerateC(path, "test", config) + """ +int LogMessage(uint8_t level, char* buf, uint32_t size){ + printf("log level:%d message:'%.*s'\\n", level, size, buf); +int main(int argc, char *argv[]) { + with open(path, 'w') as Cfile: + frame, message="Choose a file", + defaultDir=os.getcwd(), + wildcard="CSV (*.csv)|*.csv", + style=wx.FD_OPEN | wx.FD_CHANGE_DIR | wx.FD_FILE_MUST_EXIST ) + if dlg.ShowModal() == wx.ID_OK: + modeldata.LoadCSV(path) + frame, message="Save file as ...", defaultDir=os.getcwd(), + wildcard="CSV (*.csv)|*.csv", style=wx.FD_SAVE | wx.FD_OVERWRITE_PROMPT + if dlg.ShowModal() == wx.ID_OK: + modeldata.SaveCSV(path) + test_sizer.Add(mqtttestpanel, flag=wx.GROW|wx.EXPAND) + testbt_sizer = wx.BoxSizer(wx.HORIZONTAL) + loadbt = wx.Button(test_panel, label="Load") + test_panel.Bind(wx.EVT_BUTTON, OnLoad, loadbt) + savebt = wx.Button(test_panel, label="Save") + test_panel.Bind(wx.EVT_BUTTON, OnSave, savebt) + genbt = wx.Button(test_panel, label="Generate") + test_panel.Bind(wx.EVT_BUTTON, OnGenerate, genbt) + testbt_sizer.Add(loadbt, 0, wx.LEFT|wx.RIGHT, 5) + testbt_sizer.Add(savebt, 0, wx.LEFT|wx.RIGHT, 5) + testbt_sizer.Add(genbt, 0, wx.LEFT|wx.RIGHT, 5) + test_sizer.Add(testbt_sizer, flag=wx.GROW) + test_panel.SetAutoLayout(True) + test_panel.SetSizer(test_sizer) + mqtttestpanel.OnClose() + frame.Bind(wx.EVT_CLOSE, OnClose)