XDK API  3.6.0
Documentation
Files | Data Structures | Typedefs | Functions
PPMP Serializer

Interface header file for the PPMP Serializer feature. More...

+ Collaboration diagram for PPMP Serializer:

Files

file  XDK_PPMPSerializer.h
 

Data Structures

struct  PPMPSerializer_Setup_S
 Structure to represent the PPMP serializer setup features. More...
 

Typedefs

typedef struct
PPMPSerializer_Setup_S 
PPMPSerializer_Setup_T
 Typedef to represent the PPMP serializer setup feature. More...
 

Functions

Retcode_T PPMPSerializer_Enable (void)
 This will enable the PPMP serializer. More...
 
char * PPMPSerializer_PayloadExternalSensorSelective (bool create, char *timezoneISO8601format, uint32_t timeStampDelta, ExternalSensor_Value_T *sensorValue, ExternalSensor_Enable_T *serializeSensor)
 This will construct and destruct the PPMP payload for XDK interfaced external sensors. More...
 
char * PPMPSerializer_PayloadSensorSelective (bool create, char *timezoneISO8601format, uint32_t timeStampDelta, Sensor_Value_T *sensorValue, Sensor_Enable_T *serializeSensor)
 This will construct and destruct the PPMP payload for XDK in-built sensors. More...
 
Retcode_T PPMPSerializer_Setup (PPMPSerializer_Setup_T *setup)
 This will setup the PPMP serializer. More...
 

Detailed Description

This is responsible for serializing PPMP payload. For serializing this uses 3rd party cJson module which allocates memory from the MCU heap. This is dependent on the XDK_Sensor interface and uses the Sensor_Value_T naming for technical value.


Data Structure Documentation

struct PPMPSerializer_Setup_S

Data Fields

const char * DeviceName
 

Field Documentation

const char* DeviceName

Pointer to the PPMP device name. Must be lesser than 20 characters.

Typedef Documentation

Function Documentation

Retcode_T PPMPSerializer_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.
Note

Refer interface header for description

+ Here is the caller graph for this function:

char* PPMPSerializer_PayloadExternalSensorSelective ( bool  create,
char *  timezoneISO8601format,
uint32_t  timeStampDelta,
ExternalSensor_Value_T sensorValue,
ExternalSensor_Enable_T serializeSensor 
)
Parameters
[in]createIf "true" the payload will be Constructed by allocating memory from the MCU heap. If "false" then any previously allocated memory will be destructed.
[in]timezoneISO8601formattime zone in ISO-8601 format (string)
[in]timeStampDeltatime stamp in milli seconds offset to timezoneISO8601format value
[in]sensorValuedata collector last valid snap-shot to be serialized
[in]serializeSensordenotes which sensors needs to be serialized per request
Returns
pointer to the constructed payload. Will be NULL in-case of failure.
Note
Every PPMPSerializer_PayloadExternalSensorSelective(true, ...) must follow with with PPMPSerializer_PayloadExternalSensorSelective(false, ...) Only LEM is supported, yet.

Refer interface header for description

+ Here is the call graph for this function:

char* PPMPSerializer_PayloadSensorSelective ( bool  create,
char *  timezoneISO8601format,
uint32_t  timeStampDelta,
Sensor_Value_T sensorValue,
Sensor_Enable_T serializeSensor 
)
Parameters
[in]createIf "true" the payload will be Constructed by allocating memory from the MCU heap. If "false" then any previously allocated memory will be destructed.
[in]timezoneISO8601formattime zone in ISO-8601 format (string)
[in]timeStampDeltatime stamp in milli seconds offset to timezoneISO8601format value
[in]sensorValuedata collector last valid snap-shot to be serialized
[in]serializeSensordenotes which sensors needs to be serialized per request
Returns
pointer to the constructed payload. Will be NULL in-case of failure.
Note
Every PPMPSerializer_PayloadSensorSelective(true, ...) must follow with with PPMPSerializer_PayloadSensorSelective(false, ...)

Refer interface header for description

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T PPMPSerializer_Setup ( PPMPSerializer_Setup_T setup)
Parameters
[in]setupPointer to the PPMP serializer setup feature
Returns
RETCODE_OK on success, or an error code otherwise.
Note
  • This must be the first API to be called if PPMP serializer feature is to be used.
  • Do not call this API more than once.

Refer interface header for description

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8