1 //******************************************************************
3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
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
11 // http://www.apache.org/licenses/LICENSE-2.0
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.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
21 #ifndef PAYLOAD_LOGGING_H_
22 #define PAYLOAD_LOGGING_H_
29 #define __STDC_FORMAT_MACROS
30 #define __STDC_LIMIT_MACROS
32 #include "rdpayload.h"
39 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
40 #define PL_TAG "PayloadLog"
43 #define OC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
44 #define OIC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
45 #define UUID_SIZE (16)
46 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
47 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
49 static inline void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
51 OIC_LOG(level, (PL_TAG), "Payload Type: Representation");
52 OCRepPayload* rep = payload;
56 OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
57 OIC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
58 OIC_LOG(level, PL_TAG, "\tResource Types:");
59 OCStringLL* strll = rep->types;
62 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
65 OIC_LOG(level, PL_TAG, "\tInterfaces:");
66 strll = rep->interfaces;
69 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
73 // TODO Finish Logging: Values
74 OCRepPayloadValue* val = rep->values;
76 OIC_LOG(level, PL_TAG, "\tValues:");
83 OIC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
86 OIC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
88 case OCREP_PROP_DOUBLE:
89 OIC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
92 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
94 case OCREP_PROP_STRING:
95 OIC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
97 case OCREP_PROP_BYTE_STRING:
98 OIC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
99 OIC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
101 case OCREP_PROP_OBJECT:
102 // Note: Only prints the URI (if available), to print further, you'll
103 // need to dig into the object better!
104 OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
106 case OCREP_PROP_ARRAY:
107 switch(val->arr.type)
110 OIC_LOG_V(level, PL_TAG, "\t\t%s(int array):%zu x %zu x %zu",
112 val->arr.dimensions[0], val->arr.dimensions[1],
113 val->arr.dimensions[2]);
115 case OCREP_PROP_DOUBLE:
116 OIC_LOG_V(level, PL_TAG, "\t\t%s(double array):%zu x %zu x %zu",
118 val->arr.dimensions[0], val->arr.dimensions[1],
119 val->arr.dimensions[2]);
121 case OCREP_PROP_BOOL:
122 OIC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%zu x %zu x %zu",
124 val->arr.dimensions[0], val->arr.dimensions[1],
125 val->arr.dimensions[2]);
127 case OCREP_PROP_STRING:
128 OIC_LOG_V(level, PL_TAG, "\t\t%s(string array):%zu x %zu x %zu",
130 val->arr.dimensions[0], val->arr.dimensions[1],
131 val->arr.dimensions[2]);
133 case OCREP_PROP_BYTE_STRING:
134 OIC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%zu x %zu x %zu",
136 val->arr.dimensions[0], val->arr.dimensions[1],
137 val->arr.dimensions[2]);
139 case OCREP_PROP_OBJECT:
140 OIC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%zu x %zu x %zu",
142 val->arr.dimensions[0], val->arr.dimensions[1],
143 val->arr.dimensions[2]);
146 OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
152 OIC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
164 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
166 OIC_LOG(level, PL_TAG, "Payload Type: Discovery");
169 if(!payload->resources)
171 OIC_LOG(level, PL_TAG, "\tNO Resources");
174 OIC_LOG(level, PL_TAG, "\tSID:");
175 OIC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
176 OCResourcePayload* res = payload->resources;
180 OIC_LOG_V(level, PL_TAG, "\tResource #%d", i);
181 OIC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
182 OIC_LOG(level, PL_TAG, "\tResource Types:");
183 OCStringLL* strll = res->types;
186 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
189 OIC_LOG(level, PL_TAG, "\tInterfaces:");
190 strll = res->interfaces;
193 OIC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
197 OIC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
198 OIC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
199 OIC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
200 OIC_LOG(level, PL_TAG, "");
206 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
208 OIC_LOG(level, PL_TAG, "Payload Type: Device");
209 OIC_LOG(level, PL_TAG, "\tSID:");
210 OIC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
211 OIC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
212 OIC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
213 OIC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
216 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
218 OIC_LOG(level, PL_TAG, "Payload Type: Platform");
219 OIC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
220 OIC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
221 OIC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
222 OIC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
223 OIC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
224 OIC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
225 OIC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
226 OIC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
227 OIC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
228 OIC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
229 OIC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
230 OIC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
233 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
235 OIC_LOG(level, PL_TAG, "Payload Type: Presence");
236 OIC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
237 OIC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
238 OIC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
239 OIC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
242 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
244 OIC_LOG(level, PL_TAG, "Payload Type: Security");
245 OIC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
248 static inline void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
255 if (payload->rdDiscovery)
257 OIC_LOG(level, PL_TAG, "RD Discovery");
258 OIC_LOG_V(level, PL_TAG, " Device Name : %s", payload->rdDiscovery->n.deviceName);
259 OIC_LOG_V(level, PL_TAG, " Device Identity : %s", payload->rdDiscovery->di.id);
260 OIC_LOG_V(level, PL_TAG, " Bias: %d", payload->rdDiscovery->sel);
262 if (payload->rdPublish)
264 OIC_LOG(level, PL_TAG, "RD Publish");
265 OCResourceCollectionPayload *rdPublish = payload->rdPublish;
266 OCTagsLog(level, rdPublish->tags);
267 OCLinksLog(level, rdPublish->setLinks);
271 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
275 OIC_LOG(level, PL_TAG, "NULL Payload");
278 switch(payload->type)
280 case PAYLOAD_TYPE_REPRESENTATION:
281 OCPayloadLogRep(level, (OCRepPayload*)payload);
283 case PAYLOAD_TYPE_DISCOVERY:
284 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
286 case PAYLOAD_TYPE_DEVICE:
287 OCPayloadLogDevice(level, (OCDevicePayload*)payload);
289 case PAYLOAD_TYPE_PLATFORM:
290 OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
292 case PAYLOAD_TYPE_PRESENCE:
293 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
295 case PAYLOAD_TYPE_SECURITY:
296 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
298 case PAYLOAD_TYPE_RD:
299 OCRDPayloadLog(level, (OCRDPayload*)payload);
302 OIC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
307 #define OIC_LOG_PAYLOAD(level, payload)
308 #define OC_LOG_PAYLOAD(level, payload)