AnalogIn: change sensor type management

Author: leonardocavagnis

docs/api.md

@@ -24,7 +24,7 @@ Class for the Analog IN connector of the Portenta Machine Control.
 --------------------------------|---------------------------------------------
 `public ` [`AnalogInClass`](#public-analoginclasspinname-ai0_pin--mc_ai_ai0_pin-pinname-ai1_pin--mc_ai_ai1_pin-pinname-ai2_pin--mc_ai_ai2_pin)`(PinName ai0_pin, PinName ai1_pin, PinName ai2_pin)` | Construct an Analog Input reader for the Portenta Machine Control.
 `public ` [`~AnalogInClass`](#public-analoginclass)`()` | Destruct the AnalogInClass object.
-`public bool` [`begin`](#public-bool-beginint-sensor_type-int-res_bits--16)`(int sensor_type, int res_bits)` | Initialize the analog reader, configure the sensor type and read resolution.
+`public bool` [`begin`](#public-bool-beginint-sensor_type-int-res_bits--16)`(SensorType sensor_type, int res_bits)` | Initialize the analog reader, configure the sensor type and read resolution.
 `public uint16_t` [`read`](#public-uint16_t-readint-channel)`(int channel)` | Read the sampled voltage from the selected channel.
 
 # class `AnalogOutClass`

examples/Analog_input/Analog_input_0_10V/Analog_input_0_10V.ino

@@ -25,7 +25,7 @@ void setup() {
     ; // wait for serial port to connect.
   }
 
-  MachineControl_AnalogIn.begin(MCAI_SENSOR_0_10V);
+  MachineControl_AnalogIn.begin(SensorType::V_0_10);
 }
 
 void loop() {

examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino

@@ -26,7 +26,7 @@ void setup() {
     ; // wait for serial port to connect.
   }
 
-  MachineControl_AnalogIn.begin(MCAI_SENSOR_4_20MA);
+  MachineControl_AnalogIn.begin(SensorType::MA_4_20);
 }
 
 void loop() {

examples/Analog_input/Analog_input_NTC/Analog_input_NTC.ino

@@ -29,7 +29,7 @@ void setup() {
     ; // wait for serial port to connect.
   }
 
-  MachineControl_AnalogIn.begin(MCAI_SENSOR_NTC);
+  MachineControl_AnalogIn.begin(SensorType::NTC);
 }
 
 void loop() {

library.properties

@@ -8,4 +8,4 @@ category=Communication
 url=https://github.com/arduino-libraries/Arduino_MachineControl
 architectures=mbed, mbed_portenta
 includes=Arduino_MachineControl.h
-depends=ArduinoRS485
+depends=ArduinoRS485, Arduino_CAN

src/AnalogInClass.cpp

@@ -49,14 +49,14 @@ AnalogInClass::AnalogInClass(PinName ai0_pin, PinName ai1_pin, PinName ai2_pin)
 AnalogInClass::~AnalogInClass() 
 { }
 
-bool AnalogInClass::begin(int sensor_type, int res_bits) {
+bool AnalogInClass::begin(SensorType sensor_type, int res_bits) {
     bool ret = true;
 
     /* Set bit resolution of ADC */
     analogReadResolution(res_bits);
 
     switch (sensor_type) {
-        case MCAI_SENSOR_NTC:
+        case SensorType::NTC:
             /* Enable a 100K resistor in series with the reference voltage.	 
              * The voltage sampled is the voltage division between the 100k resistor and the input resistor (NTC/PTC) */
             digitalWrite(CH0_IN1, LOW);
@@ -74,7 +74,7 @@ bool AnalogInClass::begin(int sensor_type, int res_bits) {
             digitalWrite(CH2_IN3, HIGH);
             digitalWrite(CH2_IN4, HIGH);
             break;
-        case MCAI_SENSOR_0_10V:
+        case SensorType::V_0_10:
             /* Configure the input resistor dividers to have a ratio of 0.28
              * (Maximum input voltage is 10V). */
             digitalWrite(CH0_IN1, HIGH);
@@ -92,7 +92,7 @@ bool AnalogInClass::begin(int sensor_type, int res_bits) {
             digitalWrite(CH2_IN3, LOW);
             digitalWrite(CH2_IN4, HIGH);
             break;
-        case MCAI_SENSOR_4_20MA:
+        case SensorType::MA_4_20:
             /* Enable a 120 ohm resistor to GND to convert the 4-20mA sensor currents to voltage. 
              * Note: 24V are available from the carrier to power the 4-20mA sensors. */
             digitalWrite(CH0_IN1, HIGH);

src/AnalogInClass.h

@@ -17,11 +17,15 @@
 
 /* Exported defines ----------------------------------------------------------*/
 
-/** Analog Sensor type **/
-#define MCAI_SENSOR_NTC         1
-#define MCAI_SENSOR_0_10V       2
-#define MCAI_SENSOR_4_20MA      3
-
+/**
+ * @brief Enum class that represents different sensor types.
+ */
+enum class SensorType {
+    NTC = 1,
+    V_0_10 = 2,
+    MA_4_20 = 3
+};
+ 
 /* Class ----------------------------------------------------------------------*/
 
 /**
@@ -49,11 +53,11 @@ class AnalogInClass {
         /**
          * @brief Initialize the analog reader, configure the sensor type and read resolution.
          *
-         * @param sensor_type The sensor type (0-10V, 4-20mA or NTC)
+         * @param sensor_type The sensor type (NTC, V_0_10 or MA_4_20)
          * @param res_bits Resolution in bits of the read analog value
-         * @return true If the analog reader is successfully initialized, false Otherwise
+         * @return true If the analog reader is successfully initialized, false otherwise
          */
-        bool begin(int sensor_type, int res_bits = 16);
+        bool begin(SensorType sensor_type, int res_bits = 16);
 
         /**
          * @brief Read the sampled voltage from the selected channel.