- Changed Header management

Rocketct · Rocketct · commit 0279a1366b83 · 2019-12-02T14:58:36.000+01:00
- Changed the Copyright
- Modified Header's example

Generalized the library name and added a header for nano
diff --git a/examples/Flasher/Flasher.ino b/examples/Flasher/Flasher.ino
@@ -9,7 +9,7 @@
 
 #include "Wire.h"
 #include "fw.h"
-#include "MKRMotorCarrier.h"
+#include "ArduinoMotorCarrier.h"
 
 #define I2C_ADDRESS 0x09
 
diff --git a/examples/Motor_test/Motor_test.ino b/examples/Motor_test/Motor_test.ino
@@ -1,4 +1,4 @@
-#include <MKRMotorCarrier.h>
+#include <ArduinoMotorCarrier.h>
 #define INTERRUPT_PIN 6
 
 //Variable to store the battery voltage
@@ -89,4 +89,4 @@ void loop() {
   //wait
   delay(50);
   }
-}
+}
diff --git a/examples/Motor_test_encoder/Motor_test_encoder.ino b/examples/Motor_test_encoder/Motor_test_encoder.ino
@@ -1,4 +1,4 @@
-#include <MKRMotorCarrier.h>
+#include <ArduinoMotorCarrier.h>
 #define INTERRUPT_PIN 6
 
 //Variable to store the battery voltage
diff --git a/examples/Servo_test/Servo_test.ino b/examples/Servo_test/Servo_test.ino
@@ -1,5 +1,5 @@
 
-#include <MKRMotorCarrier.h>
+#include <ArduinoMotorCarrier.h>
 #define INTERRUPT_PIN 6
 
 //Variable to store the battery voltage
@@ -82,4 +82,4 @@ void loop() {
   controller.ping();
   //wait
   delay(50);
-}
+}
diff --git a/examples/Test/Test.ino b/examples/Test/Test.ino
@@ -5,7 +5,7 @@
   This example code is in the public domain.
 */
 
-#include "MKRMotorCarrier.h"
+#include "ArduinoMotorCarrier.h"
 
 void setup() {
 
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
-name=MKRMotorCarrier
+name=ArduinoMotorCarrier
 version=1.0.5
 author=Arduino
 maintainer=Arduino <info@arduino.cc>
-sentence=Allows to use the MKR Motor Carrier
-paragraph=Allows to use the MKR Motor Carrier
+sentence=Allows to use the Arduino Motor shields
+paragraph=Allows to use the Arduino Motor shields
 category=Signal Input/Output
 url=http://www.arduino.cc/en/Reference/
 architectures=samd
diff --git a/src/ArduinoMotorCarrier.cpp b/src/ArduinoMotorCarrier.cpp
@@ -1,6 +1,6 @@
 /*
-  MKRMotorShield.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  ArduinoMotorCarrier.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
@@ -14,7 +14,7 @@
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
-#include "MKRMotorShield.h"
+#include "ArduinoMotorCarrier.h"
 
 namespace mc {
 void setDataPIDGains(Commands cmd, uint8_t target, int16_t P, int16_t I, int16_t D) {
diff --git a/src/ArduinoMotorCarrier.h b/src/ArduinoMotorCarrier.h
@@ -1,6 +1,6 @@
 /*
-  MKRMotorShield.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  ArduinoMotorCarrier.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
@@ -14,8 +14,8 @@
   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
-#ifndef __MKRMOTORSHIELD__
-#define __MKRMOTORSHIELD__
+#ifndef __ARDUINOMOTORSHIELD__
+#define __ARDUINOMOTORSHIELD__
 
 #include <Wire.h>
 #include "Encoder.h"
diff --git a/src/Battery.cpp b/src/Battery.cpp
@@ -1,6 +1,6 @@
 /*
-  Battery.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  Battery.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/Battery.h b/src/Battery.h
@@ -1,6 +1,6 @@
 /*
-  Battery.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  Battery.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/Common.h b/src/Common.h
@@ -1,6 +1,6 @@
 /*
-  Common.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  Common.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/DCMotor.cpp b/src/DCMotor.cpp
@@ -1,6 +1,6 @@
 /*
-  DCMotor.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  DCMotor.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/DCMotor.h b/src/DCMotor.h
@@ -1,6 +1,6 @@
 /*
-  DCMotor.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  DCMotor.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/Encoder.cpp b/src/Encoder.cpp
@@ -1,6 +1,6 @@
 /*
-  Encoder.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  Encoder.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/Encoder.h b/src/Encoder.h
@@ -1,6 +1,6 @@
 /*
-  Encoder.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  Encoder.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/MKRMotorCarrier.h b/src/MKRMotorCarrier.h
@@ -1 +1,23 @@
-#include "MKRMotorShield.h"
+/*
+  MKRMotorCarrier.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
+  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.
+  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 St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef __MKRMOTORSHIELD__
+#define __MKRMOTORSHIELD__
+
+#warning "This Header is going to be deprecated please use ArduinoMotorCarrier.h"
+#include "ArduinoMotorCarrier.h"
+
+#endif
diff --git a/src/MotorController.cpp b/src/MotorController.cpp
@@ -1,6 +1,6 @@
 /*
-  MotorCOntroller.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  MotorCOntroller.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/MotorController.h b/src/MotorController.h
@@ -1,6 +1,6 @@
 /*
-  MotorController.h - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  MotorController.h - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/NanoMotorCarrirer.h b/src/NanoMotorCarrirer.h
@@ -0,0 +1,22 @@
+/*- Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
+  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.
+  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 St, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef __NANOMOTORSHIELD__
+#define __NANOMOTORSHIELD__
+
+#warning "This Header is going to be deprecated please use ArduinoMotorCarrier.h"
+#include "ArduinoMotorCarrier.h"
+
+#endif
diff --git a/src/PID.cpp b/src/PID.cpp
@@ -1,6 +1,6 @@
 /*
-  PID.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  PID.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/ServoMotor.cpp b/src/ServoMotor.cpp
@@ -1,6 +1,6 @@
 /*
-  ServoMotor.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  ServoMotor.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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
diff --git a/src/ServoMotor.h b/src/ServoMotor.h
@@ -1,6 +1,6 @@
 /*
-  ServoMotor.cpp - Library for Arduino MKR Motor Shield
-  Copyright (c) 2018 Arduino AG.  All right reserved.
+  ServoMotor.cpp - Library for Arduino Motor Shields
+  Copyright (c) 2018-2019 Arduino AG.  All right reserved.
   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

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#include <MKRMotorCarrier.h>`
	`1`	`+#include <ArduinoMotorCarrier.h>`
`2`	`2`	`#define INTERRUPT_PIN 6`
`3`	`3`
`4`	`4`	`//Variable to store the battery voltage`