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 #include "rdpayload.h"
36 // PL_TAG is made as generic predefined tag because of build problems in arduino for using logging
37 #define PL_TAG "PayloadLog"
40 #define OC_LOG_PAYLOAD(level, payload) OCPayloadLog((level),(payload))
41 #define UUID_SIZE (16)
42 #define UUID_LENGTH (37)
43 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
44 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
46 static inline void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
48 OC_LOG(level, (PL_TAG), "Payload Type: Representation");
49 OCRepPayload* rep = payload;
53 OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
54 OC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
55 OC_LOG(level, PL_TAG, "\tResource Types:");
56 OCStringLL* strll = rep->types;
59 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
62 OC_LOG(level, PL_TAG, "\tInterfaces:");
63 strll = rep->interfaces;
66 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
70 // TODO Finish Logging: Values
71 OCRepPayloadValue* val = rep->values;
73 OC_LOG(level, PL_TAG, "\tValues:");
80 OC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
83 OC_LOG_V(level, PL_TAG, "\t\t%s(int):%lld", val->name, val->i);
85 case OCREP_PROP_DOUBLE:
86 OC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
89 OC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
91 case OCREP_PROP_STRING:
92 OC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
94 case OCREP_PROP_OBJECT:
95 // Note: Only prints the URI (if available), to print further, you'll
96 // need to dig into the object better!
97 OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
99 case OCREP_PROP_ARRAY:
100 switch(val->arr.type)
103 OC_LOG_V(level, PL_TAG, "\t\t%s(int array):%lld x %lld x %lld",
105 val->arr.dimensions[0], val->arr.dimensions[1],
106 val->arr.dimensions[2]);
108 case OCREP_PROP_DOUBLE:
109 OC_LOG_V(level, PL_TAG, "\t\t%s(double array):%lld x %lld x %lld",
111 val->arr.dimensions[0], val->arr.dimensions[1],
112 val->arr.dimensions[2]);
114 case OCREP_PROP_BOOL:
115 OC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%lld x %lld x %lld",
117 val->arr.dimensions[0], val->arr.dimensions[1],
118 val->arr.dimensions[2]);
120 case OCREP_PROP_STRING:
121 OC_LOG_V(level, PL_TAG, "\t\t%s(string array):%lld x %lld x %lld",
123 val->arr.dimensions[0], val->arr.dimensions[1],
124 val->arr.dimensions[2]);
126 case OCREP_PROP_OBJECT:
127 OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%lld x %lld x %lld",
129 val->arr.dimensions[0], val->arr.dimensions[1],
130 val->arr.dimensions[2]);
133 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
139 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
151 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
153 OC_LOG(level, PL_TAG, "Payload Type: Discovery");
156 if(!payload->resources)
158 OC_LOG(level, PL_TAG, "\tNO Resources");
162 OCResourcePayload* res = payload->resources;
166 OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
167 OC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
168 OC_LOG(level, PL_TAG, "\tSID:");
169 OC_LOG_BUFFER(level, PL_TAG, res->sid, UUID_SIZE);
170 OC_LOG(level, PL_TAG, "\tResource Types:");
171 OCStringLL* strll = res->types;
174 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
177 OC_LOG(level, PL_TAG, "\tInterfaces:");
178 strll = res->interfaces;
181 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
185 OC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
186 OC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
187 OC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
188 OC_LOG(level, PL_TAG, "");
194 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
196 OC_LOG(level, PL_TAG, "Payload Type: Device");
197 OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
198 OC_LOG(level, PL_TAG, "\tSID:");
199 OC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
200 OC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
201 OC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
202 OC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
205 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
207 OC_LOG(level, PL_TAG, "Payload Type: Platform");
208 OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
209 OC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
210 OC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
211 OC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
212 OC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
213 OC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
214 OC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
215 OC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
216 OC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
217 OC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
218 OC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
219 OC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
222 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
224 OC_LOG(level, PL_TAG, "Payload Type: Presence");
225 OC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
226 OC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
227 OC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
228 OC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
231 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
233 OC_LOG(level, PL_TAG, "Payload Type: Security");
234 OC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
237 static inline void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
244 if (payload->rdDiscovery)
246 OC_LOG(level, PL_TAG, "RD Discovery");
247 OC_LOG_V(level, PL_TAG, " Device Name : %s", payload->rdDiscovery->n.deviceName);
248 OC_LOG_V(level, PL_TAG, " Device Identity : %s", payload->rdDiscovery->di.id);
249 OC_LOG_V(level, PL_TAG, " Bias: %d", payload->rdDiscovery->sel);
251 if (payload->rdPublish)
253 OC_LOG(level, PL_TAG, "RD Publish");
254 OCResourceCollectionPayload *rdPublish = payload->rdPublish;
255 OCTagsLog(level, rdPublish->tags);
256 OCLinksLog(level, rdPublish->setLinks);
260 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
264 OC_LOG(level, PL_TAG, "NULL Payload");
267 switch(payload->type)
269 case PAYLOAD_TYPE_REPRESENTATION:
270 OCPayloadLogRep(level, (OCRepPayload*)payload);
272 case PAYLOAD_TYPE_DISCOVERY:
273 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
275 case PAYLOAD_TYPE_DEVICE:
276 OCPayloadLogDevice(level, (OCDevicePayload*)payload);
278 case PAYLOAD_TYPE_PLATFORM:
279 OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
281 case PAYLOAD_TYPE_PRESENCE:
282 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
284 case PAYLOAD_TYPE_SECURITY:
285 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
287 case PAYLOAD_TYPE_RD:
288 OCRDPayloadLog(level, (OCRDPayload*)payload);
291 OC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
296 #define OC_LOG_PAYLOAD(level, payload)