ranger
[Device proxies]
Collaboration diagram for ranger:
Detailed Description
The ranger proxy provides an interface to ranger sensor devices.
Classes | |
struct | playerc_ranger_t |
Ranger proxy data. More... | |
Functions | |
playerc_ranger_t * | playerc_ranger_create (playerc_client_t *client, int index) |
Create a ranger proxy. | |
void | playerc_ranger_destroy (playerc_ranger_t *device) |
Destroy a ranger proxy. | |
int | playerc_ranger_subscribe (playerc_ranger_t *device, int access) |
Subscribe to the ranger device. | |
int | playerc_ranger_unsubscribe (playerc_ranger_t *device) |
Un-subscribe from the ranger device. | |
int | playerc_ranger_get_geom (playerc_ranger_t *device) |
Get the ranger geometry. | |
int | playerc_ranger_power_config (playerc_ranger_t *device, uint8_t value) |
Turn device power on or off. | |
int | playerc_ranger_intns_config (playerc_ranger_t *device, uint8_t value) |
Turn intensity data on or off. | |
int | playerc_ranger_set_config (playerc_ranger_t *device, double min_angle, double max_angle, double resolution, double max_range, double range_res, double frequency) |
Set the ranger device's configuration. | |
int | playerc_ranger_get_config (playerc_ranger_t *device, double *min_angle, double *max_angle, double *resolution, double *max_range, double *range_res, double *frequency) |
Get the ranger device's configuration. |
Function Documentation
int playerc_ranger_get_config | ( | playerc_ranger_t * | device, | |
double * | min_angle, | |||
double * | max_angle, | |||
double * | resolution, | |||
double * | max_range, | |||
double * | range_res, | |||
double * | frequency | |||
) |
Get the ranger device's configuration.
Not all values may be filled.
- Parameters:
-
min_angle Start angle of scans [rad]. max_angle End angle of scans [rad]. resolution Scan resolution [rad]. max_range Maximum range [m]. range_res Range resolution [m]. frequency Scanning frequency [Hz].
int playerc_ranger_get_geom | ( | playerc_ranger_t * | device | ) |
Get the ranger geometry.
This writes the result into the proxy rather than returning it to the caller.
int playerc_ranger_intns_config | ( | playerc_ranger_t * | device, | |
uint8_t | value | |||
) |
Turn intensity data on or off.
- Parameters:
-
value Set to TRUE to turn the data on, FALSE to turn the data off.
int playerc_ranger_power_config | ( | playerc_ranger_t * | device, | |
uint8_t | value | |||
) |
Turn device power on or off.
- Parameters:
-
value Set to TRUE to turn power on, FALSE to turn power off.
int playerc_ranger_set_config | ( | playerc_ranger_t * | device, | |
double | min_angle, | |||
double | max_angle, | |||
double | resolution, | |||
double | max_range, | |||
double | range_res, | |||
double | frequency | |||
) |
Set the ranger device's configuration.
Not all values may be used.
- Parameters:
-
min_angle Start angle of scans [rad]. max_angle End angle of scans [rad]. resolution Scan resolution [rad]. max_range Maximum range [m]. range_res Range resolution [m]. frequency Scanning frequency [Hz].