Health

Message representing health

Table 1. Available fields in blickfeld.core_processing.data.Health
Field	Type	Default	Unit
state	base.data.Health.State	-	-
state	High-level state of module
state_reason	string	-	-
state_reason	Reason for given state. Is not set if state is STATE_OK.
channel_status	ChannelStatus	-	-
channel_status	Status of internal channels
server_status	ServerStatus	-	-
server_status	Status of gRPC server
error_flags	ErrorFlags	-	-
error_flags	Error flags which give insight in fine-grained errors

Channel Status

Status for typed channels producing raw-data

Table 2. Available fields in blickfeld.core_processing.data.Health.ChannelStatus
Field	Type	Default	Unit
point_cloud	PointCloud	-	-
point_cloud	Point Cloud status
acceleration	Acceleration	-	-
acceleration	Acceleration status
adc	Adc	-	-
adc	Adc status
vertical_beam_deflection_control	BeamDeflectionControl	-	-
vertical_beam_deflection_control	Vertical Beam Deflection Control status
horizontal_beam_deflection_control	BeamDeflectionControl	-	-
horizontal_beam_deflection_control	Horizontal Beam Deflection Control status
magnetic_field	MagneticField	-	-
magnetic_field	Magnetic Field status

Point Cloud

Status of Point Cloud channel

Table 3. Available fields in blickfeld.core_processing.data.Health.ChannelStatus.PointCloud
Field	Type	Default	Unit
point_rate	float	-	Hz
point_rate	Processed points per second
scanline_rate	float	-	Hz
scanline_rate	Scanlines per second
frame_rate	float	-	Hz
frame_rate	Frames per second
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Acceleration

Status of Acceleration channel

Table 4. Available fields in blickfeld.core_processing.data.Health.ChannelStatus.Acceleration
Field	Type	Default	Unit
buffer_rate	float	-	Hz
buffer_rate	Processed buffers per second
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Adc

Status of Adc channel

Table 5. Available fields in blickfeld.core_processing.data.Health.ChannelStatus.Adc
Field	Type	Default	Unit
buffer_rate	float	-	Hz
buffer_rate	Processed buffers per second
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Beam Deflection Control

Status of BeamDeflectionControl channel

Table 6. Available fields in blickfeld.core_processing.data.Health.ChannelStatus.BeamDeflectionControl
Field	Type	Default	Unit
buffer_rate	float	-	Hz
buffer_rate	Produced buffers per second
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Magnetic Field

Status of Magnetic-Field channel

Table 7. Available fields in blickfeld.core_processing.data.Health.ChannelStatus.MagneticField
Field	Type	Default	Unit
buffer_rate	float	-	Hz
buffer_rate	Produced buffers per second
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Server Status

Status for Server / Client activities

Table 8. Available fields in blickfeld.core_processing.data.Health.ServerStatus
Field	Type	Default	Unit
point_cloud	PointCloud	-	-
point_cloud	Point Cloud service
acceleration	Acceleration	-	-
acceleration	Acceleration service
adc	Adc	-	-
adc	Adc service
beam_deflection_control	BeamDeflectionControl	-	-
beam_deflection_control	Beam Deflection Control service
health	Health	-	-
health	Health service
magnetic_field	MagneticField	-	-
magnetic_field	Magnetic Field service

Point Cloud

Status for Point Cloud service

Table 9. Available fields in blickfeld.core_processing.data.Health.ServerStatus.PointCloud
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods. [NOTE] This field is deprecated, use the field `clients` instead.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.
clients	repeated ClientsEntry	-	-
clients	List of currently connected client IPs and their information

Client

Connected client information

Table 10. Available fields in blickfeld.core_processing.data.Health.ServerStatus.PointCloud.Client
Field	Type	Default	Unit
number_of_streams	uint32	-	-
number_of_streams	Number of open streams belonging to the client.
lost_frames	uint64	-	-
lost_frames	Number of frames which have been lost due to slow reading from the client side.

Clients Entry

Table 11. Available fields in blickfeld.core_processing.data.Health.ServerStatus.PointCloud.ClientsEntry
Field	Type	Default	Unit
key	string	-	-
value	Client	-	-

Acceleration

Status for Acceleration service

Table 12. Available fields in blickfeld.core_processing.data.Health.ServerStatus.Acceleration
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Adc

Status for Adc service

Table 13. Available fields in blickfeld.core_processing.data.Health.ServerStatus.Adc
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Beam Deflection Control

Status for BeamDeflectionControl service

Table 14. Available fields in blickfeld.core_processing.data.Health.ServerStatus.BeamDeflectionControl
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Health

Status for Health service

Table 15. Available fields in blickfeld.core_processing.data.Health.ServerStatus.Health
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Magnetic Field

Status for Magnetic Field service

Table 16. Available fields in blickfeld.core_processing.data.Health.ServerStatus.MagneticField
Field	Type	Default	Unit
number_of_clients	uint32	-	-
number_of_clients	Number of currently open client connections [NOTE] This is a snapshot and does not distinguish between long running streams or single request / response methods.
data_rate	float	-	B/s
data_rate	Average data rate [NOTE] This value is averaged over 10 seconds, peak or current values might be different.

Error Flags

Error flags of internal data handling mechanisms

Table 17. Available fields in blickfeld.core_processing.data.Health.ErrorFlags
Field	Type	Default	Unit
packet_counter_mismatch_packager	bool	-	-
packet_counter_mismatch_packager	TLP counter mismatch for Packager DMA
packet_counter_mismatch_debug	bool	-	-
packet_counter_mismatch_debug	TLP counter mismatch for Debug DMA
exhausted_scanline_buffers	bool	-	-
exhausted_scanline_buffers	Dropping data because scanline buffers are exhausted
exhausted_acceleration_buffers	bool	-	-
exhausted_acceleration_buffers	Dropping data because acceleration buffers are exhausted
exhausted_adc_buffers	bool	-	-
exhausted_adc_buffers	Dropping data because adc buffers are exhausted
exhausted_vertical_beam_deflection_control_buffers	bool	-	-
exhausted_vertical_beam_deflection_control_buffers	Dropping data because vertical beam deflection control buffers are exhausted
exhausted_horizontal_beam_deflection_control_buffers	bool	-	-
exhausted_horizontal_beam_deflection_control_buffers	Dropping data because horizontal beam deflection control buffers are exhausted
exhausted_magnetic_field_buffers	bool	-	-
exhausted_magnetic_field_buffers	Dropping data because magnetic field buffers are exhausted
client_loosing_frames	bool	-	-
client_loosing_frames	One or multiple clients are loosing frames because they are reading too slow
point_cloud_stream_not_active	bool	-	-
point_cloud_stream_not_active	The point cloud stream is not active
point_rate_too_low	bool	-	-
point_rate_too_low	The number of points in the point cloud is too low. One of the reasons is that the device is covered. The point rate limit that is used to trigger this flag can be configured with Health.SetConfig API method.
point_cloud_alignment_changed	bool	-	-
point_cloud_alignment_changed	The point cloud alignment deviates from the reference alignment. This might have an impact on the point cloud processing as e.g. the ground alignment got incorrect. If this is expected, the alignment can be reconfigured with the Health.SetConfig API method.