IControlSystemHelper.h

Go to the documentation of this file.

 
#ifndef ZRC_ICONTROLSYSTEMHELPER_H
#define ZRC_ICONTROLSYSTEMHELPER_H
 
#include "ZRCSDKTypes.h"
 
NS_ZRCSDK_BEG
 
enum ControlSystemDeviceStatus
{
    ControlSystemDeviceStatusDisconnected = 0,  
    ControlSystemDeviceStatusConnecting,        
    ControlSystemDeviceStatusConnected          
};
 
enum ControlSystemDeviceMethodType
{
    ControlSystemDeviceMethodTypeNone = 0,      
    ControlSystemDeviceMethodTypeInit,          
    ControlSystemDeviceMethodTypeAction,        
    ControlSystemDeviceMethodTypeActions,       
    ControlSystemDeviceMethodTypeRange          
};
 
enum ControlSystemErrorCode
{
    ControlSystemErrorCodeUnknown = -1,         
    ControlSystemErrorCodeSuccess,              
    ControlSystemErrorCodeNoConfig,             
    ControlSystemErrorCodeJsonSyntax,           
    ControlSystemErrorCodeJsonConfig,           
    ControlSystemErrorCodeIP,                   
    ControlSystemErrorCodeIPIsPublic,           
    ControlSystemErrorCodeDeviceID,             
    ControlSystemErrorCodeMethodID,             
    ControlSystemErrorCodeParamID,              
    ControlSystemErrorCodeIP2SLSettings,        
    ControlSystemErrorCodeEmptyDevice           
};
 
enum ControlSystemUpdateDeviceType
{
    ControlSystemUpdateDeviceTypeInit = 0,      
    ControlSystemUpdateDeviceTypeAdd = 1,       
    ControlSystemUpdateDeviceTypeUpdate = 2     
};
 
struct ControlSystemDeviceParam
{
    std::string paramID;        
    std::string name;           
    std::string icon;           
    std::string value;          
};
 
struct ControlSystemDeviceMethod
{
    std::string                           methodID;         
    std::string                           name;             
    std::string                           icon;             
    std::string                           command;          
    ControlSystemDeviceMethodType         type = ControlSystemDeviceMethodTypeNone; 
    std::vector<ControlSystemDeviceParam> params;           
    bool                                  isMain = false;   
    bool                                  isHidden = false; 
};
 
struct ControlSystemDeviceInfo
{
    std::string                               deviceID;     
    std::string                               name;         
    std::string                               icon;         
    ControlSystemDeviceStatus                 status = ControlSystemDeviceStatusDisconnected;   
    std::vector<ControlSystemDeviceMethod>    methods;      
};
 
struct ControlSystemDeviceList
{
    ControlSystemErrorCode               errorCode = ControlSystemErrorCodeUnknown; 
    std::vector<ControlSystemDeviceInfo> devices;           
};
 
struct ControlSystemSceneInfo
{
    std::string sceneID;    
    std::string name;       
    std::string icon;       
};
 
class IControlSystemHelperSink
{
public:
    virtual ~IControlSystemHelperSink() {}
 
    virtual void OnEnableZRCSNotification(bool enable) = 0;
 
    virtual void OnUpdateZRCSDeviceList(ControlSystemUpdateDeviceType type, const ControlSystemDeviceList& list) = 0;
 
    virtual void OnUpdateZRCSSceneList(const std::vector<ControlSystemSceneInfo>& scenes) = 0;
};
 
class IControlSystemHelper
{
public:
    virtual ~IControlSystemHelper() {}
 
    virtual ZRCSDKError RegisterSink(IControlSystemHelperSink* pSink) = 0;
 
    virtual ZRCSDKError DeregisterSink(IControlSystemHelperSink* pSink) = 0;
 
    virtual ZRCSDKError IsZRCSEnabled(bool& enabled) = 0;
 
    virtual ZRCSDKError OpenRoomControls(bool open) = 0;
 
    virtual ZRCSDKError GetZRCSDeviceList(ControlSystemDeviceList& deviceList) = 0;
 
    virtual ZRCSDKError ConnectZRCSDevice(const std::string& deviceID) = 0;
 
    virtual ZRCSDKError ControlZRCSDevice(const std::string& deviceID, const std::string& methodID, const std::string& paramID, const std::string& value) = 0;
 
    virtual ZRCSDKError GetZRCSSceneList(std::vector<ControlSystemSceneInfo>& scenes) = 0;
 
    virtual ZRCSDKError ExecuteZRCSScene(const std::string& sceneID) = 0;
};
 
NS_ZRCSDK_END
 
#endif //ZRC_ICONTROLSYSTEMHELPER_H