Service: Zone

This API is officially released and maintained.

The zone service allows getting, configuring, deleting and receiving updates of the configured zones.

Table 1. Available methods
Method	Request	Response
List	google.protobuf.Empty	ZoneListResponse
Store	ZoneStoreRequest	google.protobuf.Empty
Delete	ZoneDeleteRequest	google.protobuf.Empty
DeleteAll	google.protobuf.Empty	google.protobuf.Empty
Watch	google.protobuf.Empty	ZoneWatchResponseStream
GetTareVolume	ZoneGetTareVolumeRequest	ZoneGetTareVolumeResponse

List

Returns the configured zones

Response containing the configured list of zones

Table 2. Available fields in blickfeld.percept_pipeline.services.ZoneListResponse
Field	Type	Default	Unit
zones	repeated config.ZoneAlgorithm	-	-
zones	The currently configured zones

Store / Update a zone

Request to store or update existing zones

Table 3. Available fields in blickfeld.percept_pipeline.services.ZoneStoreRequest
Field	Type	Default	Unit
zone	config.ZoneAlgorithm	-	-
zone	The new zone to be added. If there is a zone with the same uuid, that zone will get updated with this configuration.
zones	repeated config.ZoneAlgorithm	-	-
zones	For a batch update: the new zones to be added. If any of them has a uuid matching an existing zone, it will get updated.
delete_others	bool	-	-
delete_others	If this is set to true, all existing zones that are not specified in this request will be deleted.

Delete a zone

Request to delete zones

Table 4. Available fields in blickfeld.percept_pipeline.services.ZoneDeleteRequest
Field	Type	Default	Unit
uuid	string	-	-
uuid	The uuid of the zone to be deleted
uuids	repeated string	-	-
uuids	For a batch delete: the uuids of the zones to be deleted

Delete all zones

Watch configuration for zone list

Continuous response on zone list changes

Table 5. Available fields in blickfeld.percept_pipeline.services.ZoneWatchResponse
Field	Type	Default	Unit
zones	repeated config.ZoneAlgorithm	-	-
zones	The current/updated list of zones

Computes raw volume within a volume zone without any offsets.

Request for the raw volume to be used for taring a volume zone

Table 6. Available fields in blickfeld.percept_pipeline.services.ZoneGetTareVolumeRequest
Field	Type	Default	Unit
zone_uuid	string	-	-
zone_uuid	The uuid of the volume zone

Response containing the raw volume of the requested zone

Table 7. Available fields in blickfeld.percept_pipeline.services.ZoneGetTareVolumeResponse
Field	Type	Default	Unit
tare_volume	float	-	m^3
tare_volume	The raw volume of the volume zone without any offsets/modifications. The value is supposed to be configured as 'empty_volume' value of a volume zone. As a result the current volume of the zone will be '0' until more volume is added.