Force Sensor

APIs for force sensors. More...

Functions
pup_device_t *	pup_force_sensor_get_device (pbio_port_id_t port)
	Get the PUP device pointer of the force sensor specified with the port ID. More...
float	pup_force_sensor_force (pup_device_t *pdev)
	Get the force detected by a force sensor. More...
float	pup_force_sensor_distance (pup_device_t *pdev)
	Get the distance how much force sensor's button has moved. More...
bool	pup_force_sensor_pressed (pup_device_t *pdev, float force)
	Check a force sensor's button is pressed. More...
bool	pup_force_sensor_touched (pup_device_t *pdev)
	Check a force sensor's button is touched. More...

Detailed Description

APIs for force sensors.

Function Documentation

pup_force_sensor_distance()

float pup_force_sensor_distance

(

pup_device_t *

pdev

)

Get the distance how much force sensor's button has moved.

Parameters

pdev	PUP devie pointer to be inquired.

Returns

Distance in millimeters.

pup_force_sensor_force()

float pup_force_sensor_force

(

pup_device_t *

pdev

)

Get the force detected by a force sensor.

Parameters

pdev	PUP devie pointer to be inquired.

Returns

Force in newton.

pup_force_sensor_get_device()

pup_device_t * pup_force_sensor_get_device

(

pbio_port_id_t

port

)

Get the PUP device pointer of the force sensor specified with the port ID.

If it fails, it outputs an error log and returns NULL.

Parameters

port	PUP port ID to be inquired.

Returns

pdev PUP device pointer.

pup_force_sensor_pressed()

bool pup_force_sensor_pressed	(	pup_device_t *	pdev,
		float	force
	)

Check a force sensor's button is pressed.

Parameters

pdev	PUP devie pointer to be inquired.
force	Minimum force in newton to be considerd as pressed.

Returns

true The button is pressed.

false The button is not pressed.

pup_force_sensor_touched()

bool pup_force_sensor_touched

(

pup_device_t *

pdev

)

Check a force sensor's button is touched.

Parameters

pdev	PUP devie pointer to be inquired.

Returns

true The button is touched.

false The button is not touched.