rename SyncController into PyController

Author: SteveNguyen

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rustypot"
-version = "1.0.0"
+version = "1.1.0"
 edition = "2021"
 license = "Apache-2.0"
 authors = ["Pollen Robotics"]

python/README.md

@@ -23,9 +23,9 @@ The Python bindings exposes the same API as the Controller API in the rust crate
 You first need to create a Controller object. For instance, to communicate with a serial port to Feetech STS3215 motors, you can do the following:
 
 ```python
-from rustypot.servo import Sts3215SyncController
+from rustypot.servo import Sts3215PyController
 
-c = Sts3215SyncController(serial_port='/dev/ttyUSB0', baudrate=100000, timeout=0.1)
+c = Sts3215PyController(serial_port='/dev/ttyUSB0', baudrate=100000, timeout=0.1)
 ```
 
 

python/examples/feetech_sinus.py

@@ -1,12 +1,12 @@
 import time
 import numpy as np
 
-from rustypot.servo import Sts3215SyncController
+from rustypot.servo import Sts3215PyController
 
 def main():
     c = Sts3215SyncController(
-        serial_port='/dev/tty.usbmodem58FA0822621', 
-        baudrate=1000000, 
+        serial_port='/dev/tty.usbmodem58FA0822621',
+        baudrate=1000000,
         timeout=0.1,
     )
 
@@ -24,4 +24,4 @@ def main():
         time.sleep(0.01)
 
 if __name__ == '__main__':
-    main()
+    main()

src/servo/servo_macro.rs

@@ -31,7 +31,7 @@ macro_rules! generate_servo {
 
             #[cfg(feature = "python")]
             #[pyo3::pyclass(frozen)]
-            pub struct [<$servo_name:camel SyncController>](std::sync::Mutex<[<$servo_name:camel Controller>]>);
+            pub struct [<$servo_name:camel PyController>](std::sync::Mutex<[<$servo_name:camel Controller>]>);
         }
 
         #[cfg(feature = "python")]
@@ -62,7 +62,7 @@ macro_rules! generate_protocol_constructor {
             }
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 #[new]
                 pub fn new(serial_port: &str, baudrate: u32, timeout: f32) -> PyResult<Self> {
                     let serial_port = serialport::new(serial_port, baudrate)
@@ -93,7 +93,7 @@ macro_rules! generate_protocol_constructor {
             }
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 #[new]
                 pub fn new(serial_port: &str, baudrate: u32, timeout: f32) -> PyResult<Self> {
                     let serial_port = serialport::new(serial_port, baudrate)
@@ -165,7 +165,7 @@ macro_rules! generate_addr_read_write {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 pub fn read_raw_data(
                     &self,
                     py: Python,
@@ -309,7 +309,7 @@ macro_rules! generate_reg_read {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 pub fn [<sync_read_ $reg_name>](
                     &self,
                     py: Python,
@@ -328,7 +328,7 @@ macro_rules! generate_reg_read {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 pub fn [<read_ $reg_name>](
                     &self,
                     py: Python,
@@ -462,7 +462,7 @@ macro_rules! generate_reg_read {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 #[doc = concat!("Sync read raw register *", stringify!($name), "* (addr: ", stringify!($addr), ", type: ", stringify!($reg_type), ")")]
                 pub fn [<sync_read_raw_ $reg_name>](
                     &self,
@@ -590,7 +590,7 @@ macro_rules! generate_reg_write {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 #[doc = concat!("Sync write register *", stringify!($name), "* (addr: ", stringify!($addr), ", type: ", stringify!($reg_type), ")")]
                 pub fn [<sync_write_ $reg_name>](
                     &self,
@@ -736,7 +736,7 @@ macro_rules! generate_reg_write {
 
             #[cfg(feature = "python")]
             #[pymethods]
-            impl [<$servo_name:camel SyncController>] {
+            impl [<$servo_name:camel PyController>] {
                 #[doc = concat!("Sync write raw register *", stringify!($name), "* (addr: ", stringify!($addr), ", type: ", stringify!($reg_type), ")")]
                 pub fn [<sync_write_raw_ $reg_name>](
                     &self,
@@ -871,7 +871,7 @@ macro_rules! register_servo {
                 let child_module = PyModule::new(parent_module.py(), "servo")?;
 
                 $(
-                    child_module.add_class::<$group::[<$servo:lower>]::[<$servo:camel SyncController>]>()?;
+                    child_module.add_class::<$group::[<$servo:lower>]::[<$servo:camel PyController>]>()?;
                 )+
 
                     parent_module.add_submodule(&child_module)?;