beremiz: comparison bacnet/web

equal deleted inserted replaced

-:f71c22b2ca25
+:703ebf57508a
 # Will contain references to the C functions
 # (implemented in beremiz/bacnet/runtime/server.c)
 # used to get/set the BACnet specific configuration paramters
-GetParamFuncs = {}
+BacnetGetParamFuncs = {}
-SetParamFuncs = {}
+BacnetSetParamFuncs = {}
 # Upon PLC load, this Dictionary is initialised with the BACnet configuration
 # hardcoded in the C file
 # (i.e. the configuration inserted in Beremiz IDE when project was compiled)
-_DefaultConfiguration = None
+_BacnetDefaultConfiguration = None
 # Dictionary that contains the BACnet configuration currently being shown
 # on the web interface
 # This configuration will almost always be identical to the current
 # configuration in the PLC (i.e., the current state stored in the
 # C variables in the .so file).
 # The configuration viewed on the web will only be different to the current
 # configuration when the user edits the configuration, and when
 # the user asks to save the edited configuration but it contains an error.
-_WebviewConfiguration = None
+_BacnetWebviewConfiguration = None
 # Dictionary that stores the BACnet configuration currently stored in a file
 # Currently only used to decide whether or not to show the "Delete" button on the
-# web interface (only shown if _SavedConfiguration is not None)
+# web interface (only shown if _BacnetSavedConfiguration is not None)
-_SavedConfiguration = None
+_BacnetSavedConfiguration = None
 # File to which the new BACnet configuration gets stored on the PLC
 # Note that the stored configuration is likely different to the
 # configuration hardcoded in C generated code (.so file), so
-def _CheckPortnumber(port_number):
+def _CheckBacnetPortnumber(port_number):
 """ check validity of the port number """
 try:
 portnum = int(port_number)
 if (portnum < 0) or (portnum > 65535):
 raise Exception
 return True
-def _CheckDeviceID(device_id):
+def _CheckBacnetDeviceID(device_id):
 """
 # check validity of the Device ID
 # NOTE: BACnet device (object) IDs are 22 bits long (not counting the 10 bits for the type ID)
 #       so the Device instance ID is limited from 0 to 22^2-1 = 4194303
 #       However, 4194303 is reserved for special use (similar to NULL pointer), so last
-def _CheckConfiguration(BACnetConfig):
+def _CheckBacnetConfiguration(BACnetConfig):
 res = True
-res = res and _CheckPortnumber(BACnetConfig["port_number"])
+res = res and _CheckBacnetPortnumber(BACnetConfig["port_number"])
-res = res and _CheckDeviceID  (BACnetConfig["device_id"])
+res = res and _CheckBacnetDeviceID  (BACnetConfig["device_id"])
 return res
-def _CheckWebConfiguration(BACnetConfig):
+def _CheckBacnetWebConfiguration(BACnetConfig):
 res = True
 # check the port number
-if not _CheckPortnumber(BACnetConfig["port_number"]):
+if not _CheckBacnetPortnumber(BACnetConfig["port_number"]):
 raise annotate.ValidateError(
 {"port_number": "Invalid port number: " + str(BACnetConfig["port_number"])},
 _("BACnet configuration error:"))
 res = False
-if not _CheckDeviceID(BACnetConfig["device_id"]):
+if not _CheckBacnetDeviceID(BACnetConfig["device_id"]):
 raise annotate.ValidateError(
 {"device_id": "Invalid device ID: " + str(BACnetConfig["device_id"])},
 _("BACnet configuration error:"))
 res = False
-def _SetSavedConfiguration(BACnetConfig):
+def _SetBacnetSavedConfiguration(BACnetConfig):
 """ Stores in a file a dictionary containing the BACnet parameter configuration """
-global _SavedConfiguration
+global _BacnetSavedConfiguration
-if BACnetConfig == _DefaultConfiguration :
+if BACnetConfig == _BacnetDefaultConfiguration :
-_DelSavedConfiguration()
+_DelBacnetSavedConfiguration()
-_SavedConfiguration = None
+_BacnetSavedConfiguration = None
 else :
 with open(os.path.realpath(_BACnetConfFilename), 'w') as f:
 json.dump(BACnetConfig, f, sort_keys=True, indent=4)
-_SavedConfiguration = BACnetConfig
+_BacnetSavedConfiguration = BACnetConfig
-def _DelSavedConfiguration():
+def _DelBacnetSavedConfiguration():
 """ Deletes the file cotaining the persistent BACnet configuration """
 if os.path.exists(_BACnetConfFilename):
 os.remove(_BACnetConfFilename)
-def _GetSavedConfiguration():
+def _GetBacnetSavedConfiguration():
 """
 # Returns a dictionary containing the BACnet parameter configuration
 # that was last saved to file. If no file exists, then return None
 """
 try:
 #if os.path.isfile(_BACnetConfFilename):
 saved_config = json.load(open(_BACnetConfFilename))
 except Exception:
 return None
-if _CheckConfiguration(saved_config):
+if _CheckBacnetConfiguration(saved_config):
 return saved_config
 else:
 return None
-def _GetPLCConfiguration():
+def _GetBacnetPLCConfiguration():
 """
 # Returns a dictionary containing the current BACnet parameter configuration
 # stored in the C variables in the loaded PLC (.so file)
 """
 current_config = {}
 for par_name, x1, x2, x3 in BACnet_parameters:
-value = GetParamFuncs[par_name]()
+value = BacnetGetParamFuncs[par_name]()
 if value is not None:
 current_config[par_name] = value
 return current_config
-def _SetPLCConfiguration(BACnetConfig):
+def _SetBacnetPLCConfiguration(BACnetConfig):
 """
 # Stores the BACnet parameter configuration into the
 # the C variables in the loaded PLC (.so file)
 """
 for par_name in BACnetConfig:
 value = BACnetConfig[par_name]
-#PLCObject.LogMessage("BACnet web server extension::_SetPLCConfiguration()  Setting "
+#PLCObject.LogMessage("BACnet web server extension::_SetBacnetPLCConfiguration()  Setting "
 #                       + par_name + " to " + str(value) )
 if value is not None:
-SetParamFuncs[par_name](value)
+BacnetSetParamFuncs[par_name](value)
 # update the configuration shown on the web interface
-global _WebviewConfiguration
+global _BacnetWebviewConfiguration
-_WebviewConfiguration = _GetPLCConfiguration()
+_BacnetWebviewConfiguration = _GetBacnetPLCConfiguration()
-def _GetWebviewConfigurationValue(ctx, argument):
+def _GetBacnetWebviewConfigurationValue(ctx, argument):
 """
 # Callback function, called by the web interface (NevowServer.py)
 # to fill in the default value of each parameter
 """
 try:
-return _WebviewConfiguration[argument.name]
+return _BacnetWebviewConfiguration[argument.name]
 except Exception:
 return ""
 # The configuration of the web form used to see/edit the BACnet parameters
-webFormInterface = [(name, web_dtype (label=web_label, default=_GetWebviewConfigurationValue))
+webFormInterface = [(name, web_dtype (label=web_label, default=_GetBacnetWebviewConfigurationValue))
 for name, web_label, c_dtype, web_dtype in BACnet_parameters]
-def OnButtonSave(**kwargs):
+def OnBacnetButtonSave(**kwargs):
 """
 # Function called when user clicks 'Save' button in web interface
 # The function will configure the BACnet plugin in the PLC with the values
 # specified in the web interface. However, values must be validated first!
 """
-#PLCObject.LogMessage("BACnet web server extension::OnButtonSave()  Called")
+#PLCObject.LogMessage("BACnet web server extension::OnBacnetButtonSave()  Called")
 newConfig = {}
 for par_name, x1, x2, x3 in BACnet_parameters:
 value = kwargs.get(par_name, None)
 if value is not None:
 newConfig[par_name] = value
 # First check if configuration is OK.
-if not _CheckWebConfiguration(newConfig):
+if not _CheckBacnetWebConfiguration(newConfig):
 return
 # store to file the new configuration so that
 # we can recoup the configuration the next time the PLC
 # has a cold start (i.e. when Beremiz_service.py is retarted)
-_SetSavedConfiguration(newConfig)
+_SetBacnetSavedConfiguration(newConfig)
 # Configure PLC with the current BACnet parameters
-_SetPLCConfiguration(newConfig)
+_SetBacnetPLCConfiguration(newConfig)
-def OnButtonReset(**kwargs):
+def OnBacnetButtonReset(**kwargs):
 """
 # Function called when user clicks 'Delete' button in web interface
 # The function will delete the file containing the persistent
 # BACnet configution
 """
 # Delete the file
-_DelSavedConfiguration()
+_DelBacnetSavedConfiguration()
 # Set the current configuration to the default (hardcoded in C)
-_SetPLCConfiguration(_DefaultConfiguration)
+_SetBacnetPLCConfiguration(_BacnetDefaultConfiguration)
 # Reset global variable
-global _SavedConfiguration
+global _BacnetSavedConfiguration
-_SavedConfiguration = None
+_BacnetSavedConfiguration = None
 # location_str is replaced by extension's value in CTNGenerateC call
 def _runtime_bacnet_websettings_%(location_str)s_init():
 GetParamFuncName = "__bacnet_%(location_str)s_get_ConfigParam_" + name
 SetParamFuncName = "__bacnet_%(location_str)s_set_ConfigParam_" + name
 # XXX TODO : stop reading from PLC .so file. This code is template code
 #            that can use modbus extension build data
-GetParamFuncs[name]          = getattr(PLCObject.PLClibraryHandle, GetParamFuncName)
+BacnetGetParamFuncs[name]          = getattr(PLCObject.PLClibraryHandle, GetParamFuncName)
-GetParamFuncs[name].restype  = c_dtype
+BacnetGetParamFuncs[name].restype  = c_dtype
-GetParamFuncs[name].argtypes = None
+BacnetGetParamFuncs[name].argtypes = None
-SetParamFuncs[name]          = getattr(PLCObject.PLClibraryHandle, SetParamFuncName)
+BacnetSetParamFuncs[name]          = getattr(PLCObject.PLClibraryHandle, SetParamFuncName)
-SetParamFuncs[name].restype  = None
+BacnetSetParamFuncs[name].restype  = None
-SetParamFuncs[name].argtypes = [c_dtype]
+BacnetSetParamFuncs[name].argtypes = [c_dtype]
 # Default configuration is the configuration done in Beremiz IDE
 # whose parameters get hardcoded into C, and compiled into the .so file
 # We read the default configuration from the .so file before the values
 # get changed by the user using the web server, or by the call (further on)
-# to _SetPLCConfiguration(SavedConfiguration)
+# to _SetBacnetPLCConfiguration(BacnetSavedConfiguration)
-global _DefaultConfiguration
+global _BacnetDefaultConfiguration
-_DefaultConfiguration = _GetPLCConfiguration()
+_BacnetDefaultConfiguration = _GetBacnetPLCConfiguration()
 # Show the current PLC configuration on the web interface
-global _WebviewConfiguration
+global _BacnetWebviewConfiguration
-_WebviewConfiguration = _GetPLCConfiguration()
+_BacnetWebviewConfiguration = _GetBacnetPLCConfiguration()
 # Read from file the last used configuration, which is likely
 # different to the hardcoded configuration.
 # We Reset the current configuration (i.e., the config stored in the
 # variables of .so file) to this saved configuration
 # so the PLC will start off with this saved configuration instead
 # of the hardcoded (in Beremiz C generated code) configuration values.
 #
-# Note that _SetPLCConfiguration() will also update
+# Note that _SetBacnetPLCConfiguration() will also update
-# _WebviewConfiguration , if necessary.
+# _BacnetWebviewConfiguration , if necessary.
-global _SavedConfiguration
+global _BacnetSavedConfiguration
-_SavedConfiguration  = _GetSavedConfiguration()
+_BacnetSavedConfiguration  = _GetBacnetSavedConfiguration()
-if _SavedConfiguration is not None:
+if _BacnetSavedConfiguration is not None:
-if _CheckConfiguration(_SavedConfiguration):
+if _CheckBacnetConfiguration(_BacnetSavedConfiguration):
-_SetPLCConfiguration(_SavedConfiguration)
+_SetBacnetPLCConfiguration(_BacnetSavedConfiguration)
 WebSettings = NS.newExtensionSetting("BACnet extension", "bacnet_token")
 # Configure the web interface to include the BACnet config parameters
 WebSettings.addSettings(
 "BACnetConfigParm",                # name
 _("BACnet Configuration"),         # description
 webFormInterface,                  # fields
 _("Apply"),  # button label
-OnButtonSave)                      # callback
+OnBacnetButtonSave)                      # callback
 # Add the Delete button to the web interface
 WebSettings.addSettings(
 "BACnetConfigDelSaved",                   # name
 _("BACnet Configuration"),                # description
 [ ("status",
 annotate.String(label=_("Current state"),
 immutable=True,
-default=lambda *k:getConfigStatus())),
+default=lambda *k:getBacnetConfigStatus())),
 ],                                       # fields  (empty, no parameters required!)
 _("Reset"), # button label
-OnButtonReset)
+OnBacnetButtonReset)
-def getConfigStatus():
+def getBacnetConfigStatus():
-if _WebviewConfiguration == _DefaultConfiguration :
+if _BacnetWebviewConfiguration == _BacnetDefaultConfiguration :
 return "Unchanged"
 return "Modified"
 # location_str is replaced by extension's value in CTNGenerateC call
 #PLCObject.LogMessage("BACnet web server extension::OnUnLoadPLC() Called...")
 NS.removeExtensionSetting("bacnet_token")
-GetParamFuncs = {}
+BacnetGetParamFuncs = {}
-SetParamFuncs = {}
+BacnetSetParamFuncs = {}
-_WebviewConfiguration = None
+_BacnetWebviewConfiguration = None
-_SavedConfiguration   = None
+_BacnetSavedConfiguration   = None

changeset 2686	703ebf57508a
parent 2676	b276d05bdb09
child 2703	32ffdb32b14e