Discover

API Discover calls

The discover calls are used to learn about the present state of a given MobiusFlow instance

Discover MobiusFlow services on a given hub

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

Responses

200

Ok response

application/json

Ok response

tsstringRequired

Timestamp of the response

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

uristringRequired

URI of the response

Example: 000001

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

/api/v1/mobius/discover/{hid}

HTTPcURLJavaScriptPython

GET /api/v1/mobius/discover/{hid} HTTP/1.1
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001",
  "data": [
    {
      "id": "0004/002",
      "spid": "0004",
      "registered": "2022-12-21T09:27:33.406Z",
      "status": "online"
    },
    {
      "id": "0012/012",
      "spid": "0012",
      "registered": "2022-12-21T09:27:35.006Z",
      "status": "online"
    },
    {
      "id": "0021/020",
      "spid": "0021",
      "registered": "2022-12-21T10:24:51.695Z",
      "status": "online"
    }
  ]
}

Discover MobiusFlow objects profiles on a given service

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

Responses

200

Ok response

application/json

Ok response

tsstringRequired

Timestamp of the response

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

uristringRequired

URI of the response

Example: 000001/020

datastring[]Required

Response data

Example: ["0001","000D","0010"]

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

/api/v1/mobius/discover/{hid}/{sid}

HTTPcURLJavaScriptPython

GET /api/v1/mobius/discover/{hid}/{sid} HTTP/1.1
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020",
  "data": [
    "0001",
    "000D",
    "0010"
  ]
}

Discover MobiusFlow objects of a given type

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

Responses

200

Ok response

application/json

Ok response

tsstringRequired

Timestamp of the response

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

uristringRequired

URI of the response

Example: 000001/020/000D

datastring[]Required

Response data

Example: ["0001","0002"]

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

/api/v1/mobius/discover/{hid}/{sid}/{pid}

HTTPcURLJavaScriptPython

GET /api/v1/mobius/discover/{hid}/{sid}/{pid} HTTP/1.1
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D",
  "data": [
    "0001",
    "0002"
  ]
}

Discover a MobiusFlow object

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

Responses

200

Ok response

application/json

Ok response

tsstringRequired

Timestamp of the response

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

uristringRequired

URI of the response

Example: 000001/020/000D/0001

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

/api/v1/mobius/discover/{hid}/{sid}/{pid}/{ins}

HTTPcURLJavaScriptPython

GET /api/v1/mobius/discover/{hid}/{sid}/{pid}/{ins} HTTP/1.1
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001",
  "data": [
    {
      "pid": "000D",
      "ins": "0001",
      "profileName": "enocean_A5-08-01",
      "description": "EnOcean light, temperature and occupancy sensor",
      "resources": [
        {
          "rid": "00",
          "type": "string",
          "name": "parentObject",
          "pv": "",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "",
            ""
          ],
          "settings": {
            "access": "rw",
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "01",
          "type": "string",
          "name": "name",
          "pv": "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "EnOcean EEP A5-08-01 Light, Temperature and Occupancy Sensor",
            ""
          ],
          "settings": {
            "access": "r",
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "02",
          "type": "datetime",
          "name": "objectLastUpdated",
          "pv": "1970-01-01T00:00:00.000Z",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "1970-01-01T00:00:00.000Z",
            "1970-01-01T00:00:00.000Z"
          ],
          "settings": {
            "access": "r"
          }
        },
        {
          "rid": "03",
          "type": "string",
          "name": "description",
          "pv": "",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "",
            ""
          ],
          "settings": {
            "access": "r",
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "04",
          "type": "string",
          "name": "location",
          "pv": "",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "",
            ""
          ],
          "settings": {
            "access": "r",
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "0A",
          "type": "string",
          "name": "eep",
          "pv": "A5-08-01",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "A5-08-01",
            ""
          ],
          "settings": {
            "access": "r",
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "0B",
          "type": "string",
          "name": "uid",
          "pv": "12345678",
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            "12345678",
            ""
          ],
          "settings": {
            "access": "r",
            "maxlen": 8,
            "tags": {
              "attribute": "true"
            }
          }
        },
        {
          "rid": "0C",
          "type": "number",
          "name": "status",
          "pv": 0,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            0,
            0
          ],
          "settings": {
            "access": "r"
          }
        },
        {
          "rid": "0D",
          "type": "number",
          "name": "dBm",
          "pv": 0,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            0,
            0
          ],
          "settings": {
            "access": "r",
            "units": "dBm"
          }
        },
        {
          "rid": "0E",
          "type": "bool",
          "name": "lrn",
          "pv": false,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            false,
            false
          ],
          "settings": {
            "access": "r"
          }
        },
        {
          "rid": "40",
          "type": "number",
          "name": "tmp",
          "pv": 0,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            0,
            0
          ],
          "settings": {
            "access": "r",
            "min": 0,
            "max": 51,
            "precision": 1,
            "units": "C"
          }
        },
        {
          "rid": "41",
          "type": "number",
          "name": "lux",
          "pv": 0,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            0,
            0
          ],
          "settings": {
            "access": "r",
            "min": 0,
            "max": 510,
            "precision": 1,
            "units": "lx"
          }
        },
        {
          "rid": "42",
          "type": "bool",
          "name": "pirs",
          "pv": false,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            false,
            false
          ],
          "settings": {
            "access": "r"
          }
        },
        {
          "rid": "43",
          "type": "bool",
          "name": "occupany",
          "pv": false,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            false,
            false
          ],
          "settings": {
            "access": "r"
          }
        },
        {
          "rid": "44",
          "type": "number",
          "name": "supplyVoltage",
          "pv": 0,
          "prar": [
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            null,
            0,
            0
          ],
          "settings": {
            "access": "r",
            "min": 0,
            "max": 5.1,
            "precision": 1,
            "units": "V"
          }
        }
      ],
      "families": [
        "EnOcean",
        "TemperatureSensor",
        "OccupancySensor",
        "LightSensor"
      ],
      "isFromConfig": 1
    }
  ]
}

Discover a MobiusFlow resource

get

Path parameters

hidstringRequired

MobiusFlow Hub ID

Example: {"value":"000001"}Pattern: ^[0-9A-Fa-f]{6}$

sidstringRequired

MobiusFlow Service ID

Example: {"value":"020"}Pattern: ^[0-9A-Fa-f]{3}$

pidstringRequired

MobiusFlow Object Profile ID

Example: {"value":"014A"}Pattern: ^[0-9A-Fa-f]{4}$

insstringRequired

MobiusFlow Object Instance ID

Example: {"value":"0001"}Pattern: ^[0-9A-Fa-f]{4}$

ridstringRequired

MobiusFlow Resource ID

Example: {"value":"40"}Pattern: ^[0-9A-Fa-f]{2}$

Responses

200

Ok response

application/json

Ok response

tsstringRequired

Timestamp of the response

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

uristringRequired

URI of the response

Example: 000001/020/000D/0001/40

400

Bad Request

application/json

401

Unauthorized

application/json

408

Request Timeout

application/json

500

Internal Server Error

application/json

get

/api/v1/mobius/discover/{hid}/{sid}/{pid}/{ins}/{rid}

HTTPcURLJavaScriptPython

GET /api/v1/mobius/discover/{hid}/{sid}/{pid}/{ins}/{rid} HTTP/1.1
Accept: */*

{
  "ts": "2022-12-21T10:25:54.585Z",
  "uri": "000001/020/000D/0001/40",
  "data": [
    {
      "rid": "40",
      "type": "number",
      "name": "tmp",
      "pv": 0,
      "prar": [
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        null,
        0,
        0
      ],
      "settings": {
        "access": "r",
        "min": 0,
        "max": 51,
        "precision": 1,
        "units": "C"
      }
    }
  ]
}