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 UUID_SIZE (16)
45 #define UUID_LENGTH (37)
46 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
47 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
49 static inline void OCPayloadLogRep(LogLevel level, OCRepPayload* payload)
51 OC_LOG(level, (PL_TAG), "Payload Type: Representation");
52 OCRepPayload* rep = payload;
56 OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
57 OC_LOG_V(level, PL_TAG, "\tURI:%s", rep->uri);
58 OC_LOG(level, PL_TAG, "\tResource Types:");
59 OCStringLL* strll = rep->types;
62 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
65 OC_LOG(level, PL_TAG, "\tInterfaces:");
66 strll = rep->interfaces;
69 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
73 // TODO Finish Logging: Values
74 OCRepPayloadValue* val = rep->values;
76 OC_LOG(level, PL_TAG, "\tValues:");
83 OC_LOG_V(level, PL_TAG, "\t\t%s: NULL", val->name);
86 OC_LOG_V(level, PL_TAG, "\t\t%s(int):%zd", val->name, val->i);
88 case OCREP_PROP_DOUBLE:
89 OC_LOG_V(level, PL_TAG, "\t\t%s(double):%f", val->name, val->d);
92 OC_LOG_V(level, PL_TAG, "\t\t%s(bool):%s", val->name, val->b ? "true" : "false");
94 case OCREP_PROP_STRING:
95 OC_LOG_V(level, PL_TAG, "\t\t%s(string):%s", val->name, val->str);
97 case OCREP_PROP_BYTE_STRING:
98 OC_LOG_V(level, PL_TAG, "\t\t%s(binary):", val->name);
99 OC_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 OC_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 OC_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 OC_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 OC_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 OC_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 OC_LOG_V(level, PL_TAG, "\t\t%s(byte array):%lld x %lld x %lld",
136 val->arr.dimensions[0], val->arr.dimensions[1],
137 val->arr.dimensions[2]);
139 case OCREP_PROP_OBJECT:
140 OC_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 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown/unsupported array type!",
152 OC_LOG_V(ERROR, PL_TAG, "\t\t%s <-- Unknown type!", val->name);
164 static inline void OCPayloadLogDiscovery(LogLevel level, OCDiscoveryPayload* payload)
166 OC_LOG(level, PL_TAG, "Payload Type: Discovery");
169 if(!payload->resources)
171 OC_LOG(level, PL_TAG, "\tNO Resources");
175 OCResourcePayload* res = payload->resources;
179 OC_LOG_V(level, PL_TAG, "\tResource #%d", i);
180 OC_LOG_V(level, PL_TAG, "\tURI:%s", res->uri);
181 OC_LOG(level, PL_TAG, "\tSID:");
182 OC_LOG_BUFFER(level, PL_TAG, res->sid, UUID_SIZE);
183 OC_LOG(level, PL_TAG, "\tResource Types:");
184 OCStringLL* strll = res->types;
187 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
190 OC_LOG(level, PL_TAG, "\tInterfaces:");
191 strll = res->interfaces;
194 OC_LOG_V(level, PL_TAG, "\t\t%s", strll->value);
198 OC_LOG_V(level, PL_TAG, "\tBitmap: %u", res->bitmap);
199 OC_LOG_V(level, PL_TAG, "\tSecure?: %s", res->secure ? "true" : "false");
200 OC_LOG_V(level, PL_TAG, "\tPort: %u", res->port);
201 OC_LOG(level, PL_TAG, "");
207 static inline void OCPayloadLogDevice(LogLevel level, OCDevicePayload* payload)
209 OC_LOG(level, PL_TAG, "Payload Type: Device");
210 OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
211 OC_LOG(level, PL_TAG, "\tSID:");
212 OC_LOG_BUFFER(level, PL_TAG, payload->sid, UUID_SIZE);
213 OC_LOG_V(level, PL_TAG, "\tDevice Name:%s", payload->deviceName);
214 OC_LOG_V(level, PL_TAG, "\tSpec Version%s", payload->specVersion);
215 OC_LOG_V(level, PL_TAG, "\tData Model Version:%s", payload->dataModelVersion);
218 static inline void OCPayloadLogPlatform(LogLevel level, OCPlatformPayload* payload)
220 OC_LOG(level, PL_TAG, "Payload Type: Platform");
221 OC_LOG_V(level, PL_TAG, "\tURI:%s", payload->uri);
222 OC_LOG_V(level, PL_TAG, "\tPlatform ID:%s", payload->info.platformID);
223 OC_LOG_V(level, PL_TAG, "\tMfg Name:%s", payload->info.manufacturerName);
224 OC_LOG_V(level, PL_TAG, "\tMfg URL:%s", payload->info.manufacturerUrl);
225 OC_LOG_V(level, PL_TAG, "\tModel Number:%s", payload->info.modelNumber);
226 OC_LOG_V(level, PL_TAG, "\tDate of Mfg:%s", payload->info.dateOfManufacture);
227 OC_LOG_V(level, PL_TAG, "\tPlatform Version:%s", payload->info.platformVersion);
228 OC_LOG_V(level, PL_TAG, "\tOS Version:%s", payload->info.operatingSystemVersion);
229 OC_LOG_V(level, PL_TAG, "\tHardware Version:%s", payload->info.hardwareVersion);
230 OC_LOG_V(level, PL_TAG, "\tFirmware Version:%s", payload->info.firmwareVersion);
231 OC_LOG_V(level, PL_TAG, "\tSupport URL:%s", payload->info.supportUrl);
232 OC_LOG_V(level, PL_TAG, "\tSystem Time:%s", payload->info.systemTime);
235 static inline void OCPayloadLogPresence(LogLevel level, OCPresencePayload* payload)
237 OC_LOG(level, PL_TAG, "Payload Type: Presence");
238 OC_LOG_V(level, PL_TAG, "\tSequence Number:%u", payload->sequenceNumber);
239 OC_LOG_V(level, PL_TAG, "\tMax Age:%d", payload->maxAge);
240 OC_LOG_V(level, PL_TAG, "\tTrigger:%s", convertTriggerEnumToString(payload->trigger));
241 OC_LOG_V(level, PL_TAG, "\tResource Type:%s", payload->resourceType);
244 static inline void OCPayloadLogSecurity(LogLevel level, OCSecurityPayload* payload)
246 OC_LOG(level, PL_TAG, "Payload Type: Security");
247 OC_LOG_V(level, PL_TAG, "\tSecurity Data: %s", payload->securityData);
250 static inline void OCRDPayloadLog(const LogLevel level, const OCRDPayload *payload)
257 if (payload->rdDiscovery)
259 OC_LOG(level, PL_TAG, "RD Discovery");
260 OC_LOG_V(level, PL_TAG, " Device Name : %s", payload->rdDiscovery->n.deviceName);
261 OC_LOG_V(level, PL_TAG, " Device Identity : %s", payload->rdDiscovery->di.id);
262 OC_LOG_V(level, PL_TAG, " Bias: %d", payload->rdDiscovery->sel);
264 if (payload->rdPublish)
266 OC_LOG(level, PL_TAG, "RD Publish");
267 OCResourceCollectionPayload *rdPublish = payload->rdPublish;
268 OCTagsLog(level, rdPublish->tags);
269 OCLinksLog(level, rdPublish->setLinks);
273 static inline void OCPayloadLog(LogLevel level, OCPayload* payload)
277 OC_LOG(level, PL_TAG, "NULL Payload");
280 switch(payload->type)
282 case PAYLOAD_TYPE_REPRESENTATION:
283 OCPayloadLogRep(level, (OCRepPayload*)payload);
285 case PAYLOAD_TYPE_DISCOVERY:
286 OCPayloadLogDiscovery(level, (OCDiscoveryPayload*)payload);
288 case PAYLOAD_TYPE_DEVICE:
289 OCPayloadLogDevice(level, (OCDevicePayload*)payload);
291 case PAYLOAD_TYPE_PLATFORM:
292 OCPayloadLogPlatform(level, (OCPlatformPayload*)payload);
294 case PAYLOAD_TYPE_PRESENCE:
295 OCPayloadLogPresence(level, (OCPresencePayload*)payload);
297 case PAYLOAD_TYPE_SECURITY:
298 OCPayloadLogSecurity(level, (OCSecurityPayload*)payload);
300 case PAYLOAD_TYPE_RD:
301 OCRDPayloadLog(level, (OCRDPayload*)payload);
304 OC_LOG_V(level, PL_TAG, "Unknown Payload Type: %d", payload->type);
309 #define OC_LOG_PAYLOAD(level, payload)