Merge pull request #118 from leonardocavagnis/deprecation

leonardocavagnis · web-flow · commit a2a31d34408d · 2024-02-27T12:31:23.000+01:00
Deprecate library
diff --git a/README.md b/README.md
@@ -1,4 +1,11 @@
-# Portenta Machine Control Library for Arduino
+# [Deprecated] Portenta Machine Control Library for Arduino
+
+> [!WARNING]
+> This library is deprecated and no longer actively maintained.
+>
+> We recommend transitioning to the [Arduino_PortentaMachineControl](https://github.com/arduino-libraries/Arduino_PortentaMachineControl) library for ongoing support, new features and contributions. If you need assistance with migration, refer to the [migration guide](https://docs.arduino.cc/tutorials/portenta-machine-control/pmc-arduino-library).
+>
+> Please note that the [examples](./examples/) provided with this library are not compatible with the new library.
 
 [![Check Arduino status](https://github.com/arduino-libraries/Arduino_MachineControl/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_MachineControl/actions/workflows/check-arduino.yml)
 [![Compile Examples status](https://github.com/arduino-libraries/Arduino_MachineControl/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_MachineControl/actions/workflows/compile-examples.yml)
diff --git a/examples/Analog_Out/Analog_Out.ino b/examples/Analog_Out/Analog_Out.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Analog out Example
 
diff --git a/examples/Analog_input/Analog_input_0_10V/Analog_input_0_10V.ino b/examples/Analog_input/Analog_input_0_10V/Analog_input_0_10V.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Analog in 0 - 10 V Example
 
diff --git a/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino b/examples/Analog_input/Analog_input_4_20mA/Analog_input_4_20mA.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Analog in 4 - 20 mA Example
 
diff --git a/examples/Analog_input/Analog_input_NTC/Analog_input_NTC.ino b/examples/Analog_input/Analog_input_NTC/Analog_input_NTC.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Analog in NTC Example
 
diff --git a/examples/CAN/ReadCan/ReadCan.ino b/examples/CAN/ReadCan/ReadCan.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   CAN Read Example
 
diff --git a/examples/CAN/WriteCan/WriteCan.ino b/examples/CAN/WriteCan/WriteCan.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   CAN Write Example
 
diff --git a/examples/Digital_output/Digital_output.ino b/examples/Digital_output/Digital_output.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Digital Output Example
 
diff --git a/examples/Digital_programmable/CombinedIOExpander/CombinedIOExpander.ino b/examples/Digital_programmable/CombinedIOExpander/CombinedIOExpander.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - IOExpander Read And Write Example
 
diff --git a/examples/Digital_programmable/Digital_input/Digital_input.ino b/examples/Digital_programmable/Digital_input/Digital_input.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Digital Input Example
 
diff --git a/examples/Digital_programmable/GPIO_programmable/GPIO_programmable.ino b/examples/Digital_programmable/GPIO_programmable/GPIO_programmable.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - IOExpander Read And Write Example
 
diff --git a/examples/Encoders/Encoders.ino b/examples/Encoders/Encoders.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 #include <Arduino_MachineControl.h>
 
 using namespace machinecontrol;
diff --git a/examples/RS232/RS232.ino b/examples/RS232/RS232.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   RS232 communication
 
diff --git a/examples/RS485_fullduplex/RS485_fullduplex.ino b/examples/RS485_fullduplex/RS485_fullduplex.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   RS485 Full duplex communication
 
diff --git a/examples/RS485_halfduplex/RS485_halfduplex.ino b/examples/RS485_halfduplex/RS485_halfduplex.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   RS485 Half Duplex communication
 
diff --git a/examples/RTC/RTC.ino b/examples/RTC/RTC.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - RTC Example
 
diff --git a/examples/RTC_Alarm/RTC_Alarm.ino b/examples/RTC_Alarm/RTC_Alarm.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - RTC Alarm Example
 
diff --git a/examples/Temp_probes_RTD/Temp_probes_RTD.ino b/examples/Temp_probes_RTD/Temp_probes_RTD.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Temperature probes RTD example
 
diff --git a/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino b/examples/Temp_probes_Thermocouples/Temp_probes_Thermocouples.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 /*
   Machine Control - Thermocouples Read Sensors
 
diff --git a/examples/USB_host/USB_host.ino b/examples/USB_host/USB_host.ino
@@ -1,3 +1,15 @@
+/*
+ * IMPORTANT NOTE:
+ *
+ * This example is associated with the deprecated Arduino_MachineControl library.
+ * We have introduced a new and improved library called Arduino_PortentaMachineControl, which offers enhanced features
+ * and ongoing support. 
+ * We encourage you to update your projects to use the new library.
+ * 
+ * The functions and syntax in this example are not compatible with Arduino_PortentaMachineControl.
+ * Please refer to the migration guide for necessary adjustments.
+ */
+
 #include <Arduino_MachineControl.h>
 #include <USBHost.h>
 
diff --git a/library.properties b/library.properties
@@ -2,8 +2,8 @@ name=Arduino_MachineControl
 version=1.1.1
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
-sentence=Arduino Library for Portenta Machine Control - PMC
-paragraph=
+sentence=DEPRECATED. Arduino Library for Portenta Machine Control - PMC
+paragraph=This library is no longer actively maintained and is deprecated. Consider migrating to the Arduino_PortentaMachineControl library.
 category=Communication
 url=https://github.com/arduino-libraries/Arduino_MachineControl
 architectures=mbed, mbed_portenta
