start commenting

Author: fabiankuffer

components/battery/battery.c

@@ -18,13 +18,15 @@ static adc_oneshot_unit_handle_t adc_handle;
 static adc_cali_handle_t adc_cal_handle = NULL;
 static bool adc_calibrated = false;
 static int measurementCount = 0;
-static int sumVoltage = 0; //Voltage in mV
+static int sumVoltage = 0; //voltage in mV
 
 static bool adc_calibration(adc_unit_t unit, adc_atten_t atten, adc_cali_handle_t *out_handle);
 static int32_t getVoltage();
 
 
-//determine the esp ADC reference voltage which is around 1100 mV
+/**
+ * determine the esp ADC reference voltage which is around 1100 mV
+ */
 static bool adc_calibration(adc_unit_t unit, adc_atten_t atten, adc_cali_handle_t *return_handle){
     adc_cali_handle_t handle = NULL;
     esp_err_t ret = ESP_FAIL;
@@ -47,18 +49,19 @@ static bool adc_calibration(adc_unit_t unit, adc_atten_t atten, adc_cali_handle_
 }
 
 void initBatteryRead(){
-    //adc init
+    //ADC init
     adc_oneshot_unit_init_cfg_t init_config = {
         .unit_id = ADC_UNIT_1,
         .ulp_mode = ADC_ULP_MODE_DISABLE,
     };
 
     ESP_ERROR_CHECK(adc_oneshot_new_unit(&init_config, &adc_handle));
 
-    //adc configuration
-    //wenn .atten auf 0db Dämpfung gesetzt ist, ist der mögliche Wertebereich von 0 bis 1.1V
-    //bei .atten 12db wird der Wertebereich von 0 bis theoretisch 3.9V (3.55*1.1V) verwendet aber durch VDD auf 3.3V begrenzt 
-    //recommended range between 150 to 2450 mV at 12db
+    /*ADC configuration
+     * if .atten is set to 0db attenuation, the possible value range is from 0 to 1.1V
+     * at .atten 12db the value range from 0 to theoretically 3.9V (3.55*1.1V) is used but limited by VDD to 3.3V 
+     * recommended range between 150 to 2450 mV at 12db
+     */
     adc_oneshot_chan_cfg_t config = {
         .bitwidth = ADC_BITWIDTH_12,
         .atten = ADC_ATTEN_DB_11,
@@ -70,7 +73,9 @@ void initBatteryRead(){
     adc_calibrated = adc_calibration(ADC_UNIT_1, ADC_ATTEN_DB_11, &adc_cal_handle);
 }
 
-//Voltage in mV
+/**
+ * determines the applied voltage at the ADC. Either calibrated or raw.
+ */
 static int32_t getVoltage(){
     int raw_val, voltage;
     adc_oneshot_read(adc_handle, ADC_CHANNEL_4, &raw_val);
@@ -86,7 +91,10 @@ static int32_t getVoltage(){
 }
 
 void battery_Timer_Event(TimerHandle_t ev){
-    //https://esp32.com/viewtopic.php?t=1459
+    /* If there is too much output, the ESP crashes
+     * https://esp32.com/viewtopic.php?t=1459
+     */
+
 
     getVoltage();
     if(measurementCount < 10){
@@ -98,7 +106,7 @@ void battery_Timer_Event(TimerHandle_t ev){
         measurementCount = 0;
 
         //battery range between 3.4 and 4.2V
-        //r2/(r1+r2) = 0.755 akutell
+        //r2/(r1+r2) = 0.755 with the used resistors
         //vmax_in = 4.2*0.755 = 3.171
         //vmin_in = 3.8*0.755 = 2.869
         //steps = (3171-2869)/100 = 302/100

components/battery/include/battery.h

@@ -6,9 +6,19 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/timers.h"
 
+//global storage var of the battery percentage
 extern uint8_t batteryPercentage;
 
+/**
+ * initialize the required ADC.
+ */
 void initBatteryRead();
+
+/**
+ * Timer event which determines a percentage value from the measured voltage.
+ *
+ * @param ev                  timer handle. Not used.
+ */
 void battery_Timer_Event(TimerHandle_t ev);
 
 #endif

components/ble/gap.c

@@ -35,6 +35,7 @@ void bleAdvertise(void){
     struct ble_gap_adv_params adv_params;
     struct ble_hs_adv_fields fields;
     int rc;
+    const char* name;
 
     /*
      *  Set the advertisement data included in our advertisements:
@@ -60,8 +61,9 @@ void bleAdvertise(void){
     fields.tx_pwr_lvl_is_present = 1;
     fields.tx_pwr_lvl = BLE_HS_ADV_TX_PWR_LVL_AUTO;
 
-    fields.name = (uint8_t *)CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME;
-    fields.name_len = strlen(CONFIG_BT_NIMBLE_SVC_GAP_DEVICE_NAME);
+    name = ble_svc_gap_device_name();
+    fields.name = (uint8_t *)name;
+    fields.name_len = strlen(name);
     fields.name_is_complete = 1;
 
     fields.appearance = ble_svc_gap_device_appearance();

components/button/button.c

@@ -30,6 +30,11 @@ void initButtons(){
     gpio_set_pull_mode(GPIO_NUM_25,GPIO_PULLUP_ONLY);
 }
 
+/**
+ * Interrupt Service Routine for the buttons
+ * 
+ * @param arg       enum of the pressedbutton
+ */
 static void IRAM_ATTR buttonISRHandler(void* arg)
 {
     BUTTON pressedButton = (BUTTON) arg;

components/button/include/button.h

@@ -1,13 +1,30 @@
 #ifndef BUTTON_H
 #define BUTTON_H
 
+/**
+ * enum with the possible buttons
+ */
 typedef enum BUTTON {
     LEFTBUTTON,
     RIGHTBUTTON,
 } BUTTON;
 
+/**
+ * setup the gpios for the buttons
+ */
 void initButtons();
+
+/**
+ * Get the last value for a specific button. If there is no data for 30 seconds it will be aborted.
+ * 
+ * @param selectedButton        specify a specific button
+ * @return                      High or Low for the button output 
+ */
 int getButton(BUTTON *selectedButton);
+
+/**
+ * Clear the Queue with stored button states
+ */
 void clearStoredButtons();
 
 #endif

components/ssd1306/include/ssd1306.h

@@ -1,22 +1,66 @@
+/*credits:  https://github.com/nopnop2002/esp-idf-ssd1306
+ *          http://robotcantalk.blogspot.com/2015/03/interfacing-arduino-with-ssd1306-driven.html
+*/
+
 #ifndef SSD1306_H
 #define SSD1306_H
 
-//credits:  https://github.com/nopnop2002/esp-idf-ssd1306
-//          http://robotcantalk.blogspot.com/2015/03/interfacing-arduino-with-ssd1306-driven.html
-
 #include <stdint.h>
 #include <stdbool.h>
 
 #define SSD1306_WIDTH   128
 #define SSD1306_HEIGHT  32
 
+/**
+ * setup the ssd1306 display
+ */
 void ssd1306_init();
+
+/**
+ * setup the I2C interface on the ESP
+ */
 void I2C_master_init();
+
+/**
+ * clear the memory of the selected pixels. Only on the ESP side.
+ */
 void ssd1306_clear();
+
+/**
+ * display the current stored pixel data on the ESP
+ */
 void ssd1306_display();
+
+/**
+ * Set a specific pixel in the pixel data. Axis origin is the left top.
+ *
+ * @param x                  x coord
+ * @param y                  y coord
+ * @param status             enable or disable the bit
+ */
 void ssd1306_setPixel(uint8_t x, uint8_t y, bool status);
+
+/**
+ * Set a char at a specific position in the pixel data.
+ *
+ * @param c                  the character to be written
+ * @param x                  x coord
+ * @param y                  y coord
+ */
 void ssd1306_setChar(char c, uint8_t x, uint8_t y);
+
+/**
+ * set a string at a specific position in the pixel data.
+ *
+ * @param str                The string to be written
+ * @param x                  x coord
+ * @param y                  y coord
+ */
 void ssd1306_setString(const char* str, uint8_t x, uint8_t y);
+
+/**
+ * set an image in the whole pixel data with a connected icon.
+ */
 void ssd1306_setConnectedImage();
 
 #endif