Profiles
API Calls for Service Profiles, Object Profiles and Command Profiles
Last updated
API Calls for Service Profiles, Object Profiles and Command Profiles
Last updated
© 2023 MobiusFlow® - All Rights Reserved - MobiusFlow® is a registered trademark of Infrastructure Software Solutions Limited trading as MobiusFlow® - All other brand names, product names, or trademarks belong to their respective owners
MobiusFlow Hub ID
Ok response
Timestamp of the response
URI of the response
Array of object profile families
const response = await fetch('/api/v1/mobius/profile/object/families/{hid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"GeneralIO": {
"type": "InputOutput",
"description": "<p>General analog and digital IO</p>",
"__$markdownParsed": true
},
"DigitalInput": {
"type": "Input",
"description": "<p>Digital input</p>",
"__$markdownParsed": true
},
"DigitalOutput": {
"type": "Output",
"description": "<p>Digital output</p>",
"__$markdownParsed": true
}
}
}
MobiusFlow Hub ID
MobiusFlow Command ID
Ok response
Timestamp of the response
URI of the response
Mobius command profile
const response = await fetch('/api/v1/mobius/profile/command/{hid}/{command}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"description": "<p>Broadcast a received EnOcean raw radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"rorg": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"rawData": {
"type": "array"
}
},
"required": [
"rorg",
"rawData"
]
},
"__$markdownParsed": true
}
}
MobiusFlow Hub ID
MobiusFlow Service Profile ID
Ok response
Timestamp of the response
URI of the response
Mobius service profile
const response = await fetch('/api/v1/mobius/profile/service/{hid}/{spid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"spid": "000E",
"defaultID": "00E",
"name": "node-red connector",
"description": "<p>This service creates a connection between the MobiusFlow Services, Objects, and Resources and the logic Flows. The host address and port, and the pre-shared key must be entered into both the service settings and the Flow.</p>",
"isConfigurable": true,
"icon": "default",
"allowedObjectFamilies": [],
"__$markdownParsed": true
}
}
MobiusFlow Hub ID
Ok response
Timestamp of the response
URI of the response
Array of Mobius service profiles
const response = await fetch('/api/v1/mobius/profile/service/{hid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": [
{
"spid": "0001",
"defaultID": "001",
"name": "mobius router",
"description": "<p>POPULATE</p>",
"isConfigurable": true,
"icon": "default",
"allowedObjectFamilies": [],
"__$markdownParsed": true
},
{
"spid": "FE02",
"defaultID": "E00",
"name": "iqrf connector",
"description": "<p>POPULATE</p>",
"isConfigurable": false,
"icon": "default",
"allowedObjectFamilies": [],
"__$markdownParsed": true
},
{
"spid": "FE03",
"defaultID": "E00",
"name": "room display",
"description": "<p>POPULATE</p>",
"isConfigurable": false,
"icon": "default",
"allowedObjectFamilies": [],
"__$markdownParsed": true
}
]
}
MobiusFlow Hub ID
MobiusFlow Object Profile ID
Ok response
Timestamp of the response
URI of the response
Mobius object profile
const response = await fetch('/api/v1/mobius/profile/object/{hid}/{pid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"header": {
"pid": "513",
"profileName": "numericValue",
"instances": "multiple",
"uiname": "Numeric Value"
},
"resources": {
"parentObject": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "Parent",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"name": {
"rid": "1",
"access": "r",
"type": "string",
"uiname": "Name",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"objectLastUpdated": {
"rid": "2",
"access": "r",
"type": "datetime",
"uiname": "Object Last Updated"
},
"description": {
"rid": "3",
"access": "r",
"type": "string",
"uiname": "Description",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"location": {
"rid": "4",
"access": "r",
"type": "string",
"uiname": "Location",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"value": {
"rid": "64",
"access": "rw",
"type": "number",
"uiname": "Value",
"settings": {
"pv": 0
}
}
}
}
}
MobiusFlow Hub ID
MobiusFlow Object Profile Name
Ok response
Timestamp of the response
URI of the response
Mobius object profile
const response = await fetch('/api/v1/mobius/profile/object/by-name/{hid}/{profileName}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"header": {
"pid": "513",
"profileName": "numericValue",
"instances": "multiple",
"uiname": "Numeric Value"
},
"resources": {
"parentObject": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "Parent",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"name": {
"rid": "1",
"access": "r",
"type": "string",
"uiname": "Name",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"objectLastUpdated": {
"rid": "2",
"access": "r",
"type": "datetime",
"uiname": "Object Last Updated"
},
"description": {
"rid": "3",
"access": "r",
"type": "string",
"uiname": "Description",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"location": {
"rid": "4",
"access": "r",
"type": "string",
"uiname": "Location",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"value": {
"rid": "64",
"access": "rw",
"type": "number",
"uiname": "Value",
"settings": {
"pv": 0
}
}
}
}
}
MobiusFlow Hub ID
Ok response
Timestamp of the response
URI of the response
Mobius command profiles
const response = await fetch('/api/v1/mobius/profile/command/{hid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"ENOCEAN_RADIO_RAW": {
"description": "<p>Broadcast a received EnOcean raw radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"rorg": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"rawData": {
"type": "array"
}
},
"required": [
"rorg",
"rawData"
]
},
"__$markdownParsed": true
},
"ENOCEAN_RADIO_ERP1": {
"description": "<p>Broadcast a received EnOcean ERP1 type radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"rorg": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"db_0": {
"type": "number"
},
"db_1": {
"type": "number"
},
"db_2": {
"type": "number"
},
"db_3": {
"type": "number"
},
"uid": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"status": {
"type": "number"
},
"subTelNum": {
"type": "number"
},
"dBm": {
"type": "number"
}
},
"required": [
"rorg",
"db_0",
"db_1",
"db_2",
"db_3",
"uid",
"status",
"subTelNum",
"dBm"
]
},
"__$markdownParsed": true
},
"ENOCEAN_RADIO_ERP1_VLD": {
"description": "<p>Broadcast a received EnOcean ERP1 type radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"rorg": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"vlData": {
"type": "array"
},
"uid": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"status": {
"type": "number"
},
"subTelNum": {
"type": "number"
},
"dBm": {
"type": "number"
}
},
"required": [
"rorg",
"vlData",
"uid",
"status",
"subTelNum",
"dBm"
]
},
"__$markdownParsed": true
},
"ENOCEAN_RADIO_MSC": {
"description": "<p>Broadcast a received EnOcean MSC type radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"rorg": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"func": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"type": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"mscData": {
"type": "array"
},
"uid": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"status": {
"type": "number"
},
"subTelNum": {
"type": "number"
},
"dBm": {
"type": "number"
}
},
"required": [
"rorg",
"func",
"type",
"mscData",
"uid",
"status",
"subTelNum",
"dBm"
]
},
"__$markdownParsed": true
},
"ENOCEAN_RADIO_RMC": {
"description": "<p>Broadcast a received EnOcean MSC type radio telegram</p>",
"schema": {
"type": "object",
"properties": {
"packetType": {
"type": "string",
"minLength": 2,
"maxLength": 2
},
"funcNum": {
"type": "number"
},
"manufId": {
"type": "number"
},
"destUID": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"srcUID": {
"type": "string",
"minLength": 8,
"maxLength": 8
},
"dBm": {
"type": "number"
},
"cmdData": {
"type": "array"
}
},
"required": [
"packetType",
"funcNum",
"manufId",
"destUID",
"srcUID",
"dBm",
"cmdData"
]
},
"__$markdownParsed": true
}
}
}
MobiusFlow Hub ID
Ok response
Timestamp of the response
URI of the response
Mobius object profiles
const response = await fetch('/api/v1/mobius/profile/object/{hid}', {
method: 'GET',
headers: {},
});
const data = await response.json();
{
"ts": "2022-12-21T10:25:54.585Z",
"uri": "000001",
"data": {
"serviceStatus": {
"header": {
"pid": "1",
"profileName": "serviceStatus",
"isConfigurable": false,
"instances": "single",
"uiname": "Mobius Service Status"
},
"resources": {
"parentObject": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "Parent",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"status": {
"rid": "1",
"access": "r",
"type": "enum",
"uiname": "Status",
"settings": {
"enum": {
"Unknown": -1,
"Fault": 0,
"OK": 1
}
}
},
"statusText": {
"rid": "2",
"access": "r",
"type": "string",
"uiname": "Status Text",
"settings": {
"pv": "Unknown"
}
},
"lastChanged": {
"rid": "3",
"access": "r",
"type": "datetime",
"uiname": "Last Changed",
"settings": {
"pv": "NOW"
}
}
}
},
"licenceStatus": {
"header": {
"pid": "2",
"profileName": "licenceStatus",
"isConfigurable": false,
"instances": "single",
"uiname": "Mobius Licence Status"
},
"resources": {
"licenceCode": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "LicenceCode",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"status": {
"rid": "1",
"access": "r",
"type": "enum",
"uiname": "Status",
"settings": {
"pv": -1,
"enum": {
"Unknown": -1,
"Valid": 0,
"Wrong Licence Type": 1,
"Hub Not Registered": 2,
"Licence Not Active": 4,
"Licence Not Yet Valid": 8,
"Licence Expired": 16,
"Licence Size Exceeded": 32,
"Error": 128
}
}
},
"expiryDate": {
"rid": "2",
"access": "r",
"type": "string",
"uiname": "Expiry Date",
"settings": {
"pv": ""
}
},
"licenceSize": {
"rid": "3",
"access": "r",
"type": "number",
"uiname": "Licence Size"
},
"objectCount": {
"rid": "4",
"access": "r",
"type": "number",
"uiname": "Object Count"
},
"server": {
"rid": "5",
"access": "r",
"type": "string",
"uiname": "Server"
},
"lastVerified": {
"rid": "6",
"access": "r",
"type": "string",
"uiname": "Last Verified"
},
"slowCheckInterval": {
"rid": "7",
"access": "r",
"type": "number",
"uiname": "Slow Check Interval"
},
"fastCheckInterval": {
"rid": "8",
"access": "r",
"type": "number",
"uiname": "Fast Check Interval"
}
}
},
"mobiusFlowConnector": {
"header": {
"pid": "65472",
"profileName": "mobiusFlowConnector",
"instances": "multiple",
"uiname": "MobiusFlow Connector"
},
"resources": {
"parentObject": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "Parent",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"name": {
"rid": "1",
"access": "r",
"type": "string",
"uiname": "Name",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"objectLastUpdated": {
"rid": "2",
"access": "r",
"type": "datetime",
"uiname": "Object Last Updated"
},
"description": {
"rid": "3",
"access": "r",
"type": "string",
"uiname": "Description",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"location": {
"rid": "4",
"access": "r",
"type": "string",
"uiname": "Location",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"partNumber": {
"rid": "10",
"access": "r",
"type": "string",
"uiname": "Part Number",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"serialNumber": {
"rid": "11",
"access": "r",
"type": "string",
"uiname": "Serial Number",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"psk": {
"rid": "12",
"access": "r",
"type": "string",
"uiname": "Pre-shared Key",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"firmwareVersion": {
"rid": "13",
"access": "r",
"type": "string",
"uiname": "Firmware Version",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"module1Type": {
"rid": "14",
"access": "r",
"type": "string",
"uiname": "Module 1 Type",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"module2Type": {
"rid": "15",
"access": "r",
"type": "string",
"uiname": "Module 2 Type",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"enOceanChipID": {
"rid": "16",
"access": "r",
"type": "string",
"uiname": "EnOcean Chip ID",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"macAddress": {
"rid": "17",
"access": "r",
"type": "string",
"uiname": "MAC Address",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"ipAddress": {
"rid": "18",
"access": "r",
"type": "string",
"uiname": "IP Address"
},
"subnetMask": {
"rid": "19",
"access": "r",
"type": "string",
"uiname": "Subnet Mask"
},
"dnsAddress": {
"rid": "20",
"access": "r",
"type": "string",
"uiname": "DNS Address"
},
"defaultGateway": {
"rid": "21",
"access": "r",
"type": "string",
"uiname": "Default Gateway"
},
"ssid": {
"rid": "22",
"access": "r",
"type": "string",
"uiname": "SSID"
},
"rssi": {
"rid": "23",
"access": "r",
"type": "number",
"uiname": "RSSI"
},
"bssid": {
"rid": "24",
"access": "r",
"type": "string",
"uiname": "BSSID"
},
"online": {
"rid": "64",
"access": "r",
"type": "bool",
"uiname": "Online"
},
"uptime": {
"rid": "65",
"access": "r",
"type": "string",
"uiname": "Uptime (days:hours:minutes)"
},
"lastEnOceanUID": {
"rid": "66",
"access": "r",
"type": "string",
"uiname": "Last EnOcean UID"
},
"lastWorkOccUID": {
"rid": "67",
"access": "r",
"type": "string",
"uiname": "Last WorkOcc UID"
}
}
},
"arubaEnOceanAP": {
"header": {
"pid": "65473",
"profileName": "arubaEnOceanAP",
"instances": "multiple",
"uiname": "Aruba Access Point"
},
"resources": {
"parentObject": {
"rid": "0",
"access": "rw",
"type": "string",
"uiname": "Parent",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"name": {
"rid": "1",
"access": "r",
"type": "string",
"uiname": "Name",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"objectLastUpdated": {
"rid": "2",
"access": "r",
"type": "datetime",
"uiname": "Object Last Updated"
},
"description": {
"rid": "3",
"access": "r",
"type": "string",
"uiname": "Description",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"location": {
"rid": "4",
"access": "r",
"type": "string",
"uiname": "Location",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"macAddress": {
"rid": "11",
"access": "r",
"type": "string",
"uiname": "MAC Address",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"psk": {
"rid": "12",
"access": "r",
"type": "string",
"uiname": "Pre-shared Key",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"firmwareVersion": {
"rid": "13",
"access": "r",
"type": "string",
"uiname": "Firmware Version",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"enOceanChipID": {
"rid": "16",
"access": "r",
"type": "string",
"uiname": "EnOcean Chip ID",
"settings": {
"tags": {
"attribute": "true"
}
}
},
"ipAddress": {
"rid": "18",
"access": "r",
"type": "string",
"uiname": "IP Address"
},
"online": {
"rid": "64",
"access": "r",
"type": "bool",
"uiname": "Online"
},
"uptime": {
"rid": "65",
"access": "r",
"type": "string",
"uiname": "Uptime (days:hours:minutes)"
},
"lastEnOceanUID": {
"rid": "66",
"access": "r",
"type": "string",
"uiname": "Last EnOcean UID"
}
}
}
}
}