Creating module instances

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

• Open N3uron and navigate to the “Config” view.
• Click on “Modules”, then create a new module. This instance can have any name (except names with reserved characters like ‘.’, ‘/’, etc.), although it’s recommended to name the instance similarly to the name  of the module being instantiated. In this case, the name will be RestApiClient.

Figure 1: Creating new module instances

By setting the module type to RestApiClient, the created instance will be a RestApiClient instance. After saving, RestApiClient should appear in the module list in bold because there are unsaved changes.Figure 2: Setting the instance type

Additionally, each instance can be configured with the following options:

• Required: 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. If disabled, this module will have no effect on links when offline.
• 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.
• Monitor: This section is used to monitor the status of each module, as well as to enable automatic restart if it goes offline.
  • Automatic restart: If true, whenever the module goes offline (except when manually stopped by the user), the module will automatically restart.
  • Restart delay: Determines the delay before restarting the module after it has gone offline.