CLC_Fct_LocalDevice.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_LocalDevice.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_BASELOCALDEVICE_H_
#define _CLC_FCT_BASELOCALDEVICE_H_

#ifdef __cplusplus
extern "C" {
#endif

    // Local device functions



    CLC_SDK_API CLC_ErrorCode LocalDevice_AddSubDevice(
        ObjectTypes deviceType,
        CPHOBJECT const hLocalDevice,
        CPUINT16 const wModuleID,
        CPBOOLEAN const fHidden,
        ExtendedDeviceCapabilities const extendedCapabilities,
        CPCHAR8 const * const utf8ModelName, 
        CPUINT32 const dwNewDeviceUserData,
        CPHOBJECT * const phNewDevice);

#if !defined(NO_DEVICE_ENABLED)
    CLC_SDK_API CLC_ErrorCode LocalDevice_RegisterNotificationHandler(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_UnregisterNotificationHandler(
        CPHOBJECT const hLocalDevice);
#endif // !defined(NO_DEVICE_ENABLED)

#if defined(ENABLE_SNAPSHOT)
    CLC_SDK_API CLC_ErrorCode LocalDevice_RegisterSnapshotNotificationHandler(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_UnregisterSnapshotNotificationHandler(
        CPHOBJECT const hLocalDevice);
#endif // defined(ENABLE_SNAPSHOT)

#ifdef ENABLE_SMARTCONNECT_TARGET

    CLC_SDK_API CLC_ErrorCode LocalDevice_RegisterSmartConnectTargetNotificationHandler(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_UnregisterSmartConnectTargetNotificationHandler(
        CPHOBJECT const hLocalDevice);

#endif // ENABLE_SMARTCONNECT_TARGET

#if defined(ENABLE_SIGNAL)
    CLC_SDK_API CLC_ErrorCode LocalDevice_RegisterSignalNotificationHandler(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_UnregisterSignalNotificationHandler(
        CPHOBJECT const hLocalDevice);
#endif // defined(ENABLE_SIGNAL)



    CLC_SDK_API CLC_ErrorCode LocalDevice_GetInfo(
        CPHOBJECT const hLocalDevice, 
        CPLOCALDEVICEINFO * const  pInfo);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetCustomName(
        CPHOBJECT const hLocalDevice, 
        CPCHAR8 const * const utf8CustomName);

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetName(
        CPHOBJECT const hLocalDevice, 
        DeviceNameFormats format, 
        CPCHAR8 const ** const putf8Name);

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetPath(
        CPHOBJECT const hLocalDevice, 
        CPCHAR8 const ** const putf8Name);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetVisibility(
        CPHOBJECT const hLocalDevice, 
        CPBOOLEAN const fHidden);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetDisabledDestinationAutoDelete(
        CPHOBJECT const hLocalDevice, 
        CPBOOLEAN const fAutoDelete);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetSectionName(
        CPHOBJECT const hLocalDevice, 
        CPSECTIONID const * const pSectionID,
        CPCHAR8 const * const utf8Name);

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetSectionName(
        CPHOBJECT const hLocalDevice, 
        CPSECTIONID const * const pSectionID,
        CPCHAR8 const ** const putf8Name);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetStringProperty(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wPropertyNum,
        CPCHAR8 const * const utf8Value);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetNumericProperty(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wPropertyNum,
        CPUINT64 const qwValue);



    CLC_SDK_API CLC_ErrorCode LocalDevice_AddOutput(
        CPHOBJECT const hLocalDevice, 
        InOutCapabilities const outCaps, 
        CPCHAR8 const * const utf8OutputName,
        CPSECTIONID const * const pSectionID,
        CPUINT32 const dwOutputUserData,
        CPHOBJECT * const phOutput,
        CPUINT16 * const pwOutputID );

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetOutputFromID(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wOutputID, 
        CPHOBJECT * const phOutput);

    CLC_SDK_API CLC_ErrorCode LocalDevice_ClearOutputs(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_Flush(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_AddController(
        CPHOBJECT const hLocalDevice,
        CPCHAR8 const * const utf8Name,
        ControllerTypes const types,
        MessageTypes const preferredMsgType,
        CPUINT16 const wPreferredMsgNum,
        CPUINT16 const wGroup,
        CPSECTIONID const * const pSectionID,
        CPUINT32 const dwControllerUserData,
        CPHOBJECT * const phController,
        CPUINT16 * const pwControllerID);

    CLC_SDK_API CLC_ErrorCode LocalDevice_ClearControllers(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_UnassignAllControllers(
        CPHOBJECT const hLocalDevice,
        CPBOOLEAN const fAlsoForChildren);



    CLC_SDK_API CLC_ErrorCode LocalDevice_AddInput(CPHOBJECT const hLocalDevice,
        InOutCapabilities const inCaps,
        CPCHAR8 const * const utf8InputName, 
        CPSECTIONID const * const pSectionID,
        CPUINT32 const dwInputUserData,
        CPHOBJECT * const phInput,
        CPUINT16 * const pwInputID );

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetInputFromID(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wInputID, 
        CPHOBJECT * const phInput);

    CLC_SDK_API CLC_ErrorCode LocalDevice_ClearInputs(
        CPHOBJECT const hLocalDevice);


    CLC_SDK_API CLC_ErrorCode LocalDevice_FlowControl(
        CPHOBJECT const hLocalDevice, 
        CPBOOLEAN const fSuspend);


    CLC_SDK_API CLC_ErrorCode LocalDevice_AddPipe(
        CPHOBJECT const hLocalDevice, 
        CPBOOLEAN const fSynapse, 
        CPUINT32 const dwPipeUserData,
        CPHOBJECT * const phPipe, 
        CPUINT16 * const pwPipeID);

    CLC_SDK_API CLC_ErrorCode LocalDevice_GetPipeFromID(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wPipeID, 
        CPHOBJECT * const phPipe);

    CLC_SDK_API CLC_ErrorCode LocalDevice_ClearPipes(
        CPHOBJECT const hLocalDevice);


    CLC_SDK_API CLC_ErrorCode LocalDevice_LeaveLearningMode(
        CPHOBJECT const hLocalDevice);

    CLC_SDK_API CLC_ErrorCode LocalDevice_IsLearningModeActive(
        CPHOBJECT const hLocalDevice, 
        CPBOOLEAN * const pfActive);



    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_UnassignAndRequestSectionList(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wSessionID,
        CPDEVICEID const * const pDevID);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_RequestControllerList(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wSessionID,
        CPDEVICEID const * const pDevID,
        CPSECTIONID const * const pSectionID);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_AssignController(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wSessionID,
        CPDEVICEID const * const pDevID,
        CPUINT16 const wControllerID,
        CPCONTROLLERASSIGNMENT const * const pAssignment);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_AssignOutput(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wSessionID,
        CPDEVICEID const * const pDevID,
        CPSECTIONID const * const pSectionID,
        CPENDPOINT const * const pTargetEndpoint);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_Finished(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wSessionID,
        Errors const errCode);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_Started_GetDeviceID(
        CPUINT16 const wIndex,
        CPDEVICEID * const pDevID);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_SectionListReply_GetSCSectionItem(
        CPUINT16 const wIndex,
        CPSMARTCONNECTSECTIONITEM * const pSectionItem);

    CLC_SDK_API CLC_ErrorCode LocalDevice_SCT_ControllerListReply_GetSCControllerItem(
        CPUINT16 const wIndex,
        CPSMARTCONNECTCONTROLLERITEM * const pControllerItem);


    CLC_SDK_API CLC_ErrorCode LocalDevice_Signal(
        CPHOBJECT const hLocalDevice,
        CPDEVICEID 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_SNAPSHOT)

    CLC_SDK_API CLC_ErrorCode LocalDevice_SetDisabledInternalSnapshot(
        CPHOBJECT const hLocalDevice,
        CPBOOLEAN const fDisabled,
        CPBOOLEAN const fAlsoForChildren);


    CLC_SDK_API CLC_ErrorCode LocalDevice_Reply_RequestCollectSnapshotData(
        CPHOBJECT const hLocalDevice,
        CPUINT16 const wRequestID,
        SnapshotBlockPriorities const priority,
        CPUINT32 const dwSnapshotContextData,
        CPUINT16 const wBlockSize,
        CPBOOLEAN const fLastBlock,
        CPBYTE const * const pBlockData);

    CLC_SDK_API CLC_ErrorCode LocalDevice_Reply_RequestRestoreSnapshotData(
        CPHOBJECT const hLocalDevice,
        CPUINT16 const wRequestID,
        Errors const returnCode,
        CPUINT32 const dwSnapshotContextData);

    CLC_SDK_API CLC_ErrorCode LocalDevice_Reply_InvalidRequest(
        CPHOBJECT const hLocalDevice, 
        CPUINT16 const wRequestID);

#endif // defined(ENABLE_SNAPSHOT)


#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_BASELOCALDEVICE_H_