Adafruit_AS7341.h

Go to the documentation of this file.

/*
  This library is adapted from an example with the following Copyright and
  Warranty:

  This is a Hello world example code written for the AS7241 XWing Spectral
  Sensor I2C interface with Arduino µC. The main idea is to get fimilar with the
  register configuration. This code helps to learn basic settings and procedure
  to read out raw values with different SMUX configuration. Also defined the
  procedure to set the default flicker detection for 100 and 120 Hz.

  Written by Sijo John @ ams AG, Application Support in October, 2018

  Development environment specifics: Arduino IDE 1.8.5

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

*/

#ifndef _ADAFRUIT_AS7341_H
#define _ADAFRUIT_AS7341_H

#include "Arduino.h"
#include <Adafruit_BusIO_Register.h>
#include <Adafruit_I2CDevice.h>
#include <Wire.h>
#define AS7341_I2CADDR_DEFAULT 0x39 
#define AS7341_CHIP_ID 0x09         

#define AS7341_WHOAMI 0x92 

#define AS7341_ASTATUS 0x60     
#define AS7341_CH0_DATA_L_ 0x61 
#define AS7341_CH0_DATA_H_ 0x62 
#define AS7341_ITIME_L 0x63     
#define AS7341_ITIME_M 0x64     
#define AS7341_ITIME_H 0x65     
#define AS7341_CONFIG 0x70 
#define AS7341_STAT 0x71   
#define AS7341_EDGE 0x72   
#define AS7341_GPIO 0x73   
#define AS7341_LED 0x74    
#define AS7341_ENABLE                                                          \
  0x80 
#define AS7341_ATIME 0x81       
#define AS7341_WTIME 0x83       
#define AS7341_SP_LOW_TH_L 0x84 
#define AS7341_SP_LOW_TH_H                                                     \
  0x85 
#define AS7341_SP_HIGH_TH_L                                                    \
  0x86 
#define AS7341_SP_HIGH_TH_H                                                    \
  0x87                    
#define AS7341_AUXID 0x90 
#define AS7341_REVID 0x91 
#define AS7341_ID 0x92    
#define AS7341_STATUS                                                          \
  0x93 
#define AS7341_ASTATUS_ 0x94   
#define AS7341_CH0_DATA_L 0x95 
#define AS7341_CH0_DATA_H 0x96 
#define AS7341_CH1_DATA_L 0x97 
#define AS7341_CH1_DATA_H 0x98 
#define AS7341_CH2_DATA_L 0x99 
#define AS7341_CH2_DATA_H 0x9A 
#define AS7341_CH3_DATA_L 0x9B 
#define AS7341_CH3_DATA_H 0x9C 
#define AS7341_CH4_DATA_L 0x9D 
#define AS7341_CH4_DATA_H 0x9E 
#define AS7341_CH5_DATA_L 0x9F 
#define AS7341_CH5_DATA_H 0xA0 
#define AS7341_STATUS2 0xA3 
#define AS7341_STATUS3                                                         \
  0xA4 
#define AS7341_STATUS5 0xA6 
#define AS7341_STATUS6 0xA7 
#define AS7341_CFG0                                                            \
  0xA9 
#define AS7341_CFG1 0xAA 
#define AS7341_CFG3 0xAC 
#define AS7341_CFG6 0xAF 
#define AS7341_CFG8 0xB1 
#define AS7341_CFG9                                                            \
  0xB2 
#define AS7341_CFG10 0xB3 
#define AS7341_CFG12                                                           \
  0xB5 
#define AS7341_PERS                                                            \
  0xBD 
#define AS7341_GPIO2                                                           \
  0xBE 
#define AS7341_ASTEP_L 0xCA      
#define AS7341_ASTEP_H 0xCB      
#define AS7341_AGC_GAIN_MAX 0xCF 
#define AS7341_AZ_CONFIG 0xD6    
#define AS7341_FD_TIME1 0xD8 
#define AS7341_FD_TIME2 0xDA 
#define AS7341_FD_CFG0 0xD7  
#define AS7341_FD_STATUS                                                       \
  0xDB 
#define AS7341_INTENAB 0xF9  
#define AS7341_CONTROL 0xFA  
#define AS7341_FIFO_MAP 0xFC 
#define AS7341_FIFO_LVL 0xFD 
#define AS7341_FDATA_L 0xFE  
#define AS7341_FDATA_H 0xFF  

#define AS7341_SPECTRAL_INT_HIGH_MSK                                           \
  0b00100000 
#define AS7341_SPECTRAL_INT_LOW_MSK                                            \
  0b00010000 


typedef enum {
  AS7341_GAIN_0_5X,
  AS7341_GAIN_1X,
  AS7341_GAIN_2X,
  AS7341_GAIN_4X,
  AS7341_GAIN_8X,
  AS7341_GAIN_16X,
  AS7341_GAIN_32X,
  AS7341_GAIN_64X,
  AS7341_GAIN_128X,
  AS7341_GAIN_256X,
  AS7341_GAIN_512X,
} as7341_gain_t;

typedef enum {
  AS7341_SMUX_CMD_ROM_RESET, 
  AS7341_SMUX_CMD_READ,      
  AS7341_SMUX_CMD_WRITE, 
} as7341_smux_cmd_t;
typedef enum {
  AS7341_ADC_CHANNEL_0,
  AS7341_ADC_CHANNEL_1,
  AS7341_ADC_CHANNEL_2,
  AS7341_ADC_CHANNEL_3,
  AS7341_ADC_CHANNEL_4,
  AS7341_ADC_CHANNEL_5,
} as7341_adc_channel_t;
typedef enum {
  AS7341_CHANNEL_415nm_F1,
  AS7341_CHANNEL_445nm_F2,
  AS7341_CHANNEL_480nm_F3,
  AS7341_CHANNEL_515nm_F4,
  AS7341_CHANNEL_CLEAR_0,
  AS7341_CHANNEL_NIR_0,
  AS7341_CHANNEL_555nm_F5,
  AS7341_CHANNEL_590nm_F6,
  AS7341_CHANNEL_630nm_F7,
  AS7341_CHANNEL_680nm_F8,
  AS7341_CHANNEL_CLEAR,
  AS7341_CHANNEL_NIR,
} as7341_color_channel_t;

typedef enum {
  AS7341_INT_COUNT_ALL, 
  AS7341_INT_COUNT_1,   
  AS7341_INT_COUNT_2,   
  AS7341_INT_COUNT_3,   
  AS7341_INT_COUNT_5,   
  AS7341_INT_COUNT_10,  
  AS7341_INT_COUNT_15,  
  AS7341_INT_COUNT_20,  
  AS7341_INT_COUNT_25,  
  AS7341_INT_COUNT_30,  
  AS7341_INT_COUNT_35,  
  AS7341_INT_COUNT_40,  
  AS7341_INT_COUNT_45,  
  AS7341_INT_COUNT_50,  
  AS7341_INT_COUNT_55,  
  AS7341_INT_COUNT_60,  
} as7341_int_cycle_count_t;

typedef enum {
  AS7341_GPIO_OUTPUT, 
  AS7341_GPIO_INPUT,  
} as7341_gpio_dir_t;

typedef enum {
  AS7341_WAITING_START, //
  AS7341_WAITING_LOW,   //
  AS7341_WAITING_HIGH,  //
  AS7341_WAITING_DONE,  //
} as7341_waiting_t;

class Adafruit_AS7341;

class Adafruit_AS7341 {
public:
  Adafruit_AS7341();
  ~Adafruit_AS7341();

  bool begin(uint8_t i2c_addr = AS7341_I2CADDR_DEFAULT, TwoWire *wire = &Wire,
             int32_t sensor_id = 0);

  bool setASTEP(uint16_t astep_value);
  bool setATIME(uint8_t atime_value);
  bool setGain(as7341_gain_t gain_value);

  uint16_t getASTEP();
  uint8_t getATIME();
  as7341_gain_t getGain();

  long getTINT();
  float toBasicCounts(uint16_t raw);

  bool readAllChannels(void);
  bool readAllChannels(uint16_t *readings_buffer);
  void delayForData(int waitTime = 0);
  uint16_t readChannel(as7341_adc_channel_t channel);
  uint16_t getChannel(as7341_color_channel_t channel);

  bool startReading(void);
  bool checkReadingProgress();
  bool getAllChannels(uint16_t *readings_buffer);

  uint16_t detectFlickerHz(void);

  void setup_F1F4_Clear_NIR(void);
  void setup_F5F8_Clear_NIR(void);

  void powerEnable(bool enable_power);
  bool enableSpectralMeasurement(bool enable_measurement);

  bool setHighThreshold(uint16_t high_threshold);
  bool setLowThreshold(uint16_t low_threshold);

  uint16_t getHighThreshold(void);
  uint16_t getLowThreshold(void);

  bool enableSpectralInterrupt(bool enable_int);
  bool enableSystemInterrupt(bool enable_int);

  bool setAPERS(as7341_int_cycle_count_t cycle_count);
  bool setSpectralThresholdChannel(as7341_adc_channel_t channel);

  uint8_t getInterruptStatus(void);
  bool clearInterruptStatus(void);

  bool spectralInterruptTriggered(void);
  uint8_t spectralInterruptSource(void);
  bool spectralLowTriggered(void);
  bool spectralHighTriggered(void);

  bool enableLED(bool enable_led);
  bool setLEDCurrent(uint16_t led_current_ma);
  uint16_t getLEDCurrent(void);

  void disableAll(void);

  bool getIsDataReady();
  bool setBank(bool low); // low true gives access to 0x60 to 0x74

  as7341_gpio_dir_t getGPIODirection(void);
  bool setGPIODirection(as7341_gpio_dir_t gpio_direction);
  bool getGPIOInverted(void);
  bool setGPIOInverted(bool gpio_inverted);
  bool getGPIOValue(void);
  bool setGPIOValue(bool);

protected:
  virtual bool _init(int32_t sensor_id);
  uint8_t last_spectral_int_source =
      0; 

  Adafruit_I2CDevice *i2c_dev = NULL; 

private:
  bool enableSMUX(void);
  bool enableFlickerDetection(bool enable_fd);
  void FDConfig(void);
  int8_t getFlickerDetectStatus(void);
  bool setSMUXCommand(as7341_smux_cmd_t command);
  void writeRegister(byte addr, byte val);
  void setSMUXLowChannels(bool f1_f4);
  uint16_t _channel_readings[12];
  as7341_waiting_t _readingState;
};

#endif