Service: History

This API is officially released and maintained.

The history service provides historical data. The data is captured event-based e.g. when an intrusion occurs. The capture window is +/- 10 seconds around the event. The data is intended for event analysis and fine tuning of config.

The data is stored in volatile memory thus it is not persisted over a power reset of the device. Additionally, only a limited amount is kept.

Table 1. Available methods
Method	Request	Response
StreamRange	HistoryStreamRangeRequest	HistoryStreamRangeResponseStream

StreamRange

Stream historical data in the given id range.

Raises a NOT_FOUND error when no historical data in the given range is available.

Request

Request for stream range method

Table 2. Available fields in blickfeld.percept_processing.services.HistoryStreamRangeRequest
Field	Type	Default	Unit
start_id	string	-	-
start_id	ID where the stream should start
end_id	string	-	-
end_id	ID where the stream should stop

Response Stream

Response for stream range method

Table 3. Available fields in blickfeld.percept_processing.services.HistoryStreamRangeResponse
Field	Type	Default	Unit
objects	data.Objects	-	-
objects	Historical objects
states	data.States	-	-
states	Historical states
foreground	core_processing.data.Frame	-	-
foreground	Historical foreground point cloud
zone_coverage	optional core_processing.data.Frame	-	-
zone_coverage	Historical zone coverage point cloud Only available for zones where a minimum coverage is configured.