From 005264adc169ca44b1133c122498392c7dbf0ee6 Mon Sep 17 00:00:00 2001
From: "Morgan 'ARR\\!' Allen" <morganrallen@gmail.com>
Date: Tue, 19 Jul 2022 21:23:40 -0700
Subject: [PATCH] init

---
 CMakeLists.txt       |  5 ++++
 README.md            | 55 ++++++++++++++++++++++++++++++++++++++++++++
 include/esp32-gp2y.h | 21 +++++++++++++++++
 main/esp32-gp2y.c    | 42 +++++++++++++++++++++++++++++++++
 4 files changed, 123 insertions(+)
 create mode 100644 CMakeLists.txt
 create mode 100644 README.md
 create mode 100644 include/esp32-gp2y.h
 create mode 100644 main/esp32-gp2y.c

diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644
index 0000000..a4aa714
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,5 @@
+idf_component_register(SRCS
+  "main/esp32-gp2y.c"
+
+  INCLUDE_DIRS "include"
+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e12fa23
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# ESP32 GP2Y Dust Sensor
+
+## Install
+
+Designed to be used as an `esp-idf component`. Suggested usage is with  `git submodule`
+
+```
+git submodule add https://git.oit.cloud/morgan/esp32-gp2y.git components/esp32-gp2y/
+git submodule update --init
+```
+
+## API
+
+### `typedef gp2y_cfg_t`
+`float K` Sensitivity. Default: 0.5
+`float offset_voltage` Voltage level at 0ug/m3 dust. Defaults to 0.6v, dynamically lowers.
+`int8_t pin_led` Pin to pulse LED on.
+`adc1_channel_t adc_channel` ADC channel to read on. See IDF Guide to get pin to channel reference.
+`adc_unit_t adc_unit` ADC unit to read on.
+
+### `int32_t gp2y_read(gp2y_cfg_t *cfg, uint8_t samples)`
+Passing a pointer to `gp2y_cfg_t` and number of samples to take. 100 is a good starting point.
+
+
+## Example
+```
+#include <stdio.h>
+#include <unistd.h>
+#include "driver/gpio.h"
+#include "driver/adc.h"
+#include "esp32-gp2y.h"
+
+#define PIN_LED         5
+
+void app_main() {
+    gp2y_cfg_t gp2y_cfg = GP2Y_DEFAULT_CFG;
+    gp2y_cfg.adc_channel = channel;
+    gp2y_cfg.pin_led = PIN_LED;
+
+    gpio_config_t io_conf;
+    io_conf.intr_type = GPIO_INTR_DISABLE;
+    io_conf.mode = GPIO_MODE_OUTPUT;
+    io_conf.pin_bit_mask = (1ULL<<gp2y_cfg.pin_led);
+    io_conf.pull_down_en = 1;
+    io_conf.pull_up_en = 0;
+    gpio_config(&io_conf);
+
+    adc1_config_channel_atten(gp2y_cfg.adc_channel, ADC_ATTEN_DB_11);
+
+    while (1) {
+      printf("aqi: %dug/m3\n", gp2y_read(&gp2y_cfg, 100));
+      vTaskDelay(1000 / portTICK_PERIOD_MS);
+    }
+}
+```
diff --git a/include/esp32-gp2y.h b/include/esp32-gp2y.h
new file mode 100644
index 0000000..a301545
--- /dev/null
+++ b/include/esp32-gp2y.h
@@ -0,0 +1,21 @@
+#ifndef _LORA32_H__
+#define _LORA32_H__
+
+typedef struct {
+  float K;
+  float offset_voltage;
+  int8_t pin_led;
+  adc1_channel_t adc_channel;
+  adc_unit_t adc_unit;
+} gp2y_cfg_t;
+
+#define GP2Y_DEFAULT_CFG {\
+  .K = 0.5,\
+  .offset_voltage = 0.6,\
+  .pin_led = -1,\
+  .adc_channel = -1\
+}
+
+int32_t gp2y_read(gp2y_cfg_t *cfg, uint8_t samples);
+
+#endif // _ESP32_GP2Y_H__
diff --git a/main/esp32-gp2y.c b/main/esp32-gp2y.c
new file mode 100644
index 0000000..da0875e
--- /dev/null
+++ b/main/esp32-gp2y.c
@@ -0,0 +1,42 @@
+#include <string.h>
+#include <unistd.h>
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+#include "driver/adc.h"
+#include "driver/gpio.h"
+#include "esp_log.h"
+#include "esp32-gp2y.h"
+
+int32_t gp2y_read(gp2y_cfg_t *cfg, uint8_t samples) {
+  int32_t accum = 0;
+
+  for(uint8_t i = 0; i < samples; i++) {
+    portMUX_TYPE myMutex = portMUX_INITIALIZER_UNLOCKED;
+    taskENTER_CRITICAL(&myMutex);
+
+    gpio_set_level(cfg->pin_led, 0);
+    usleep(280);
+
+    accum += adc1_get_raw(cfg->adc_channel);
+
+    gpio_set_level(cfg->pin_led, 1);
+
+    taskEXIT_CRITICAL(&myMutex);
+
+    usleep(9620);
+  }
+
+  float avg_adc = (accum / samples);
+  float avg_volt = avg_adc / 4095 * 3.3;
+  float dV = avg_volt - cfg->offset_voltage;
+
+  // recalibrate offset_volt to lowest value seen
+  if(dV < 0) {
+    dV = 0;
+    cfg->offset_voltage = avg_volt;
+  }
+
+  return dV / cfg->K * 100.0;
+}