Merge branch 'dev' of github.com:askuric/Arduino-FOC into dev

Author: askuric

examples/utils/sensor_test/magnetic_sensors/magnetic_sensor_analog_example/magnetic_sensor_analog_example.ino

@@ -8,7 +8,7 @@
  * MagneticSensorAnalog(uint8_t _pinAnalog, int _min, int _max)
  * - pinAnalog      - the pin that is reading the pwm from magnetic sensor
  * - min_raw_count  - the smallest expected reading.  Whilst you might expect it to be 0 it is often ~15.  Getting this wrong results in a small click once per revolution
- * - max_raw_count  - the largest value read.  whilst you might expect it to be 2^10 = 1023 it is often ~ 1020
+ * - max_raw_count  - the largest value read.  whilst you might expect it to be 2^10 = 1023 it is often ~ 1020. Note ESP32 will be closer to 4096 with its 12bit ADC
  */
 MagneticSensorAnalog sensor = MagneticSensorAnalog(A1, 14, 1020);
 

src/MagneticSensorAnalog.cpp

@@ -3,7 +3,7 @@
 /** MagneticSensorAnalog(uint8_t _pinAnalog, int _min, int _max)
  * @param _pinAnalog  the pin that is reading the pwm from magnetic sensor
  * @param _min_raw_count  the smallest expected reading.  Whilst you might expect it to be 0 it is often ~15.  Getting this wrong results in a small click once per revolution
- * @param _max_raw_count  the largest value read.  whilst you might expect it to be 2^10 = 1023 it is often ~ 1020
+ * @param _max_raw_count  the largest value read.  whilst you might expect it to be 2^10 = 1023 it is often ~ 1020. Note: For ESP32 (with 12bit ADC the value will be nearer 4096)
  */
 MagneticSensorAnalog::MagneticSensorAnalog(uint8_t _pinAnalog, int _min_raw_count, int _max_raw_count){
 
@@ -106,4 +106,4 @@ int MagneticSensorAnalog::needsAbsoluteZeroSearch(){
 // function reading the raw counter of the magnetic sensor
 int MagneticSensorAnalog::getRawCount(){
 	return analogRead(pinAnalog);
-}
+}