Nol.A SDK Library 26.11.2
For IoT System Software Development
Loading...
Searching...
No Matches
Topics | Files | Classes | Macros | Typedefs | Enumerations | Variables
Device Drivers

Sensor, display, storage, and peripheral driver APIs. More...

Topics

 VL53L0 Platform Functions
 VL53L0 Platform Functions.
 VL53L0X Defines
 VL53L0X Defines.
 VL53L0X cut1.1 Function Definition
 VL53L0X cut1.1 Function Definition.
 VL53L0X cut1.1 Device Specific
 VL53L0X cut1.1 Device Specific Defines.
 Calc_sigma_estimate

Files

file  include/dev/AcCurrentSensor.hpp
 Public driver declarations and configuration constants.
file  include/dev/Adafruit_ADS1X15.hpp
file  include/dev/Adafruit_AMG88xx.hpp
 Public driver declarations and configuration constants.
file  include/dev/Adafruit_GFX.hpp
 Public driver declarations and configuration constants.
file  include/dev/Adafruit_NeoPixel.hpp
 Public driver declarations and configuration constants.
file  include/dev/Adafruit_SSD1306.hpp
file  include/dev/Adafruit_SSD1306_splash.h
 Built-in SSD1306 startup bitmap data; not a callable driver API.
file  include/dev/Adafruit_VC0706.hpp
 Public driver declarations and configuration constants.
file  include/dev/Adafruit_VL53L0X.hpp
file  include/dev/Adafruit_VS1053.hpp
 Public driver declarations and configuration constants.
file  include/dev/CM1106.hpp
 Public driver declarations and configuration constants.
file  include/dev/Dogm128_6.hpp
 Public driver declarations and configuration constants.
file  include/dev/EVAM8M.hpp
 Public driver declarations and configuration constants.
file  include/dev/GPS.hpp
 Public driver declarations and configuration constants.
file  include/dev/HTU20D.hpp
 Public driver declarations and configuration constants.
file  include/dev/HTU2xD.hpp
 Public driver declarations and configuration constants.
file  include/dev/HX711.hpp
 Public driver declarations and configuration constants.
file  include/dev/KXM12864M_3.hpp
 Public driver declarations and configuration constants.
file  include/dev/LiquidCrystal_I2C.hpp
 Public driver declarations and configuration constants.
file  include/dev/M25P32.hpp
 Public driver declarations and configuration constants.
file  include/dev/MCP391x.hpp
 Public driver declarations and configuration constants.
file  include/dev/MMA8452Q.hpp
 Public driver declarations and configuration constants.
file  include/dev/MT3339.hpp
 Public driver declarations and configuration constants.
file  include/dev/MaxBotix_HRXL_MaxSonar_WR.hpp
 Public driver declarations and configuration constants.
file  include/dev/ORG4400.hpp
 Public driver declarations and configuration constants.
file  include/dev/PCF8574.hpp
 Public driver declarations and configuration constants.
file  include/dev/PMS3003.hpp
 Public driver declarations and configuration constants.
file  include/dev/PMS7003.hpp
 Public driver declarations and configuration constants.
file  include/dev/RHT03.hpp
 Public driver declarations and configuration constants.
file  include/dev/SHTSensor.hpp
 Public driver declarations and configuration constants.
file  include/dev/ST7920.hpp
 Public driver declarations and configuration constants.
file  include/dev/SparkFun_BQ27441.hpp
 Public driver declarations and configuration constants.
file  include/dev/SparkFun_CCS811.hpp
 Public driver declarations and configuration constants.
file  include/dev/SparkFun_VEML6030.hpp
 Public driver declarations and configuration constants.
file  include/dev/T9602_I2C.hpp
 Public driver declarations and configuration constants.
file  include/dev/TM1637Display.hpp
 Public driver declarations and configuration constants.
file  include/dev/VC0706.hpp
 Public driver declarations and configuration constants.
file  include/dev/VL53L5CX.hpp
 Public driver declarations and configuration constants.
file  include/dev/gfxfont.hpp
 Glyph and font storage formats used by Adafruit_GFX.

Classes

class  AcCurrentSensor
 Peak-sampling AC current estimator. Call Sense() to update the public readings. More...
class  Adafruit_ADS1X15
 Sensor driver for the Adafruit ADS1X15 ADC breakouts. More...
class  Adafruit_ADS1015
 Sensor driver for the Adafruit ADS1015 ADC breakout. More...
class  Adafruit_ADS1115
 Sensor driver for the Adafruit ADS1115 ADC breakout. More...
class  Adafruit_AMG88xx
 Class that stores state and functions for interacting with AMG88xx IR sensor chips. More...
class  Adafruit_GFX
 Device-independent drawing and text interface derived from Print. More...
class  Adafruit_GFX_Button
 Drawable button geometry with application-supplied press state. More...
class  GFXcanvas1
 Owned off-screen monochrome drawing surface. More...
class  GFXcanvas8
 Owned off-screen 8-bit drawing surface. More...
class  GFXcanvas16
 Owned off-screen RGB565 drawing surface. More...
class  Adafruit_NeoPixel
 Buffered RGB/RGBW LED strip driver. Keep the object alive while using its buffer. More...
class  Adafruit_SSD1306
 Class that stores state and functions for interacting with SSD1306 OLED displays. More...
class  Adafruit_VC0706
 Blocking VC0706 UART camera commands. Call begin() before camera access. Returned buffers belong to the driver and are overwritten by subsequent commands. Boolean command results normally indicate acknowledgement, except setPTZ(). More...
class  Adafruit_VL53L0X
 Class that stores state and functions for interacting with VL53L0X time-of-flight sensor chips. More...
class  CM1106
 Asynchronous CM1106 UART CO2 sensor. Call begin() before measurement(). More...
class  Dogm128_6
 Buffered DOGM128-6 128x64 SPI display. Call begin(), draw into buffer, then lcdSendBuffer(buffer) to transfer the image. More...
class  EVAM8M
 EVA-M8M NMEA receiver. Call begin(), register callbacks, then turnOn(). The UART must outlive the driver; turnOn()/turnOff() control listening only. More...
class  Gps
 Common GPS callback interface and NMEA parsers for device-specific drivers. More...
class  HTU20D
 Timer-driven asynchronous HTU20D temperature and humidity driver. Initialize the I2C bus, call begin(), and register callbacks before requesting readings. Keep the driver and bus alive until the measurement completes. More...
class  HTU2xD
 Synchronous HTU2xD I2C temperature and humidity driver at address 0x40. Call begin() first. Reads do not validate CRC or return communication errors. More...
class  Hx711
 Nol.A library for digital weight scale based on HX711. More...
class  KXM12864M_3
 128x64 ST7920 panel with the KXM12864M-3 split GDRAM layout. Initialize and draw through ST7920, then call invalidate(). More...
class  LiquidCrystal_I2C
 HD44780-compatible character display through an I2C backpack. Inherits Print for formatted text. The I2C bus must outlive the display. More...
class  M25P32
 Nol.A library for M25P32 Micron 32Mb Serial NOR Flash Memory. More...
class  MCP391x
 SPI driver for MCP391x multi-channel ADCs. Call begin() before reads. I2C operation and the declared streaming entry points are not implemented. More...
class  MMA8452Q
 MMA8452Q accelerometer register driver with optional interrupt GPIOs. Initialize the I2C bus before begin(); communication errors are not reported. More...
class  MT3339
 MT3339 UART NMEA receiver. Call begin(), register callbacks, then turnOn(). Cached sentence pointers belong to the driver and must not be freed. A new sentence can replace its cache; VTG reception clears RMC/GGA/GSA/GSV caches after onNMEAReceived returns. Copy needed sentences within that callback. More...
class  MaxBotix_HRXL_MaxSonar_WR
 UART ultrasonic range reader. Call begin() then turnOn(). The driver and serial port must remain alive while receiving or awaiting timeout. More...
class  ORG4400
 ORG4400 GPS receiver with on/off pulse and wakeup-status GPIOs. Call begin() and register the device-specific callback before enabling reception. More...
class  PCF8574
 PCF8574 eight-pin quasi-bidirectional I2C expander. Call begin() first. Release input pins by writing 1; check lastError() after I/O. More...
class  PMS3003
 Asynchronous Plantower PMS3003 particulate sensor. Call begin() and install a callback; keep the UART and driver alive while receiving. More...
class  PMS7003
 PMS7003 particulate sensor with particle-count reporting. Use inherited begin() before receiving measurements. More...
class  RHT03
 Blocking RHT03 temperature/humidity reader. Call begin(), then update() before accessing cached readings; the caller controls the sampling interval. More...
class  SHTSensor
class  SHTSensorDriver
class  SHTI2cSensor
class  SHT3xAnalogSensor
 Analog SHT3x reader with configurable ADC resolution. More...
class  ST7920
 Buffered monochrome ST7920 SPI display. Call begin(), clearDisplay(), draw with Adafruit_GFX methods, then invalidate() to update the panel. More...
class  BQ27441
 BQ27441 battery fuel-gauge interface. Call begin() before other operations. The I2C bus is borrowed and must outlive the driver. More...
class  CCS811Core
 Low-level CCS811 I2C register transport. The current register helpers return SENSOR_SUCCESS without validating transfers. More...
class  CCS811
 CCS811 gas sensor with cached eCO2 and TVOC results. Call begin(), allow measurements to accumulate, then readAlgorithmResults() before reading the cached getters. The driver does not report transport failures. More...
class  SparkFun_VEML6030
 VEML6030 ambient and white-light sensor driver. Register reads/writes do not expose transport error status. Configure gain and integration time before setting lux-based interrupt thresholds. More...
class  T9602_I2C
 Synchronous T9602 humidity and temperature reader. Call begin() first. Communication errors and sensor status are not reported. More...
class  TM1637Display
 GPIO-driven TM1637 segment display. Call setBrightness() before the first update. Buffered brightness is applied on the next setSegments() or number display operation. More...
class  VC0706
 Asynchronous UART JPEG camera with timer-driven command handling. Call begin() before commands and keep the driver/UART alive during callbacks. Commands share a state machine; do not overlap capture and command sequences. More...
class  VL53L5CX
 VL53L5CX multi-zone time-of-flight sensor wrapper. Call begin(), configure while stopped, then startRanging(). Poll checkDataReady() before getRangingData(). Status-returning methods use ST codes (0 = success). Keep this object and VL53L5CX_ResultsData in static storage on embedded targets. More...
struct  GFXglyph
 Metrics and bitmap offset for one GFX font glyph. More...
struct  GFXfont
 Borrowed bitmap/glyph tables and character range for Adafruit_GFX::setFont(). More...

Macros

#define dataNum   3000
 Number of analog samples acquired by one AcCurrentSensor::Sense() call.
#define ADS1X15_ADDRESS   (0x48)
 1001 000 (ADDR = GND)
#define ADS1X15_REG_POINTER_MASK   (0x03)
 Point mask.
#define ADS1X15_REG_POINTER_CONVERT   (0x00)
 Conversion.
#define ADS1X15_REG_POINTER_CONFIG   (0x01)
 Configuration.
#define ADS1X15_REG_POINTER_LOWTHRESH   (0x02)
 Low threshold.
#define ADS1X15_REG_POINTER_HITHRESH   (0x03)
 High threshold.
#define ADS1X15_REG_CONFIG_OS_MASK   (0x8000)
 OS Mask.
#define ADS1X15_REG_CONFIG_OS_SINGLE   (0x8000)
 Write: Set to start a single-conversion.
#define ADS1X15_REG_CONFIG_OS_BUSY   (0x0000)
 Read: Bit = 0 when conversion is in progress.
#define ADS1X15_REG_CONFIG_OS_NOTBUSY   (0x8000)
 Read: Bit = 1 when device is not performing a conversion.
#define ADS1X15_REG_CONFIG_MUX_MASK   (0x7000)
 Mux Mask.
#define ADS1X15_REG_CONFIG_MUX_DIFF_0_1   (0x0000)
 Differential P = AIN0, N = AIN1 (default).
#define ADS1X15_REG_CONFIG_MUX_DIFF_0_3   (0x1000)
 Differential P = AIN0, N = AIN3.
#define ADS1X15_REG_CONFIG_MUX_DIFF_1_3   (0x2000)
 Differential P = AIN1, N = AIN3.
#define ADS1X15_REG_CONFIG_MUX_DIFF_2_3   (0x3000)
 Differential P = AIN2, N = AIN3.
#define ADS1X15_REG_CONFIG_MUX_SINGLE_0   (0x4000)
 Single-ended AIN0.
#define ADS1X15_REG_CONFIG_MUX_SINGLE_1   (0x5000)
 Single-ended AIN1.
#define ADS1X15_REG_CONFIG_MUX_SINGLE_2   (0x6000)
 Single-ended AIN2.
#define ADS1X15_REG_CONFIG_MUX_SINGLE_3   (0x7000)
 Single-ended AIN3.
#define ADS1X15_REG_CONFIG_PGA_MASK   (0x0E00)
 PGA Mask.
#define ADS1X15_REG_CONFIG_PGA_6_144V   (0x0000)
 +/-6.144V range = Gain 2/3
#define ADS1X15_REG_CONFIG_PGA_4_096V   (0x0200)
 +/-4.096V range = Gain 1
#define ADS1X15_REG_CONFIG_PGA_2_048V   (0x0400)
 +/-2.048V range = Gain 2 (default)
#define ADS1X15_REG_CONFIG_PGA_1_024V   (0x0600)
 +/-1.024V range = Gain 4
#define ADS1X15_REG_CONFIG_PGA_0_512V   (0x0800)
 +/-0.512V range = Gain 8
#define ADS1X15_REG_CONFIG_PGA_0_256V   (0x0A00)
 +/-0.256V range = Gain 16
#define ADS1X15_REG_CONFIG_MODE_MASK   (0x0100)
 Mode Mask.
#define ADS1X15_REG_CONFIG_MODE_CONTIN   (0x0000)
 Continuous conversion mode.
#define ADS1X15_REG_CONFIG_MODE_SINGLE   (0x0100)
 Power-down single-shot mode (default).
#define ADS1X15_REG_CONFIG_RATE_MASK   (0x00E0)
 Data Rate Mask.
#define ADS1X15_REG_CONFIG_CMODE_MASK   (0x0010)
 CMode Mask.
#define ADS1X15_REG_CONFIG_CMODE_TRAD   (0x0000)
 Traditional comparator with hysteresis (default).
#define ADS1X15_REG_CONFIG_CMODE_WINDOW   (0x0010)
 Window comparator.
#define ADS1X15_REG_CONFIG_CPOL_MASK   (0x0008)
 CPol Mask.
#define ADS1X15_REG_CONFIG_CPOL_ACTVLOW   (0x0000)
 ALERT/RDY pin is low when active (default).
#define ADS1X15_REG_CONFIG_CPOL_ACTVHI   (0x0008)
 ALERT/RDY pin is high when active.
#define ADS1X15_REG_CONFIG_CLAT_MASK   (0x0004)
 Determines if ALERT/RDY pin latches once asserted.
#define ADS1X15_REG_CONFIG_CLAT_NONLAT   (0x0000)
 Non-latching comparator (default).
#define ADS1X15_REG_CONFIG_CLAT_LATCH   (0x0004)
 Latching comparator.
#define ADS1X15_REG_CONFIG_CQUE_MASK   (0x0003)
 CQue Mask.
#define ADS1X15_REG_CONFIG_CQUE_1CONV   (0x0000)
 Assert ALERT/RDY after one conversions.
#define ADS1X15_REG_CONFIG_CQUE_2CONV   (0x0001)
 Assert ALERT/RDY after two conversions.
#define ADS1X15_REG_CONFIG_CQUE_4CONV   (0x0002)
 Assert ALERT/RDY after four conversions.
#define ADS1X15_REG_CONFIG_CQUE_NONE   (0x0003)
 Disable the comparator and put ALERT/RDY in high state (default).
#define RATE_ADS1015_128SPS   (0x0000)
 128 samples per second
#define RATE_ADS1015_250SPS   (0x0020)
 250 samples per second
#define RATE_ADS1015_490SPS   (0x0040)
 490 samples per second
#define RATE_ADS1015_920SPS   (0x0060)
 920 samples per second
#define RATE_ADS1015_1600SPS   (0x0080)
 1600 samples per second (default)
#define RATE_ADS1015_2400SPS   (0x00A0)
 2400 samples per second
#define RATE_ADS1015_3300SPS   (0x00C0)
 3300 samples per second
#define RATE_ADS1115_8SPS   (0x0000)
 8 samples per second
#define RATE_ADS1115_16SPS   (0x0020)
 16 samples per second
#define RATE_ADS1115_32SPS   (0x0040)
 32 samples per second
#define RATE_ADS1115_64SPS   (0x0060)
 64 samples per second
#define RATE_ADS1115_128SPS   (0x0080)
 128 samples per second (default)
#define RATE_ADS1115_250SPS   (0x00A0)
 250 samples per second
#define RATE_ADS1115_475SPS   (0x00C0)
 475 samples per second
#define RATE_ADS1115_860SPS   (0x00E0)
 860 samples per second
#define AMG88xx_ADDRESS   (0x69)
 Default 7-bit AMG88xx address.
#define AMG88xx_PIXEL_ARRAY_SIZE   64
 Number of pixels in the 8 by 8 thermal array.
#define AMG88xx_PIXEL_TEMP_CONVERSION   .25
 Degrees Celsius per raw infrared pixel count.
#define AMG88xx_THERMISTOR_CONVERSION   .0625
 Degrees Celsius per raw thermistor count.
#define NEO_RGB   ((0 << 6) | (0 << 4) | (1 << 2) | (2))
 NeoPixel byte order: RGB. Combine with a NEO_KHZ* signaling rate.
#define NEO_RBG   ((0 << 6) | (0 << 4) | (2 << 2) | (1))
 NeoPixel byte order: RBG. Combine with a NEO_KHZ* signaling rate.
#define NEO_GRB   ((1 << 6) | (1 << 4) | (0 << 2) | (2))
 NeoPixel byte order: GRB. Combine with a NEO_KHZ* signaling rate.
#define NEO_GBR   ((2 << 6) | (2 << 4) | (0 << 2) | (1))
 NeoPixel byte order: GBR. Combine with a NEO_KHZ* signaling rate.
#define NEO_BRG   ((1 << 6) | (1 << 4) | (2 << 2) | (0))
 NeoPixel byte order: BRG. Combine with a NEO_KHZ* signaling rate.
#define NEO_BGR   ((2 << 6) | (2 << 4) | (1 << 2) | (0))
 NeoPixel byte order: BGR. Combine with a NEO_KHZ* signaling rate.
#define NEO_WRGB   ((0 << 6) | (1 << 4) | (2 << 2) | (3))
 NeoPixel byte order: WRGB. Combine with a NEO_KHZ* signaling rate.
#define NEO_WRBG   ((0 << 6) | (1 << 4) | (3 << 2) | (2))
 NeoPixel byte order: WRBG. Combine with a NEO_KHZ* signaling rate.
#define NEO_WGRB   ((0 << 6) | (2 << 4) | (1 << 2) | (3))
 NeoPixel byte order: WGRB. Combine with a NEO_KHZ* signaling rate.
#define NEO_WGBR   ((0 << 6) | (3 << 4) | (1 << 2) | (2))
 NeoPixel byte order: WGBR. Combine with a NEO_KHZ* signaling rate.
#define NEO_WBRG   ((0 << 6) | (2 << 4) | (3 << 2) | (1))
 NeoPixel byte order: WBRG. Combine with a NEO_KHZ* signaling rate.
#define NEO_WBGR   ((0 << 6) | (3 << 4) | (2 << 2) | (1))
 NeoPixel byte order: WBGR. Combine with a NEO_KHZ* signaling rate.
#define NEO_RWGB   ((1 << 6) | (0 << 4) | (2 << 2) | (3))
 NeoPixel byte order: RWGB. Combine with a NEO_KHZ* signaling rate.
#define NEO_RWBG   ((1 << 6) | (0 << 4) | (3 << 2) | (2))
 NeoPixel byte order: RWBG. Combine with a NEO_KHZ* signaling rate.
#define NEO_RGWB   ((2 << 6) | (0 << 4) | (1 << 2) | (3))
 NeoPixel byte order: RGWB. Combine with a NEO_KHZ* signaling rate.
#define NEO_RGBW   ((3 << 6) | (0 << 4) | (1 << 2) | (2))
 NeoPixel byte order: RGBW. Combine with a NEO_KHZ* signaling rate.
#define NEO_RBWG   ((2 << 6) | (0 << 4) | (3 << 2) | (1))
 NeoPixel byte order: RBWG. Combine with a NEO_KHZ* signaling rate.
#define NEO_RBGW   ((3 << 6) | (0 << 4) | (2 << 2) | (1))
 NeoPixel byte order: RBGW. Combine with a NEO_KHZ* signaling rate.
#define NEO_GWRB   ((1 << 6) | (2 << 4) | (0 << 2) | (3))
 NeoPixel byte order: GWRB. Combine with a NEO_KHZ* signaling rate.
#define NEO_GWBR   ((1 << 6) | (3 << 4) | (0 << 2) | (2))
 NeoPixel byte order: GWBR. Combine with a NEO_KHZ* signaling rate.
#define NEO_GRWB   ((2 << 6) | (1 << 4) | (0 << 2) | (3))
 NeoPixel byte order: GRWB. Combine with a NEO_KHZ* signaling rate.
#define NEO_GRBW   ((3 << 6) | (1 << 4) | (0 << 2) | (2))
 NeoPixel byte order: GRBW. Combine with a NEO_KHZ* signaling rate.
#define NEO_GBWR   ((2 << 6) | (3 << 4) | (0 << 2) | (1))
 NeoPixel byte order: GBWR. Combine with a NEO_KHZ* signaling rate.
#define NEO_GBRW   ((3 << 6) | (2 << 4) | (0 << 2) | (1))
 NeoPixel byte order: GBRW. Combine with a NEO_KHZ* signaling rate.
#define NEO_BWRG   ((1 << 6) | (2 << 4) | (3 << 2) | (0))
 NeoPixel byte order: BWRG. Combine with a NEO_KHZ* signaling rate.
#define NEO_BWGR   ((1 << 6) | (3 << 4) | (2 << 2) | (0))
 NeoPixel byte order: BWGR. Combine with a NEO_KHZ* signaling rate.
#define NEO_BRWG   ((2 << 6) | (1 << 4) | (3 << 2) | (0))
 NeoPixel byte order: BRWG. Combine with a NEO_KHZ* signaling rate.
#define NEO_BRGW   ((3 << 6) | (1 << 4) | (2 << 2) | (0))
 NeoPixel byte order: BRGW. Combine with a NEO_KHZ* signaling rate.
#define NEO_BGWR   ((2 << 6) | (3 << 4) | (1 << 2) | (0))
 NeoPixel byte order: BGWR. Combine with a NEO_KHZ* signaling rate.
#define NEO_BGRW   ((3 << 6) | (2 << 4) | (1 << 2) | (0))
 NeoPixel byte order: BGRW. Combine with a NEO_KHZ* signaling rate.
#define NEO_KHZ800   0x0000
 Select an 800 kHz NeoPixel data stream.
#define NEO_KHZ400   0x0100
 Select a 400 kHz NeoPixel data stream.
#define SSD1306_128_32
 DEPRECATED: old way to specify 128x32 screen.
#define BLACK   0
 Draw 'off' pixels.
#define WHITE   1
 Draw 'on' pixels.
#define INVERSE   2
 Invert pixels.
#define SSD1306_MEMORYMODE   0x20
 See datasheet.
#define SSD1306_COLUMNADDR   0x21
 See datasheet.
#define SSD1306_PAGEADDR   0x22
 See datasheet.
#define SSD1306_SETCONTRAST   0x81
 See datasheet.
#define SSD1306_CHARGEPUMP   0x8D
 See datasheet.
#define SSD1306_SEGREMAP   0xA0
 See datasheet.
#define SSD1306_DISPLAYALLON_RESUME   0xA4
 See datasheet.
#define SSD1306_DISPLAYALLON   0xA5
 Not currently used.
#define SSD1306_NORMALDISPLAY   0xA6
 See datasheet.
#define SSD1306_INVERTDISPLAY   0xA7
 See datasheet.
#define SSD1306_SETMULTIPLEX   0xA8
 See datasheet.
#define SSD1306_DISPLAYOFF   0xAE
 See datasheet.
#define SSD1306_DISPLAYON   0xAF
 See datasheet.
#define SSD1306_COMSCANINC   0xC0
 Not currently used.
#define SSD1306_COMSCANDEC   0xC8
 See datasheet.
#define SSD1306_SETDISPLAYOFFSET   0xD3
 See datasheet.
#define SSD1306_SETDISPLAYCLOCKDIV   0xD5
 See datasheet.
#define SSD1306_SETPRECHARGE   0xD9
 See datasheet.
#define SSD1306_SETCOMPINS   0xDA
 See datasheet.
#define SSD1306_SETVCOMDETECT   0xDB
 See datasheet.
#define SSD1306_SETLOWCOLUMN   0x00
 Not currently used.
#define SSD1306_SETHIGHCOLUMN   0x10
 Not currently used.
#define SSD1306_SETSTARTLINE   0x40
 See datasheet.
#define SSD1306_EXTERNALVCC   0x01
 External display voltage source.
#define SSD1306_SWITCHCAPVCC   0x02
 Gen. display voltage from 3.3V.
#define SSD1306_RIGHT_HORIZONTAL_SCROLL   0x26
 Init rt scroll.
#define SSD1306_LEFT_HORIZONTAL_SCROLL   0x27
 Init left scroll.
#define SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL   0x29
 Init diag scroll.
#define SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL   0x2A
 Init diag scroll.
#define SSD1306_DEACTIVATE_SCROLL   0x2E
 Stop scroll.
#define SSD1306_ACTIVATE_SCROLL   0x2F
 Start scroll.
#define SSD1306_SET_VERTICAL_SCROLL_AREA   0xA3
 Set scroll range.
#define SSD1306_LCDWIDTH   128
 DEPRECATED: width w/SSD1306_128_32 defined.
#define SSD1306_LCDHEIGHT   32
 DEPRECATED: height w/SSD1306_128_32 defined.
#define splash1_width   82
 Startup bitmap width in pixels.
#define splash1_height   64
 Startup bitmap height in pixels.
#define splash2_width   115
 Startup bitmap width in pixels.
#define splash2_height   32
 Startup bitmap height in pixels.
#define VC0706_RESET   0x26
 VC0706 reset protocol constant.
#define VC0706_GEN_VERSION   0x11
 VC0706 gen version protocol constant.
#define VC0706_SET_PORT   0x24
 VC0706 set port protocol constant.
#define VC0706_READ_FBUF   0x32
 VC0706 read fbuf protocol constant.
#define VC0706_GET_FBUF_LEN   0x34
 VC0706 get fbuf len protocol constant.
#define VC0706_FBUF_CTRL   0x36
 VC0706 fbuf ctrl protocol constant.
#define VC0706_DOWNSIZE_CTRL   0x54
 VC0706 downsize ctrl protocol constant.
#define VC0706_DOWNSIZE_STATUS   0x55
 VC0706 downsize status protocol constant.
#define VC0706_READ_DATA   0x30
 VC0706 read data protocol constant.
#define VC0706_WRITE_DATA   0x31
 VC0706 write data protocol constant.
#define VC0706_COMM_MOTION_CTRL   0x37
 VC0706 comm motion ctrl protocol constant.
#define VC0706_COMM_MOTION_STATUS   0x38
 VC0706 comm motion status protocol constant.
#define VC0706_COMM_MOTION_DETECTED   0x39
 VC0706 comm motion detected protocol constant.
#define VC0706_MOTION_CTRL   0x42
 VC0706 motion ctrl protocol constant.
#define VC0706_MOTION_STATUS   0x43
 VC0706 motion status protocol constant.
#define VC0706_TVOUT_CTRL   0x44
 VC0706 tvout ctrl protocol constant.
#define VC0706_OSD_ADD_CHAR   0x45
 VC0706 osd add char protocol constant.
#define VC0706_STOPCURRENTFRAME   0x0
 VC0706 stopcurrentframe protocol constant.
#define VC0706_STOPNEXTFRAME   0x1
 VC0706 stopnextframe protocol constant.
#define VC0706_RESUMEFRAME   0x2
 VC0706 resumeframe protocol constant.
#define VC0706_STEPFRAME   0x3
 VC0706 stepframe protocol constant.
#define VC0706_640x480   0x00
 VC0706 640x480 protocol constant.
#define VC0706_320x240   0x11
 VC0706 320x240 protocol constant.
#define VC0706_160x120   0x22
 VC0706 160x120 protocol constant.
#define VC0706_MOTIONCONTROL   0x0
 VC0706 motioncontrol protocol constant.
#define VC0706_UARTMOTION   0x01
 VC0706 uartmotion protocol constant.
#define VC0706_ACTIVATEMOTION   0x01
 VC0706 activatemotion protocol constant.
#define VC0706_SET_ZOOM   0x52
 VC0706 set zoom protocol constant.
#define VC0706_GET_ZOOM   0x53
 VC0706 get zoom protocol constant.
#define CAMERABUFFSIZ   100
 Maximum shared Adafruit_VC0706 response-buffer payload size in bytes.
#define CAMERADELAY   10
 Adafruit_VC0706 JPEG read-response delay setting.
#define VL53L0X_I2C_ADDR   0x29
 Default sensor I2C address.
#define DOGM128_6_LCDWIDTH   128
 DOGM128-6 width in pixels.
#define DOGM128_6_LCDHEIGHT   64
 DOGM128-6 height in pixels.
#define BLACK   0
 Draw a black pixel in the DOGM128-6 framebuffer.
#define WHITE   1
 Draw a white pixel in the DOGM128-6 framebuffer.
#define INVERSE   2
 Toggle the selected DOGM128-6 framebuffer pixels.
#define LCD_CLEARDISPLAY   0x01
 HD44780 cleardisplay command or bit-field value.
#define LCD_RETURNHOME   0x02
 HD44780 returnhome command or bit-field value.
#define LCD_ENTRYMODESET   0x04
 HD44780 entrymodeset command or bit-field value.
#define LCD_DISPLAYCONTROL   0x08
 HD44780 displaycontrol command or bit-field value.
#define LCD_CURSORSHIFT   0x10
 HD44780 cursorshift command or bit-field value.
#define LCD_FUNCTIONSET   0x20
 HD44780 functionset command or bit-field value.
#define LCD_SETCGRAMADDR   0x40
 HD44780 setcgramaddr command or bit-field value.
#define LCD_SETDDRAMADDR   0x80
 HD44780 setddramaddr command or bit-field value.
#define LCD_ENTRYRIGHT   0x00
 HD44780 entryright command or bit-field value.
#define LCD_ENTRYLEFT   0x02
 HD44780 entryleft command or bit-field value.
#define LCD_ENTRYSHIFTINCREMENT   0x01
 HD44780 entryshiftincrement command or bit-field value.
#define LCD_ENTRYSHIFTDECREMENT   0x00
 HD44780 entryshiftdecrement command or bit-field value.
#define LCD_DISPLAYON   0x04
 HD44780 displayon command or bit-field value.
#define LCD_DISPLAYOFF   0x00
 HD44780 displayoff command or bit-field value.
#define LCD_CURSORON   0x02
 HD44780 cursoron command or bit-field value.
#define LCD_CURSOROFF   0x00
 HD44780 cursoroff command or bit-field value.
#define LCD_BLINKON   0x01
 HD44780 blinkon command or bit-field value.
#define LCD_BLINKOFF   0x00
 HD44780 blinkoff command or bit-field value.
#define LCD_DISPLAYMOVE   0x08
 HD44780 displaymove command or bit-field value.
#define LCD_CURSORMOVE   0x00
 HD44780 cursormove command or bit-field value.
#define LCD_MOVERIGHT   0x04
 HD44780 moveright command or bit-field value.
#define LCD_MOVELEFT   0x00
 HD44780 moveleft command or bit-field value.
#define LCD_8BITMODE   0x10
 HD44780 8bitmode command or bit-field value.
#define LCD_4BITMODE   0x00
 HD44780 4bitmode command or bit-field value.
#define LCD_2LINE   0x08
 HD44780 2line command or bit-field value.
#define LCD_1LINE   0x00
 HD44780 1line command or bit-field value.
#define LCD_5x10DOTS   0x04
 HD44780 5x10dots command or bit-field value.
#define LCD_5x8DOTS   0x00
 HD44780 5x8dots command or bit-field value.
#define LCD_BACKLIGHT   0x08
 HD44780 backlight command or bit-field value.
#define LCD_NOBACKLIGHT   0x00
 HD44780 nobacklight command or bit-field value.
#define En   0b00000100
#define Rw   0b00000010
#define Rs   0b00000001
#define PCF8574_LIB_VERSION   (F("0.4.2"))
 Upstream PCF8574 library version string.
#define PCF8574_INITIAL_VALUE   0xFF
 Default output latch byte, with all pins released high.
#define PCF8574_OK   0x00
 No stored PCF8574 error.
#define PCF8574_PIN_ERROR   0x81
 Invalid PCF8574 pin index.
#define PCF8574_I2C_ERROR   0x82
 PCF8574 I2C read failure.
#define RHT_READ_INTERVAL_MS   1000
 Suggested RHT03 sampling interval in milliseconds; not enforced by update().
#define BQ72441_I2C_TIMEOUT   2000
 BQ27441 polling timeout in milliseconds.
#define CSS811_void   0x00
 CCS811 void register address.
#define CSS811_MEAS_MODE   0x01
 CCS811 meas mode register address.
#define CSS811_ALG_RESULT_DATA   0x02
 CCS811 alg result data register address.
#define CSS811_RAW_DATA   0x03
 CCS811 raw data register address.
#define CSS811_ENV_DATA   0x05
 CCS811 env data register address.
#define CSS811_NTC   0x06
 CCS811 ntc register address.
#define CSS811_THRESHOLDS   0x10
 CCS811 thresholds register address.
#define CSS811_BASELINE   0x11
 CCS811 baseline register address.
#define CSS811_HW_ID   0x20
 CCS811 hw id register address.
#define CSS811_HW_VERSION   0x21
 CCS811 hw version register address.
#define CSS811_FW_BOOT_VERSION   0x23
 CCS811 fw boot version register address.
#define CSS811_FW_APP_VERSION   0x24
 CCS811 fw app version register address.
#define CSS811_ERROR_ID   0xE0
 CCS811 error id register address.
#define CSS811_APP_START   0xF4
 CCS811 app start register address.
#define CSS811_SW_RESET   0xFF
 CCS811 sw reset register address.
#define ENABLE   0x01
 Enable a VEML6030 register feature.
#define DISABLE   0x00
 Disable a VEML6030 register feature.
#define SHUTDOWN   0x01
 VEML6030 shutdown bit value.
#define POWER   0x00
 VEML6030 powered-on bit value.
#define NO_INT   0x00
 No decoded VEML6030 interrupt.
#define INT_HIGH   0x01
 Decoded VEML6030 upper-threshold interrupt.
#define INT_LOW   0x02
 Decoded VEML6030 lower-threshold interrupt.
#define UNKNOWN_ERROR   0xFF
 VEML6030 invalid-setting sentinel, 0xFF.
#define VC0706_HPP
 VC0706 hpp protocol constant.
#define returnSign   0x76
 VC0706 response header marker.
#define serialNumber   0x00
 VC0706 serial protocol device number.

Typedefs

typedef uint16_t neoPixelType
 Encoded pixel byte order and signaling rate, combining NEO_* and NEO_KHZ* constants.
typedef class SPI SPIClass

Enumerations

enum  adsGain_t {
  GAIN_TWOTHIRDS = ADS1X15_REG_CONFIG_PGA_6_144V , GAIN_ONE = ADS1X15_REG_CONFIG_PGA_4_096V , GAIN_TWO = ADS1X15_REG_CONFIG_PGA_2_048V , GAIN_FOUR = ADS1X15_REG_CONFIG_PGA_1_024V ,
  GAIN_EIGHT = ADS1X15_REG_CONFIG_PGA_0_512V , GAIN_SIXTEEN = ADS1X15_REG_CONFIG_PGA_0_256V
}
enum  {
  AMG88xx_PCTL = 0x00 , AMG88xx_RST = 0x01 , AMG88xx_FPSC = 0x02 , AMG88xx_INTC = 0x03 ,
  AMG88xx_STAT = 0x04 , AMG88xx_SCLR = 0x05 , AMG88xx_AVE = 0x07 , AMG88xx_INTHL = 0x08 ,
  AMG88xx_INTHH = 0x09 , AMG88xx_INTLL = 0x0A , AMG88xx_INTLH = 0x0B , AMG88xx_IHYSL = 0x0C ,
  AMG88xx_IHYSH = 0x0D , AMG88xx_TTHL = 0x0E , AMG88xx_TTHH = 0x0F , AMG88xx_INT_OFFSET = 0x010 ,
  AMG88xx_PIXEL_OFFSET = 0x80
}
enum  power_modes { AMG88xx_NORMAL_MODE = 0x00 , AMG88xx_SLEEP_MODE = 0x01 , AMG88xx_STAND_BY_60 = 0x20 , AMG88xx_STAND_BY_10 = 0x21 }
 Power-control register mode values. More...
enum  sw_resets { AMG88xx_FLAG_RESET = 0x30 , AMG88xx_INITIAL_RESET = 0x3F }
 Software-reset command values. More...
enum  frame_rates { AMG88xx_FPS_10 = 0x00 , AMG88xx_FPS_1 = 0x01 }
 Thermal frame-rate register values. More...
enum  int_enables { AMG88xx_INT_DISABLED = 0x00 , AMG88xx_INT_ENABLED = 0x01 }
 Interrupt-output enable bit values. More...
enum  int_modes { AMG88xx_DIFFERENCE = 0x00 , AMG88xx_ABSOLUTE_VALUE = 0x01 }
 Difference or absolute-temperature interrupt comparison modes. More...
enum  VEML6030_16BIT_REGISTERS {
  SETTING_REG = 0x00 , H_THRESH_REG , L_THRESH_REG , POWER_SAVE_REG ,
  AMBIENT_LIGHT_DATA_REG , WHITE_LIGHT_DATA_REG , INTERRUPT_REG
}
 VEML6030 register addresses. More...
enum  VEML6030_16BIT_REG_MASKS {
  THRESH_MASK = 0x0 , GAIN_MASK = 0xE7FF , INTEG_MASK = 0xFC3F , PERS_PROT_MASK = 0xFFCF ,
  INT_EN_MASK = 0xFFFD , SD_MASK = 0xFFFE , POW_SAVE_EN_MASK = 0x06 , POW_SAVE_MASK = 0x01 ,
  INT_MASK = 0xC000
}
 Masks retaining unrelated VEML6030 register bits. More...
enum  REGISTER_BIT_POSITIONS {
  NO_SHIFT = 0x00 , INT_EN_POS = 0x01 , PSM_POS = 0x01 , PERS_PROT_POS = 0x04 ,
  INTEG_POS = 0x06 , GAIN_POS = 0xB , INT_POS = 0xE
}
 Bit positions of VEML6030 register fields. More...

Variables

constexpr uint16_t MUX_BY_CHANNEL []
 MUX config by channel.
const uint8_t PROGMEM splash1_data []
 Packed monochrome startup image stored in program memory.
const uint8_t PROGMEM splash2_data []
 Packed monochrome startup image stored in program memory.
const uint8_t defAddr = 0x48
 Default 7-bit sensor address, 0x48.
const uint8_t altAddr = 0x10
 Alternative 7-bit sensor address, 0x10.
const float eightHIt [] = {.0036, .0072, .0288, .0576}
 Lux-per-count conversion factors for 800 ms integration, indexed by gain bits.
const float fourHIt [] = {.0072, .0144, .0576, .1152}
 Lux-per-count conversion factors for 400 ms integration, indexed by gain bits.
const float twoHIt [] = {.0144, .0288, .1152, .2304}
 Lux-per-count conversion factors for 200 ms integration, indexed by gain bits.
const float oneHIt [] = {.0288, .0576, .2304, .4608}
 Lux-per-count conversion factors for 100 ms integration, indexed by gain bits.
const float fiftyIt [] = {.0576, .1152, .4608, .9216}
 Lux-per-count conversion factors for 50 ms integration, indexed by gain bits.
const float twentyFiveIt [] = {.1152, .2304, .9216, 1.8432}
 Lux-per-count conversion factors for 25 ms integration, indexed by gain bits.

Detailed Description

Sensor, display, storage, and peripheral driver APIs.

Macro Definition Documentation

◆ ADS1X15_REG_CONFIG_CLAT_MASK

#define ADS1X15_REG_CONFIG_CLAT_MASK   (0x0004)

Determines if ALERT/RDY pin latches once asserted.

102#define ADS1X15_REG_CONFIG_CLAT_MASK \
103 (0x0004)

◆ ADS1X15_REG_CONFIG_CLAT_NONLAT

#define ADS1X15_REG_CONFIG_CLAT_NONLAT   (0x0000)

Non-latching comparator (default).

104#define ADS1X15_REG_CONFIG_CLAT_NONLAT \
105 (0x0000)

◆ ADS1X15_REG_CONFIG_CMODE_TRAD

#define ADS1X15_REG_CONFIG_CMODE_TRAD   (0x0000)

Traditional comparator with hysteresis (default).

92#define ADS1X15_REG_CONFIG_CMODE_TRAD \
93 (0x0000)

◆ ADS1X15_REG_CONFIG_CPOL_ACTVHI

#define ADS1X15_REG_CONFIG_CPOL_ACTVHI   (0x0008)

ALERT/RDY pin is high when active.

99#define ADS1X15_REG_CONFIG_CPOL_ACTVHI \
100 (0x0008)

◆ ADS1X15_REG_CONFIG_CPOL_ACTVLOW

#define ADS1X15_REG_CONFIG_CPOL_ACTVLOW   (0x0000)

ALERT/RDY pin is low when active (default).

97#define ADS1X15_REG_CONFIG_CPOL_ACTVLOW \
98 (0x0000)

◆ ADS1X15_REG_CONFIG_CQUE_1CONV

#define ADS1X15_REG_CONFIG_CQUE_1CONV   (0x0000)

Assert ALERT/RDY after one conversions.

109#define ADS1X15_REG_CONFIG_CQUE_1CONV \
110 (0x0000)

◆ ADS1X15_REG_CONFIG_CQUE_2CONV

#define ADS1X15_REG_CONFIG_CQUE_2CONV   (0x0001)

Assert ALERT/RDY after two conversions.

111#define ADS1X15_REG_CONFIG_CQUE_2CONV \
112 (0x0001)

◆ ADS1X15_REG_CONFIG_CQUE_4CONV

#define ADS1X15_REG_CONFIG_CQUE_4CONV   (0x0002)

Assert ALERT/RDY after four conversions.

113#define ADS1X15_REG_CONFIG_CQUE_4CONV \
114 (0x0002)

◆ ADS1X15_REG_CONFIG_CQUE_NONE

#define ADS1X15_REG_CONFIG_CQUE_NONE   (0x0003)

Disable the comparator and put ALERT/RDY in high state (default).

115#define ADS1X15_REG_CONFIG_CQUE_NONE \
116 (0x0003)

◆ ADS1X15_REG_CONFIG_MODE_SINGLE

#define ADS1X15_REG_CONFIG_MODE_SINGLE   (0x0100)

Power-down single-shot mode (default).

86#define ADS1X15_REG_CONFIG_MODE_SINGLE \
87 (0x0100)

◆ ADS1X15_REG_CONFIG_MUX_DIFF_0_1

#define ADS1X15_REG_CONFIG_MUX_DIFF_0_1   (0x0000)

Differential P = AIN0, N = AIN1 (default).

55#define ADS1X15_REG_CONFIG_MUX_DIFF_0_1 \
56 (0x0000)

◆ ADS1X15_REG_CONFIG_MUX_DIFF_0_3

#define ADS1X15_REG_CONFIG_MUX_DIFF_0_3   (0x1000)

Differential P = AIN0, N = AIN3.

57#define ADS1X15_REG_CONFIG_MUX_DIFF_0_3 \
58 (0x1000)

◆ ADS1X15_REG_CONFIG_MUX_DIFF_1_3

#define ADS1X15_REG_CONFIG_MUX_DIFF_1_3   (0x2000)

Differential P = AIN1, N = AIN3.

59#define ADS1X15_REG_CONFIG_MUX_DIFF_1_3 \
60 (0x2000)

◆ ADS1X15_REG_CONFIG_MUX_DIFF_2_3

#define ADS1X15_REG_CONFIG_MUX_DIFF_2_3   (0x3000)

Differential P = AIN2, N = AIN3.

61#define ADS1X15_REG_CONFIG_MUX_DIFF_2_3 \
62 (0x3000)

◆ ADS1X15_REG_CONFIG_OS_BUSY

#define ADS1X15_REG_CONFIG_OS_BUSY   (0x0000)

Read: Bit = 0 when conversion is in progress.

49#define ADS1X15_REG_CONFIG_OS_BUSY \
50 (0x0000)

◆ ADS1X15_REG_CONFIG_OS_NOTBUSY

#define ADS1X15_REG_CONFIG_OS_NOTBUSY   (0x8000)

Read: Bit = 1 when device is not performing a conversion.

51#define ADS1X15_REG_CONFIG_OS_NOTBUSY \
52 (0x8000)

◆ ADS1X15_REG_CONFIG_OS_SINGLE

#define ADS1X15_REG_CONFIG_OS_SINGLE   (0x8000)

Write: Set to start a single-conversion.

47#define ADS1X15_REG_CONFIG_OS_SINGLE \
48 (0x8000)

◆ ADS1X15_REG_CONFIG_PGA_2_048V

#define ADS1X15_REG_CONFIG_PGA_2_048V   (0x0400)

+/-2.048V range = Gain 2 (default)

78#define ADS1X15_REG_CONFIG_PGA_2_048V \
79 (0x0400)

◆ BLACK

#define BLACK   0

Draw 'off' pixels.

Draw a black pixel in the DOGM128-6 framebuffer.

Examples
feather-m0/OLED-FeatherWing/main.cpp.

◆ INVERSE

#define INVERSE   2

Invert pixels.

Toggle the selected DOGM128-6 framebuffer pixels.

◆ RATE_ADS1015_128SPS

#define RATE_ADS1015_128SPS   (0x0000)

128 samples per second

Data rates

◆ WHITE

#define WHITE   1

Draw 'on' pixels.

Draw a white pixel in the DOGM128-6 framebuffer.

Examples
feather-m0/AMG88xx_IoT.own/main.cpp, feather-m0/OLED-FeatherWing/main.cpp, feather-m0/TFMini-I2C/main.cpp, feather-m0/UltimateGPS+OLED/main.cpp, plm100s/PLS100W_SSD1306-I2C/main.cpp, and plm150/OLED-Display_SSD1306-I2C/main.cpp.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
44 {
45 AMG88xx_PCTL = 0x00,
46 AMG88xx_RST = 0x01,
47 AMG88xx_FPSC = 0x02,
48 AMG88xx_INTC = 0x03,
49 AMG88xx_STAT = 0x04,
50 AMG88xx_SCLR = 0x05,
51 //0x06 reserved
52 AMG88xx_AVE = 0x07,
53 AMG88xx_INTHL = 0x08,
54 AMG88xx_INTHH = 0x09,
55 AMG88xx_INTLL = 0x0A,
56 AMG88xx_INTLH = 0x0B,
57 AMG88xx_IHYSL = 0x0C,
58 AMG88xx_IHYSH = 0x0D,
59 AMG88xx_TTHL = 0x0E,
60 AMG88xx_TTHH = 0x0F,
61 AMG88xx_INT_OFFSET = 0x010,
62 AMG88xx_PIXEL_OFFSET = 0x80
63 };

◆ adsGain_t

enum adsGain_t

Gain settings

120 {
121 GAIN_TWOTHIRDS = ADS1X15_REG_CONFIG_PGA_6_144V,
122 GAIN_ONE = ADS1X15_REG_CONFIG_PGA_4_096V,
123 GAIN_TWO = ADS1X15_REG_CONFIG_PGA_2_048V,
124 GAIN_FOUR = ADS1X15_REG_CONFIG_PGA_1_024V,
125 GAIN_EIGHT = ADS1X15_REG_CONFIG_PGA_0_512V,
126 GAIN_SIXTEEN = ADS1X15_REG_CONFIG_PGA_0_256V
127} adsGain_t;
ADS1X15_REG_CONFIG_PGA_0_512V
#define ADS1X15_REG_CONFIG_PGA_0_512V
+/-0.512V range = Gain 8
Definition Adafruit_ADS1X15.hpp:81
adsGain_t
adsGain_t
Definition Adafruit_ADS1X15.hpp:120
ADS1X15_REG_CONFIG_PGA_0_256V
#define ADS1X15_REG_CONFIG_PGA_0_256V
+/-0.256V range = Gain 16
Definition Adafruit_ADS1X15.hpp:82
ADS1X15_REG_CONFIG_PGA_2_048V
#define ADS1X15_REG_CONFIG_PGA_2_048V
+/-2.048V range = Gain 2 (default)
Definition Adafruit_ADS1X15.hpp:78
ADS1X15_REG_CONFIG_PGA_1_024V
#define ADS1X15_REG_CONFIG_PGA_1_024V
+/-1.024V range = Gain 4
Definition Adafruit_ADS1X15.hpp:80
ADS1X15_REG_CONFIG_PGA_6_144V
#define ADS1X15_REG_CONFIG_PGA_6_144V
+/-6.144V range = Gain 2/3
Definition Adafruit_ADS1X15.hpp:76
ADS1X15_REG_CONFIG_PGA_4_096V
#define ADS1X15_REG_CONFIG_PGA_4_096V
+/-4.096V range = Gain 1
Definition Adafruit_ADS1X15.hpp:77

◆ frame_rates

enum frame_rates

Thermal frame-rate register values.

86 {
87 AMG88xx_FPS_10 = 0x00,
88 AMG88xx_FPS_1 = 0x01
89 };

◆ int_enables

enum int_enables

Interrupt-output enable bit values.

94 {
95 AMG88xx_INT_DISABLED = 0x00,
96 AMG88xx_INT_ENABLED = 0x01
97 };

◆ int_modes

enum int_modes

Difference or absolute-temperature interrupt comparison modes.

102 {
103 AMG88xx_DIFFERENCE = 0x00,
104 AMG88xx_ABSOLUTE_VALUE = 0x01
105 };

◆ power_modes

enum power_modes

Power-control register mode values.

68 {
69 AMG88xx_NORMAL_MODE = 0x00,
70 AMG88xx_SLEEP_MODE = 0x01,
71 AMG88xx_STAND_BY_60 = 0x20,
72 AMG88xx_STAND_BY_10 = 0x21
73 };

◆ REGISTER_BIT_POSITIONS

enum REGISTER_BIT_POSITIONS

Bit positions of VEML6030 register fields.

76 {
77 NO_SHIFT = 0x00,
78 INT_EN_POS = 0x01,
79 PSM_POS = 0x01,
80 PERS_PROT_POS = 0x04,
81 INTEG_POS = 0x06,
82 GAIN_POS = 0xB,
83 INT_POS = 0xE
84
85};

◆ sw_resets

enum sw_resets

Software-reset command values.

78 {
79 AMG88xx_FLAG_RESET = 0x30,
80 AMG88xx_INITIAL_RESET = 0x3F
81 };

◆ VEML6030_16BIT_REG_MASKS

enum VEML6030_16BIT_REG_MASKS

Masks retaining unrelated VEML6030 register bits.

60 {
61 THRESH_MASK = 0x0,
62 GAIN_MASK = 0xE7FF,
63 INTEG_MASK = 0xFC3F,
64 PERS_PROT_MASK = 0xFFCF,
65 INT_EN_MASK = 0xFFFD,
66 SD_MASK = 0xFFFE,
67 POW_SAVE_EN_MASK = 0x06, // Most of this register is reserved
68 POW_SAVE_MASK = 0x01, // Most of this register is reserved
69 INT_MASK = 0xC000
70
71};

◆ VEML6030_16BIT_REGISTERS

enum VEML6030_16BIT_REGISTERS

VEML6030 register addresses.

46 {
47 SETTING_REG = 0x00,
48 H_THRESH_REG,
49 L_THRESH_REG,
50 POWER_SAVE_REG,
51 AMBIENT_LIGHT_DATA_REG,
52 WHITE_LIGHT_DATA_REG,
53 INTERRUPT_REG
54
55};

Variable Documentation

◆ eightHIt

const float eightHIt[] = {.0036, .0072, .0288, .0576}

Lux-per-count conversion factors for 800 ms integration, indexed by gain bits.

94{.0036, .0072, .0288, .0576};

◆ fiftyIt

const float fiftyIt[] = {.0576, .1152, .4608, .9216}

Lux-per-count conversion factors for 50 ms integration, indexed by gain bits.

110{.0576, .1152, .4608, .9216};

◆ fourHIt

const float fourHIt[] = {.0072, .0144, .0576, .1152}

Lux-per-count conversion factors for 400 ms integration, indexed by gain bits.

98{.0072, .0144, .0576, .1152};

◆ MUX_BY_CHANNEL

uint16_t MUX_BY_CHANNEL[]
constexpr
Initial value:
= {
ADS1X15_REG_CONFIG_MUX_SINGLE_0,
ADS1X15_REG_CONFIG_MUX_SINGLE_1,
ADS1X15_REG_CONFIG_MUX_SINGLE_2,
ADS1X15_REG_CONFIG_MUX_SINGLE_3
}
ADS1X15_REG_CONFIG_MUX_SINGLE_3
#define ADS1X15_REG_CONFIG_MUX_SINGLE_3
Single-ended AIN3.
Definition Adafruit_ADS1X15.hpp:66
ADS1X15_REG_CONFIG_MUX_SINGLE_0
#define ADS1X15_REG_CONFIG_MUX_SINGLE_0
Single-ended AIN0.
Definition Adafruit_ADS1X15.hpp:63
ADS1X15_REG_CONFIG_MUX_SINGLE_2
#define ADS1X15_REG_CONFIG_MUX_SINGLE_2
Single-ended AIN2.
Definition Adafruit_ADS1X15.hpp:65
ADS1X15_REG_CONFIG_MUX_SINGLE_1
#define ADS1X15_REG_CONFIG_MUX_SINGLE_1
Single-ended AIN1.
Definition Adafruit_ADS1X15.hpp:64

MUX config by channel.

68 {
69 ADS1X15_REG_CONFIG_MUX_SINGLE_0,
70 ADS1X15_REG_CONFIG_MUX_SINGLE_1,
71 ADS1X15_REG_CONFIG_MUX_SINGLE_2,
72 ADS1X15_REG_CONFIG_MUX_SINGLE_3
73};

◆ oneHIt

const float oneHIt[] = {.0288, .0576, .2304, .4608}

Lux-per-count conversion factors for 100 ms integration, indexed by gain bits.

106{.0288, .0576, .2304, .4608};

◆ splash1_data

const uint8_t PROGMEM splash1_data[]

Packed monochrome startup image stored in program memory.

17 {
18 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00,
19 0x00, 0x00, 0x00, 0x00, 0x03, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
20 0x00, 0x00, 0x00, 0x07, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
21 0x00, 0x00, 0x07, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
22 0x00, 0x0F, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
23 0x1F, 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x1F,
24 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3F, 0xE0,
25 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3F, 0xF0, 0x00,
26 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7F, 0xF0, 0x00, 0x00,
27 0x00, 0x00, 0x00, 0x00, 0x00, 0x1F, 0xF8, 0x7F, 0xF0, 0x00, 0x00, 0x00,
28 0x00, 0x00, 0x00, 0x00, 0x3F, 0xFE, 0x7F, 0xF0, 0x00, 0x00, 0x00, 0x00,
29 0x00, 0x00, 0x00, 0x3F, 0xFF, 0x7F, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00,
30 0x00, 0x00, 0x1F, 0xFF, 0xFB, 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
31 0x00, 0x0F, 0xFF, 0xF9, 0xFF, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
32 0x0F, 0xFF, 0xF9, 0xFF, 0xF8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07,
33 0xFF, 0xF1, 0xFF, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0xFC,
34 0x73, 0xFF, 0xFF, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xFE, 0x3F,
35 0xFF, 0xFF, 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF, 0x1E, 0x0F,
36 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7F, 0xFE, 0x1F, 0xFC,
37 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x3F, 0xFF, 0xFF, 0xF8, 0x00,
38 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0F, 0xDF, 0xFF, 0xE0, 0x00, 0x00,
39 0x00, 0x00, 0x00, 0x00, 0x00, 0x1F, 0x19, 0xFF, 0xC0, 0x00, 0x00, 0x00,
40 0x00, 0x00, 0x00, 0x00, 0x3F, 0x3C, 0xFF, 0x00, 0x00, 0x00, 0x00, 0x00,
41 0x00, 0x00, 0x00, 0x7E, 0x7C, 0xF8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
42 0x00, 0x00, 0x7F, 0xFE, 0x7C, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
43 0x00, 0xFF, 0xFF, 0xFC, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
44 0xFF, 0xFF, 0xFE, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xFF,
45 0xFF, 0xFE, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xFF, 0xEF,
46 0xFE, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xFF, 0xCF, 0xFE,
47 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0xFF, 0x07, 0xFE, 0x00,
48 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0xFC, 0x07, 0xFE, 0x00, 0x00,
49 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0xF0, 0x03, 0xFE, 0x00, 0x00, 0x00,
50 0x00, 0x00, 0x00, 0x00, 0x01, 0x80, 0x00, 0xFE, 0x00, 0x00, 0x00, 0x00,
51 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x7E, 0x00, 0x00, 0x00, 0x00, 0x00,
52 0x00, 0x00, 0x00, 0x00, 0x00, 0x3E, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
53 0x00, 0x00, 0x00, 0x00, 0x0C, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07,
54 0x80, 0x00, 0xFC, 0x00, 0x00, 0x03, 0xC0, 0x00, 0x00, 0x00, 0x07, 0x80,
55 0x01, 0xFC, 0x00, 0x00, 0x03, 0xC0, 0x00, 0x00, 0x00, 0x07, 0x80, 0x01,
56 0xFC, 0x00, 0x00, 0x03, 0xC0, 0x00, 0x00, 0x00, 0x07, 0x80, 0x01, 0xE0,
57 0x00, 0x00, 0x00, 0x1E, 0x00, 0x00, 0x00, 0x07, 0x80, 0x01, 0xE0, 0x00,
58 0x00, 0x00, 0x1E, 0x00, 0x7F, 0xE3, 0xF7, 0x9F, 0xF9, 0xFD, 0xE7, 0x78,
59 0x7B, 0xDF, 0xC0, 0xFF, 0xF7, 0xFF, 0xBF, 0xFD, 0xFD, 0xFF, 0x78, 0x7B,
60 0xDF, 0xC0, 0xFF, 0xF7, 0xFF, 0xBF, 0xFD, 0xFD, 0xFF, 0x78, 0x7B, 0xDF,
61 0xC0, 0xF0, 0xF7, 0x87, 0xBC, 0x3D, 0xE1, 0xFF, 0x78, 0x7B, 0xDE, 0x00,
62 0xF0, 0xF7, 0x87, 0xBC, 0x3D, 0xE1, 0xF0, 0x78, 0x7B, 0xDE, 0x00, 0x00,
63 0xF7, 0x87, 0x80, 0x3D, 0xE1, 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0x7F, 0xF7,
64 0x87, 0x9F, 0xFD, 0xE1, 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0xFF, 0xF7, 0x87,
65 0xBF, 0xFD, 0xE1, 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0xF0, 0xF7, 0x87, 0xBC,
66 0x3D, 0xE1, 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0xF0, 0xF7, 0x87, 0xBC, 0x3D,
67 0xE1, 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0xF0, 0xF7, 0x87, 0xBC, 0x3D, 0xE1,
68 0xE0, 0x78, 0x7B, 0xDE, 0x00, 0xFF, 0xF7, 0xFF, 0xBF, 0xFD, 0xE1, 0xE0,
69 0x7F, 0xFB, 0xDF, 0xC0, 0xFF, 0xF7, 0xFF, 0xBF, 0xFD, 0xE1, 0xE0, 0x7F,
70 0xFB, 0xDF, 0xC0, 0x7C, 0xF3, 0xF3, 0x9F, 0x3D, 0xE1, 0xE0, 0x3E, 0x7B,
71 0xCF, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
72 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xC0,
73 0xFF, 0xFF, 0xFF, 0xFF, 0xFD, 0x68, 0xDB, 0x11, 0x1A, 0x31, 0xC0, 0xFF,
74 0xFF, 0xFF, 0xFF, 0xFD, 0x2B, 0x5A, 0xFB, 0x6A, 0xEF, 0xC0, 0xFF, 0xFF,
75 0xFF, 0xFF, 0xFD, 0x4B, 0x5B, 0x3B, 0x1A, 0x33, 0xC0, 0xFF, 0xFF, 0xFF,
76 0xFF, 0xFD, 0x6B, 0x5B, 0xDB, 0x6A, 0xFD, 0xC0 };

◆ splash2_data

const uint8_t PROGMEM splash2_data[]

Packed monochrome startup image stored in program memory.

84 {
85 0x00, 0x00, 0x60, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
86 0x00, 0x00, 0x00, 0x00, 0x00, 0xE0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
87 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xE0, 0x00, 0x00, 0x00,
88 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0xF0,
89 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
90 0x00, 0x03, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
91 0x00, 0x00, 0x00, 0x00, 0x07, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
92 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07, 0xF8, 0x00, 0x00, 0x00,
93 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x0F, 0xF8,
94 0x00, 0x00, 0x00, 0x03, 0xC0, 0x00, 0x7E, 0x00, 0x00, 0x01, 0xE0, 0x00,
95 0x7F, 0x0F, 0xF8, 0x00, 0x00, 0x00, 0x03, 0xC0, 0x00, 0xFE, 0x00, 0x00,
96 0x01, 0xE0, 0x00, 0xFF, 0xEF, 0xF8, 0x00, 0x00, 0x00, 0x03, 0xC0, 0x00,
97 0xFE, 0x00, 0x00, 0x01, 0xE0, 0x00, 0xFF, 0xFF, 0xF8, 0x00, 0x00, 0x00,
98 0x03, 0xC0, 0x00, 0xF0, 0x00, 0x00, 0x00, 0x0F, 0x00, 0x7F, 0xFE, 0x7F,
99 0xC0, 0x00, 0x00, 0x03, 0xC0, 0x00, 0xF0, 0x00, 0x00, 0x00, 0x0F, 0x00,
100 0x3F, 0xFE, 0x7F, 0xF8, 0x3F, 0xF1, 0xFB, 0xCF, 0xFC, 0xFE, 0xF3, 0xBC,
101 0x3D, 0xEF, 0xE0, 0x1F, 0xFE, 0x7F, 0xFF, 0x7F, 0xFB, 0xFF, 0xDF, 0xFE,
102 0xFE, 0xFF, 0xBC, 0x3D, 0xEF, 0xE0, 0x1F, 0xC6, 0xFF, 0xFF, 0x7F, 0xFB,
103 0xFF, 0xDF, 0xFE, 0xFE, 0xFF, 0xBC, 0x3D, 0xEF, 0xE0, 0x0F, 0xE3, 0xC7,
104 0xFE, 0x78, 0x7B, 0xC3, 0xDE, 0x1E, 0xF0, 0xFF, 0xBC, 0x3D, 0xEF, 0x00,
105 0x07, 0xFF, 0x87, 0xFC, 0x78, 0x7B, 0xC3, 0xDE, 0x1E, 0xF0, 0xF8, 0x3C,
106 0x3D, 0xEF, 0x00, 0x01, 0xFF, 0xFF, 0xF0, 0x00, 0x7B, 0xC3, 0xC0, 0x1E,
107 0xF0, 0xF0, 0x3C, 0x3D, 0xEF, 0x00, 0x01, 0xF3, 0x7F, 0xE0, 0x3F, 0xFB,
108 0xC3, 0xCF, 0xFE, 0xF0, 0xF0, 0x3C, 0x3D, 0xEF, 0x00, 0x03, 0xE3, 0x3F,
109 0x80, 0x7F, 0xFB, 0xC3, 0xDF, 0xFE, 0xF0, 0xF0, 0x3C, 0x3D, 0xEF, 0x00,
110 0x07, 0xE7, 0x3C, 0x00, 0x78, 0x7B, 0xC3, 0xDE, 0x1E, 0xF0, 0xF0, 0x3C,
111 0x3D, 0xEF, 0x00, 0x07, 0xFF, 0xBE, 0x00, 0x78, 0x7B, 0xC3, 0xDE, 0x1E,
112 0xF0, 0xF0, 0x3C, 0x3D, 0xEF, 0x00, 0x07, 0xFF, 0xFE, 0x00, 0x78, 0x7B,
113 0xC3, 0xDE, 0x1E, 0xF0, 0xF0, 0x3C, 0x3D, 0xEF, 0x00, 0x0F, 0xFF, 0xFE,
114 0x00, 0x7F, 0xFB, 0xFF, 0xDF, 0xFE, 0xF0, 0xF0, 0x3F, 0xFD, 0xEF, 0xE0,
115 0x0F, 0xFF, 0xFF, 0x00, 0x7F, 0xFB, 0xFF, 0xDF, 0xFE, 0xF0, 0xF0, 0x3F,
116 0xFD, 0xEF, 0xE0, 0x0F, 0xF9, 0xFF, 0x00, 0x3E, 0x79, 0xF9, 0xCF, 0x9E,
117 0xF0, 0xF0, 0x1F, 0x3D, 0xE7, 0xE0, 0x1F, 0xF1, 0xFF, 0x00, 0x00, 0x00,
118 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x1F, 0x80, 0xFF,
119 0x00, 0x7F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xE0,
120 0x1C, 0x00, 0x7F, 0x00, 0x7F, 0xFF, 0xFF, 0xFF, 0xFE, 0xB4, 0x6D, 0x88,
121 0x8D, 0x18, 0xE0, 0x00, 0x00, 0x1F, 0x00, 0x7F, 0xFF, 0xFF, 0xFF, 0xFE,
122 0x95, 0xAD, 0x7D, 0xB5, 0x77, 0xE0, 0x00, 0x00, 0x0F, 0x00, 0x7F, 0xFF,
123 0xFF, 0xFF, 0xFE, 0xA5, 0xAD, 0x9D, 0x8D, 0x19, 0xE0, 0x00, 0x00, 0x06,
124 0x00, 0x7F, 0xFF, 0xFF, 0xFF, 0xFE, 0xB5, 0xAD, 0xED, 0xB5, 0x7E, 0xE0 };

◆ twentyFiveIt

const float twentyFiveIt[] = {.1152, .2304, .9216, 1.8432}

Lux-per-count conversion factors for 25 ms integration, indexed by gain bits.

114{.1152, .2304, .9216, 1.8432};

◆ twoHIt

const float twoHIt[] = {.0144, .0288, .1152, .2304}

Lux-per-count conversion factors for 200 ms integration, indexed by gain bits.

102{.0144, .0288, .1152, .2304};
Generated on for Nol.A SDK Library by doxygen 1.17.0