Cumulocity Official / Mbed 2 deprecated MbedSmartRestMain Featured

Official reference client implementation for Cumulocity SmartREST on u-blox C027.

Dependencies:   C027_Support C12832 LM75B MMA7660 MbedSmartRest mbed-rtos mbed

Fork of MbedSmartRestMain by Vincent Wochnik

DeviceIntegration.cpp@101:dbcd3bc51758, 2015-05-08 (annotated)

Committer:
xinlei
Date:
Fri May 08 12:19:57 2015 +0000
Revision:
101:dbcd3bc51758
Parent:
100:47ea098f8a47
Child:
110:b7a403dbceb6
v2.1rc3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
xinlei 93:0acd11870c6a 1 #include <stdio.h>
Cumulocity 41:804f6a0bda26 2 #include "DeviceIntegration.h"
Cumulocity 41:804f6a0bda26 3 #include "ComposedRecord.h"
Cumulocity 41:804f6a0bda26 4 #include "CharValue.h"
Cumulocity 41:804f6a0bda26 5 #include "IntegerValue.h"
xinlei 101:dbcd3bc51758 6 #include "SmartRestConf.h"
xinlei 72:c5709ae7b193 7 #include "logging.h"
Cumulocity 41:804f6a0bda26 8
xinlei 92:48069375dffa 9 DeviceIntegration::DeviceIntegration(AbstractSmartRest& client, SmartRestTemplate& tpl,
xinlei 100:47ea098f8a47 10 DeviceInfo& deviceInfo) :
xinlei 92:48069375dffa 11 _tpl(tpl),
Cumulocity 41:804f6a0bda26 12 _client(client),
Cumulocity 41:804f6a0bda26 13 _deviceInfo(deviceInfo)
Cumulocity 41:804f6a0bda26 14 {
Cumulocity 41:804f6a0bda26 15 _init = false;
Cumulocity 41:804f6a0bda26 16 }
Cumulocity 41:804f6a0bda26 17
Cumulocity 41:804f6a0bda26 18 bool DeviceIntegration::init()
Cumulocity 41:804f6a0bda26 19 {
Cumulocity 41:804f6a0bda26 20 if (_init)
Cumulocity 41:804f6a0bda26 21 return false;
Cumulocity 41:804f6a0bda26 22
Cumulocity 41:804f6a0bda26 23 // get device by identity
Cumulocity 41:804f6a0bda26 24 // Usage: 100,<SERIAL/NR>
Cumulocity 41:804f6a0bda26 25 if (!_tpl.add("10,100,GET,/identity/externalIds/c8y_Serial/%%,,application/vnd.com.nsn.cumulocity.externalId+json,%%,STRING,\r\n"))
Cumulocity 41:804f6a0bda26 26 return false;
Cumulocity 41:804f6a0bda26 27
Cumulocity 41:804f6a0bda26 28 // get device id from identity
Cumulocity 41:804f6a0bda26 29 // Response: 200,<DEVICE/ID>
Cumulocity 41:804f6a0bda26 30 if (!_tpl.add("11,200,\"$.managedObject\",,\"$.id\"\r\n"))
Cumulocity 41:804f6a0bda26 31 return false;
Cumulocity 41:804f6a0bda26 32
Cumulocity 41:804f6a0bda26 33 // Create device
Cumulocity 41:804f6a0bda26 34 // Usage: 101,<SERIAL/NR>
vwochnik 69:237c01eb36c2 35 if (!_tpl.add("10,101,POST,/inventory/managedObjects,application/vnd.com.nsn.cumulocity.managedObject+json,application/vnd.com.nsn.cumulocity.managedObject+json,%%,STRING,\"{\"\"name\"\":\"\"Mbed Test Device\"\",\"\"type\"\":\"\"com_ublox_C027_REV-A\"\",\"\"c8y_Hardware\"\":{\"\"revision\"\":\"\"1\"\",\"\"model\"\":\"\"Ublox C027\"\",\"\"serialNumber\"\":\"\"%%\"\"},\"\"c8y_SupportedOperations\"\":[\"\"c8y_Relay\"\",\"\"c8y_Configuration\"\",\"\"c8y_Message\"\"],\"\"c8y_IsDevice\"\":{},\"\"com_cumulocity_model_Agent\"\":{}}\"\r\n"))
Cumulocity 41:804f6a0bda26 36 return false;
Cumulocity 41:804f6a0bda26 37
Cumulocity 41:804f6a0bda26 38 // Get device id
Cumulocity 41:804f6a0bda26 39 // Response: 201,<DEVICE/ID>
Cumulocity 41:804f6a0bda26 40 if (!_tpl.add("11,201,,\"$.c8y_IsDevice\",\"$.id\"\r\n"))
Cumulocity 41:804f6a0bda26 41 return false;
Cumulocity 41:804f6a0bda26 42
Cumulocity 41:804f6a0bda26 43 // Insert global ID
Cumulocity 41:804f6a0bda26 44 // Usage: 102,<DEVICE/ID>,<SERIAL/NR>
Cumulocity 41:804f6a0bda26 45 if (!_tpl.add("10,102,POST,/identity/globalIds/%%/externalIds,application/vnd.com.nsn.cumulocity.externalId+json,application/vnd.com.nsn.cumulocity.externalId+json,%%,UNSIGNED STRING,\"{\"\"type\"\":\"\"c8y_Serial\"\",\"\"externalId\"\":\"\"%%\"\"}\"\r\n"))
Cumulocity 41:804f6a0bda26 46 return false;
Cumulocity 41:804f6a0bda26 47
Cumulocity 41:804f6a0bda26 48 // Update IMEI, CellId and iccid
Cumulocity 41:804f6a0bda26 49 // Usage: 103,<DEVICE/ID>,<IMEI>,<CELL/ID>,<ICCID>
Cumulocity 41:804f6a0bda26 50 if (!_tpl.add("10,103,PUT,/inventory/managedObjects/%%,application/vnd.com.nsn.cumulocity.managedObject+json,application/vnd.com.nsn.cumulocity.managedObject+json,%%,UNSIGNED STRING STRING STRING,\"{\"\"c8y_Mobile\"\":{\"\"imei\"\":\"\"%%\"\",\"\"cellId\"\":\"\"%%\"\",\"\"iccid\"\":\"\"%%\"\"}}\"\r\n"))
Cumulocity 41:804f6a0bda26 51 return false;
Cumulocity 41:804f6a0bda26 52
Cumulocity 41:804f6a0bda26 53 _init = true;
Cumulocity 41:804f6a0bda26 54 return true;
Cumulocity 41:804f6a0bda26 55 }
Cumulocity 41:804f6a0bda26 56
Cumulocity 41:804f6a0bda26 57 bool DeviceIntegration::integrate()
Cumulocity 41:804f6a0bda26 58 {
xinlei 100:47ea098f8a47 59 if (deviceID != 0)
Cumulocity 41:804f6a0bda26 60 return false;
Cumulocity 41:804f6a0bda26 61
Cumulocity 41:804f6a0bda26 62 // template bootstrapping process
Cumulocity 41:804f6a0bda26 63 if (_client.bootstrap(_tpl) != SMARTREST_SUCCESS) {
xinlei 72:c5709ae7b193 64 aError("Template bootstrap failed.\r\n");
Cumulocity 49:ac0ba9d54ebc 65 return false;
Cumulocity 41:804f6a0bda26 66 }
Cumulocity 41:804f6a0bda26 67
vwochnik 52:8f1370084268 68 if ((!deviceExisting()) && ((!createDevice()) || (!addGlobalIdentifier())))
vwochnik 52:8f1370084268 69 return false;
Cumulocity 41:804f6a0bda26 70
vwochnik 52:8f1370084268 71 if (!updateDevice())
Cumulocity 41:804f6a0bda26 72 return false;
Cumulocity 41:804f6a0bda26 73
Cumulocity 41:804f6a0bda26 74 return true;
Cumulocity 41:804f6a0bda26 75 }
Cumulocity 41:804f6a0bda26 76
Cumulocity 41:804f6a0bda26 77 bool DeviceIntegration::deviceExisting()
Cumulocity 41:804f6a0bda26 78 {
Cumulocity 41:804f6a0bda26 79 ComposedRecord record;
Cumulocity 41:804f6a0bda26 80 ParsedRecord received;
Cumulocity 41:804f6a0bda26 81
Cumulocity 41:804f6a0bda26 82 IntegerValue msgId(100);
Cumulocity 41:804f6a0bda26 83 CharValue imei(_deviceInfo.imei());
Cumulocity 41:804f6a0bda26 84 if ((!record.add(msgId)) || (!record.add(imei)))
Cumulocity 41:804f6a0bda26 85 return false;
Cumulocity 41:804f6a0bda26 86
Cumulocity 41:804f6a0bda26 87 if (_client.send(record) != SMARTREST_SUCCESS) {
xinlei 77:f6717e4eccc4 88 aWarning("Send failed.\r\n");
Cumulocity 41:804f6a0bda26 89 _client.stop();
Cumulocity 41:804f6a0bda26 90 return false;
Cumulocity 41:804f6a0bda26 91 }
Cumulocity 41:804f6a0bda26 92
Cumulocity 41:804f6a0bda26 93 if (_client.receive(received) != SMARTREST_SUCCESS) {
xinlei 93:0acd11870c6a 94 aError("No device found.\n");
Cumulocity 41:804f6a0bda26 95 _client.stop();
Cumulocity 41:804f6a0bda26 96 return false;
Cumulocity 41:804f6a0bda26 97 }
Cumulocity 41:804f6a0bda26 98 _client.stop();
Cumulocity 41:804f6a0bda26 99
Cumulocity 41:804f6a0bda26 100 if (received.values() == 0) {
Cumulocity 41:804f6a0bda26 101 return false;
Cumulocity 41:804f6a0bda26 102 }
Cumulocity 41:804f6a0bda26 103
Cumulocity 41:804f6a0bda26 104 if (received.value(0).integerValue() == 50) {
Cumulocity 41:804f6a0bda26 105 return false;
Cumulocity 41:804f6a0bda26 106 }
Cumulocity 41:804f6a0bda26 107
Cumulocity 41:804f6a0bda26 108 if (received.value(0).integerValue() != 200) {
xinlei 93:0acd11870c6a 109 aError("Unknown message ID: %d.\n", received.value(0).integerValue());
Cumulocity 41:804f6a0bda26 110 return false;
Cumulocity 41:804f6a0bda26 111 }
xinlei 100:47ea098f8a47 112 setDeviceID(received.value(2).integerValue());
Cumulocity 41:804f6a0bda26 113
Cumulocity 41:804f6a0bda26 114 return true;
Cumulocity 41:804f6a0bda26 115 }
Cumulocity 41:804f6a0bda26 116
Cumulocity 41:804f6a0bda26 117 bool DeviceIntegration::createDevice()
Cumulocity 41:804f6a0bda26 118 {
Cumulocity 41:804f6a0bda26 119 ComposedRecord record;
Cumulocity 41:804f6a0bda26 120 ParsedRecord received;
Cumulocity 41:804f6a0bda26 121
xinlei 93:0acd11870c6a 122 aInfo("Create device...\n");
Cumulocity 41:804f6a0bda26 123
Cumulocity 41:804f6a0bda26 124 IntegerValue msgId(101);
Cumulocity 41:804f6a0bda26 125 CharValue imei(_deviceInfo.imei());
Cumulocity 41:804f6a0bda26 126 if ((!record.add(msgId)) || (!record.add(imei)))
Cumulocity 41:804f6a0bda26 127 return false;
Cumulocity 41:804f6a0bda26 128
Cumulocity 41:804f6a0bda26 129 if (_client.send(record) != SMARTREST_SUCCESS) {
Cumulocity 41:804f6a0bda26 130 _client.stop();
Cumulocity 41:804f6a0bda26 131 return 0;
Cumulocity 41:804f6a0bda26 132 }
Cumulocity 41:804f6a0bda26 133
Cumulocity 41:804f6a0bda26 134 if (_client.receive(received) != SMARTREST_SUCCESS) {
xinlei 93:0acd11870c6a 135 aError("No device found.\n");
Cumulocity 41:804f6a0bda26 136 _client.stop();
Cumulocity 41:804f6a0bda26 137 return false;
Cumulocity 41:804f6a0bda26 138 }
Cumulocity 41:804f6a0bda26 139 _client.stop();
Cumulocity 41:804f6a0bda26 140
Cumulocity 41:804f6a0bda26 141 if (received.values() != 3) {
xinlei 93:0acd11870c6a 142 aError("createDevice: Incomplete response.\n");
Cumulocity 41:804f6a0bda26 143 return false;
Cumulocity 41:804f6a0bda26 144 }
Cumulocity 41:804f6a0bda26 145
Cumulocity 41:804f6a0bda26 146 if (received.value(0).integerValue() != 201) {
xinlei 93:0acd11870c6a 147 aError("createDevice: Unknown message ID: %d.\n", received.value(0).integerValue());
Cumulocity 41:804f6a0bda26 148 return false;
Cumulocity 41:804f6a0bda26 149 }
Cumulocity 41:804f6a0bda26 150
xinlei 100:47ea098f8a47 151 setDeviceID(received.value(2).integerValue());
Cumulocity 41:804f6a0bda26 152 return true;
Cumulocity 41:804f6a0bda26 153 }
Cumulocity 41:804f6a0bda26 154
Cumulocity 41:804f6a0bda26 155 bool DeviceIntegration::addGlobalIdentifier()
Cumulocity 41:804f6a0bda26 156 {
Cumulocity 41:804f6a0bda26 157 ComposedRecord record;
Cumulocity 41:804f6a0bda26 158 ParsedRecord received;
Cumulocity 41:804f6a0bda26 159
xinlei 93:0acd11870c6a 160 aInfo("Add global identifier.\n");
Cumulocity 41:804f6a0bda26 161
Cumulocity 41:804f6a0bda26 162 IntegerValue msgId(102);
xinlei 100:47ea098f8a47 163 IntegerValue devId(deviceID);
Cumulocity 41:804f6a0bda26 164 CharValue imei(_deviceInfo.imei());
xinlei 100:47ea098f8a47 165 if ((!record.add(msgId)) || (!record.add(devId)) || (!record.add(imei)))
Cumulocity 41:804f6a0bda26 166 return false;
Cumulocity 41:804f6a0bda26 167
Cumulocity 41:804f6a0bda26 168 if (_client.send(record) != SMARTREST_SUCCESS) {
xinlei 77:f6717e4eccc4 169 aWarning("Adding global identifier failed.\r\n");
Cumulocity 41:804f6a0bda26 170 _client.stop();
Cumulocity 41:804f6a0bda26 171 return false;
Cumulocity 41:804f6a0bda26 172 }
Cumulocity 41:804f6a0bda26 173
Cumulocity 41:804f6a0bda26 174 if (_client.receive(received) != SMARTREST_SUCCESS) {
xinlei 93:0acd11870c6a 175 aError("Receive identifier failed.\n");
Cumulocity 41:804f6a0bda26 176 _client.stop();
Cumulocity 41:804f6a0bda26 177 return false;
Cumulocity 41:804f6a0bda26 178 }
Cumulocity 41:804f6a0bda26 179 _client.stop();
Cumulocity 41:804f6a0bda26 180
Cumulocity 41:804f6a0bda26 181 if (received.values() != 3) {
xinlei 93:0acd11870c6a 182 aError("%d (3) values received.\n", received.values());
Cumulocity 41:804f6a0bda26 183 return false;
Cumulocity 41:804f6a0bda26 184 }
Cumulocity 41:804f6a0bda26 185
Cumulocity 41:804f6a0bda26 186 if (received.value(0).integerValue() != 200) {
xinlei 93:0acd11870c6a 187 aError("Unknown message ID: %d\n", received.value(0).integerValue());
Cumulocity 41:804f6a0bda26 188 return false;
Cumulocity 41:804f6a0bda26 189 }
Cumulocity 41:804f6a0bda26 190
Cumulocity 41:804f6a0bda26 191 return true;
Cumulocity 41:804f6a0bda26 192 }
Cumulocity 41:804f6a0bda26 193
Cumulocity 41:804f6a0bda26 194 bool DeviceIntegration::updateDevice()
Cumulocity 41:804f6a0bda26 195 {
Cumulocity 41:804f6a0bda26 196 ComposedRecord record;
Cumulocity 41:804f6a0bda26 197 ParsedRecord received;
Cumulocity 41:804f6a0bda26 198
Cumulocity 41:804f6a0bda26 199 IntegerValue msgId(103);
xinlei 100:47ea098f8a47 200 IntegerValue devId(deviceID);
Cumulocity 41:804f6a0bda26 201 CharValue imei(_deviceInfo.imei());
Cumulocity 41:804f6a0bda26 202 CharValue cellId(_deviceInfo.cellId());
Cumulocity 41:804f6a0bda26 203 CharValue iccid(_deviceInfo.iccid());
xinlei 94:61d44636f020 204 aInfo("Update Device.\n");
xinlei 100:47ea098f8a47 205 if ((!record.add(msgId)) || (!record.add(devId)) || (!record.add(imei)) || (!record.add(cellId)) || (!record.add(iccid)))
Cumulocity 41:804f6a0bda26 206 return false;
Cumulocity 41:804f6a0bda26 207
Cumulocity 41:804f6a0bda26 208 if (_client.send(record) != SMARTREST_SUCCESS) {
xinlei 93:0acd11870c6a 209 aError("Send.\n");
Cumulocity 41:804f6a0bda26 210 _client.stop();
Cumulocity 41:804f6a0bda26 211 return false;
Cumulocity 41:804f6a0bda26 212 }
Cumulocity 41:804f6a0bda26 213
Cumulocity 41:804f6a0bda26 214 if (_client.receive(received) != SMARTREST_SUCCESS) {
xinlei 93:0acd11870c6a 215 aError("Receive.\n");
Cumulocity 41:804f6a0bda26 216 _client.stop();
Cumulocity 41:804f6a0bda26 217 return false;
Cumulocity 41:804f6a0bda26 218 }
Cumulocity 41:804f6a0bda26 219 _client.stop();
Cumulocity 41:804f6a0bda26 220
Cumulocity 41:804f6a0bda26 221 if (received.values() != 3) {
xinlei 93:0acd11870c6a 222 aError("%d (3) values received.\n", received.values());
Cumulocity 41:804f6a0bda26 223 return false;
Cumulocity 41:804f6a0bda26 224 }
Cumulocity 41:804f6a0bda26 225
Cumulocity 41:804f6a0bda26 226 if (received.value(0).integerValue() != 201) {
xinlei 93:0acd11870c6a 227 aError("Unknown message ID: %d\n", received.value(0).integerValue());
Cumulocity 41:804f6a0bda26 228 return false;
Cumulocity 41:804f6a0bda26 229 }
Cumulocity 41:804f6a0bda26 230
Cumulocity 41:804f6a0bda26 231 return true;
Cumulocity 41:804f6a0bda26 232 }