makcu 0.1.2__tar.gz → 0.1.4__tar.gz

{makcu-0.1.2/makcu.egg-info → makcu-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: makcu
-Version: 0.1.2
+Version: 0.1.4
 Summary: Python library to interact with Makcu devices.
 Author: SleepyTotem
 License: GPL
@@ -50,14 +50,6 @@ python -m makcu [command]
 | `--testPort COM3` | Tests a specific COM port for connectivity |
 | `--runtest` | Runs all automated tests and opens a test report |
 
-### Examples
-
-```bash
-python -m makcu --debug
-python -m makcu --testPort COM3
-python -m makcu --runtest
-```
-
 ---
 
 ## 🧠 Quickstart (Python)
@@ -65,7 +57,7 @@ python -m makcu --runtest
 ```python
 from makcu import create_controller, MouseButton
 
-makcu = create_controller("COM1") # Fallback port
+makcu = create_controller("COM1")
 makcu.click(MouseButton.LEFT)
 makcu.move(100, 50)
 makcu.scroll(-1)
@@ -79,20 +71,14 @@ makcu.disconnect()
 ### 🔧 Initialization
 
 ```python
-makcu = create_controller(debug=True, send_init=True)
-```
-
-#### Set fallback port manually
-
-```python
-makcu = create_controller("COM4")  # Optional fallback com port
+makcu = create_controller(fallback_com_port="COM1", debug=True, send_init=True)
 ```
 
 ---
 
 ### 🎮 Mouse Control
 
-#### Clicks
+#### Button Actions
 
 ```python
 makcu.click(MouseButton.LEFT)
@@ -103,21 +89,21 @@ makcu.release(MouseButton.RIGHT)
 #### Movement
 
 ```python
-makcu.move(dx=30, dy=20)
+makcu.move(30, 20)
 makcu.move_smooth(100, 40, segments=10)
 makcu.move_bezier(50, 50, 15, ctrl_x=25, ctrl_y=25)
 ```
 
-#### Scrolling
+#### Scroll Wheel
 
 ```python
-makcu.scroll(-3)  # Scroll down
-makcu.scroll(3)   # Scroll up
+makcu.scroll(-3)
+makcu.scroll(3)
 ```
 
 ---
 
-### 🔒 Locking and Unlocking
+### 🔒 Locking
 
 ```python
 makcu.lock_left(True)
@@ -129,10 +115,10 @@ makcu.lock_mouse_x(True)
 makcu.lock_mouse_y(False)
 ```
 
-#### Lock Status
+#### Lock State Query
 
 ```python
-makcu.is_button_locked(MouseButton.LEFT)
+makcu.is_locked(MouseButton.LEFT)
 makcu.get_all_lock_states()
 ```
 
@@ -144,7 +130,7 @@ makcu.get_all_lock_states()
 makcu.click_human_like(
     button=MouseButton.LEFT,
     count=5,
-    profile="normal",  # "fast", "slow" also available
+    profile="normal",  # or "fast", "slow"
     jitter=3
 )
 ```
@@ -155,10 +141,7 @@ makcu.click_human_like(
 
 ```python
 info = makcu.get_device_info()
-print(info)
-
 version = makcu.get_firmware_version()
-print(version)
 ```
 
 ---
@@ -172,15 +155,15 @@ makcu.reset_serial()
 
 ---
 
-## 🧪 Button Monitoring & Capture
+## 🧪 Button Monitoring
 
-### Enable Real-time Monitoring
+### Enable Monitoring
 
 ```python
 makcu.enable_button_monitoring(True)
 ```
 
-### Set Callback Function
+### Set Event Callback
 
 ```python
 def on_button_event(button, pressed):
@@ -191,66 +174,46 @@ makcu.set_button_callback(on_button_event)
 
 ---
 
-## ❌ Click Capturing (Pending Firmware Update)
-
-Click capturing will allow you to detect and count click events in software.
+## ❌ Click Capturing (Pending Firmware Fix)
 
 ```python
 makcu.mouse.lock_right(True)
-makcu.capture(MouseButton.RIGHT)
+makcu.mouse.begin_capture("RIGHT")
 
-# User clicks however many times
+# Simulated user input...
 
 makcu.mouse.lock_right(False)
-count = makcu.get_captured_clicks(MouseButton.RIGHT)
+count = makcu.mouse.stop_capturing_clicks("RIGHT")
 print(f"Captured clicks: {count}")
 ```
 
-> ⚠️ This feature is currently broken in firmware. Do not rely on it yet.
+> ⚠️ Not fully supported yet — firmware must be updated to complete this feature.
 
 ---
 
 ## 🔢 Bitmask & Button States
 
-### Get Bitmask of Active Buttons
-
 ```python
 mask = makcu.get_button_mask()
-print(f"Button mask: {mask}")
-```
-
-### Get Raw Button State Map
-
-```python
 states = makcu.get_button_states()
-print(states)  # {'left': False, 'right': True, ...}
-```
-
-### Check if a Specific Button Is Pressed
 
-```python
-if makcu.is_button_pressed(MouseButton.RIGHT):
-    print("Right button is pressed")
+if makcu.is_pressed(MouseButton.RIGHT):
+    print("Right button is currently pressed")
 ```
 
 ---
 
-## ⚙️ Low-Level Command Access
-
-### Send raw serial commands
+## ⚙️ Low-Level Access
 
 ```python
-from makcu import create_controller
-makcu = create_controller()
 response = makcu.transport.send_command("km.version()", expect_response=True)
-print(response)
 ```
 
 ---
 
 ## 🧪 Test Suite
 
-Run all tests and generate HTML report:
+Run full test suite and generate an HTML report:
 
 ```bash
 python -m makcu --runtest
@@ -287,11 +250,11 @@ except MakcuConnectionError as e:
 
 ## 🛠️ Developer Notes
 
-- Uses CH343 USB Serial
-- Auto-connects to correct port or fallback
-- Supports baud rate switching to 4M
-- Automatically enables `km.buttons(1)` monitoring if `send_init=True`
-- Supports raw button state polling
+- Communicates via CH343 USB serial
+- Automatically finds correct port or uses fallback
+- Switches baud to 4M after initial connect
+- Enables `km.buttons(1)` on init if requested
+- Supports full button state tracking with events
 
 ---
 
@@ -301,10 +264,11 @@ GPL License © SleepyTotem
 
 ---
 
-## Support
-Please open an issue on the project repository and I will get to it asap
+## 🙋 Support
+
+Open an issue on GitHub if you encounter bugs or need help.
 
 ## 🌐 Links
 
-- 🔗 [Project Homepage](https://github.com/SleepyTotem/makcu-py-lib)
-- 🔗 [PyPi Homepage](https://github.com/SleepyTotem/makcu-py-lib)
+- [GitHub Repo](https://github.com/SleepyTotem/makcu-py-lib)
+- [PyPI Package](https://pypi.org/project/makcu/)

{makcu-0.1.2 → makcu-0.1.4}/README.md

@@ -38,14 +38,6 @@ python -m makcu [command]
 | `--testPort COM3` | Tests a specific COM port for connectivity |
 | `--runtest` | Runs all automated tests and opens a test report |
 
-### Examples
-
-```bash
-python -m makcu --debug
-python -m makcu --testPort COM3
-python -m makcu --runtest
-```
-
 ---
 
 ## 🧠 Quickstart (Python)
@@ -53,7 +45,7 @@ python -m makcu --runtest
 ```python
 from makcu import create_controller, MouseButton
 
-makcu = create_controller("COM1") # Fallback port
+makcu = create_controller("COM1")
 makcu.click(MouseButton.LEFT)
 makcu.move(100, 50)
 makcu.scroll(-1)
@@ -67,20 +59,14 @@ makcu.disconnect()
 ### 🔧 Initialization
 
 ```python
-makcu = create_controller(debug=True, send_init=True)
-```
-
-#### Set fallback port manually
-
-```python
-makcu = create_controller("COM4")  # Optional fallback com port
+makcu = create_controller(fallback_com_port="COM1", debug=True, send_init=True)
 ```
 
 ---
 
 ### 🎮 Mouse Control
 
-#### Clicks
+#### Button Actions
 
 ```python
 makcu.click(MouseButton.LEFT)
@@ -91,21 +77,21 @@ makcu.release(MouseButton.RIGHT)
 #### Movement
 
 ```python
-makcu.move(dx=30, dy=20)
+makcu.move(30, 20)
 makcu.move_smooth(100, 40, segments=10)
 makcu.move_bezier(50, 50, 15, ctrl_x=25, ctrl_y=25)
 ```
 
-#### Scrolling
+#### Scroll Wheel
 
 ```python
-makcu.scroll(-3)  # Scroll down
-makcu.scroll(3)   # Scroll up
+makcu.scroll(-3)
+makcu.scroll(3)
 ```
 
 ---
 
-### 🔒 Locking and Unlocking
+### 🔒 Locking
 
 ```python
 makcu.lock_left(True)
@@ -117,10 +103,10 @@ makcu.lock_mouse_x(True)
 makcu.lock_mouse_y(False)
 ```
 
-#### Lock Status
+#### Lock State Query
 
 ```python
-makcu.is_button_locked(MouseButton.LEFT)
+makcu.is_locked(MouseButton.LEFT)
 makcu.get_all_lock_states()
 ```
 
@@ -132,7 +118,7 @@ makcu.get_all_lock_states()
 makcu.click_human_like(
     button=MouseButton.LEFT,
     count=5,
-    profile="normal",  # "fast", "slow" also available
+    profile="normal",  # or "fast", "slow"
     jitter=3
 )
 ```
@@ -143,10 +129,7 @@ makcu.click_human_like(
 
 ```python
 info = makcu.get_device_info()
-print(info)
-
 version = makcu.get_firmware_version()
-print(version)
 ```
 
 ---
@@ -160,15 +143,15 @@ makcu.reset_serial()
 
 ---
 
-## 🧪 Button Monitoring & Capture
+## 🧪 Button Monitoring
 
-### Enable Real-time Monitoring
+### Enable Monitoring
 
 ```python
 makcu.enable_button_monitoring(True)
 ```
 
-### Set Callback Function
+### Set Event Callback
 
 ```python
 def on_button_event(button, pressed):
@@ -179,66 +162,46 @@ makcu.set_button_callback(on_button_event)
 
 ---
 
-## ❌ Click Capturing (Pending Firmware Update)
-
-Click capturing will allow you to detect and count click events in software.
+## ❌ Click Capturing (Pending Firmware Fix)
 
 ```python
 makcu.mouse.lock_right(True)
-makcu.capture(MouseButton.RIGHT)
+makcu.mouse.begin_capture("RIGHT")
 
-# User clicks however many times
+# Simulated user input...
 
 makcu.mouse.lock_right(False)
-count = makcu.get_captured_clicks(MouseButton.RIGHT)
+count = makcu.mouse.stop_capturing_clicks("RIGHT")
 print(f"Captured clicks: {count}")
 ```
 
-> ⚠️ This feature is currently broken in firmware. Do not rely on it yet.
+> ⚠️ Not fully supported yet — firmware must be updated to complete this feature.
 
 ---
 
 ## 🔢 Bitmask & Button States
 
-### Get Bitmask of Active Buttons
-
 ```python
 mask = makcu.get_button_mask()
-print(f"Button mask: {mask}")
-```
-
-### Get Raw Button State Map
-
-```python
 states = makcu.get_button_states()
-print(states)  # {'left': False, 'right': True, ...}
-```
-
-### Check if a Specific Button Is Pressed
 
-```python
-if makcu.is_button_pressed(MouseButton.RIGHT):
-    print("Right button is pressed")
+if makcu.is_pressed(MouseButton.RIGHT):
+    print("Right button is currently pressed")
 ```
 
 ---
 
-## ⚙️ Low-Level Command Access
-
-### Send raw serial commands
+## ⚙️ Low-Level Access
 
 ```python
-from makcu import create_controller
-makcu = create_controller()
 response = makcu.transport.send_command("km.version()", expect_response=True)
-print(response)
 ```
 
 ---
 
 ## 🧪 Test Suite
 
-Run all tests and generate HTML report:
+Run full test suite and generate an HTML report:
 
 ```bash
 python -m makcu --runtest
@@ -275,11 +238,11 @@ except MakcuConnectionError as e:
 
 ## 🛠️ Developer Notes
 
-- Uses CH343 USB Serial
-- Auto-connects to correct port or fallback
-- Supports baud rate switching to 4M
-- Automatically enables `km.buttons(1)` monitoring if `send_init=True`
-- Supports raw button state polling
+- Communicates via CH343 USB serial
+- Automatically finds correct port or uses fallback
+- Switches baud to 4M after initial connect
+- Enables `km.buttons(1)` on init if requested
+- Supports full button state tracking with events
 
 ---
 
@@ -289,10 +252,11 @@ GPL License © SleepyTotem
 
 ---
 
-## Support
-Please open an issue on the project repository and I will get to it asap
+## 🙋 Support
+
+Open an issue on GitHub if you encounter bugs or need help.
 
 ## 🌐 Links
 
-- 🔗 [Project Homepage](https://github.com/SleepyTotem/makcu-py-lib)
-- 🔗 [PyPi Homepage](https://github.com/SleepyTotem/makcu-py-lib)
+- [GitHub Repo](https://github.com/SleepyTotem/makcu-py-lib)
+- [PyPI Package](https://pypi.org/project/makcu/)

{makcu-0.1.2 → makcu-0.1.4}/makcu/__main__.py

@@ -33,7 +33,7 @@ def debug_console():
 def test_port(port):
     try:
         print(f"Trying to connect to {port} (without init command)...")
-        controller = create_controller(send_init=False)
+        controller = create_controller(fallback_com_port=port, send_init=False)
         print(f"✅ Successfully connected to {port}")
         controller.disconnect()
     except MakcuConnectionError as e:
@@ -47,14 +47,14 @@ def run_tests():
     package_dir = Path(__file__).resolve().parent
     test_file = package_dir / "test_suite.py"
 
-    sys.exit(pytest.main([
+    result = pytest.main([
         str(test_file),
         "--rootdir", str(package_dir),
         "-v", "--tb=short",
         "--capture=tee-sys",
         "--html=latest_pytest.html",
         "--self-contained-html"
-    ]))
+    ])
 
     report_path = os.path.abspath("latest_pytest.html")
     if os.path.exists(report_path):
@@ -63,11 +63,13 @@ def run_tests():
     else:
         print("❌ Report not found. Something went wrong.")
 
-    if result.returncode != 0:
+    if result != 0:
         print("❌ Some tests failed.")
     else:
         print("✅ All tests passed.")
 
+    sys.exit(result)
+    
 def main():
     args = sys.argv[1:]