Протокол¶
Оглавление¶
-
keyapis/telemetry_control/v1/keyapis_telemetry_control_device_v1.proto
- DeleteDeviceIndicatorResponse
- DeleteDeviceRequest
- DeleteDeviceResponse
- Device
- Device.MetricPoint
- Device.ValidationError
- DeviceFilter
- DeviceFilter.ValidationError
- DeviceGroup
- DeviceGroupFilter
- DeviceGroupPaging
- DeviceIndicatorMetricPoint
- DeviceIndicatorMetricPointFilter
- DeviceIndicatorMetricPointPaging
- DevicePaging
- DevicePaging.ValidationError
- DevicePaging.ValidationError.LimitInvalid
- DevicePaging.ValidationError.OffsetInvalid
- GetDeviceCountRequest
- GetDeviceCountResponse
- GetDeviceCountResponse.Error
- GetDeviceGroupCountRequest
- GetDeviceGroupCountResponse
- GetDeviceGroupListRequest
- GetDeviceGroupListResponse
- GetDeviceIndicatorCountRequest
- GetDeviceIndicatorCountResponse
- GetDeviceIndicatorCountResponse.Error
- GetDeviceIndicatorListRequest
- GetDeviceIndicatorListResponse
- GetDeviceIndicatorListResponse.Error
- GetDeviceIndicatorMetricPointCountRequest
- GetDeviceIndicatorMetricPointCountResponse
- GetDeviceIndicatorMetricPointListRequest
- GetDeviceIndicatorMetricPointListResponse
- GetDeviceIndicatorRequest
- GetDeviceIndicatorResponse
- GetDeviceListRequest
- GetDeviceListResponse
- GetDeviceListResponse.Error
- GetDeviceRequest
- GetDeviceResponse
- Indicator
- Indicator.ValidationError
- IndicatorFilter
- IndicatorFilter.ValidationError
- IndicatorPaging
- IndicatorPaging.ValidationError
- IndicatorPaging.ValidationError.LimitInvalid
- IndicatorPaging.ValidationError.OffsetInvalid
- PostDeviceFullDuplexRequest
- PostDeviceFullDuplexRequest.DeviceAsyncStatus
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.IpError
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.NetworkAddressError
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.PortError
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.UnknownError
- PostDeviceFullDuplexRequest.DeviceAsyncStatus.Success
- PostDeviceFullDuplexResponse
- PostDeviceIndicatorRequest
- PostDeviceIndicatorResponse
- PostDeviceIndicatorResponse.Error
- PostDeviceReplaceRequest
- PostDeviceReplaceResponse
- PostDeviceReplaceResponse.Error
- PostDeviceReplaceResponse.Error.CreateIndicatorsFail
- PostDeviceReplaceResponse.Error.MetricPointNotFound
- PostDeviceReplaceResponse.Error.MultiLinkedMetricPoint
- PostDeviceReplaceResponse.Error.ReplaceDeviceNotFound
- PostDeviceReplaceResponse.Error.WrongBuilding
- PostDeviceRequest
- PostDeviceResponse
- PostDeviceResponse.Error
- PutDeviceGroupAttachRequest
- PutDeviceGroupAttachResponse
- PutDeviceGroupDetachRequest
- PutDeviceGroupDetachResponse
- PutDeviceIndicatorMetricPointAttachRequest
- PutDeviceIndicatorMetricPointAttachResponse
- PutDeviceIndicatorMetricPointDetachRequest
- Device.MetricPoint.MetricType
- Device.MetricPoint.PrimaryCurrentType
- Device.MetricPoint.StatusType
- Device.PipeType
- Device.PlanType
- Device.SecondaryCurrentType
- Device.StatusType
- Device.Type
- DeviceGroupPaging.DirectionType
- DeviceGroupPaging.OrderByType
- DeviceIndicatorMetricPointPaging.DirectionType
- DeviceIndicatorMetricPointPaging.OrderByType
- DevicePaging.DirectionType
- DevicePaging.OrderByType
- Indicator.ArchiveType
- Indicator.SignType
- Indicator.UnitType
- Indicator.VendorType
- IndicatorPaging.DirectionType
- IndicatorPaging.OrderByType
Схема классов¶
keyapis/telemetry_control/v1/keyapis_telemetry_control_device_v1.proto¶
Сервис реализует функционал управления приборами учёта(ПУ)
DeviceService¶
Сервис приборов учёта (ПУ). Авторизация: - Authorization: Bearer token. - X-Api-Key: apiKey
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| PostDeviceFullDuplex | Полнодуплексный метод отправки команд на сервер и получения изменения со стороны сервера. Разрешения: telemetry_control:device:list, telemetry_control:device:list:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. При наличии разрешений. Метод доступен для: ApiKey: Без учета разрешений | keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest stream | keyapis.telemetry_control.v1.PostDeviceFullDuplexResponse stream |
| GetDevice | Метод получения ПУ. Разрешения: telemetry_control:device:card, telemetry_control:device:card:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee, master. При наличии разрешений. Метод доступен для: ApiKey: При наличии разрешений | keyapis.telemetry_control.v1.GetDeviceRequest | keyapis.telemetry_control.v1.GetDeviceResponse |
| GetDeviceList | Метод получения списка приборов учета. Разрешения: telemetry_control:device:list, telemetry_control:device:list:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee, master. При наличии разрешений. Метод доступен для: ApiKey: При наличии разрешений | keyapis.telemetry_control.v1.GetDeviceListRequest | keyapis.telemetry_control.v1.GetDeviceListResponse stream |
| GetDeviceCount | Метод получения количества приборов учета. Разрешения: telemetry_control:device:list, telemetry_control:device:list:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee, master. При наличии разрешений. Метод доступен для: ApiKey: При наличии разрешений | keyapis.telemetry_control.v1.GetDeviceCountRequest | keyapis.telemetry_control.v1.GetDeviceCountResponse |
| PostDeviceReplace | Метод замены прибора учета. Создает ПУ и привязывает его индикаторы к ТУ исходного ПУ. Разрешения: telemetry_control:device:save, telemetry_control:device:save:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. При наличии разрешений | keyapis.telemetry_control.v1.PostDeviceReplaceRequest | keyapis.telemetry_control.v1.PostDeviceReplaceResponse |
| PostDevice | Метод сохранения прибора учета. Поддерживает создание и обновление. Разрешения: telemetry_control:device:save, telemetry_control:device:save:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. При наличии разрешений | keyapis.telemetry_control.v1.PostDeviceRequest | keyapis.telemetry_control.v1.PostDeviceResponse |
| DeleteDevice | Метод удаления прибора учета. Разрешения: telemetry_control:device:remove, telemetry_control:device:remove:own. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. При наличии разрешений | keyapis.telemetry_control.v1.DeleteDeviceRequest | keyapis.telemetry_control.v1.DeleteDeviceResponse |
| PostDeviceIndicator | Метод сохранения индикатора. Поддерживает создание и обновление. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.PostDeviceIndicatorRequest | keyapis.telemetry_control.v1.PostDeviceIndicatorResponse |
| GetDeviceIndicator | Метод получения индикатора. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceIndicatorRequest | keyapis.telemetry_control.v1.GetDeviceIndicatorResponse |
| GetDeviceIndicatorList | Метод получения списка индикаторов. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceIndicatorListRequest | keyapis.telemetry_control.v1.GetDeviceIndicatorListResponse stream |
| GetDeviceIndicatorCount | Метод получения количества индикаторов. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceIndicatorCountRequest | keyapis.telemetry_control.v1.GetDeviceIndicatorCountResponse |
| DeleteDeviceIndicator | Метод удаления индикаторa. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.DeleteDeviceIndicatorRequest | keyapis.telemetry_control.v1.DeleteDeviceIndicatorResponse |
| GetDeviceIndicatorMetricPointList | Метод получения списка связей индикаторов и ТУ. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceIndicatorMetricPointListRequest | keyapis.telemetry_control.v1.GetDeviceIndicatorMetricPointListResponse stream |
| GetDeviceIndicatorMetricPointCount | Метод получения количества связей индикаторов и ТУ. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceIndicatorMetricPointCountRequest | keyapis.telemetry_control.v1.GetDeviceIndicatorMetricPointCountResponse |
| PutDeviceIndicatorMetricPointAttach | Метод сохранения связи индикаторов и ТУ. Поддерживает только создание связи. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.PutDeviceIndicatorMetricPointAttachRequest | keyapis.telemetry_control.v1.PutDeviceIndicatorMetricPointAttachResponse |
| PutDeviceIndicatorMetricPointDetach | Метод удаления связи индикаторов и ТУ. Метод доступен для: Token: admin, service, bti, seller, application, owner, employee. Без учета разрешений | keyapis.telemetry_control.v1.PutDeviceIndicatorMetricPointDetachRequest | keyapis.telemetry_control.v1.PutDeviceIndicatorMetricPointDetachResponse |
| GetDeviceGroupList | Метод получения списка связей ПУ и группы пользователя. Метод доступен для: Token: admin, service, bti, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceGroupListRequest | keyapis.telemetry_control.v1.GetDeviceGroupListResponse stream |
| GetDeviceGroupCount | Метод получения количества связей ПУ и группы пользователя. Метод доступен для: Token: admin, service, bti, seller. Без учета разрешений | keyapis.telemetry_control.v1.GetDeviceGroupCountRequest | keyapis.telemetry_control.v1.GetDeviceGroupCountResponse |
| PutDeviceGroupAttach | Метод сохранения связей ПУ и группы пользователя. Поддерживает только создание. Метод доступен для: Token: admin, service, bti, seller. Без учета разрешений | keyapis.telemetry_control.v1.PutDeviceGroupAttachRequest | keyapis.telemetry_control.v1.PutDeviceGroupAttachResponse |
| PutDeviceGroupDetach | Метод удаления связей ПУ и группы пользователя. Метод доступен для: Token: admin, service, bti, seller. Без учета разрешений | keyapis.telemetry_control.v1.PutDeviceGroupDetachRequest | keyapis.telemetry_control.v1.PutDeviceGroupDetachResponse |
DeleteDeviceIndicatorRequest¶
Запрос удаления индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | REQUIRED |
DeleteDeviceIndicatorResponse¶
Ответ на запрос удаления индикатора
DeleteDeviceRequest¶
Запрос удаления прибора учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | REQUIRED |
DeleteDeviceResponse¶
Ответ на запрос удаления прибора учета
Device¶
Прибор учёта
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | |
| indicators | Индикаторы | repeated keyapis.telemetry_control.v1.Indicator | OUTPUT_ONLY |
| metric_point | Deprecated. Точка учета | keyapis.telemetry_control.v1.Device.MetricPoint | |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта | google.protobuf.Timestamp | OUTPUT_ONLY |
| type | Тип прибора учёта(ПУ) | keyapis.telemetry_control.v1.Device.Type | REQUIRED |
| serial_number | Серийный номер | string | REQUIRED |
| model | Производитель и модель счетчика | string | REQUIRED |
| year | Deprecated. Год выпуска счётчика | int32 | REQUIRED |
| fias_id | Deprecated. Идентификатор строения ФИАС | string | REQUIRED |
| resource_owner_id | Deprecated. Идентификатор владельца. Заполняется сервером | string | OUTPUT_ONLY |
| status_type | Тип статуса | keyapis.telemetry_control.v1.Device.StatusType | |
| installed_at | Дата установки | google.protobuf.Timestamp | |
| removed_at | Дата удаления | google.protobuf.Timestamp | |
| check_at | Дата предыдущей поверки счетчика | google.protobuf.Timestamp | |
| next_check_at | Дата следующей поверки счетчика | google.protobuf.Timestamp | |
| external_id | Внешний дентификатор прибора учёта(ПУ) | google.protobuf.StringValue | |
| plan_type | Тип тарифного плана | keyapis.telemetry_control.v1.Device.PlanType | |
| parent_id | Идентификатор хаба | google.protobuf.Int32Value | |
| pipe_type | Тип трубопровода | keyapis.telemetry_control.v1.Device.PipeType | |
| dev_eui | Идентификатор модуля LoraWan | google.protobuf.StringValue | |
| mac | MAC-адрес | google.protobuf.StringValue | |
| port | Номер порта | google.protobuf.Int32Value | |
| network_address | Сетевой адрес | google.protobuf.StringValue | |
| comm_channel | Канал связи. Для станции LoraWan | google.protobuf.StringValue | |
| sim_number | MSISDN SIM-карты. Номер телефона | google.protobuf.StringValue | |
| sim_serial | Серийный номер SIM-карты | google.protobuf.StringValue | |
| ip_address_sim | IP адрес SIM-карты | google.protobuf.StringValue | |
| placement | Размещение | google.protobuf.StringValue | |
| installation_place | Место установки | google.protobuf.StringValue | |
| appkey | Deprecated. Kлюч приложения. Используется в процессе присоединения к сети для получения сессионных ключей NwkSKey и AppSKey для LoRaWAN [128 бит] | google.protobuf.StringValue | |
| appeui | Deprecated. Идентификатор приложения. Для LoRaWAN [64 бита] | google.protobuf.StringValue | |
| protocol_type_label | Тип протокола | google.protobuf.StringValue | |
| channel_number | Deprecated. Номер канала для многоканального ПУ | google.protobuf.Int32Value | |
| wire_interface | Тип проводного интерфейса | google.protobuf.StringValue | |
| building_id | Идентификатор объекта строительства | int32 | |
| manufacture_year | Год выпуска счётчика | google.protobuf.Int32Value | |
| indicator_vendor_type | Посредник получения показаний | keyapis.telemetry_control.v1.Indicator.VendorType |
Device.MetricPoint¶
Точка учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | string | |
| metric_type | Тип энергоресурса | keyapis.telemetry_control.v1.Device.MetricPoint.MetricType | REQUIRED |
| room_number | Номер помещения | string | REQUIRED |
| room_label | Лейбл помещения | string | REQUIRED |
| zone_label | Зона | google.protobuf.StringValue | |
| status_type | Тип статуса | keyapis.telemetry_control.v1.Device.MetricPoint.StatusType | REQUIRED |
| accounting_type | Тип учёта | keyapis.telemetry_control.v1.Device.MetricPoint.AccountingType | REQUIRED |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| primary_current_type | Тип номинала первичного тока | keyapis.telemetry_control.v1.Device.MetricPoint.PrimaryCurrentType | |
| secondary_current_type | Тип номинала вторичной обмотки | keyapis.telemetry_control.v1.Device.SecondaryCurrentType | |
| building_id | Идентификатор объекта строительства | int32 | REQUIRED |
| changed_at | Дата изменения | google.protobuf.Timestamp | OUTPUT_ONLY |
| building_level | Уровень | int32 | |
| building_section | Секция | int32 |
Device.ValidationError¶
Ошибки валидации. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования protobuf | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
DeviceFilter¶
Фильтр для запроса приборов учета. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| fias_ids | По ФИАС | repeated string | |
| types | По типам приборов учета | repeated keyapis.telemetry_control.v1.Device.Type | |
| status_types | По типам статусов | repeated keyapis.telemetry_control.v1.Device.StatusType | |
| models | По модели счетчика | repeated string | |
| metric_point_metric_types | По типам метрик | repeated keyapis.telemetry_control.v1.Device.MetricPoint.MetricType | |
| room_numbers | По номерам помещений точек учета, привязанных через индикаторы | repeated string | |
| room_labels | По лейблам помещений точек учета, привязанных через индикаторы | repeated string | |
| parent_ids | По идентификаторам хабов | repeated int32 | |
| ids | Deprecated. По идентификаторам приборов учета. Устарело, использовать метод GetDevice | repeated int32 | |
| building_ids | По идентификатору объекта строительства | repeated int32 | |
| serial_numbers | По серийным номерам | repeated string | |
| metric_point_ids | По ID точек учета, привязанных через индикаторы | repeated string | |
| serial_ids | Смешанный поиск по полям serial_number, dev_eui, MAC-адрес, model, external_id | repeated string | |
| orpons | По ОРПОНам | repeated int64 | |
| indicator_vendor_types | По посреднику получения показаний | repeated keyapis.telemetry_control.v1.Indicator.VendorType |
DeviceFilter.ValidationError¶
Ошибки валидации. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования protobuf | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
DeviceGroup¶
Связка ПУ и группы пользователя. Задает область ресурсов (resource scope), доступную пользователю. Используется для контроля доступа к ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| group_id | Идентификатор группы. # Тип: Guid | string | REQUIRED |
| device_id | Идентификатор ПУ. # Диапазон: 0..2147483647 | int32 | REQUIRED |
DeviceGroupFilter¶
Фильтр для запроса связей ПУ и группы пользователя. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| group_ids | По Идентификатору группы пользователя | repeated string | |
| device_ids | По ПУ | repeated int32 |
DeviceGroupPaging¶
Пагинация связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: GROUP_ID | keyapis.telemetry_control.v1.DeviceGroupPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_control.v1.DeviceGroupPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
DeviceIndicatorMetricPoint¶
Связка индикатора и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| indicator_id | Идентификатор индикатора. # Диапазон: 0..2147483647 | int32 | REQUIRED |
| metric_point_id | Идентификатору ТУ. # Тип: Guid | string | REQUIRED |
DeviceIndicatorMetricPointFilter¶
Фильтр для запроса индикаторов и ТУ. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| indicator_id | По Идентификатору индикатора | repeated int32 | |
| metric_point_id | По Идентификатору ТУ | repeated string |
DeviceIndicatorMetricPointPaging¶
Пагинация связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: ID | keyapis.telemetry_control.v1.DeviceIndicatorMetricPointPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_control.v1.DeviceIndicatorMetricPointPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
DevicePaging¶
Пагинация устройств
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: ID | keyapis.telemetry_control.v1.DevicePaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_control.v1.DevicePaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
DevicePaging.ValidationError¶
Ошибка валидации постраничной пагинации по ПУ. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| limit | Количество передано некорректно | optional keyapis.telemetry_control.v1.DevicePaging.ValidationError.LimitInvalid | |
| offset | Сдвиг передан некорректно | optional keyapis.telemetry_control.v1.DevicePaging.ValidationError.OffsetInvalid |
DevicePaging.ValidationError.LimitInvalid¶
Причины: - Значение количества < 0 или > 100
DevicePaging.ValidationError.OffsetInvalid¶
Причины: - Значение сдвига < 0
GetDeviceCountRequest¶
Запрос получения количества устройств
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр по устройствам | keyapis.telemetry_control.v1.DeviceFilter |
GetDeviceCountResponse¶
Ответ на запрос получения количества устройств
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего устройств | optional int32 | |
| error | Ошибка | optional keyapis.telemetry_control.v1.GetDeviceCountResponse.Error |
GetDeviceCountResponse.Error¶
Ошибка запроса получения количества устройств
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_filter_validation | Ошибка фильтрации | optional keyapis.telemetry_control.v1.DeviceFilter.ValidationError |
GetDeviceGroupCountRequest¶
Запрос получения количества связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей ПУ и группы пользователя | keyapis.telemetry_control.v1.DeviceGroupFilter |
GetDeviceGroupCountResponse¶
Ответ на запрос получения количества связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего связей ПУ и группы пользователя | optional int32 |
GetDeviceGroupListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей ПУ и группы пользователя | keyapis.telemetry_control.v1.DeviceGroupFilter | |
| paging | Пагинация | optional keyapis.telemetry_control.v1.DeviceGroupPaging |
GetDeviceGroupListResponse¶
Ответ на запрос получения списка связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Связь ПУ и группы пользователя | optional keyapis.telemetry_control.v1.DeviceGroup |
GetDeviceIndicatorCountRequest¶
Запрос получения количества индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр по индикаторам | keyapis.telemetry_control.v1.IndicatorFilter |
GetDeviceIndicatorCountResponse¶
Ответ на запрос получения количества индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего индикаторов | optional int32 | |
| error | Ошибка | optional keyapis.telemetry_control.v1.GetDeviceIndicatorCountResponse.Error |
GetDeviceIndicatorCountResponse.Error¶
Ошибка запроса получения количества индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_filter_validation | Ошибка фильтрации | optional keyapis.telemetry_control.v1.IndicatorFilter.ValidationError |
GetDeviceIndicatorListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр индикаторов | keyapis.telemetry_control.v1.IndicatorFilter | |
| paging | Пагинация по индикаторам | optional keyapis.telemetry_control.v1.IndicatorPaging |
GetDeviceIndicatorListResponse¶
Ответ на запрос получения списка индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Индикатор | optional keyapis.telemetry_control.v1.Indicator | |
| error | Ошибка | optional keyapis.telemetry_control.v1.GetDeviceIndicatorListResponse.Error |
GetDeviceIndicatorListResponse.Error¶
Ошибка запроса получения списка индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_filter_validation | Ошибка фильтрации | optional keyapis.telemetry_control.v1.IndicatorFilter.ValidationError | |
| device_paging_validation | Ошибка пагинации по страницам | optional keyapis.telemetry_control.v1.IndicatorPaging.ValidationError |
GetDeviceIndicatorMetricPointCountRequest¶
Запрос получения количества связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей индикаторов и ТУ | keyapis.telemetry_control.v1.DeviceIndicatorMetricPointFilter |
GetDeviceIndicatorMetricPointCountResponse¶
Ответ на запрос получения количества связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Всего связей индикаторов и ТУ | optional int32 |
GetDeviceIndicatorMetricPointListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр связей индикаторов и ТУ | keyapis.telemetry_control.v1.DeviceIndicatorMetricPointFilter | |
| paging | Пагинация | optional keyapis.telemetry_control.v1.DeviceIndicatorMetricPointPaging |
GetDeviceIndicatorMetricPointListResponse¶
Ответ на запрос получения списка связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Связь индикатора и ТУ | optional keyapis.telemetry_control.v1.DeviceIndicatorMetricPoint |
GetDeviceIndicatorRequest¶
Запрос получения индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор индикатора | int32 | REQUIRED |
GetDeviceIndicatorResponse¶
Ответ на запрос получения индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Индикатор | optional keyapis.telemetry_control.v1.Indicator |
GetDeviceListRequest¶
Запрос получения списка
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| filter | Фильтр | keyapis.telemetry_control.v1.DeviceFilter | |
| paging | Пагинация | optional keyapis.telemetry_control.v1.DevicePaging |
GetDeviceListResponse¶
Ответ на запрос получения списка приборов учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Прибор учета | optional keyapis.telemetry_control.v1.Device | |
| error | Ошибка | optional keyapis.telemetry_control.v1.GetDeviceListResponse.Error |
GetDeviceListResponse.Error¶
Ошибка запроса получения списка приборов учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_filter_validation | Ошибка фильтрации | optional keyapis.telemetry_control.v1.DeviceFilter.ValidationError | |
| device_paging_validation | Ошибка пагинации по страницам | optional keyapis.telemetry_control.v1.DevicePaging.ValidationError |
GetDeviceRequest¶
Запрос получения ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор ПУ | int32 | REQUIRED |
GetDeviceResponse¶
Ответ на запрос получения ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Прибор учета | optional keyapis.telemetry_control.v1.Device |
Indicator¶
Индикатор
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| id | Идентификатор | int32 | |
| device_id | Идентификатор прибора учета(ПУ) | int32 | REQUIRED |
| title | Название | string | REQUIRED |
| unit_type | Тип единицы измерения, в которой интерпретировано, получаемое измерение | keyapis.telemetry_control.v1.Indicator.UnitType | REQUIRED |
| sign_type | Тип измерения | keyapis.telemetry_control.v1.Indicator.SignType | REQUIRED |
| created_at | Дата создания | google.protobuf.Timestamp | OUTPUT_ONLY |
| changed_at | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта | google.protobuf.Timestamp | OUTPUT_ONLY |
| is_individual | Флаг видимости индикатора для клиента | bool | |
| compatibility_code | Код для совместимости с поставщиком метрик | google.protobuf.StringValue | |
| archive_type | Тип архивности показаний | keyapis.telemetry_control.v1.Indicator.ArchiveType | |
| presentation_unit_type | Тип единицы измерения для отображения измерения. При UNIT_TYPE_UNKNOWN отображаемые единицы совпадают с единицами источников значений, преобразования единиц не происходит. Применяется после коэффициента | keyapis.telemetry_control.v1.Indicator.UnitType | |
| coefficient | Коэффициент, на который умножается отображаемое значение. Применяется перед преобразованием единиц измерений к presentation_unit_type и после применения поправки | google.protobuf.FloatValue | |
| shift | Величина поправки к отображаемому значению. Применяется перед применением коэффициента | google.protobuf.FloatValue | |
| round_decimal_digits | Количество возвращаемых десятичных знаков при округлении итогового значения. При пустом параметре округления не происходит. Применяется после преобразования единиц измерения | google.protobuf.Int32Value | |
| metric_expected_freq | Ожидаемая частота поступления показаний в днях | int32 | |
| channel_number | Номер канала для многоканального ПУ | google.protobuf.StringValue | |
| channel_order | Порядковый номер канала для многоканального ПУ | google.protobuf.Int32Value | |
| vendor_type | Посредник получения показаний | keyapis.telemetry_control.v1.Indicator.VendorType |
Indicator.ValidationError¶
Ошибки валидации. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования protobuf | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
IndicatorFilter¶
Фильтр для запроса индикаторов. При передаче массива в параметр фильтра элементы массива работают в выборке через ИЛИ. При передаче нескольких разных параметров фильтра они работают в выборке через И
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_ids | По списку приборов учета | repeated int32 | |
| sign_types | По типам измерений | repeated keyapis.telemetry_control.v1.Indicator.SignType | |
| ids | Deprecated. По списку ключей индикаторов. Устарело, использовать метод GetDeviceIndicator | repeated int32 | |
| device_serial_numbers | По серийным номерам привязанных ПУ | repeated string | |
| building_ids | По идентификаторам объектов строительства, привязанных ТУ | repeated int32 | |
| room_numbers | По Номерам помещений, привязанных ТУ | repeated string | |
| room_labels | По Лейблам помещений, привязанных ТУ | repeated string | |
| metric_point_ids | По ID привязанных точек учета | repeated string | |
| indicator_vendor_types | По посреднику получения показаний | repeated keyapis.telemetry_control.v1.Indicator.VendorType |
IndicatorFilter.ValidationError¶
Ошибки валидации. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| path | Путь к полю в формате наименования protobuf | string | REQUIRED |
| message | Валидационное сообщение | string | REQUIRED |
IndicatorPaging¶
Пагинация индикаторов
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| order_by_type | Тип значения сортировки. По умолчанию: ID | keyapis.telemetry_control.v1.IndicatorPaging.OrderByType | |
| direction_type | Тип направления сортировки. По умолчанию: DESC | keyapis.telemetry_control.v1.IndicatorPaging.DirectionType | |
| limit | Количество записей на страницу. Минимальное значение: 1. Максимальное значение: 100. По умолчанию: 20. Если значение 0 (не передано), то выставляем значение по умолчанию | int32 | |
| offset | Сдвиг. По умолчанию: 0 | int32 |
IndicatorPaging.ValidationError¶
Ошибка валидации постраничной пагинации по индикаторам. Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| limit | Количество передано некорректно | optional keyapis.telemetry_control.v1.IndicatorPaging.ValidationError.LimitInvalid | |
| offset | Сдвиг передан некорректно | optional keyapis.telemetry_control.v1.IndicatorPaging.ValidationError.OffsetInvalid |
IndicatorPaging.ValidationError.LimitInvalid¶
Причины: - Значение количества < 0 или > 100
IndicatorPaging.ValidationError.OffsetInvalid¶
Причины: - Значение сдвига < 0
PostDeviceFullDuplexRequest¶
Запрос создания задачи с клиента на сервере
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| request_id | Идентификатор запроса | string | REQUIRED |
| post_device_full_duplex_device_async_status | Результат обработки устройства на клиенте | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus |
PostDeviceFullDuplexRequest.DeviceAsyncStatus¶
Результат обработки устройства на клиенте
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_id | Идентификатор ПУ | int32 | REQUIRED |
| data | Успех | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Success | |
| error | Ошибка | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error |
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error¶
Ошибки обработки устройства на клиенте
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| post_device_request_unknown | Неизвестная ошибка | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.UnknownError | |
| post_device_request_ip | Неверный IP | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.IpError | |
| post_device_request_port | Неверный порт | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.PortError | |
| post_device_request_network_address | Неверный сетевой адрес | optional keyapis.telemetry_control.v1.PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.NetworkAddressError |
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.IpError¶
Причины: - Устройство не найденно на данном IP адресе
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.NetworkAddressError¶
Причины: - Неверный сетевой адрес
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.PortError¶
Причины: - Устройство отсутствует на порту
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Error.UnknownError¶
Неизвестная ошибка на стороне клиента
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| message | Произвольный текст ошибки на стороне клиента. Отправляется в случае если в спецификации нет подходящей ошибки. После анализа таких ошибок в спецификацию добавляется специальный тип под эту ошибку | string | REQUIRED |
PostDeviceFullDuplexRequest.DeviceAsyncStatus.Success¶
Команда принята
PostDeviceFullDuplexResponse¶
Событие изменения ПУ на сервера
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| request_id | Идентификатор запроса | string | REQUIRED |
| post_device | Измененние ПУ на сервере | optional keyapis.telemetry_control.v1.PostDeviceResponse |
PostDeviceIndicatorRequest¶
Запрос сохранения индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Индикатор | keyapis.telemetry_control.v1.Indicator | REQUIRED |
PostDeviceIndicatorResponse¶
Ответ на запрос сохранения индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Индикатор | optional keyapis.telemetry_control.v1.Indicator | |
| error | Ошибка | optional keyapis.telemetry_control.v1.PostDeviceIndicatorResponse.Error |
PostDeviceIndicatorResponse.Error¶
Ошибка запроса сохранения индикатора
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.telemetry_control.v1.Indicator.ValidationError |
PostDeviceReplaceRequest¶
Запрос замены прибора учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| replace_device_id | Идентификатор заменяемого прибора учета | int32 | REQUIRED |
| device | Создаваемый прибор учета | keyapis.telemetry_control.v1.Device | REQUIRED |
PostDeviceReplaceResponse¶
Ответ на замену прибора учета
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Созданный на замену ПУ | optional keyapis.telemetry_control.v1.Device | |
| error | Ошибка | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error |
PostDeviceReplaceResponse.Error¶
Ошибка замены ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.telemetry_control.v1.Device.ValidationError | |
| replace_device_not_found | Не найден заменяемый ПУ | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error.ReplaceDeviceNotFound | |
| create_indicators_fail | Не удалось создать индикаторы нового ПУ | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error.CreateIndicatorsFail | |
| multi_linked_metric_point | Попытка замены ПУ, привязанного ко многим ТУ | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error.MultiLinkedMetricPoint | |
| wrong_building | Заменяющий ПУ не привязан к дому заменяемого ПУ | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error.WrongBuilding | |
| metric_point_not_found | Заменяемый ПУ не привязан к ТУ | optional keyapis.telemetry_control.v1.PostDeviceReplaceResponse.Error.MetricPointNotFound |
PostDeviceReplaceResponse.Error.CreateIndicatorsFail¶
Не удалось создать индикаторы нового ПУ
PostDeviceReplaceResponse.Error.MetricPointNotFound¶
Заменяемый ПУ не привязан к ТУ
PostDeviceReplaceResponse.Error.MultiLinkedMetricPoint¶
Попытка замены ПУ, привязанного ко многим ТУ
PostDeviceReplaceResponse.Error.ReplaceDeviceNotFound¶
Не найден заменяемый ПУ
PostDeviceReplaceResponse.Error.WrongBuilding¶
Заменяющий ПУ не привязан к дому заменяемого ПУ
PostDeviceRequest¶
Запрос сохранения ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device | Прибор учета | keyapis.telemetry_control.v1.Device | REQUIRED |
PostDeviceResponse¶
Ответ на изменение ПУ на сервере
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | ПУ | optional keyapis.telemetry_control.v1.Device | |
| error | Ошибка | optional keyapis.telemetry_control.v1.PostDeviceResponse.Error |
PostDeviceResponse.Error¶
Ошибка запроса сохранения ПУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional keyapis.telemetry_control.v1.Device.ValidationError |
PutDeviceGroupAttachRequest¶
Запрос сохранения связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_group | Связь ПУ и группы пользователя | keyapis.telemetry_control.v1.DeviceGroup | REQUIRED |
PutDeviceGroupAttachResponse¶
Ответ на запрос сохранения связи ПУ и группы пользователя
PutDeviceGroupDetachRequest¶
Запрос удаления связей ПУ и группы пользователя
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_group | Связь ПУ и группы пользователя | keyapis.telemetry_control.v1.DeviceGroup | REQUIRED |
PutDeviceGroupDetachResponse¶
Ответ на запрос удаления связи ПУ и группы пользователя
PutDeviceIndicatorMetricPointAttachRequest¶
Запрос сохранения связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_indicator_metric_point | Связь индикатора и ТУ | keyapis.telemetry_control.v1.DeviceIndicatorMetricPoint | REQUIRED |
PutDeviceIndicatorMetricPointAttachResponse¶
Ответ на запрос сохранения связи индикатора и ТУ
PutDeviceIndicatorMetricPointDetachRequest¶
Запрос удаления связей индикаторов и ТУ
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| device_indicator_metric_point | Связь индикатора и ТУ | keyapis.telemetry_control.v1.DeviceIndicatorMetricPoint | REQUIRED |
PutDeviceIndicatorMetricPointDetachResponse¶
Ответ на запрос удаления связи индикатора и ТУ
Device.MetricPoint.AccountingType¶
Справочник типов учёта
| Номер | Тип | Название |
|---|---|---|
| 0 | ACCOUNTING_TYPE_UNKNOWN | Значение не указано |
| 1 | COMMERCIAL | Коммерческий учёт |
| 2 | TECHNICAL | Технический учёт |
Device.MetricPoint.MetricType¶
Справочние типов энергоресурсов
| Номер | Тип | Название |
|---|---|---|
| 0 | METRIC_TYPE_UNKNOWN | Значение не указано |
| 1 | HOT_WATER | Горячая вода |
| 2 | COLD_WATER | Холодная вода |
| 3 | HEAT | Теплоэнергия |
| 4 | GAS | Газ |
| 5 | ELECTRICITY | Электроэнергия |
Device.MetricPoint.PrimaryCurrentType¶
Справочник типов номиналов первичных токов. У выпускаемых трансформаторов тока (А)
| Номер | Тип | Название |
|---|---|---|
| 0 | PRIMARY_CURRENT_TYPE_UNKNOWN | Значение не указано |
| 1 | TT1A | 1 (А) |
| 2 | TT5A | 5 (А) |
| 3 | TT10A | 10 (А) |
| 4 | TT15A | 15 (А) |
| 5 | TT20A | 20 (А) |
| 6 | TT30A | 30 (А) |
| 7 | TT40A | 40 (А) |
| 8 | TT50A | 50 (А) |
| 9 | TT75A | 75 (А) |
| 10 | TT80A | 80 (А) |
| 11 | TT100A | 100 (А) |
| 12 | TT150A | 150 (А) |
| 13 | TT200A | 200 (А) |
| 14 | TT300A | 300 (А) |
| 15 | TT400A | 400 (А) |
| 16 | TT500A | 500 (А) |
| 17 | TT600A | 600 (А) |
| 18 | TT750A | 750 (А) |
| 19 | TT800A | 800 (А) |
| 20 | TT1000A | 1000 (А) |
| 21 | TT1200A | 1200 (А) |
| 22 | TT1500A | 1500 (А) |
| 23 | TT2000A | 2000 (А) |
Device.MetricPoint.StatusType¶
Справочник типов статусов
| Номер | Тип | Название |
|---|---|---|
| 0 | STATUS_TYPE_UNKNOWN | Значение не указано |
| 1 | ACTIVE | Активная |
| 2 | WRONG | Deprecated. Не активная |
| 3 | ARCHIVE | Архивная |
Device.PipeType¶
Справочник типов трубопроводов
| Номер | Тип | Название |
|---|---|---|
| 0 | PIPE_TYPE_UNKNOWN | Значение не указано |
| 1 | INFEED | Подающий |
| 2 | CIRCULATING | Циркуляционный |
Device.PlanType¶
Справочник типов тарифных планов
| Номер | Тип | Название |
|---|---|---|
| 0 | PLAN_TYPE_UNKNOWN | Значение не указано |
| 1 | SINGLE | Однотарифный |
| 2 | DOUBLE | Двухтарифный |
| 3 | TRIPLE | Трёхтарифный |
Device.SecondaryCurrentType¶
Справочник типов номинальных нагрузок вторичных обмоток. У трансформаторов тока (В*А)
| Номер | Тип | Название |
|---|---|---|
| 0 | SECONDARY_CURRENT_TYPE_UNKNOWN | Значение не указано |
| 1 | TT1A | 1 (А) |
| 2 | TT2A | 2 (А) |
| 3 | TT5A | 5 (А) |
Device.StatusType¶
Справочник типов статусов
| Номер | Тип | Название |
|---|---|---|
| 0 | STATUS_TYPE_UNKNOWN | Значение не указано |
| 1 | RECEIVED | Получен клиентом, еще не сконфигурирован |
| 2 | ACTIVE | Сконфигурирован клиентом, активен |
| 3 | WRONG | Обработан клиентом, возникла ошибка |
| 4 | ARCHIVE | Переведен в архивный статус |
| 5 | DELETE | Удален |
| 6 | UNLINK | Отсоединен |
Device.Type¶
Справочник типов приборов учёта(ПУ)
| Номер | Тип | Название |
|---|---|---|
| 0 | TYPE_UNKNOWN | Значение не указано |
| 1 | HUB | Коммуникационный модуль |
| 2 | PULSE_COUNTER_RECORDER | Счетчик импульсов - регистратор |
| 3 | PULSE_COUNTER_RECORDER_LR | Счетчик импульсов - регистратор LoRaWAN |
| 4 | METERING_DEVICE | Прибор учета расхода коммунальных услуг |
| 5 | INTERFACE_CONVERTER | Конвертер интерфейсов |
| 6 | M_BUS_HUB | M-BUS концентратор |
| 7 | COMMUNICATION_MODULE_LR | Модуль связи LoRaWAN |
| 8 | BASE_LR | Базовая станция LoRaWAN |
DeviceGroupPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DeviceGroupPaging.OrderByType¶
Справочник типов сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | GROUP_ID | По Идентификатору группы пользователя |
| 2 | DEVICE_ID | По ПУ |
DeviceIndicatorMetricPointPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DeviceIndicatorMetricPointPaging.OrderByType¶
Справочник типов сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | INDICATOR_ID | По Идентификатору индикатора |
| 2 | METRIC_POINT_ID | По По Идентификатору ТУ |
DevicePaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
DevicePaging.OrderByType¶
Справочник типов значений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По идентификатору |
Indicator.ArchiveType¶
Справочник типа архивности показаний. Используется для указания за какой период произошло измерение. По умолчанию CURRENT
| Номер | Тип | Название |
|---|---|---|
| 0 | ARCHIVE_TYPE_UNKNOWN | Значение не указано |
| 1 | CURRENT | Текущие показания |
| 2 | HALFHOUR | За 30 мин |
| 3 | HOUR | За час |
| 4 | DAY | За сутки |
| 5 | MONTH | За месяц |
| 6 | YEAR | За год |
Indicator.SignType¶
Справочник типов измерений
| Номер | Тип | Название |
|---|---|---|
| 0 | SIGN_TYPE_UNKNOWN | Значение не указано |
| 1 | ABSOLUTE_DS | Абсолютный показатель |
| 2 | ABSOLUTE_RC | Абсолютный расход ресурса |
| 3 | INTERVAL_DS | Интервальный показатель состояния |
| 4 | INTERVAL_RC | Интервальный расход ресурса |
| 5 | CURRENT_DS | Текущее состояние |
| 6 | CURRENT_RS | Текущее состояние ресурса |
| 7 | VOLUME | Объём |
| 8 | PARAMETER | Параметр конфигурации |
| 9 | FLAG | Флаг состояния |
Indicator.UnitType¶
Справочник типов единиц измерений
| Номер | Тип | Название |
|---|---|---|
| 0 | UNIT_TYPE_UNKNOWN | Значение не указано |
| 1 | PERCENT | Процент |
| 2 | C | Градус по Цельсию |
| 3 | WT | Ватт |
| 4 | GKAL | Гигакалория |
| 5 | VALUE | Количество |
| 6 | KWH | Киловaтт-час |
| 7 | KG_CM2 | Килограмм на квадратный сантиметр |
| 8 | KGF_CM2 | Килограмм-сила на квадратный сантиметр |
| 9 | M3 | Кубический метр |
| 10 | M3_H | Кубический метр в час |
| 11 | MPA | Мегапаскаль |
| 12 | MS | Миллисекунда |
| 13 | BOOLEAN | Флаг состояния |
| 14 | T | Тонна |
| 15 | T_H | Тонна в час |
| 16 | H | Час |
| 17 | NON_MEASURABLE | Безразмерная величина |
| 18 | IMP | Импульс |
| 19 | J | Джоуль |
| 20 | KJ | Килоджоуль |
| 21 | GJ | Гигаджоуль |
| 22 | WTH | Ватт-час |
| 23 | KWT | Киловатт |
| 24 | MIN | Минута |
| 25 | S | Секунда |
Indicator.VendorType¶
Посредники получения показаний
| Номер | Тип | Название |
|---|---|---|
| 0 | VENDOR_TYPE_UNKNOWN | Значение не указано |
| 1 | ENVIRO | Энвайро |
| 2 | LARTECH | Лартех |
| 3 | RTK | РТК |
IndicatorPaging.DirectionType¶
Справочник типов направлений сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | DIRECTION_TYPE_UNKNOWN | Значение не указано |
| 1 | DESC | От большего к меньшему |
| 2 | ASC | От меньшего к большему |
IndicatorPaging.OrderByType¶
Справочник типов сортировки
| Номер | Тип | Название |
|---|---|---|
| 0 | ORDER_BY_TYPE_UNKNOWN | Значение не указано |
| 1 | ID | По уникальному ключу |
| 2 | SIGN_TYPE | По типу измерений |
| 3 | DEVICE_ID | По Прибору учета |
| 4 | CREATED_AT | По Дате создания |
Скалярные типы значений¶
| .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 |