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@100:47ea098f8a47, 2015-05-07 (annotated)

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