CLCm_Utils.h

Go to the documentation of this file.

//*********************************************************
// File:            CLCm_Utils.h
// Project:         CopperLan CHAILink SDK Common Part
//                  For Client & Server
// Version:         1.3
// Release Date:    2014/04/15
//**********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef __CLCM_UTILS_H__
#define __CLCM_UTILS_H__

#include "CLCm_Defines.h"


// size for special types
#define CLM_DEVICEID_SIZE                   (sizeof(CPUINT16) * 5)
#define CLM_ENDPOINT_SIZE                   (sizeof(CPUINT16) * 6)
#define CLM_SECTIONID_SIZE                  (sizeof(CPUINT16) * 5)
#define CLM_PARAMETERID_SIZE                (sizeof(CPUINT16) * 4)
#define CLM_CONTROLLERID_SIZE               (sizeof(CPUINT16) * 3)
#define CLM_CONTROLLERASSIGNMENT_SIZE       (CLM_ENDPOINT_SIZE + sizeof(CPUINT16) * 6 + sizeof(CPUINT8) * 2)
#define CLM_SMARTCONNECTSECTIONITEM_SIZE    (sizeof(CPUINT64) + CLM_DEVICEID_SIZE + sizeof(CPUINT16))
#define CLM_SMARTCONNECTCONTROLLERITEM_SIZE (sizeof(CPUINT16) * 5)
#define CLM_INTERNAL_VALUE_SIZE             (sizeof(CPUINT16) * 2 + sizeof(CPUINT8) * 8)
#define CLM_APPMSGHEADER_SIZE               (sizeof(CPUINT16) + CLM_ENDPOINT_SIZE + sizeof(CPUINT8) * 2)
#define CLM_APPMODIFIERMSG_SIZE             (sizeof(CPUINT16) * 10 + CLM_INTERNAL_VALUE_SIZE)
#define CLM_APPEVENTMSG_SIZE                (sizeof(CPUINT16) * 9)
#define CLM_APPSELECTORMSG_SIZE             (sizeof(CPUINT16) * 11)
#define CLM_APPTEXTMSG_BASESIZE             (sizeof(CPUINT16) * 10)
#define CLM_APPMIDISYSEXMSG_BASESIZE        (sizeof(CPUINT8) * 2)
#define CLM_TIMESTAMPINFO_SIZE              (sizeof(CPUINT64) + sizeof(CPUINT32) + sizeof(CPUINT16))

#ifdef __cplusplus
extern "C" {
#endif

//=========================================================================
// Serialization/Deserialization
//=========================================================================
CPUINT16 Serialize_String(CPCHAR8 const * const utf8Text, CPUINT16 const wMaxSize, CPBYTE** ppCursor);
CPUINT16 Deserialize_String(CPCHAR8  const ** const putf8Text, CPUINT16 const wMaxSize, CPBYTE ** ppCursor);

#ifdef __cplusplus
}
#endif


#endif // __CLCM_UTILS_H__