fix: wrong adc resolution for ESP32

Author: gbr1

Diff for: examples/SerialDebug/SerialDebug.ino

@@ -1,29 +1,24 @@
 /*
-  This file is part of the Arduino_ScienceKitCarrier library.
-  Copyright (c) 2023 Arduino SA. All rights reserved.
+    This file is part of the Arduino_ScienceKitCarrier library.
 
-  This library is free software; you can redistribute it and/or
-  modify it under the terms of the GNU Lesser General Public
-  License as published by the Free Software Foundation; either
-  version 2.1 of the License, or (at your option) any later version.
+    Copyright (c) 2024 Arduino SA
 
-  This library 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.  See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public
-  License along with this library; if not, write to the Free Software
-  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+    This Source Code Form is subject to the terms of the Mozilla Public
+    License, v. 2.0. If a copy of the MPL was not distributed with this
+    file, You can obtain one at http://mozilla.org/MPL/2.0/.
+    
 */
 
+// This examples print all data from Arduino Science Kit R3
+
 #include "Arduino_ScienceKitCarrier.h"
 
 ScienceKitCarrier science_kit;
 
 
 void setup() {
   Serial.begin(115200);
+  while(!Serial);
   science_kit.begin(START_AUXILIARY_THREADS);
 }
 
@@ -93,6 +88,20 @@ void loop() {
   Serial.print(science_kit.getExternalTemperatureIsConnected());
   Serial.print("\t|| ");
 
+  Serial.print(science_kit.getUltrasonicIsConnected());
+  Serial.print("\t");
+  Serial.print(science_kit.getDistance());
+  Serial.print("\t");
+  Serial.print(science_kit.getTravelTime());
+  Serial.print("\t|| ");
+
+  // Microphone is only availble on Arduino Nano RP2040 Connect edition
+  #ifdef ARDUINO_NANO_RP2040_CONNECT
+  Serial.print(science_kit.getMicrophoneRMS());
+  Serial.print("\t|| ");
+  #endif
+  
   Serial.print("\n");
+  
   delay(10);
-}
+}

Diff for: src/Arduino_ScienceKitCarrier.cpp

@@ -34,6 +34,7 @@ ScienceKitCarrier::ScienceKitCarrier(){
   inputA=0;
   inputB=0;
   timer_inputA = 0;
+  board_resolution = BOARD_RESOLUTION;
 
   apds9960 = new APDS9960(Wire,INT_APDS9960);
   proximity=0;
@@ -235,6 +236,9 @@ void ScienceKitCarrier::update(const bool roundrobin){
 
 
 
+
+
+
 /********************************************************************/
 /*                          Analog Inputs                           */
 /********************************************************************/
@@ -249,7 +253,7 @@ void ScienceKitCarrier::updateAnalogInput(const uint8_t input_to_update){
   if ((input_to_update==UPDATE_INPUT_A)||(input_to_update==UPDATE_ALL)){
 
     if (!getExternalTemperatureIsConnected()){
-      inputA=analogRead(inputA_pin);
+      inputA=analogRead(inputA_pin)>>board_resolution;
       #ifdef ESP32
         beginExternalTemperature();
       #endif
@@ -260,7 +264,7 @@ void ScienceKitCarrier::updateAnalogInput(const uint8_t input_to_update){
 
   }
   if ((input_to_update==UPDATE_INPUT_B)||(input_to_update==UPDATE_ALL)){
-    inputB=analogRead(inputB_pin);
+    inputB=analogRead(inputB_pin)>>board_resolution;
   }
 }
 
@@ -279,12 +283,14 @@ int ScienceKitCarrier::getInputB(){
 /********************************************************************/
 /*                             APDS9960                             */
 /********************************************************************/
+
 int ScienceKitCarrier::beginAPDS(){
   if (!apds9960->begin()) {
     return ERR_BEGIN_APDS;
   }
   return 0;
 }
+
 void ScienceKitCarrier::updateAPDS(){
   wire_lock;
   if (apds9960->proximityAvailable()){
@@ -407,8 +413,6 @@ float ScienceKitCarrier::getResistanceMeasureVolts(){
   return value;
 }
 
-
-
 float ScienceKitCarrier::getResistance(){
   return resistance;
 }
@@ -590,6 +594,7 @@ float ScienceKitCarrier::getMagneticFieldZ(){
 
 
 
+
 /********************************************************************/
 /*                   LEDs: errors and status                      */
 /********************************************************************/
@@ -680,6 +685,9 @@ void ScienceKitCarrier::freeRTOSStatusLed(void * pvParameters){
 #endif
 
 
+
+
+
 /********************************************************************/
 /*                  Function Generator Controller                   */
 /********************************************************************/
@@ -722,6 +730,8 @@ uint8_t ScienceKitCarrier::getRange2(){
 
 
 
+
+
 /********************************************************************/
 /*                        Ultrasonic Sensor                         */
 /********************************************************************/
@@ -802,10 +812,13 @@ void ScienceKitCarrier::freeRTOSUltrasonic(void * pvParameters){
 }
 #endif
 
+
+
+
+
 /********************************************************************/
 /*                    External Temperature Probe                    */
 /********************************************************************/
-//WIP
 
 int ScienceKitCarrier::beginExternalTemperature(){
   new (&ow) OneWireNg_CurrentPlatform(OW_PIN, false);
@@ -854,7 +867,6 @@ void ScienceKitCarrier::updateExternalTemperature(){
   }
 }
 
-
 float ScienceKitCarrier::getExternalTemperature(){
   return external_temperature;
 }
@@ -880,9 +892,13 @@ void ScienceKitCarrier::freeRTOSExternalTemperature(void * pvParameters){
 #endif
 
 
+
+
+
 /********************************************************************/
 /*                             Microphone                           */
 /********************************************************************/
+
 #ifdef ARDUINO_NANO_RP2040_CONNECT
 int ScienceKitCarrier::beginMicrophone(){
   PDM.setGain(50);
@@ -920,6 +936,7 @@ uint ScienceKitCarrier::getMicrophoneRMS(){
 
 
 
+
 /********************************************************************/
 /*                              Threads                             */
 /********************************************************************/
@@ -976,6 +993,9 @@ void ScienceKitCarrier::startAuxiliaryThreads(const uint8_t auxiliary_threads){
 }
 
 
+
+
+
 /***
  *                       _       _                                    
  *         /\           | |     (_)                                   

Diff for: src/Arduino_ScienceKitCarrier.h

@@ -71,6 +71,7 @@ class ScienceKitCarrier{
 
     uint8_t inputA_pin, inputB_pin;
     int inputA, inputB;
+    uint8_t board_resolution;
     uint8_t timer_inputA;
 
     APDS9960 * apds9960;

Diff for: src/utils/Arduino_ScienceKitCarrier_definitions.h

@@ -28,6 +28,13 @@
 #define UPDATE_INPUT_A 1
 #define UPDATE_INPUT_B 2
 
+#ifdef ARDUINO_NANO_RP2040_CONNECT
+#define BOARD_RESOLUTION 0
+#endif
+#ifdef ESP32
+#define BOARD_RESOLUTION 2
+#endif
+
 // APDS9960
 #define INT_APDS9960 9
 
@@ -113,7 +120,7 @@ const uint16_t MAXIMUM_AMPS{1};            // 1A
 #define START_EXTERNAL_AMBIENT_SENSOR 3     // ds18b20
 #define START_ULTRASONIC 4                  // grove I2C ultrasonic sensor
 #define START_STATUS_LED 5
-#
+
 
 #ifdef ESP32 // 1 user, 0 secondary core
 #define EXTERNAL_TEMPERATURE_CORE 1