pypsxwakebt 0.1.0__tar.gz

pypsxwakebt-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FreeTHX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pypsxwakebt-0.1.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: pypsxwakebt
+Version: 0.1.0
+Summary: A Python library to wake PlayStation consoles via Bluetooth and extract MAC addresses via USB.
+Home-page: https://github.com/FreeTHX/pypsxwakebt
+Author: FreeTHX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: usb
+Requires-Dist: pyusb; extra == "usb"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# pypsxwakebt
+
+A Python library dedicated to PlayStation (PS3, PS4, PS5) Bluetooth operations and wake-up sequences.
+
+## 🏛️ Legacy Notice
+This library is the official, modern successor to the previous **[pywakepsXonbt](https://github.com/FreeTHX/pywakepsXonbt)** and **[pywakeps4onbt](https://github.com/FreeTHX/pywakeps4onbt)** projects. It unifies, updates, and improves the functionality of these older repositories into a single, actively maintained package.
+
+## 🚀 Current Status: Beta (v0.1.0)
+
+At this stage of development, the library provides a robust utility to extract Bluetooth MAC addresses from PlayStation controllers (DualShock 3, DualShock 4, DualSense) connected via USB. 
+
+*Future releases will integrate low-level Bluetooth HCI commands, MAC address spoofing, and complete wake-up sequences directly from Python.*
+
+## ⚙️ Installation
+
+To install the library with the USB extraction dependencies, run:
+
+```bash
+pip install pypsxwakebt[usb]
+```
+
+## ⚡ Quick Start
+
+Extracting the console and controller MAC addresses via USB:
+
+```python
+from pypsxwakebt.usb import extract_psx_bt_macs
+
+# Ensure your controller is connected via USB before running
+mac_data = extract_psx_bt_macs()
+
+if mac_data:
+    print(f"Controller Type: {mac_data['controller_type']}")
+    print(f"Controller MAC:  {mac_data['dsx_mac']}")
+    print(f"Console MAC:     {mac_data['psx_mac']}")
+else:
+    print("No supported Sony controller found on USB.")
+```
+
+## 🎮 Supported Devices
+
+* DualShock 3 (PS3)
+* DualShock 4 (PS4)
+* DualSense & DualSense Edge (PS5)
+
+## 📄 License
+
+This project is licensed under the MIT License.

pypsxwakebt-0.1.0/README.md

@@ -0,0 +1,48 @@
+# pypsxwakebt
+
+A Python library dedicated to PlayStation (PS3, PS4, PS5) Bluetooth operations and wake-up sequences.
+
+## 🏛️ Legacy Notice
+This library is the official, modern successor to the previous **[pywakepsXonbt](https://github.com/FreeTHX/pywakepsXonbt)** and **[pywakeps4onbt](https://github.com/FreeTHX/pywakeps4onbt)** projects. It unifies, updates, and improves the functionality of these older repositories into a single, actively maintained package.
+
+## 🚀 Current Status: Beta (v0.1.0)
+
+At this stage of development, the library provides a robust utility to extract Bluetooth MAC addresses from PlayStation controllers (DualShock 3, DualShock 4, DualSense) connected via USB. 
+
+*Future releases will integrate low-level Bluetooth HCI commands, MAC address spoofing, and complete wake-up sequences directly from Python.*
+
+## ⚙️ Installation
+
+To install the library with the USB extraction dependencies, run:
+
+```bash
+pip install pypsxwakebt[usb]
+```
+
+## ⚡ Quick Start
+
+Extracting the console and controller MAC addresses via USB:
+
+```python
+from pypsxwakebt.usb import extract_psx_bt_macs
+
+# Ensure your controller is connected via USB before running
+mac_data = extract_psx_bt_macs()
+
+if mac_data:
+    print(f"Controller Type: {mac_data['controller_type']}")
+    print(f"Controller MAC:  {mac_data['dsx_mac']}")
+    print(f"Console MAC:     {mac_data['psx_mac']}")
+else:
+    print("No supported Sony controller found on USB.")
+```
+
+## 🎮 Supported Devices
+
+* DualShock 3 (PS3)
+* DualShock 4 (PS4)
+* DualSense & DualSense Edge (PS5)
+
+## 📄 License
+
+This project is licensed under the MIT License.

pypsxwakebt-0.1.0/psxwakebt/__init__.py

@@ -0,0 +1,8 @@
+"""
+pypsxwakebt
+A library to manage PlayStation wake-up sequences.
+"""
+
+from .usb import extract_psx_bt_macs
+
+__all__ = ["extract_psx_bt_macs"]

pypsxwakebt-0.1.0/psxwakebt/const.py

@@ -0,0 +1,33 @@
+"""
+Constants for the pypsxwakebt library.
+"""
+
+# USB Vendor ID for Sony Corporation
+VENDOR_SONY = 0x054C
+
+# USB Product IDs
+PID_DUALSHOCK3 = 0x0268
+PID_DUALSHOCK4_V1 = 0x05C4
+PID_DUALSHOCK4_V2 = 0x09CC
+PID_DUALSENSE = 0x0CE6
+PID_DUALSENSE_EDGE = 0x0DF2
+
+# Controller String Identifiers
+CTRL_DUALSHOCK3 = "dualshock3"
+CTRL_DUALSHOCK4 = "dualshock4"
+CTRL_DUALSENSE = "dualsense"
+CTRL_DUALSENSE_EDGE = "dualsense_edge"
+
+# Result Dictionary Keys
+KEY_DSX_MAC = "dsx_mac"
+KEY_PSX_MAC = "psx_mac"
+KEY_CTRL_TYPE = "controller_type"
+
+# Device Mapping Table
+SUPPORTED_DEVICES = {
+    PID_DUALSHOCK3: CTRL_DUALSHOCK3,
+    PID_DUALSHOCK4_V1: CTRL_DUALSHOCK4,
+    PID_DUALSHOCK4_V2: CTRL_DUALSHOCK4,
+    PID_DUALSENSE: CTRL_DUALSENSE,
+    PID_DUALSENSE_EDGE: CTRL_DUALSENSE_EDGE,
+}

pypsxwakebt-0.1.0/psxwakebt/usb.py

@@ -0,0 +1,95 @@
+"""
+Module for extracting PlayStation MAC addresses via USB.
+Requires the 'pyusb' package (install with: pip install pypsxwakebt[usb]).
+"""
+import logging
+from typing import Dict, Optional
+
+from .const import (
+    VENDOR_SONY,
+    SUPPORTED_DEVICES,
+    CTRL_DUALSHOCK3,
+    CTRL_DUALSHOCK4,
+    CTRL_DUALSENSE,
+    CTRL_DUALSENSE_EDGE,
+    KEY_DSX_MAC,
+    KEY_PSX_MAC,
+    KEY_CTRL_TYPE,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+def extract_psx_bt_macs() -> Optional[Dict[str, str]]:
+    """Scans for supported controllers and extracts MAC addresses."""
+    try:
+        import usb.core
+        import usb.util
+    except ImportError:
+        _LOGGER.error("The 'pyusb' library is required. Install it using: pip install pypsxwakebt[usb]")
+        return None
+
+    dev = None
+    controller_type = None
+
+    # Find the first connected supported Sony controller
+    for pid, name in SUPPORTED_DEVICES.items():
+        dev = usb.core.find(idVendor=VENDOR_SONY, idProduct=pid)
+        if dev is not None:
+            controller_type = name
+            break
+
+    if dev is None:
+        return None
+
+    # Detach kernel driver if necessary so pyusb can claim the interface
+    kernel_driver_detached = False
+    if dev.is_kernel_driver_active(0):
+        try:
+            dev.detach_kernel_driver(0)
+            kernel_driver_detached = True
+        except usb.core.USBError as err:
+            _LOGGER.error("Failed to detach kernel driver: %s", err)
+            return None
+
+    try:
+        dsx_mac = None
+        psx_mac = None
+
+        if controller_type == CTRL_DUALSHOCK3:
+            msg_ds = dev.ctrl_transfer(0xA1, 0x01, 0x03F2, 0, 17)
+            dsx_mac = ":".join(f"{x:02X}" for x in msg_ds[4:10])
+            
+            msg_host = dev.ctrl_transfer(0xA1, 0x01, 0x03F5, 0, 8)
+            psx_mac = ":".join(f"{x:02X}" for x in msg_host[2:8])
+
+        elif controller_type == CTRL_DUALSHOCK4:
+            msg = dev.ctrl_transfer(0xA1, 0x01, 0x0312, 0, 16)
+            dsx_mac = ":".join(f"{x:02X}" for x in msg[1:7][::-1])
+            psx_mac = ":".join(f"{x:02X}" for x in msg[10:16][::-1])
+
+        elif controller_type in (CTRL_DUALSENSE, CTRL_DUALSENSE_EDGE):
+            msg = dev.ctrl_transfer(0xA1, 0x01, 0x0309, 0, 20)
+            dsx_mac = ":".join(f"{x:02X}" for x in msg[1:7][::-1])
+            psx_mac = ":".join(f"{x:02X}" for x in msg[10:16][::-1])
+
+        if dsx_mac and psx_mac:
+            return {
+                KEY_DSX_MAC: dsx_mac, 
+                KEY_PSX_MAC: psx_mac,
+                KEY_CTRL_TYPE: controller_type
+            }
+            
+    except Exception as err:
+        _LOGGER.error("Error reading USB Feature Report: %s", err)
+        return None
+        
+    finally:
+        # Always clean up USB resources
+        usb.util.dispose_resources(dev)
+        if kernel_driver_detached:
+            try:
+                dev.attach_kernel_driver(0)
+            except usb.core.USBError:
+                pass
+
+    return None

pypsxwakebt-0.1.0/pypsxwakebt.egg-info/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: pypsxwakebt
+Version: 0.1.0
+Summary: A Python library to wake PlayStation consoles via Bluetooth and extract MAC addresses via USB.
+Home-page: https://github.com/FreeTHX/pypsxwakebt
+Author: FreeTHX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: usb
+Requires-Dist: pyusb; extra == "usb"
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# pypsxwakebt
+
+A Python library dedicated to PlayStation (PS3, PS4, PS5) Bluetooth operations and wake-up sequences.
+
+## 🏛️ Legacy Notice
+This library is the official, modern successor to the previous **[pywakepsXonbt](https://github.com/FreeTHX/pywakepsXonbt)** and **[pywakeps4onbt](https://github.com/FreeTHX/pywakeps4onbt)** projects. It unifies, updates, and improves the functionality of these older repositories into a single, actively maintained package.
+
+## 🚀 Current Status: Beta (v0.1.0)
+
+At this stage of development, the library provides a robust utility to extract Bluetooth MAC addresses from PlayStation controllers (DualShock 3, DualShock 4, DualSense) connected via USB. 
+
+*Future releases will integrate low-level Bluetooth HCI commands, MAC address spoofing, and complete wake-up sequences directly from Python.*
+
+## ⚙️ Installation
+
+To install the library with the USB extraction dependencies, run:
+
+```bash
+pip install pypsxwakebt[usb]
+```
+
+## ⚡ Quick Start
+
+Extracting the console and controller MAC addresses via USB:
+
+```python
+from pypsxwakebt.usb import extract_psx_bt_macs
+
+# Ensure your controller is connected via USB before running
+mac_data = extract_psx_bt_macs()
+
+if mac_data:
+    print(f"Controller Type: {mac_data['controller_type']}")
+    print(f"Controller MAC:  {mac_data['dsx_mac']}")
+    print(f"Console MAC:     {mac_data['psx_mac']}")
+else:
+    print("No supported Sony controller found on USB.")
+```
+
+## 🎮 Supported Devices
+
+* DualShock 3 (PS3)
+* DualShock 4 (PS4)
+* DualSense & DualSense Edge (PS5)
+
+## 📄 License
+
+This project is licensed under the MIT License.

pypsxwakebt-0.1.0/pypsxwakebt.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+setup.py
+psxwakebt/__init__.py
+psxwakebt/const.py
+psxwakebt/usb.py
+pypsxwakebt.egg-info/PKG-INFO
+pypsxwakebt.egg-info/SOURCES.txt
+pypsxwakebt.egg-info/dependency_links.txt
+pypsxwakebt.egg-info/requires.txt
+pypsxwakebt.egg-info/top_level.txt

pypsxwakebt-0.1.0/pypsxwakebt.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pypsxwakebt-0.1.0/pypsxwakebt.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[usb]
+pyusb

pypsxwakebt-0.1.0/pypsxwakebt.egg-info/top_level.txt

@@ -0,0 +1 @@
+psxwakebt

pypsxwakebt-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pypsxwakebt-0.1.0/setup.py

@@ -0,0 +1,33 @@
+"""
+Setup configuration for the pypsxwakebt package.
+"""
+from setuptools import setup, find_packages
+
+setup(
+    name="pypsxwakebt",
+    version="0.1.0",
+    description="A Python library to wake PlayStation consoles via Bluetooth and extract MAC addresses via USB.",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    author="FreeTHX",
+    url="https://github.com/FreeTHX/pypsxwakebt",
+    packages=find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    # Base dependencies (empty for now, but you can add your Bluetooth libs here later)
+    install_requires=[],
+    # Optional dependencies (The "Extras" for Home Assistant)
+    extras_require={
+        "usb": ["pyusb"], 
+    },
+    python_requires=">=3.7",
+)