cybros labs

openHES API

version 402

ApiService - Devices

CreateCommunicationUnit

The method called by the RestAPI to register a new communication unit. The parameter contains the communication unit specification.

CreateCommunicationUnit(io.clbs.openhes.models.acquisition.CreateCommunicationUnitRequest) returns (google.protobuf.StringValue)

UpdateCommunicationUnit

The method updates the communication unit. The parameter contains the communication unit specification.

UpdateCommunicationUnit(io.clbs.openhes.models.acquisition.CommunicationUnit)

ListCommunicationUnits

The method called by the RestAPI to get the information about the communication unit. The parameter contains the search criteria.

ListCommunicationUnits(io.clbs.openhes.models.common.ListSelector) returns (io.clbs.openhes.models.acquisition.ListOfCommunicationUnit)

GetCommunicationUnit

The method called by the RestAPI to get the information about the communication unit. The parameter contains the search criteria.

GetCommunicationUnit(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.CommunicationUnit)

CreateCommunicationBus

CreateCommunicationBus(io.clbs.openhes.models.acquisition.CreateCommunicationBusRequest) returns (google.protobuf.StringValue)

ListCommunicationBuses

ListCommunicationBuses(io.clbs.openhes.models.common.ListSelector) returns (io.clbs.openhes.models.acquisition.ListOfCommunicationBus)

AddCommunicationUnitsToCommunicationBus

AddCommunicationUnitsToCommunicationBus(io.clbs.openhes.models.acquisition.AddCommunicationUnitsToCommunicationBusRequest)

RemoveCommunicationUnitsFromCommunicationBus

RemoveCommunicationUnitsFromCommunicationBus(io.clbs.openhes.models.acquisition.RemoveCommunicationUnitsFromCommunicationBusRequest)

CreateDevice

The method called by the RestAPI to register a new device. The parameter contains the device specification.

CreateDevice(io.clbs.openhes.models.acquisition.CreateDeviceRequest) returns (google.protobuf.StringValue)

UpdateDevice

The method updates the device. The parameter contains the device specification.

UpdateDevice(io.clbs.openhes.models.acquisition.Device)

ListDevices

The method called by the RestAPI to get the information about the device. The parameter contains the search criteria.

ListDevices(io.clbs.openhes.models.common.ListSelector) returns (io.clbs.openhes.models.acquisition.ListOfDevice)

GetDevice

The method called by the RestAPI to get the information about the device. The parameter contains the search criteria.

GetDevice(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.Device)

GetDeviceInfo

The method to stream out profile-typed meter data.

GetDeviceInfo(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.DeviceInfo)

SetDeviceCommunicationUnits

The method called by the RestAPI to replace ordered set of linked communication units.

SetDeviceCommunicationUnits(io.clbs.openhes.models.acquisition.SetDeviceCommunicationUnitsRequest)

GetDeviceCommunicationUnits

The method called by the RestAPI to get communication units definitions linked to the device(s).

GetDeviceCommunicationUnits(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.ListOfDeviceCommunicationUnit)

CreateDeviceGroup

The method called by the RestAPI to create a new device group. The parameter contains the device group specification.

CreateDeviceGroup(io.clbs.openhes.models.acquisition.CreateDeviceGroupRequest) returns (google.protobuf.StringValue)

ListDeviceGroups

The method returns a list of device groups.

ListDeviceGroups(io.clbs.openhes.models.common.ListSelector) returns (io.clbs.openhes.models.acquisition.ListOfDeviceGroup)

GetDeviceGroup

The method returns single device group.

GetDeviceGroup(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.DeviceGroup)

AddDevicesToGroup

The method called by the RestAPI to add a new device to the device group. The parameter contains the device group specification.

AddDevicesToGroup(io.clbs.openhes.models.acquisition.AddDevicesToGroupRequest)

RemoveDevicesFromGroup

The method called by the RestAPI to remove a device from the device group. The parameter contains the device group specification.

RemoveDevicesFromGroup(io.clbs.openhes.models.acquisition.RemoveDevicesFromGroupRequest)

ListDeviceGroupDevices

ListDeviceGroupDevices(io.clbs.openhes.models.acquisition.ListDeviceGroupDevicesRequest) returns (io.clbs.openhes.models.acquisition.ListOfDevice)

ListModemPools

The method to get list of the modem pools.

ListModemPools(io.clbs.openhes.models.common.ListSelector) returns (io.clbs.openhes.models.acquisition.ListOfModemPool)

GetModemPool

The method to get the information about the modem pool. The method returns the modem pool information.

GetModemPool(google.protobuf.StringValue) returns (io.clbs.openhes.models.acquisition.ModemPool)

CreateModemPool

The method to create a new modem pool.

CreateModemPool(io.clbs.openhes.models.acquisition.SetModemPoolRequest) returns (google.protobuf.StringValue)

UpdateModemPool

The method to update the modem pool.

UpdateModemPool(io.clbs.openhes.models.acquisition.SetModemPoolRequest)

DeleteModemPool

The method to delete the modem pool.

DeleteModemPool(google.protobuf.StringValue)

CreateModem

The method to create a new modem within the pool.

CreateModem(io.clbs.openhes.models.acquisition.SetModemRequest) returns (google.protobuf.StringValue)

UpdateModem

The method to update the modem within the pool.

UpdateModem(io.clbs.openhes.models.acquisition.SetModemRequest)

DeleteModem

The method to delete the modem.

DeleteModem(google.protobuf.StringValue)