IControlSystemHelper.h File Reference

Room control system interfaces. More...

#include "ZRCSDKTypes.h"

Go to the source code of this file.

Data Structures
struct	ControlSystemDeviceParam
	Control system device param. More...
struct	ControlSystemDeviceMethod
	Control system device method. More...
struct	ControlSystemDeviceInfo
	Control system device info. More...
struct	ControlSystemDeviceList
	Control system device list. More...
struct	ControlSystemSceneInfo
	Control system scene info. More...
class	IControlSystemHelperSink
	Control System helper event callback. More...
class	IControlSystemHelper
	Control System helper interface. More...

Enumerations
enum	ControlSystemDeviceStatus { ControlSystemDeviceStatusDisconnected = 0 , ControlSystemDeviceStatusConnecting , ControlSystemDeviceStatusConnected }
	Control system device status Here are more detailed structural descriptions. More...
enum	ControlSystemDeviceMethodType {   ControlSystemDeviceMethodTypeNone = 0 , ControlSystemDeviceMethodTypeInit , ControlSystemDeviceMethodTypeAction , ControlSystemDeviceMethodTypeActions ,   ControlSystemDeviceMethodTypeRange }
	Control system device method type Here are more detailed structural descriptions. More...
enum	ControlSystemErrorCode {   ControlSystemErrorCodeUnknown = -1 , ControlSystemErrorCodeSuccess , ControlSystemErrorCodeNoConfig , ControlSystemErrorCodeJsonSyntax ,   ControlSystemErrorCodeJsonConfig , ControlSystemErrorCodeIP , ControlSystemErrorCodeIPIsPublic , ControlSystemErrorCodeDeviceID ,   ControlSystemErrorCodeMethodID , ControlSystemErrorCodeParamID , ControlSystemErrorCodeIP2SLSettings , ControlSystemErrorCodeEmptyDevice }
	Control system error code Here are more detailed structural descriptions. More...
enum	ControlSystemUpdateDeviceType { ControlSystemUpdateDeviceTypeInit = 0 , ControlSystemUpdateDeviceTypeAdd = 1 , ControlSystemUpdateDeviceTypeUpdate = 2 }
	Control system update device type Here are more detailed structural descriptions. More...

Detailed Description

Room control system interfaces.

Since

Added in ZRC SDK 6.0.0

Definition in file IControlSystemHelper.h.

Enumeration Type Documentation

ControlSystemDeviceMethodType

enum ControlSystemDeviceMethodType

Control system device method type Here are more detailed structural descriptions.

Enumerator
ControlSystemDeviceMethodTypeNone	None.
ControlSystemDeviceMethodTypeInit	Init.
ControlSystemDeviceMethodTypeAction	Action.
ControlSystemDeviceMethodTypeActions	Actions.
ControlSystemDeviceMethodTypeRange	Range.

Definition at line 28 of file IControlSystemHelper.h.

{
    ControlSystemDeviceMethodTypeNone = 0,      
    ControlSystemDeviceMethodTypeInit,          
    ControlSystemDeviceMethodTypeAction,        
    ControlSystemDeviceMethodTypeActions,       
    ControlSystemDeviceMethodTypeRange          
};

ControlSystemDeviceStatus

enum ControlSystemDeviceStatus

Control system device status Here are more detailed structural descriptions.

Enumerator
ControlSystemDeviceStatusDisconnected	Disconnected.
ControlSystemDeviceStatusConnecting	Connecting.
ControlSystemDeviceStatusConnected	Connected.

Definition at line 17 of file IControlSystemHelper.h.

{
    ControlSystemDeviceStatusDisconnected = 0,  
    ControlSystemDeviceStatusConnecting,        
    ControlSystemDeviceStatusConnected          
};

ControlSystemErrorCode

enum ControlSystemErrorCode

Control system error code Here are more detailed structural descriptions.

Enumerator
ControlSystemErrorCodeUnknown	Unknown.
ControlSystemErrorCodeSuccess	Success.
ControlSystemErrorCodeNoConfig	No Config error.
ControlSystemErrorCodeJsonSyntax	Json syntax error.
ControlSystemErrorCodeJsonConfig	Json config error.
ControlSystemErrorCodeIP	IP error.
ControlSystemErrorCodeIPIsPublic	IP is public.
ControlSystemErrorCodeDeviceID	Device ID error.
ControlSystemErrorCodeMethodID	Method ID error.
ControlSystemErrorCodeParamID	Param ID error.
ControlSystemErrorCodeIP2SLSettings	IP2SL settings error.
ControlSystemErrorCodeEmptyDevice	Empty device.

Definition at line 41 of file IControlSystemHelper.h.

{
    ControlSystemErrorCodeUnknown = -1,         
    ControlSystemErrorCodeSuccess,              
    ControlSystemErrorCodeNoConfig,             
    ControlSystemErrorCodeJsonSyntax,           
    ControlSystemErrorCodeJsonConfig,           
    ControlSystemErrorCodeIP,                   
    ControlSystemErrorCodeIPIsPublic,           
    ControlSystemErrorCodeDeviceID,             
    ControlSystemErrorCodeMethodID,             
    ControlSystemErrorCodeParamID,              
    ControlSystemErrorCodeIP2SLSettings,        
    ControlSystemErrorCodeEmptyDevice           
};

ControlSystemUpdateDeviceType

enum ControlSystemUpdateDeviceType

Control system update device type Here are more detailed structural descriptions.

Enumerator
ControlSystemUpdateDeviceTypeInit	Init.
ControlSystemUpdateDeviceTypeAdd	Add.
ControlSystemUpdateDeviceTypeUpdate	Update.

Definition at line 61 of file IControlSystemHelper.h.

{
    ControlSystemUpdateDeviceTypeInit = 0,      
    ControlSystemUpdateDeviceTypeAdd = 1,       
    ControlSystemUpdateDeviceTypeUpdate = 2     
};