readProximity

Read the proximity from APDS9960 sensor

Since R2021b

Add-On Required: This feature requires the MATLAB Support Package for Arduino Hardware add-on.

Syntax

[proximity,timestamp] = readProximity(apds9960obj)

Description

[proximity,timestamp] = readProximity(apds9960obj) returns one reading of the proximity value with the timestamp. Timestamp argument is optional.

Examples

Read Proximity from Sensor

Create an Arduino object.

arduinoobj = arduino('COM4', 'Nano33BLE', 'Libraries', 'APDS9960');

Create the sensor object for the sensor in use.

apds9960obj = apds9960(arduinoobj)

Return one sample of the proximity data.

proximReadings = readProximity(apds9960obj)

proximReadings = 0.9647

Input Arguments

collapse all

`apds9960obj` — `APDS9960` sensor object
object

APDS9960 sensor connection, specified as a apds9960 sensor object.

Output Arguments

collapse all

`proximity` — Proximity value read from the sensor
scalar in the range of [0,1]

Proximity value read from the sensor, ranges from 0 and 1 with 0 being the most proximal.

Data Types: double

`timestamp` — Timestamp of the sensor data
datetime

The time at which MATLAB^® receives the proximity data from the sensor, specified as a datetime.

Version History

Introduced in R2021b