Class Opt3001

A Texas Instruments OPT3001 driven over an I2C bus, measuring on demand in single-shot mode.

Index

Constructors

Accessors

Methods

init measure setLimits

Constructors

constructor

new Opt3001(
    bus: actuators.I2cBus,
    address: number,
    settings?: sensors.Opt3001Settings | null,
): sensors.Opt3001
A driver for the part at address on bus. Nothing is sent until init or the first measure.
Parameters
- bus: actuators.I2cBus
- address: number
- Optionalsettings: sensors.Opt3001Settings | null
Returns sensors.Opt3001
- Defined in native/index.d.ts:2487

Accessors

configuration

get configuration(): sensors.Opt3001Config
The configuration the driver writes, with the part in shutdown.

Returns sensors.Opt3001Config
- Defined in native/index.d.ts:2504

Methods

init

init(): Promise<void>
Checks the part is an OPT3001 and writes the settings with the part in shutdown. Rejects when nothing answers or another part does.

Returns Promise<void>
- Defined in native/index.d.ts:2492

measure

measure(): Promise<sensors.Opt3001Reading>
Runs one conversion and resolves with the illuminance, initializing the part first if init has not run.

Returns Promise<sensors.Opt3001Reading>
- Defined in native/index.d.ts:2497

setLimits

setLimits(lowMilliLux: number, highMilliLux: number): Promise<void>
Writes the low and high limits the part's interrupt pin compares each result against, in millilux.
Parameters
- lowMilliLux: number
- highMilliLux: number
Returns Promise<void>
- Defined in native/index.d.ts:2502