Service: State List

This API is officially released and maintained.

An RPC service to request a stream of state list messages. If a pipeline is already running, it will be used to stream the data. If no pipeline is running, it will be started first and then the stream will start. NOTE: in this second case, the pipeline will also be automatically stopped once the this second case, the pipeline will also be automatically stopped once there are no more clients requesting any stream type from the module.

Table 1. Available methods
Method Request Response

Stream

StateListStreamRequest

StateListStreamResponseStream

Stream

A method to get a stream of state list messages from the pipeline

Request

A request to receive a stream of state list messages

Table 2. Available fields in blickfeld.percept_processing.services.StateListStreamRequest
Field Type Default Unit

Response Stream

A response for getting a stream of state list messages from the running pipeline

Table 3. Available fields in blickfeld.percept_processing.services.StateListStreamResponse
Field Type Default Unit

state_list

data.StateList

-

-

The current state list with the information detected in the zones configured in the running pipeline