Create a New Module Instance
  • 23 Aug 2022
  • 1 Minute to read
  • PDF

Create a New Module Instance

  • PDF

Article summary

The first step when using a module after N3uron installation is to instantiate the relevant module:

  • Open N3uron and navigate to the “Config” menu.
  • Click on “Modules”, then create a new module. This instance can be given any name (except names with special characters like ‘.’, ‘/’, etc.), although users are recommended to name instances in a similar way to the name of the module being instantiated for easy identification. In this example, the ModbusClient module has been selected and has also been named ModbusClient.

Figure 1- Creating new module instances(37)Figure 1: Creating a new module instance


By setting the module type to ModbusClient, the created instance will automatically become a Modbus Client instance. Once saved, the name should appear in bold in the module list because there are still some unsaved changes.

Figure 2-Setting the instance type(3)Figure 2: Setting the instance type


Each instance can also be configured according to the following options:

  • Pause links while unavailable: When set to Enabled and when this module is receiving data from other N3uron nodes, all links will be paused whilst the module is offline to avoid data loss. During the pause, data is stored in the remote nodes providing they have the Store&Forward mechanism enabled. If Disabled, this module will have no effect on links when offline.

Active this feature only when S&F is enabled in the remote nodes. It does not make sense to activate this option if the Module can't handle time-stamped data, e. g. Modbus Server.
  • Auto-start: This section controls how the module behaves when the N3uron service is started (which also includes service restarts).
    • Enabled: If True, the module will automatically start when the N3uron service starts. Otherwise, the module must be started manually.
    • Start delay: When automatic start is Enabled, this setting is used to control how much delay there should be between starting the N3uron service and starting the module. This value is displayed in milliseconds.
  • Auto-restart: This section is used to monitor the status of each module, as well as to enable automatic restart if the module goes offline.
    • Enabled: If True,the module will automatically restart whenever the module goes offline (except when manually stopped by the user).
    • Restart delay: Determines the delay before restarting the module after it has gone offline.

Each module has an API and Logger section that will need to be configured separately. The default settings will be sufficient for this, but users will need to actively open the API and Logger configuration settings and save the default values to fully apply the settings. Click here for more information about API and Logger Configuration.

Was this article helpful?