rs_safety_sensor.h File Reference

Exposes RealSense safety sensor functionality for C compilers. More...

#include "rs_types.h"

Go to the source code of this file.

Functions
const rs2_raw_data_buffer *	rs2_get_safety_preset (rs2_sensor const *sensor, int index, rs2_error **error)
void	rs2_set_safety_preset (rs2_sensor const *sensor, int index, const char *sp_json_str, rs2_error **error)
const rs2_raw_data_buffer *	rs2_get_safety_interface_config (rs2_sensor const *sensor, rs2_calib_location loc, rs2_error **error)
void	rs2_set_safety_interface_config (rs2_sensor const *sensor, const char *sic_json_str, rs2_error **error)
const rs2_raw_data_buffer *	rs2_get_application_config (rs2_sensor const *sensor, rs2_error **error)
void	rs2_set_application_config (rs2_sensor const *sensor, const char *application_config_json_str, rs2_error **error)

Detailed Description

Exposes RealSense safety sensor functionality for C compilers.

Function Documentation

rs2_get_application_config()

const rs2_raw_data_buffer* rs2_get_application_config	(	rs2_sensor const *	sensor,
		rs2_error **	error
	)

rs2_get_application_config

Parameters

[in]	sensor	Safety sensor
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns

JSON string representing the application config as rs2_raw_data_buffer

rs2_get_safety_interface_config()

const rs2_raw_data_buffer* rs2_get_safety_interface_config	(	rs2_sensor const *	sensor,
		rs2_calib_location	loc,
		rs2_error **	error
	)

rs2_get_safety_interface_config

Parameters

[in]	sensor	Safety sensor
[out]	loc	Calibration location that needs to be read from
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns

JSON string representing the safety interface config as rs2_raw_data_buffer

rs2_get_safety_preset()

const rs2_raw_data_buffer* rs2_get_safety_preset	(	rs2_sensor const *	sensor,
		int	index,
		rs2_error **	error
	)

rs2_get_safety_preset

Parameters

[in]	sensor	Safety sensor
[in]	index	Index to read from
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

Returns

JSON string representing the safety preset at the given index as rs2_raw_data_buffer

rs2_set_application_config()

void rs2_set_application_config	(	rs2_sensor const *	sensor,
		const char *	application_config_json_str,
		rs2_error **	error
	)

rs2_set_application_config

Parameters

[in]	sensor	Safety sensor
[in]	application_config_json_str	Application config as JSON string
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

rs2_set_safety_interface_config()

void rs2_set_safety_interface_config	(	rs2_sensor const *	sensor,
		const char *	sic_json_str,
		rs2_error **	error
	)

rs2_set_safety_interface_config

Parameters

[in]	sensor	Safety sensor
[in]	sic_json_str	Safety interface config as JSON string
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored

rs2_set_safety_preset()

void rs2_set_safety_preset	(	rs2_sensor const *	sensor,
		int	index,
		const char *	sp_json_str,
		rs2_error **	error
	)

rs2_set_safety_preset

Parameters

[in]	sensor	Safety sensor
[in]	index	Index to write to
[in]	sp_json_str	Safety preset as JSON string
[out]	error	If non-null, receives any error that occurs during this call, otherwise, errors are ignored