Протокол¶

Оглавление¶

Сервис управления реле устройства

RelayService¶

Сервис управления реле устройства

Название метода	Описание	Тип запроса	Тип ответа
PostRelayClose	Метод закрытия реле. Закрытие реле принудительно без учета времени открытия. Отмена режима постоянного открытия	deviceapis.device.v1.PostRelayCloseRequest	deviceapis.device.v1.PostRelayCloseResponse
PostRelayOpen	Метод открытия реле	deviceapis.device.v1.PostRelayOpenRequest	deviceapis.device.v1.PostRelayOpenResponse
PostRelayOpenPermanently	Метод открытия реле без дальнейшего закрытия	deviceapis.device.v1.PostRelayOpenPermanentlyRequest	deviceapis.device.v1.PostRelayOpenPermanentlyResponse
EditRelayPropsOpen	Метод редактирования настроек открытия реле	deviceapis.device.v1.EditRelayPropsOpenRequest	deviceapis.device.v1.EditRelayPropsOpenResponse
GetRelayOpenList	Метод получения настроек открытия реле	deviceapis.device.v1.GetRelayOpenListRequest	deviceapis.device.v1.GetRelayOpenListResponse
EditRelayPropsDtmf	Метод редактирования настроек DTMF реле	deviceapis.device.v1.EditRelayPropsDtmfRequest	deviceapis.device.v1.EditRelayPropsDtmfResponse
GetRelayDtmfList	Метод получения настроек DTMF реле	deviceapis.device.v1.GetRelayDtmfListRequest	deviceapis.device.v1.GetRelayDtmfListResponse
GetRelayStatusList	Метод получения статусов реле устройства	deviceapis.device.v1.GetRelayStatusListRequest	deviceapis.device.v1.GetRelayStatusListResponse

EditRelayPropsDtmfRequest ¶

Запрос на установку настроек DTMF реле

Поле	Описание	Тип	Признак
data	Настройки DTMF реле	deviceapis.device.v1.RelayDtmf	REQUIRED
update_mask	Маска полей обновления	google.protobuf.FieldMask

EditRelayPropsDtmfResponse ¶

Ответ на запрос на установку настроек DTMF

Поле	Описание	Тип	Признак
error	Ошибка	optional deviceapis.device.v1.EditRelayPropsDtmfResponse.Error

EditRelayPropsDtmfResponse.Error ¶

Ошибка запроса на установку настроек DTMF

Поле	Описание	Тип	Признак
validation	Ошибка валидации	optional deviceapis.device.v1.ValidationError

EditRelayPropsOpenRequest ¶

Запрос редактирования настроек открытия реле

Поле	Описание	Тип	Признак
data	Настройки реле	deviceapis.device.v1.RelayOpen	REQUIRED
update_mask	Маска полей обновления	google.protobuf.FieldMask

EditRelayPropsOpenResponse ¶

Ответ на запрос на установку настроек открытия реле

Поле	Описание	Тип	Признак
error	Ошибка	optional deviceapis.device.v1.EditRelayPropsOpenResponse.Error

EditRelayPropsOpenResponse.Error ¶

Ошибка запроса на установку настроек открытия реле

Поле	Описание	Тип	Признак
validation	Ошибка валидации	optional deviceapis.device.v1.ValidationError

GetRelayDtmfListRequest ¶

Запрос получения настроек DTMF реле

GetRelayDtmfListResponse ¶

Ответ на запрос получения настроек DTMF реле

Поле	Описание	Тип	Признак
data	Настройки DTMF реле	repeated deviceapis.device.v1.RelayDtmf

GetRelayOpenListRequest ¶

Запрос получения настроек открытия реле

GetRelayOpenListResponse ¶

Ответ на запрос получения настроек открытия реле

Поле	Описание	Тип	Признак
data	Настройки открытия реле	repeated deviceapis.device.v1.RelayOpen

GetRelayStatusListRequest ¶

Запрос получения статусов реле устройства

GetRelayStatusListResponse ¶

Ответ на запрос получения статусов реле устройства

Поле	Описание	Тип	Признак
data	Список состояний реле	repeated deviceapis.device.v1.RelayState

PostRelayCloseRequest ¶

Запрос закрытия реле

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED

PostRelayCloseResponse ¶

Ответ на запрос закрытия реле

Поле	Описание	Тип	Признак
error	Ошибка	optional deviceapis.device.v1.PostRelayCloseResponse.Error

PostRelayCloseResponse.Error ¶

Ошибка запроса закрытия реле

Поле	Описание	Тип	Признак
validation	Ошибка валидации	optional deviceapis.device.v1.ValidationError

PostRelayOpenPermanentlyRequest ¶

Запрос открытия реле без дальнейшего закрытия

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED

PostRelayOpenPermanentlyResponse ¶

Ответ на запрос открытия реле без дальнейшего закрытия

Поле	Описание	Тип	Признак
error	Ошибка	optional deviceapis.device.v1.PostRelayOpenPermanentlyResponse.Error

PostRelayOpenPermanentlyResponse.Error ¶

Ошибка запроса открытия реле без дальнейшего закрытия

Поле	Описание	Тип	Признак
validation	Ошибка валидации	optional deviceapis.device.v1.ValidationError

PostRelayOpenRequest ¶

Запрос открытия реле

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED
current_open_time	Задержка в секундах. Если не передано, используется установленное значение времени открытия из настроек. Диапазон: 1..200	int32

PostRelayOpenResponse ¶

Ответ на запрос открытия реле

Поле	Описание	Тип	Признак
error	Ошибка	optional deviceapis.device.v1.PostRelayOpenResponse.Error

PostRelayOpenResponse.Error ¶

Ошибка запроса открытия реле

Поле	Описание	Тип	Признак
validation	Ошибка валидации	optional deviceapis.device.v1.ValidationError

RelayDtmf ¶

Настройки DTMF реле

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED
dtmf_code	DTMF код. Для разных реле допускается одинаковый DTMF код. Один символ из 0,1,2,3,4,5,6,7,8,9,*,#	string

RelayOpen ¶

Настройки открытия реле

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED
lock_type	Тип замка	deviceapis.device.v1.RelayOpen.LockType
open_time_general	Общее время открытия. Диапазон: 1..200	int32
open_time_emergency	Время открытия в секундах при экстренном оповещении. При 0 - до конца экстренного оповещения. Диапазон: 0..3600	int32

RelayState ¶

Состояние реле

Поле	Описание	Тип	Признак
relay_index	Индекс реле. Диапазон: 1..32767	int32	REQUIRED
state_type	Состояние	deviceapis.device.v1.RelayState.StateType

RelayOpen.LockType ¶

Тип замка

Номер	Тип	Название
0	LOCK_TYPE_UNKNOWN	Значение не указано
1	ELECTROMAGNETIC	Электромагнитный (state_operation)
2	ELECTROMECHANICAL	Электромеханический (pulse_operation)

RelayState.StateType ¶

Тип состояния

Номер	Тип	Название
0	STATE_TYPE_UNKNOWN	Значение не указано
1	OPEN_TEMPORARY	Открыто временно
2	CLOSED	Закрыто
3	OPEN_PERMANENT	Открыто на всегда

Скалярные типы значений¶

.proto Type	Примечание	Python	Go	Ruby	C#	C++	Java	PHP
double		float	float64	Float	double	double	double	float
float		float	float32	Float	float	float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long	int64	Bignum	long	int64	long	integer/string
uint32	Uses variable-length encoding.	int/long	uint32	Bignum or Fixnum (as required)	uint	uint32	int	integer
uint64	Uses variable-length encoding.	int/long	uint64	Bignum or Fixnum (as required)	ulong	uint64	long	integer/string
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long	int64	Bignum	long	int64	long	integer/string
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int	uint32	Bignum or Fixnum (as required)	uint	uint32	int	integer
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long	uint64	Bignum	ulong	uint64	long	integer/string
sfixed32	Always four bytes.	int	int32	Bignum or Fixnum (as required)	int	int32	int	integer
sfixed64	Always eight bytes.	int/long	int64	Bignum	long	int64	long	integer/string
bool		boolean	bool	TrueClass/FalseClass	bool	bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode	string	String (UTF-8)	string	string	String	string
bytes	May contain any arbitrary sequence of bytes.	str	[]byte	String (ASCII-8BIT)	ByteString	string	ByteString	string