Developer Portal for Smart BuildingsAPI definition
GetAll
The user publishes the following topic to obtain getall information, while subscribing to the response to receive the completed JSON response.
| Action | Topic | Payload |
|---|---|---|
| Publish | wipapi/{Username}/configuration/query | - |
| Subscribe | wipapi/{Username}/configuration/response | JSON |
Response example
{
"data": {
"project": {
"wipapSerialNumber": "105807A7F030732",
"accesstoken": "accesstoken"
},
"mode": 4,
"desap": {
"name": "fdhksd",
"master": 1,
"buildingtype": 1,
"username": "admin585",
"xmppaccount": "frontend",
"isinit": 1,
"version": "V6.29",
"revision": "5",
"build_date": "20230330183408",
"uptime": 961522,
"devices": 10,
"language": "en",
"isac": 1,
"emergency": 0,
"http": 0,
"disconnectalarm": 0,
"timeoutforoffline": 3,
"activateLocalAPI": 1,
"activateSIPServer": 1,
"SIPServerCommunication": 1,
"SIPServerVideoStreaming": 1,
"LocalAPIEncrypted": 1
},
"datetime": {
"mode": 0,
"year": 2023,
"month": 4,
"day": 28,
"hour": 1,
"minute": 24,
"second": 54,
"ntpserver": 1,
"ntpservers": "pool.ntp.org"
},
"publiclan": {
"connection": "2",
"dhcp": "1",
"ipset": "192.168.2.177",
"maskset": "255.255.255.0",
"networkset": "192.168.2.1",
"nameserver": "192.168.2.1",
"nip": "192.168.2.177",
"nmask": "255.255.255.0",
"ngateway": "192.168.2.1"
},
"privatelan": {
"dhcp": 1,
"dhcprangelow": "192.168.3.100",
"dhcprangehigh": "192.168.3.255",
"ipset": "192.168.3.1",
"maskset": "255.255.255.0",
"networkset": "192.168.3.1",
"nip": "192.168.3.1",
"nmask": "255.255.255.0",
"ngateway": "192.168.2.1"
},
"wifi": {
"mode": 3
},
"wifiap": {
"ssid": "SmartAP_0732",
"band": 0,
"channnel": 0,
"countrycode": "AF"
},
"wifista": {
"ssid": "172net"
},
"cloud": {
"enable": 0,
"username": "",
"friendlyname": "",
"email": "",
"security": 0,
"sign": "",
"jid": 0,
"remoteaccess": 0
},
"wipapname": "fdhksd",
"devices": [{
"deviceTypeId": 1,
"nameId": "FFCA",
"iconId": "e7e4",
"progress": "100",
"copyId": "3",
"commissioningState": "ready",
"isBatteryPowered": "false",
"deviceFlavor": "00",
"maxAPDULength": "37",
"profile": "0E00",
"individualAddress": "01CE",
"softwareId": "0A6E",
"buildNumber": "0000026E",
"compilerVersion": "006BE131",
"sysAp": "false",
"domainAddress": "33E7",
"deviceId": 1,
"functionId": 65279,
"deletedisable": 1,
"channels": [{
"nameId": "0571",
"mask": "00000002",
"cid": "10000121",
"bubbleId": "10000",
"i": 0,
"combinedNameId": "",
"combined": true,
"combinedDisplayName": "",
"master": 2,
"submodule": "ac",
"inputs": [{
"i": 0,
"value": "0",
"pairingId": "1000"
}],
"outputs": [{
"i": 0,
"value": "0",
"pairingId": "1000"
}],
"building": 0,
"displayName": "",
"floor": 0,
"functionId": 100,
"offsetX": 0,
"offsetY": 0,
"showinui": false,
"room": 0
}, {
"nameId": "0610",
"mask": "00000001",
"cid": "10000001",
"functionId": 101,
"bubbleId": "10000",
"inputs": [{
"i": 0,
"pairingId": "1001",
"type": 1,
"value": 1,
"mode": 2
}],
"outputs": [{
"i": 0,
"pairingId": "1002",
"eventflag": 1,
"occurtime": "2018-09-29 00: 35:04",
"user": 1,
"tag": "00000000000004",
"value": 0
}],
"i": 1,
"parameters": [{
"parameterId": 7,
"i": 0,
"value": 4
}, {
"parameterId": 9,
"i": 1,
"value": "4"
}, {
"parameterId": 10,
"i": 2,
"value": "10"
}, {
"parameterId": 15,
"i": 3,
"value": "4"
}],
"displayName": "",
"operationmode": true,
"combinedNameId": "",
"combined": true,
"combinedDisplayName": "",
"master": 2,
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0
}, {
"nameId": "0622",
"mask": "00000001",
"cid": "10000002",
"functionId": 102,
"inputs": [{
"i": 0,
"pairingId": "1001",
"type": 2,
"value": 1
}],
"outputs": [{
"i": 0,
"pairingId": "1002",
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004",
"value": 0
}],
"i": 2,
"parameters": [{
"parameterId": 14,
"i": 0,
"value": "5"
}],
"displayName": "",
"operationmode": true,
"combinedNameId": "",
"combined": true,
"combinedDisplayName": "",
"master": 0,
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0
}, {
"cid": "10000004",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"functionIds": [104, 250, 251, 252],
"i": 3,
"buildingplan": true,
"inputs": [],
"mask": "00000001",
"master": 0,
"outputs": [{
"i": 0,
"pairingId": "1009",
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004",
"value": 0
}],
"building": 1,
"floor": 1,
"functionId": 252,
"iconId": "e7eb",
"nameId": "0902",
"offsetX": 533.27104532839962,
"offsetY": 263.24745605920441,
"room": 1
}, {
"cid": "10000003",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"buildingplan": true,
"displayName": "",
"operationmode": true,
"functionId": 103,
"functionIds": [103, 253],
"i": 4,
"inputs": [{
"i": 0,
"pairingId": "100E",
"value": 0
}],
"mask": "00000001",
"master": 2,
"nameId": "0612",
"outputs": [{
"i": 0,
"pairingId": "100F",
"value": 0,
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004"
}],
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0,
"parameters": [{
"parameterId": 11,
"i": 0,
"value": "1"
}]
}, {
"cid": "10000005",
"combined": true,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"functionId": 105,
"i": 5,
"inputs": [],
"mask": "00000001",
"master": 0,
"nameId": "055A",
"outputs": [{
"i": 0,
"pairingId": "1009",
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004",
"value": 1
}],
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0,
"parameters": [{
"parameterId": 23,
"i": 0,
"value": "0"
}]
}, {
"cid": "10000006",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"functionId": 106,
"i": 6,
"inputs": [],
"mask": "00000001",
"master": 0,
"nameId": "0621",
"outputs": [{
"i": 0,
"pairingId": "1009",
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004",
"value": 0
}],
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0
}, {
"cid": "10000007",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"operationmode": true,
"functionId": 107,
"i": 7,
"inputs": [{
"i": 0,
"pairingId": "100E",
"value": 0
}],
"mask": "00000001",
"master": 0,
"nameId": "0626",
"outputs": [{
"i": 0,
"pairingId": "1009",
"value": 0,
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004"
}],
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0
}, {
"cid": "10000008",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"operationmode": false,
"functionId": 108,
"i": 8,
"inputs": [{
"i": 0,
"pairingId": "100E",
"value": 0,
"mode": 3
}],
"mask": "00000001",
"master": 0,
"nameId": "0657",
"outputs": [{
"i": 0,
"pairingId": "1009",
"eventflag": 1,
"occurtime": "2018-09-29 00:35:04",
"user": 1,
"tag": "00000000000004",
"value": 0
}],
"nobuilding": 1,
"building": 0,
"floor": 0,
"offsetX": 0,
"offsetY": 0,
"room": 0
}],
"parameters": [],
"serialNumber": "105807A7F030732",
"cpuVersion": "V6.30",
"shortSerialNumber": "BDQ",
"MCUVersion": "V1.08_20191129",
"minirouterVersion": "V1.08",
"BGMVersion": "V1.05",
"ACconnectState": 1,
"building": 1,
"floor": 4,
"offsetX": 480.3966005665722,
"offsetY": 331.75637393767704,
"room": 4,
"softwareVersion": "V6.29",
"displayName": "Smart Access Point"
}],
"pairings": [],
"devicegroups": [],
"usergroups": [],
"devicelist": [{
"buildingplan": false,
"channels": [{
"building": 0,
"cid": "ABB704044",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 244,
"i": 0,
"mask": "00000001",
"master": 2,
"nameId": "0816",
"offsetX": 0,
"offsetY": 0,
"inputs": [{
"i": 0,
"value": 0
}],
"outputs": [{
"i": 0,
"pairingId": "1001",
"value": 8
}],
"room": 0
}, {
"building": 0,
"cid": "ABB704045",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 245,
"i": 1,
"mask": "00000001",
"master": 2,
"nameId": "0567",
"offsetX": 0,
"offsetY": 0,
"inputs": [{
"i": 0,
"value": 0
}],
"outputs": [{
"i": 0,
"pairingId": "1001",
"value": 1
}],
"room": 0
}, {
"building": 0,
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"mask": "00000001",
"master": 2,
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"i": 0,
"pairingId": "1001",
"value": 8
}],
"room": 0,
"i": 2,
"nameId": "0800",
"functionId": "101",
"cid": "10000001",
"inputs": []
}],
"commissioningState": "add",
"functionId": 65279,
"offsetX": 0,
"offsetY": 0,
"deviceId": 26,
"refCnt": 0,
"shortSerialNumber": "DTH",
"mac": "020CDE017FEE",
"serialNumber": "101020CDE017FEE",
"building": 3,
"floor": 0,
"deviceTypeId": 40,
"iconId": "e792",
"nameId": "0801",
"room": 0,
"index": 3,
"parameters": [{
"i": 0,
"parameterId": 47,
"value": "3"
}, {
"i": 1,
"parameterId": 50,
"value": "3"
}],
"displayName": "OS 003-03",
"softwareVersion": "HGO05_Digital_V1.30_20220914_PP_CX92755"
}, {
"building": 0,
"channels": [{
"bubbleId": "10001",
"building": 0,
"cid": "10000120",
"combined": true,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 120,
"i": 0,
"inputs": [],
"mask": "00000002",
"master": 2,
"nameId": "0635",
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"i": 0,
"value": ""
}, {
"i": 1,
"pairingId": "1009",
"value": 1
}],
"placelinkbindchn": {
"chn": 1,
"odpi": 0,
"value": 1
},
"room": 0,
"showinui": false
}, {
"building": 0,
"cid": "10000026",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 126,
"i": 1,
"inputs": [],
"mask": "00000001",
"master": 0,
"nameId": "0636",
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"eventflag": 1,
"i": 0,
"occurtime": "2018-09-29 00:35:04",
"pairingId": "1009",
"tag": "00000000000004",
"user": 1,
"value": 1
}],
"room": 0
}, {
"bubbleId": "10001",
"building": 0,
"cid": "10000022",
"combined": true,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 122,
"i": 2,
"inputs": [{
"i": 0,
"value": 0
}],
"mask": "00000001",
"master": 2,
"nameId": "0572",
"offsetX": 0,
"offsetY": 0,
"operationmode": true,
"outputs": [{
"i": 0,
"pairingId": "1000",
"value": 0
}],
"parameters": [{
"i": 0,
"parameterId": 11,
"value": "7"
}],
"room": 0
}, {
"building": 0,
"cid": "10000021",
"combined": true,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 121,
"i": 3,
"inputs": [],
"mask": "00000001",
"master": 0,
"nameId": "0637",
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"i": 0,
"pairingId": "2000",
"value": 0
}],
"parameters": [{
"i": 0,
"parameterId": 12,
"value": "0"
}, {
"i": 1,
"parameterId": 13,
"value": "5"
}],
"room": 0
}, {
"building": 0,
"cid": "10000023",
"combined": true,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 123,
"i": 4,
"inputs": [{
"i": 0,
"value": 0
}],
"mask": "00000001",
"master": 0,
"nameId": "0638",
"offsetX": 0,
"offsetY": 0,
"operationmode": true,
"outputs": [{
"i": 0,
"pairingId": "1000",
"value": 0
}],
"room": 0
}, {
"building": 0,
"cid": "10000024",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 124,
"i": 5,
"inputs": [{
"i": 0,
"value": []
}],
"mask": "00000001",
"master": 0,
"nameId": "0639",
"nobuilding": 1,
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"i": 0,
"pairingId": "2001",
"value": []
}],
"room": 0
}, {
"building": 0,
"cid": "10000025",
"combined": false,
"combinedDisplayName": "",
"combinedNameId": "",
"displayName": "",
"floor": 0,
"functionId": 125,
"i": 6,
"inputs": [{
"i": 0,
"value": ""
}],
"mask": "00000001",
"master": 0,
"nameId": "0640",
"offsetX": 0,
"offsetY": 0,
"outputs": [{
"i": 0,
"pairingId": "100B",
"value": 0
}],
"room": 0
}],
"commissioningState": "add",
"deviceTypeId": 2,
"displayName": "Cylinder",
"enableUpdate": 1,
"floor": 0,
"functionId": 65279,
"iconId": "e7de",
"nameId": "0562",
"offsetX": 0,
"offsetY": 0,
"parameters": [{
"enableState": ["init"],
"i": 0,
"notallowempty": 1,
"parameterId": 1,
"value": "AAABBBCCC000111"
}],
"room": 0,
"softwareVersion": "",
"serialNumber": "AAABBBCCC000111",
"deviceId": 783,
"refCnt": 0,
"shortSerialNumber": "COZ"
}],
"timerPrograms": [{
"uid": 1,
"enabled": 1,
"displayName": "default",
"type": "default",
"timers": [{
"timer": {
"datapoints": [{
"i": 0,
"value": 1
}],
"buildingUid": 0,
"earliestEnable": 1,
"earlist": 0,
"floorUid": 0,
"lastestEnabled": 1,
"latest": 0,
"mode": 0,
"offset": 360,
"roomUid": 0,
"serialNumber": "105807A7F030732/ch0008",
"weekDays": "0123456",
"zombie": true
},
"uid": 1,
"uid": 1
}, {
"timer": {
"datapoints": [{
"i": 0,
"value": 0
}],
"buildingUid": 0,
"earliestEnable": 1,
"earlist": 0,
"floorUid": 0,
"lastestEnabled": 1,
"latest": 0,
"mode": 0,
"offset": 1080,
"roomUid": 0,
"serialNumber": "105807A7F030732/ch0008",
"weekDays": "0123456",
"zombie": true
},
"uid": 2,
"uid": 2
}]
}]
},
"method": "getAll",
"jid": "nginx@abb.com/nginx",
"queryid": 2,
"result": 0,
"sessionjwt": ""
}
Set DataPoint
Users publish the following topics to set SmartAP datapoints, while subscribing to topics to receive JSON responses.
| Action | Topic | Payload |
|---|---|---|
| Publish | wipapi/{Username}/datapoint/set | JSON |
| Subscribe | wipapi/{Username}/datapoint/response | JSON |
Request example
{
"attributes":
{
"value": 1,
"is_secondlock": 1
},
"path": "101807A7F04AAA0/ch0001/idp0000"
}
This is an example of opening outdoor station with serial number "101807A7F04AAA0".
***Is_ Secondlock * * *=0 represents the default lock, * * * is_ Secondlock * * *=1 represents an auxiliary lock
In the example the device 101807A7F04AAA0 has one channel (ch0001) with the datapoint of "idp0000" which represents an outdoor station door opener.
value equals to 1 means door open.
Notification
Users regularly send heatbeats (30s) to maintain online status, while subscribing to the following notifications
Receive message push when SmartAP has notifications
| Action | Topic | Payload |
|---|---|---|
| Publish | wipapi/{Username}/heartbeat | - |
| Subscribe | wipapi/{Username}/notification | JSON |
Notification sample
{
"devices": [{
"path": "101807A7F02809C/ch0000/odp0000",
"attributes": {
"value": 1
}
}],
"datatype": "part",
"pushID": 140,
"method": "telemetry",
"model": "device",
"act": "update"
}
In the example the device 101807A7F04AAA0 has one channel (ch0000) with the datapoint of oidp0000" which represents an outdoor station door opener status.
value equals to 1 means door status is open.