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_BYTE_STRING:
95 OC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
96 OC_LOG_BUFFER(level, PL_TAG, val->ocByteStr.bytes, val->ocByteStr.len);
98 case OCREP_PROP_OBJECT:
99 // Note: Only prints the URI (if available), to print further, you'll
100 // need to dig into the object better!
101 OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep):%s", val->name, val->obj->uri);
103 case OCREP_PROP_ARRAY:
104 switch(val->arr.type)
107 OC_LOG_V(level, PL_TAG, "\t\t%s(int array):%lld x %lld x %lld",
109 val->arr.dimensions[0], val->arr.dimensions[1],
110 val->arr.dimensions[2]);
112 case OCREP_PROP_DOUBLE:
113 OC_LOG_V(level, PL_TAG, "\t\t%s(double array):%lld x %lld x %lld",
115 val->arr.dimensions[0], val->arr.dimensions[1],
116 val->arr.dimensions[2]);
118 case OCREP_PROP_BOOL:
119 OC_LOG_V(level, PL_TAG, "\t\t%s(bool array):%lld x %lld x %lld",
121 val->arr.dimensions[0], val->arr.dimensions[1],
122 val->arr.dimensions[2]);
124 case OCREP_PROP_STRING:
125 OC_LOG_V(level, PL_TAG, "\t\t%s(string array):%lld x %lld x %lld",
127 val->arr.dimensions[0], val->arr.dimensions[1],
128 val->arr.dimensions[2]);
130 case OCREP_PROP_BYTE_STRING:
131 OC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%lld x %lld x %lld",
133 val->arr.dimensions[0], val->arr.dimensions[1],
134 val->arr.dimensions[2]);
136 case OCREP_PROP_OBJECT:
137 OC_LOG_V(level, PL_TAG, "\t\t%s(OCRep array):%lld x %lld x %lld",
139 val->arr.dimensions[0], val->arr.dimensions[1],
140 val->arr.dimensions[2]);
143 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
149 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
161 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
163 OC_LOG(level, PL_TAG, "Payload Type: Discovery");
166 if(!payload->resources)
168 OC_LOG(level, PL_TAG, "\tNO Resources");
171 OC_LOG(level, PL_TAG, "\tSID:");
172 OC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
173 OCResourcePayload* res = payload->resources;
177 OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
178 OC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
179 OC_LOG(level, PL_TAG, "\tResource Types:");
180 OCStringLL* strll = res->types;
183 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
186 OC_LOG(level, PL_TAG, "\tInterfaces:");
187 strll = res->interfaces;
190 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
194 OC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
195 OC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
196 OC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
197 OC_LOG(level, PL_TAG, "");
203 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
205 OC_LOG(level, PL_TAG, "Payload Type: Device");
206 OC_LOG(level, PL_TAG, "\tSID:");
207 OC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
208 OC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
209 OC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
210 OC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
213 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
215 OC_LOG(level, PL_TAG, "Payload Type: Platform");
216 OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
217 OC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
218 OC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
219 OC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
220 OC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
221 OC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
222 OC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
223 OC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
224 OC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
225 OC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
226 OC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
227 OC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
230 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
232 OC_LOG(level, PL_TAG, "Payload Type: Presence");
233 OC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
234 OC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
235 OC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
236 OC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
239 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
241 OC_LOG(level, PL_TAG, "Payload Type: Security");
242 OC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
245 static inline void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
252 if (payload->rdDiscovery)
254 OC_LOG(level, PL_TAG, "RD Discovery");
255 OC_LOG_V(level, PL_TAG, " Device Name : %s", payload->rdDiscovery->n.deviceName);
256 OC_LOG_V(level, PL_TAG, " Device Identity : %s", payload->rdDiscovery->di.id);
257 OC_LOG_V(level, PL_TAG, " Bias: %d", payload->rdDiscovery->sel);
259 if (payload->rdPublish)
261 OC_LOG(level, PL_TAG, "RD Publish");
262 OCResourceCollectionPayload *rdPublish = payload->rdPublish;
263 OCTagsLog(level, rdPublish->tags);
264 OCLinksLog(level, rdPublish->setLinks);
268 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
272 OC_LOG(level, PL_TAG, "NULL Payload");
275 switch(payload->type)
277 case PAYLOAD_TYPE_REPRESENTATION:
278 OCPayloadLogRep(level, (OCRepPayload*)payload);
280 case PAYLOAD_TYPE_DISCOVERY:
281 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
283 case PAYLOAD_TYPE_DEVICE:
284 OCPayloadLogDevice(level, (OCDevicePayload*)payload);
286 case PAYLOAD_TYPE_PLATFORM:
287 OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
289 case PAYLOAD_TYPE_PRESENCE:
290 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
292 case PAYLOAD_TYPE_SECURITY:
293 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
295 case PAYLOAD_TYPE_RD:
296 OCRDPayloadLog(level, (OCRDPayload*)payload);
299 OC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
304 #define OC_LOG_PAYLOAD(level, payload)