CLC_Fct_CHAI.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_CHAI.h
// Project:         CopperLan CHAILink Client SDK
// 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 _CLC_FCT_CHAI_H_
#define _CLC_FCT_CHAI_H_

#ifdef __cplusplus
extern "C" {
#endif

// CHAI functions


CLC_SDK_API CLC_ErrorCode CHAI_GetVersion(
    CPUINT32 * const pdwVersion, 
    CPCHAR8 const ** const ppVersionString);

CLC_SDK_API CLC_ErrorCode CHAI_SetApplicationName(
    CPCHAR8 const * const utf8Name);


CLC_SDK_API CLC_ErrorCode CHAI_RegisterNotificationHandler(void);

CLC_SDK_API CLC_ErrorCode CHAI_UnregisterNotificationHandler(void);


CLC_SDK_API CLC_ErrorCode CHAI_GetGlobalSynchronizedTime(
    SystemTime * const pSystemTime);

CLC_SDK_API CLC_ErrorCode CHAI_IsGlobalSynchronizedTimeReference(CPBOOLEAN * const pfTimeReference);


//---------------------------------------------------------------------
// Snapshot
//---------------------------------------------------------------------


CLC_SDK_API CLC_ErrorCode CHAI_EnterSnapshotSavingMode(void);

CLC_SDK_API CLC_ErrorCode CHAI_EnterSnapshotRestoreMode(void);

CLC_SDK_API CLC_ErrorCode CHAI_LeaveSnapshotMode(void);

CLC_SDK_API CLC_ErrorCode CHAI_GetCurrentSnapshotMode(SnapshotModes * const pSnapshotMode);


//---------------------------------------------------------------------
//                      Lists management
//---------------------------------------------------------------------


CLC_SDK_API CLC_ErrorCode CHAI_AddIndexList(
    CPUINT16 const wSize, 
    CPCHAR8 const * const * const arutf8Names, 
    CPHOBJECT * const phIndexList);              

CLC_SDK_API CLC_ErrorCode CHAI_RemoveIndexList(
    CPHOBJECT const hIndexList);

CLC_SDK_API CLC_ErrorCode CHAI_AddSelectorItemList(
    CPUINT16 const wSize,
    CPUINT16 const * const arValues,
    CPCHAR8 const * const * const arutf8Names, 
    CPHOBJECT * const phSelectorItemList);

CLC_SDK_API CLC_ErrorCode CHAI_UpdateSelectorItemList(
    CPHOBJECT const hSelectorItemList,
    CPUINT16 const wSize,
    CPUINT16 const * const arValues,
    CPCHAR8 const * const * const arutf8Names);

CLC_SDK_API CLC_ErrorCode CHAI_RemoveSelectorItemList(
    CPHOBJECT const hSelectorItemList);



CLC_SDK_API CLC_ErrorCode CHAI_RedeclareAllDevices(void);

CLC_SDK_API CLC_ErrorCode CHAI_AddLocalDevice(
    ObjectTypes deviceType,
    CPUINT16 const wModelID,
    CPUINT32 const dwDuplicateNumber,
    DuplicateModes const duplicateMode,
    CPBOOLEAN const fHidden,
    ExtendedDeviceCapabilities const extendedCapabilities,
    CPCHAR8 const * const utf8ModelName,
    CPUINT32 const dwDeviceUserData,
    CPHOBJECT * const phDevice);

CLC_SDK_API CLC_ErrorCode CHAI_RemoveLocalDevice(
    CPHOBJECT const LocalDeviceHandle);


CLC_SDK_API CLC_ErrorCode CHAI_Connect(
    CPUINT16 const wBrandID, 
    CPCHAR8 const * const utf8BrandName, 
    CPCHAR8 const * const utf8ContactInfo);

CLC_SDK_API CLC_ErrorCode CHAI_Disconnect(void);

CLC_SDK_API CLC_ErrorCode CHAI_IsConnected(
    CPBOOLEAN * const pfConnected);

CLC_SDK_API CLC_ErrorCode CHAI_SetCHAIGroups(
    CPUINT32 const dwGroups);

CLC_SDK_API CLC_ErrorCode CHAI_GetCHAIGroups(
    CPUINT32 * const pdwGroups);



#if defined(ENABLE_NETWORK_SEARCH)
CLC_SDK_API CLC_ErrorCode CHAI_RemoteDevice_FindFirst_Async(
    FindDeviceOptions const options,
    CPDEVICEID const * const pParentDevID,
    DeviceCapabilities const includeDeviceCapabilities,
    DeviceCapabilities const excludeDeviceCapabilities,
    InOutCapabilities const includeInputCapabilities,
    InOutCapabilities const excludeInputCapabilities,
    InOutCapabilities const includeOutputCapabilities,
    InOutCapabilities const excludeOutputCapabilities,
    CPUINT16 const wBrandID, 
    CPUINT16 const wModelID, 
    CPUINT32 const dwDuplicateNumberFrom, 
    CPUINT32 const dwDuplicateNumberTo,
    CPUINT16 const wModuleIDFrom,
    CPUINT16 const wModuleIDTo,
    CPUINT32 const dwClientContextData,
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode CHAI_RemoteDevice_FindNext_Async(
    CPHOOKEDOBJECT const hDeviceEnumContext,
    CPUINT32 const dwClientContextData,
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode CHAI_RemoteDevice_FindPrev_Async(
    CPHOOKEDOBJECT const hDeviceEnumContext,
    CPUINT32 const dwClientContextData,
    CPHASYNC * const phAsync);
#endif

#if defined(ENABLE_GLOBAL_TIMER)
CLC_SDK_API CLC_ErrorCode CHAI_RegisterGlobalTimer(
    GlobalTimerNotificationFlags const flags);
#endif


CLC_SDK_API CLC_ErrorCode CHAI_Warning_Send(
    CPENDPOINT const * const pOptionalSource,
    WarningCodes const code,
    WarningDomains const domain,
    CPCHAR8 const * const utf8Title,
    CPCHAR8 const * const utf8Content);



#if defined(ENABLE_SIGNAL)
CLC_SDK_API CLC_ErrorCode CHAI_RegisterSignalNotificationHandler(void);

CLC_SDK_API CLC_ErrorCode CHAI_UnregisterSignalNotificationHandler(void);
#endif // defined(ENABLE_SIGNAL)

CLC_SDK_API CLC_ErrorCode CHAI_Signal(
      CPDEVICEID const * const pDevID,
      CPUINT16 const wSignalNumber,
      CPUINT16 const wOptionalData0,
      CPUINT16 const wOptionalData1,
      CPUINT16 const wOptionalData2,
      CPUINT16 const wOptionalData3,
      CPCHAR8 const * const utf8OptionalData,
      CPENDPOINT const * const pOptionalEndPoint);


#if defined(ENABLE_REMOTE_DEVICE)
CLC_SDK_API CLC_ErrorCode CHAI_CreateRemoteDeviceFromLocalDevice(
    CPHOBJECT const hLocalDevice, 
    CPHOOKEDOBJECT * const phRemoteDevice);

CLC_SDK_API CLC_ErrorCode CHAI_CreateRemoteDevice(
    CPDEVICEID const * const pDevID, 
    CPHOOKEDOBJECT * const phRemoteDevice);
#endif // defined(ENABLE_REMOTE_DEVICE)

CLC_SDK_API CLC_ErrorCode CHAI_CreateDataTransferMessage(
    CPUINT16 const wNumber, 
    CPHOOKEDOBJECT * const phMsg);

CLC_SDK_API CLC_ErrorCode CHAI_SetFlowControlIncomingCapacity(
    CPUINT32 const dwCapacity);


#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_CHAI_H_