Loom_AS7263 class

AS7263 Near Infrared spectrum spectral sensor module.

Reference

Base classes

class LoomI2CSensor: Abstract root for I2C sensor modules.

Protected variables

AS726X inst_AS7263: Underlying AS7263 sensor manager instance.
uint16_t nir_vals: Measured near-infra-red band values (r,s,t,u,v,w).
bool use_bulb: Whether or not to use bulb.
uint8_t gain: Gain setting.
uint8_t mode: Sensor read mode.
uint8_t integration_time: Integration time setting.

CONSTRUCTORS / DESTRUCTOR

Loom_AS7263(LoomManager* manager, const byte i2c_address = 0x49, const uint8_t mux_port = 255, const bool use_bulb = false, const uint8_t gain = 1, const uint8_t mode = 3, const uint8_t integration_time = 50): Constructor.
Loom_AS7263(LoomManager* manager, JsonArrayConst p): Constructor that takes Json Array, extracts args and delegates to regular constructor.
~Loom_AS7263() defaulted: Destructor.

OPERATION

void measure() override: Take any relevant measurements.
void package(JsonObject json) override: Package a modules measurements or state.

PRINT INFORMATION

void print_config() const override: Display the configuration settings of the module.
void print_measurements() const override: Print the last set of measurements taken.

SETTERS

void enable_bulb(const bool enable): Set whether not bulb is used for active light source.
void set_gain(const uint8_t gain): Set gain.
void set_mode(const uint8_t mode): Set mode.
void set_integration_time(const uint8_t time): Set integration time.

Function documentation

Loom_AS7263::Loom_AS7263(LoomManager* manager, const byte i2c_address = 0x49, const uint8_t mux_port = 255, const bool use_bulb = false, const uint8_t gain = 1, const uint8_t mode = 3, const uint8_t integration_time = 50)

Constructor.

Parameters
manager
i2c_address in	Set(Int) \| <0x49> \| {0x49} \| I2C address
mux_port in	Int \| <255> \| [0-16] \| Port on multiplexer
use_bulb in	Bool \| <false> \| {true, false} \| Whether or not to use bulb
gain in	Set(Int) \| <1> \| { 0("1x"), 1("3.7x"), 2("16x"), 3("64x") } \| Gain level
mode in	Set(Int) \| <3> \| { 0("Continuous reading of STUV"), 1("Continuous reading of RTUX"), 2("Continuous reading all channels"), 3("One-shot reading of all channels") } \| Read mode
integration_time in	Int \| <50> \| [0-255] \| Integration time (time will be 2.8ms * [integration value])

Loom_AS7263::Loom_AS7263(LoomManager* manager, JsonArrayConst p)

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters
manager
p in	The array of constuctor args to expand

void Loom_AS7263::package(JsonObject json) override

Package a modules measurements or state.

Parameters
json out	Object to put data into

void Loom_AS7263::print_measurements() const override

Print the last set of measurements taken.

Does not package the data.

void Loom_AS7263::enable_bulb(const bool enable)

Set whether not bulb is used for active light source.

Parameters
enable in	Whether or not to enable bulb

void Loom_AS7263::set_gain(const uint8_t gain)

Set gain.

Parameters
gain in	Gain level: 0: 1x (power-on default), 1: 3.7x, 2: 16x, 3: 64x

void Loom_AS7263::set_mode(const uint8_t mode)

Set mode.

Parameters
mode in	Mode 0: Continuous reading of STUV 1: Continuous reading of RTUX 2: Continuous reading of all channels (power-on default) 3: One-shot reading of all channels

void Loom_AS7263::set_integration_time(const uint8_t time)

Set integration time.

Parameters
time in	Integration time

Time will be 2.8ms * [integration value] (0-255), 50 is default

Variable documentation

uint16_t Loom_AS7263::nir_vals protected

Measured near-infra-red band values (r,s,t,u,v,w).

Units: counts / (μW/cm^2).