CLC_Fct_RemoteDevice.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_RemoteDevice.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_REMOTEDEVICE_H_
#define _CLC_FCT_REMOTEDEVICE_H_

#ifdef __cplusplus
extern "C" {
#endif

#if defined(ENABLE_REMOTE_DEVICE)


CLC_SDK_API CLC_ErrorCode RemoteDevice_GetInfo(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPREMOTEDEVICEINFO * const pInfo);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetStatus(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPBOOLEAN * const pfIsValid);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GenericChange(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPCHAR8 const * const utf8CustomName, 
    CPUINT32 const dwDuplicateNumber, 
    DuplicateModes const duplicateMode, 
    CPUINT32 const dwGroups);


CLC_SDK_API CLC_ErrorCode RemoteDevice_GetName_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    DeviceNameFormats const format, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetProperty_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    DeviceProperties const propertyID, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);


CLC_SDK_API CLC_ErrorCode RemoteDevice_ClearAllDestinations(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPBOOLEAN const fRecursive);

CLC_SDK_API CLC_ErrorCode RemoteDevice_ClearDestinations(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetDestination_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID_or_ControllerID, 
    CPUINT16 const wDestinationIndex, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetDetailedDestination_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID_or_ControllerID, 
    CPUINT16 const wDestinationIndex, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_AddDestination(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID, 
    CPENDPOINT const * const pDestination);

CLC_SDK_API CLC_ErrorCode RemoteDevice_ChangeDestination(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID, 
    CPENDPOINT const * const pPrevDestination, 
    CPENDPOINT const * const pNewDestination);

CLC_SDK_API CLC_ErrorCode RemoteDevice_RemoveDestination(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID, 
    CPENDPOINT const * const pDestination);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetDestinationCount_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPUINT16 const wOutputID_or_ControllerID, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetConnectedDevices_Async( 
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPBOOLEAN const fIncludingSubDevices, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);



CLC_SDK_API CLC_ErrorCode RemoteDevice_GetInputInformation_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    CPUINT16 const wInputID, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetOutputInformation_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    CPUINT16 const wOutputID, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetControllerInfo_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    CPUINT16 const wControllerID, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetParameterInfo_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    CPSECTIONID const * const pSectionID,
    CPUINT16 const wFilterInputID, 
    CPPARAMETERID const * const pParamID,
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetModifierDataTypeInfo_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    ExplorationCommands const ec,
    CPPARAMETERID const * const pParamID,
    DataTypes const dataType, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetSelectorParameterValueText_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    CPHOOKEDOBJECT const hSelectorItemListID,
    CPUINT16 const wItemIndex,
    CPBOOLEAN const fRequestMultipleValues,
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_GetIndexListItem_Async(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPHOOKEDOBJECT const hIndexListID,
    CPUINT16 const wIndex,
    CPBOOLEAN const fRequestMultipleValues,
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);



CLC_SDK_API CLC_ErrorCode RemoteDevice_AssignController(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPUINT16 const wControllerID, 
    CPCONTROLLERASSIGNMENT const * const pControllerAssignment);


CLC_SDK_API CLC_ErrorCode RemoteDevice_ResetController(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPUINT16 const wControllerID);

CLC_SDK_API CLC_ErrorCode RemoteDevice_ResetAllControllers(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPBOOLEAN const fRecursive);



//                                      It will be downgraded through the network depending on transport/hardware capabilities, so the 
//                                      returned block might be smaller than this value.
CLC_SDK_API CLC_ErrorCode RemoteDevice_CollectSnapshotData_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    SnapshotTypes const snapshotType, 
    CPUINT32 const dwOffset, 
    CPUINT32 const dwContextData, 
    CPUINT16 const wMaxBlockSize, 
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);

CLC_SDK_API CLC_ErrorCode RemoteDevice_RestoreSnapshotData_Async(
    CPHOOKEDOBJECT const hRemoteDevice, 
    SnapshotTypes const snapshotType, 
    CPUINT32 const dwOffset,
    CPUINT32 const dwContextData,
    CPUINT16 const wBlockSize,
    CPBOOLEAN const fLastBlock,
    CPBYTE const * const pBlockData ,
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);


CLC_SDK_API CLC_ErrorCode RemoteDevice_Learn(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPBOOLEAN const fActivate,
    CPUINT16 const wControllerID);



CLC_SDK_API CLC_ErrorCode RemoteDevice_SmartConnectStart_Async(
    CPHOOKEDOBJECT const hRemoteDevice,
    CPUINT16 const wArraySize, 
    CPDEVICEID const * const arSourceDeviceIDs,
    CPUINT32 const dwClientContextData, 
    CPHASYNC * const phAsync);



#endif // defined(ENABLE_REMOTE_DEVICE)

#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_REMOTEDEVICE_H_