resource/csdk/stack/include/payload_logging.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef PAYLOAD_LOGGING_H_
  22 #define PAYLOAD_LOGGING_H_
  23
  24 #ifdef __cplusplus
  25 extern "C"
  26 {
  27 #endif
  28
  29 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
  30 #define PL_TAG "PayloadLog"
  31
  32 #ifdef TB_LOG
  33     #define OC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
  34     #define UUID_SIZE (16)
  35     #define UUID_LENGTH (37)
  36 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
  37 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
  38
  39 static inline void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
  40 {
  41     OC_LOG(level, (PL_TAG), "Payload Type: Representation");
  42     OCRepPayload* rep = payload;
  43     int i = 1;
  44     while(rep)
  45     {
  46         OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
  47         OC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
  48         OC_LOG(level, PL_TAG, "\tResource Types:");
  49         OCStringLL* strll =  rep->types;
  50         while(strll)
  51         {
  52             OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  53             strll = strll->next;
  54         }
  55         OC_LOG(level, PL_TAG, "\tInterfaces:");
  56         strll =  rep->interfaces;
  57         while(strll)
  58         {
  59             OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
  60             strll = strll->next;
  61         }
  62
  63         // TODO Finish Logging: Values
  64         OCRepPayloadValue* val = rep->values;
  65
  66         OC_LOG(level, PL_TAG, "\tValues:");
  67
  68         while(val)
  69         {
  70             switch(val->type)
  71             {
  72                 case OCREP_PROP_NULL:
  73                     OC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
  74                     break;
  75                 case OCREP_PROP_INT:
  76                     OC_LOG_V(level, PL_TAG, "\t\t%s(int):%lld", val->name, val->i);
  77                     break;
  78                 case OCREP_PROP_DOUBLE:
  79                     OC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
  80                     break;
  81                 case OCREP_PROP_BOOL:
  82                     OC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
  83                     break;
  84                 case OCREP_PROP_STRING:
  85                     OC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
  86                     break;
  87                 case OCREP_PROP_OBJECT:
  88                     // Note: Only prints the URI (if available), to print further, you'll
  89                     // need to dig into the object better!
  90                     OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
  91                     break;
  92                 case OCREP_PROP_ARRAY:
  93                     switch(val->arr.type)
  94                     {
  95                         case OCREP_PROP_INT:
  96                             OC_LOG_V(level, PL_TAG, "\t\t%s(int array):%lld x %lld x %lld",
  97                                     val->name,
  98                                     val->arr.dimensions[0], val->arr.dimensions[1],
  99                                     val->arr.dimensions[2]);
 100                             break;
 101                         case OCREP_PROP_DOUBLE:
 102                             OC_LOG_V(level, PL_TAG, "\t\t%s(double array):%lld x %lld x %lld",
 103                                     val->name,
 104                                     val->arr.dimensions[0], val->arr.dimensions[1],
 105                                     val->arr.dimensions[2]);
 106                             break;
 107                         case OCREP_PROP_BOOL:
 108                             OC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%lld x %lld x %lld",
 109                                     val->name,
 110                                     val->arr.dimensions[0], val->arr.dimensions[1],
 111                                     val->arr.dimensions[2]);
 112                             break;
 113                         case OCREP_PROP_STRING:
 114                             OC_LOG_V(level, PL_TAG, "\t\t%s(string array):%lld x %lld x %lld",
 115                                     val->name,
 116                                     val->arr.dimensions[0], val->arr.dimensions[1],
 117                                     val->arr.dimensions[2]);
 118                             break;
 119                         case OCREP_PROP_OBJECT:
 120                             OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%lld x %lld x %lld",
 121                                     val->name,
 122                                     val->arr.dimensions[0], val->arr.dimensions[1],
 123                                     val->arr.dimensions[2]);
 124                             break;
 125                         default:
 126                             OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
 127                                     val->name);
 128                             break;
 129                     }
 130                     break;
 131                 default:
 132                     OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
 133                     break;
 134             }
 135             val = val -> next;
 136         }
 137
 138         ++i;
 139         rep = rep->next;
 140     }
 141
 142 }
 143
 144 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
 145 {
 146     OC_LOG(level, PL_TAG, "Payload Type: Discovery");
 147     int i = 1;
 148
 149     if(!payload->resources)
 150     {
 151         OC_LOG(level, PL_TAG, "\tNO Resources");
 152         return;
 153     }
 154
 155     OCResourcePayload* res = payload->resources;
 156
 157     while(res)
 158     {
 159         OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
 160         OC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
 161         OC_LOG(level, PL_TAG, "\tSID:");
 162         OC_LOG_BUFFER(level, PL_TAG, res->sid, UUID_SIZE);
 163         OC_LOG(level, PL_TAG, "\tResource Types:");
 164         OCStringLL* strll =  res->types;
 165         while(strll)
 166         {
 167             OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 168             strll = strll->next;
 169         }
 170         OC_LOG(level, PL_TAG, "\tInterfaces:");
 171         strll =  res->interfaces;
 172         while(strll)
 173         {
 174             OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
 175             strll = strll->next;
 176         }
 177
 178         OC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
 179         OC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
 180         OC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
 181         OC_LOG(level, PL_TAG, "");
 182         res = res->next;
 183         ++i;
 184     }
 185 }
 186
 187 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
 188 {
 189     OC_LOG(level, PL_TAG, "Payload Type: Device");
 190     OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 191     OC_LOG(level, PL_TAG, "\tSID:");
 192     OC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
 193     OC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
 194     OC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
 195     OC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
 196 }
 197
 198 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
 199 {
 200     OC_LOG(level, PL_TAG, "Payload Type: Platform");
 201     OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
 202     OC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
 203     OC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
 204     OC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
 205     OC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
 206     OC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
 207     OC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
 208     OC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
 209     OC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
 210     OC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
 211     OC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
 212     OC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
 213 }
 214
 215 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
 216 {
 217     OC_LOG(level, PL_TAG, "Payload Type: Presence");
 218     OC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
 219     OC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
 220     OC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
 221     OC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
 222 }
 223
 224 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
 225 {
 226     OC_LOG(level, PL_TAG, "Payload Type: Security");
 227     OC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
 228 }
 229
 230 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
 231 {
 232     if(!payload)
 233     {
 234         OC_LOG(level, PL_TAG, "NULL Payload");
 235         return;
 236     }
 237     switch(payload->type)
 238     {
 239         case PAYLOAD_TYPE_REPRESENTATION:
 240             OCPayloadLogRep(level, (OCRepPayload*)payload);
 241             break;
 242         case PAYLOAD_TYPE_DISCOVERY:
 243             OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
 244             break;
 245         case PAYLOAD_TYPE_DEVICE:
 246             OCPayloadLogDevice(level, (OCDevicePayload*)payload);
 247             break;
 248         case PAYLOAD_TYPE_PLATFORM:
 249             OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
 250             break;
 251         case PAYLOAD_TYPE_PRESENCE:
 252             OCPayloadLogPresence(level, (OCPresencePayload*)payload);
 253             break;
 254         case PAYLOAD_TYPE_SECURITY:
 255             OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
 256             break;
 257         default:
 258             OC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
 259             break;
 260     }
 261 }
 262 #else
 263     #define OC_LOG_PAYLOAD(level, payload)
 264 #endif
 265
 266 #ifdef __cplusplus
 267 }
 268 #endif
 269
 270 #endif