Skip to main content
The configuration file is essential for the proper functioning of the controller, as it includes important settings related to its communication interfaces, such as MQTT, CAN, Telegram, and NATS. The configuration file supports the following entries:

​
Required Entries

These entries must be configured for each controller:
  • plcnext
  • mqtt
  • nats

​
Optional Entries

These entries can be added to enable additional functionality. If included, their parameters must be configured correctly:
  • can - configures CAN bus interfaces
  • telegram - enables Telegram notifications and alerts
Below, we will provide detailed information on each entry, including the required parameters and any optional ones. The configuration file can be found in the /etc folder of the ppl-base repository and is listed as config.json.

​
plcnext

​
Required Parameters

​
ipAddress
string
required
This is the IP address of the controller. It should always be configured to the controller’s current IP address, as it is used to create sockets.Example: 192.168.1.10

​
Optional Parameters

Though these parameters are not required for the controller to operate, it is good practice to include them in the configuration file to avoid losing track of login credentials.
​
username
string
The username for logging into the WBM of the controller or a shell session. This should be set to admin.Example: admin
​
password
string
The password for logging into the WBM of the controller or a shell session.Example: password

​
mqtt

​
Required Parameters

​
broker
object
required
This entry contains all relevant information for the MQTT broker.Example:
{
  "broker": {
    "ipAddress": "192.168.1.10",
    "port": 1883
  }
}

​
nats

​
Required Parameters

The required parameters are used to set up a local NATS server on the controller. This NATS server is used to integrate with custom applications developed by the customer.
​
local
object
required
The required parameters are used to set up a local NATS server on the controller. This NATS server is used to integrate with custom applications developed by the customer.Example:
{
  "local": {
    "username": "client",
    "password": "password"
  }
}

​
Optional Parameters

The optional parameters are used for setting up a NATS connection to the cloud, which hosts a database for storing data. By providing these parameters, the controller can periodically push data to the cloud.
​
cloud
object
The optional parameters are used for setting up a NATS connection to the cloud, which hosts a database for storing data. By providing these parameters, the controller can periodically push data to the cloud.Example:
{
  "cloud": {
    "username": "client",
    "password": "password",
    "ipAddress": "192.168.1.5",
    "bucket": "my-bucket"
  }
}

​
can (optional)

The can entry is an optional array that configures the CAN bus interfaces on the controller. Each entry in the array represents a CAN bus interface. If this entry is included, the following parameters are required.

​
Required Parameters

​
can[]
array
required
An array of CAN bus interface configurations.Example:
[
  {
    "bitRate": 500000,
    "slotNumber": 1
  }
]

​
telegram (optional)

The telegram entry is optional and can be used to enable notifications and alerts. These include livebit messages every 24 hours and alerts for critical device failures in the system. If the customer does not wish to receive updates via Telegram, they simply need to omit this entry from the config file. If this entry is included, the following parameters are required.

​
Required Parameters

​
chatID
string
required
Represents the unique chat ID of the Telegram channel. Each Telegram channel has its own unique ID.Example: 123456789
​
botToken
string
required
A token consisting of letters and numbers, required for authorizing the bot and sending requests to the Bot API. The Bot API is already added to the Telegram channel.Example: 123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ

​
File Validator

Use the File Validator to verify that your config.json is correct, contains no errors, and includes all required parameters so the PPL controller can start up properly.

Open File Validator

Validate your configuration files before uploading them to the controller.