Change to semantic versioning (#107)

Author: alan412

external_samples/color_range_sensor.py

@@ -40,8 +40,8 @@ def get_part_number(self) -> str:
         return "REV-31-1557"
     def get_url(self) -> str:  
         return "https://www.revrobotics.com/rev-31-1557"
-    def get_version(self) -> tuple[int, int, str]: 
-        return (1, 0, "")
+    def get_version(self) -> tuple[int, int, int]: 
+        return (1, 0, 0)
     def stop(self) -> None:
         # send stop command to sensor
         pass

external_samples/component.py

@@ -55,12 +55,11 @@ def get_part_number(self) -> str:
     @abstractmethod
     def get_url(self) -> str:  
         pass
-    # This is the version of the software (returned as a (major, minor, revision) tuple where 
-    # major and minor are positive integers
-    # revision can be an empty string or specify small changes that are less than a
-    # minor revision
+    # This is the version of the software (returned as a (major, minor, patch) tuple where 
+    # major, minor and patch are all positive integers
+    # This MUST follow semantic versioning as described here: https://semver.org/
     @abstractmethod
-    def get_version(self) -> tuple[int, int, str]: 
+    def get_version(self) -> tuple[int, int, int]: 
         pass
 
     # This stops all movement (if any) for the component

external_samples/rev_touch_sensor.py

@@ -33,8 +33,8 @@ def get_part_number(self) -> str:
         return "REV-31-1425"
     def get_url(self) -> str:  
         return "https://www.revrobotics.com/rev-31-1425/"
-    def get_version(self) -> tuple[int, int, str]: 
-        return (1, 0, "")
+    def get_version(self) -> tuple[int, int, int]: 
+        return (1, 0, 0)
     def stop(self) -> None:
         pass
     def reset(self) -> None:

external_samples/servo.py

@@ -32,8 +32,8 @@ def get_part_number(self) -> str:
         return "REV-41-1097"
     def get_url(self) -> str:  
         return "https://www.revrobotics.com/rev-41-1097/"
-    def get_version(self) -> tuple[int, int, str]: 
-        return (1, 0, "")
+    def get_version(self) -> tuple[int, int, int]: 
+        return (1, 0, 0)
     def stop(self) -> None:
         # De-energize servo port
         pass

external_samples/smart_motor.py

@@ -31,8 +31,8 @@ def get_part_number(self) -> str:
         return "REV-xx-xxxx"
     def get_url(self) -> str:  
         return "https://www.revrobotics.com/rev-xx-xxxx"
-    def get_version(self) -> tuple[int, int, str]: 
-        return (1, 0, "")
+    def get_version(self) -> tuple[int, int, int]: 
+        return (1, 0, 0)
     def stop(self) -> None:
         # send stop command to motor
         pass

external_samples/sparkfun_led_stick.py

@@ -23,8 +23,8 @@ def get_part_number(self) -> str:
     def get_url(self) -> str:  
         return "https://www.sparkfun.com/sparkfun-qwiic-led-stick-apa102c.html"
 
-    def get_version(self) -> tuple[int, int, str]: 
-        return (1, 0, "")
+    def get_version(self) -> tuple[int, int, int]: 
+        return (1, 0, 0)
 
     def stop(self) -> None:
         self.turn_all_off()