Open Edge Device Kit – Open Edge Device Kit Controls¶

This section describes the available control options for the Open Edge Device Kit.

Initializing an agent¶

Topic	`agentruntime/controlling/command/init`
Description	Initializes the Open Edge Device Kit with a given agent configuration, if provided. After receiving this command the Open Edge Device Kit parses the configuration file and extracts authentication and data source configurations. Next, it performs onboarding using the authentication configuration. Afterwards, it sets up the data pipeline according to the data source configuration for data upload and starts the data upload. At the end it publishes a status message.
Quality of Service	1
Retained	`TRUE`

Sample Body:

{
  "header": {
    "version": "0.1",
    "generationTimeServer": "2020-01-01T12:27:53.865Z"
  },
  "device": {
    "deviceIdentifier": "device_identifier"
  },
  "agent": {
    "name": "meaningful_agent_name_for_agent_environment",
    "agentId": "s6BhdRkqt3",
    "proxy": {
      "proxyType": "FIXED",
      "host": "https://proxy.mindsphere.com:8080",
      "protocol": "HTTPS",
      "authenticationType": "BASIC",
      "user": "",
      "password": ""
    },
    "security": {
      "iat": "eyJh...",
      "clientCredentialProfile": [
        "RSA_3072"
      ],
      "clientId": "5fa51b64-dce2-11e7-9296-cec278b6b50a",
      "tenant": "6e70640a-dce2-11e7-9296-cec278b6b50a",
      "baseUrl": "https://southgate.eu-central.mindsphere.io"
    }
  }
}

Stopping an Agent¶

Topic	`agentruntime/controlling/command/stop`
Description	Stops the Open Edge Device Kit. It is recommended for configuration updates or general maintenance. The Open Edge Device Kit publishes a status message to the monitoring channel after stopping. For restarting the Open Edge Device Kit, use the init command.
Quality of Service	1
Retained	`TRUE`

Sample Body: empty body

Setting an Agent's Log Level¶

Topic	`agentruntime/controlling/command/loglevel`
Description	Sets the log level of the Open Edge Device Kit. Allowed values for the log level are limited to 0 to 3, which are associated with the levels `"error"`, `"warning"`, `"info"`, `"debug"`.
Quality of Service	1
Retained	`TRUE`

Sample Body:

{
"value": 0,
"level": "error"
}

Except where otherwise noted, content on this site is licensed under the Development License Agreement.

Last update: January 13, 2020