View Source APDS9960.Proximity (apds9960 v0.4.0)
The proximity detection.
Link to this section Summary
Functions
Returns all the current proximity settings.
Link to this section Functions
Specs
clear_interrupt(APDS9960.Sensor.t()) :: :ok
Specs
enable(APDS9960.Sensor.t(), 0 | 1) :: :ok
Specs
enable_interrupt(APDS9960.Sensor.t(), 0 | 1) :: :ok
Specs
enable_saturation_interrupt(APDS9960.Sensor.t(), 0 | 1) :: :ok
Specs
enabled?(APDS9960.Sensor.t()) :: boolean()
Specs
get_gain(APDS9960.Sensor.t()) :: 0..3
Specs
get_gain_compensation(APDS9960.Sensor.t()) :: %{ enabled: boolean(), mask: byte() }
Specs
get_interrupt_persistence(APDS9960.Sensor.t()) :: 0..15
Specs
get_led_boost(APDS9960.Sensor.t()) :: 0..3
Specs
get_led_drive(APDS9960.Sensor.t()) :: 0..3
Specs
get_offset(APDS9960.Sensor.t()) :: %{down_left: -127..127, up_right: -127..127}
Specs
get_pulse(APDS9960.Sensor.t()) :: %{count: byte(), length: 0..3}
Specs
get_threshold(APDS9960.Sensor.t()) :: %{high: byte(), low: byte()}
Specs
interrupt_enabled?(APDS9960.Sensor.t()) :: boolean()
Specs
read_proximity(APDS9960.Sensor.t(), Enum.t()) :: byte()
Specs
saturation_interrupt_enabled?(APDS9960.Sensor.t()) :: boolean()
Specs
set_gain(APDS9960.Sensor.t(), 0..3) :: :ok
Specs
set_gain_compensation(APDS9960.Sensor.t(), 0..14) :: :ok
Specs
set_interrupt_persistence(APDS9960.Sensor.t(), 0..15) :: :ok
Specs
set_led_boost(APDS9960.Sensor.t(), 0..3) :: :ok
Specs
set_led_drive(APDS9960.Sensor.t(), 0..3) :: :ok
Specs
set_offset(APDS9960.Sensor.t(), Enum.t()) :: :ok
Specs
set_pulse(APDS9960.Sensor.t(), Enum.t()) :: :ok
Specs
set_threshold(APDS9960.Sensor.t(), Enum.t()) :: :ok
Specs
settings(APDS9960.Sensor.t()) :: %{ enabled: boolean(), gain: 0..3, gain_compensation: %{enabled: boolean(), mask: byte()}, interrupt_enabled: boolean(), interrupt_persistence: byte(), led_boost: 0..3, led_drive: 0..3, offset: %{down_left: integer(), up_right: integer()}, pulse: %{count: byte(), length: 0..3}, saturation_interrupt_enabled: boolean(), threshold: %{high: byte(), low: byte()} }
Returns all the current proximity settings.
Specs
status(APDS9960.Sensor.t()) :: %{ interrupt: boolean(), saturation: boolean(), valid: boolean() }