Skip to content

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{
  "header": {
    "version": "0.1",
    "generationTimeServer": "2017-11-15T09:48:52Z"
  },
  "device": {
    "deviceIdentifier": "device_identifier",
    "serialNumber": "some_serial_No",
    "deviceType": "NANO",
    "networkInterfaces": [
      {
        "name": "my_network_interface_1",
        "DHCP": {
          "enabled": true
        },
        "static": {
          "IPv4": "1.1.1.12",
          "SubnetMask": "255.255.255.0",
          "Gateway": "1.1.1.4",
          "DNS": [
            "1.1.1.1",
            "...",
            "..."
          ],
          "IPv6": "2001:0DB8:AC10:FE01::"
        }
      }
    ]
  },
  "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:

1
2
3
4
{
"value": 0,
"level": "error"
}

Any questions left?

Ask the community


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