SPIKE-RT C API Reference [English]
An RTOS-based software platform for LEGO® Education SPIKE™.
Functions
Ultrasonic Sensor

APIs for ultrasonic sensors. More...

Functions

pup_device_tpup_ultrasonic_sensor_get_device (pbio_port_id_t port)
 Get the PUP device pointer of the ultrasonic sensor specified with the port ID. More...
 
int32_t pup_ultrasonic_sensor_distance (pup_device_t *pdev)
 Get the distance by a ultrasonic sensor. More...
 
bool pup_ultrasonic_sensor_presence (pup_device_t *pdev)
 Check a ultrasonic signal by a ultrasonic sensor. More...
 
pbio_error_t pup_ultrasonic_sensor_light_set (pup_device_t *pdev, int32_t bv1, int32_t bv2, int32_t bv3, int32_t bv4)
 Set the four light brightneses of the ultrasonic sensor. More...
 
pbio_error_t pup_ultrasonic_sensor_light_on (pup_device_t *pdev)
 Set the four light brightneses of the ultrasonic sensor. More...
 
pbio_error_t pup_ultrasonic_sensor_light_off (pup_device_t *pdev)
 Set the four light brightneses of the ultrasonic sensor. More...
 

Detailed Description

APIs for ultrasonic sensors.

Function Documentation

◆ pup_ultrasonic_sensor_distance()

int32_t pup_ultrasonic_sensor_distance ( pup_device_t pdev)

Get the distance by a ultrasonic sensor.

Always returns 0 (error log is output) when an invalid sensor number is specified.

Parameters
pdevPUP Device pointer to be inquired
Returns
Distance in centimeters.

◆ pup_ultrasonic_sensor_get_device()

pup_device_t * pup_ultrasonic_sensor_get_device ( pbio_port_id_t  port)

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

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

Parameters
portPUP port ID to be inquired.
Returns
pdev PUP device pointer.
NULL PUP device pointer.

◆ pup_ultrasonic_sensor_light_off()

pbio_error_t pup_ultrasonic_sensor_light_off ( pup_device_t pdev)

Set the four light brightneses of the ultrasonic sensor.

Parameters
pdevPUP デバイスポインタ.
Return values
errError number.

◆ pup_ultrasonic_sensor_light_on()

pbio_error_t pup_ultrasonic_sensor_light_on ( pup_device_t pdev)

Set the four light brightneses of the ultrasonic sensor.

Parameters
pdevPUP デバイスポインタ.
Return values
errError number.

◆ pup_ultrasonic_sensor_light_set()

pbio_error_t pup_ultrasonic_sensor_light_set ( pup_device_t pdev,
int32_t  bv1,
int32_t  bv2,
int32_t  bv3,
int32_t  bv4 
)

Set the four light brightneses of the ultrasonic sensor.

Parameters
pdevPUP デバイスポインタ.
bv1Brightness.
Return values
errError number.

◆ pup_ultrasonic_sensor_presence()

bool pup_ultrasonic_sensor_presence ( pup_device_t pdev)

Check a ultrasonic signal by a ultrasonic sensor.

When an invalid sensor support number is specified, always returns false (error log is output).

Parameters
portSensor port to be inquired
Return values
trueA signal has been received
falseNo signal has been received