Node

API Node Calls

The node calls are for reading a MobiusFlow hub as well as resetting the pre-shared keys on a given hub

Get node configuration

GET/api/v1/mobius/node/config/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*array of object

Mobius Node Configuration (array of services information)

id*string

Service ID

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Run at start flag

Request

Response

Get node configuration tree

GET/api/v1/mobius/node/configtree/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*array of object

Response data

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

Reset node pre-shared keys

POST/api/v1/mobius/node/resetpsks/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Response data

resultstring

Result

Request

Response

Reset node pre-shared keys

POST/api/v1/mobius/node/resetpsks/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*object

Response data

resultstring

Result

Request

Response

Get node configuration

GET/api/v1/mobius/node/config/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*array of object

Mobius Node Configuration (array of services information)

id*string

Service ID

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Run at start flag

Request

Response

Get node configuration tree

GET/api/v1/mobius/node/configtree/{hid}

Path parameters

hid*string

MobiusFlow Hub ID

Example: "000001"

Pattern: ^[0-9A-Fa-f]{6}$

Response

Ok response

Body

ts*string

Timestamp of the response

Example: "2022-12-21T10:25:54.585Z"

uri*string

URI of the response

Example: "000001"

data*array of object

Response data

sid*string

Service ID

spid*string

Service profile ID associated to the service

name*string

Service name

enabled*boolean

Service enabled flag

runAtStart*boolean

Service run at start flag

settings*object

Mobius base service settings

mqttobject

MQTT settings

host*string

Hub MQTT broker host location

port*number

Hub MQTT broker port

timeoutsobject

Timeouts

local*number

Local timeout in ms

remote*number

Remote timeout in ms

custom*object

Custom settings

Other propertiesany

objects*array of object

Array of configured objects on service

pidstring

Object PID

objectsarray of object

Array of objects

pid*string

ins*string

ridsarray of object

ridstring

settingsobject

Other propertiesany

Request

Response

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "id": "0004/002",
      "name": "mobius-engine-api",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0012/012",
      "name": "mobius-ui-restapi",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "0021/020",
      "name": "enocean devices",
      "enabled": true,
      "runAtStart": true
    },
    {
      "id": "000E/021",
      "name": "node-red connector",
      "enabled": true,
      "runAtStart": true
    }
  ]
}

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "sid": "002",
      "spid": "0004",
      "name": "mobius-engine-api",
      "enabled": true,
      "runAtStart": true,
      "settings": {
        "mqtt": {
          "host": "mqtt://localhost",
          "port": 2016
        },
        "timeouts": {
          "local": 10000,
          "remote": 5000
        }
      },
      "custom": {},
      "objects": []
    },
    {
      "sid": "012",
      "spid": "0012",
      "name": "mobius-ui-restapi",
      "enabled": true,
      "runAtStart": true,
      "settings": {
        "mqtt": {
          "host": "mqtt://localhost",
          "port": 2016
        },
        "timeouts": {
          "local": 10000,
          "remote": 5000
        }
      },
      "custom": {
        "resin-vpn": false
      },
      "objects": [
        {
          "pid": "0002",
          "objects": [
            {
              "pid": "0002",
              "ins": "0001",
              "rids": []
            }
          ]
        }
      ]
    },
    {
      "sid": "020",
      "spid": "0021",
      "name": "enocean devices",
      "enabled": true,
      "runAtStart": true,
      "settings": {
        "mqtt": {
          "host": "mqtt://localhost",
          "port": 2016
        },
        "timeouts": {
          "local": 500,
          "remote": 5000
        }
      },
      "custom": {},
      "objects": [
        {
          "pid": "000D",
          "objects": [
            {
              "pid": "000D",
              "ins": "0001",
              "rids": [
                {
                  "rid": "01",
                  "settings": {
                    "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                  }
                },
                {
                  "rid": "0B",
                  "settings": {
                    "pv": "12345678"
                  }
                }
              ]
            },
            {
              "pid": "000D",
              "ins": "0002",
              "rids": [
                {
                  "rid": "01",
                  "settings": {
                    "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor"
                  }
                },
                {
                  "rid": "0B",
                  "settings": {
                    "pv": "11223344"
                  }
                }
              ]
            }
          ]
        },
        {
          "pid": "0010",
          "objects": [
            {
              "pid": "0010",
              "ins": "0001",
              "rids": [
                {
                  "rid": "01",
                  "settings": {
                    "pv": "EnOcean EEP A5-02-02 Temperature Sensor (-30C to 10C)"
                  }
                },
                {
                  "rid": "0B",
                  "settings": {
                    "pv": "12121212"
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    {
      "sid": "021",
      "spid": "000E",
      "name": "node-red connector",
      "enabled": true,
      "runAtStart": true,
      "settings": {
        "mqtt": {
          "host": "mqtt://localhost",
          "port": 2016
        },
        "timeouts": {
          "local": 500,
          "remote": 5000
        }
      },
      "custom": {
        "host": "localhost",
        "port": 1890,
        "psk": "node-red"
      },
      "objects": []
    }
  ]
}