Skip to content

PcpOverUsb

PcpOverUsb is the canonical API 2.0.0 transport adapter for PCP communication over USB. Use it for direct actuator USB connections and for USB-connected CAN adapters.

Source code in pcp_api/pcp_over_usb.pyi 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class PcpOverUsb:
    def __init__(self, port: Optional[str] = None, connect_on_init: bool = True, logger: Optional[logging.Logger] = None) -> None: ...

    def close(self) -> None: ...

    def set_callback(self, address: int, callback: Callable) -> None:
        """Register a callback for a transport address."""
        ...

    def setCallback(self, address: int, callback: Callable) -> None: ...

    def remove_callback(self, address: int) -> None:
        """Remove a callback for a specific address"""
        ...

    def removeCallback(self, address: int) -> None: ...

    def connect(self, port: Optional[str] = None) -> bool: ...

    def disconnect(self) -> None: ...

    @property
    def is_connected(self) -> bool: ...

    @staticmethod
    def check_pcp_id_range(can_id: int) -> bool:
        """Check if the address fits the 14-bit PCP address field."""
        ...

    @staticmethod
    def check_pcp_payload_size(payload) -> bool: ...

    def send_PCP(self, address: int, data: list, priority: bool = True, can_high_speed: bool = False) -> bool: ...

    def enter_bootloader(self) -> None:
        """To put the CAN adapter itself into bootloader mode """
        ...

    @staticmethod
    def get_ports() -> list[str]: ...

    @staticmethod
    def get_port() -> str:
        """Autodiscover the serial port for PCP over USB."""
        ...

check_pcp_id_range(can_id) staticmethod

Check if the address fits the 14-bit PCP address field.

Source code in pcp_api/pcp_over_usb.pyi 
31
32
33
34
@staticmethod
def check_pcp_id_range(can_id: int) -> bool:
    """Check if the address fits the 14-bit PCP address field."""
    ...

enter_bootloader()

To put the CAN adapter itself into bootloader mode

Source code in pcp_api/pcp_over_usb.pyi 
41
42
43
def enter_bootloader(self) -> None:
    """To put the CAN adapter itself into bootloader mode """
    ...

get_port() staticmethod

Autodiscover the serial port for PCP over USB.

Source code in pcp_api/pcp_over_usb.pyi 
48
49
50
51
@staticmethod
def get_port() -> str:
    """Autodiscover the serial port for PCP over USB."""
    ...

remove_callback(address)

Remove a callback for a specific address

Source code in pcp_api/pcp_over_usb.pyi 
18
19
20
def remove_callback(self, address: int) -> None:
    """Remove a callback for a specific address"""
    ...

set_callback(address, callback)

Register a callback for a transport address.

Source code in pcp_api/pcp_over_usb.pyi 
12
13
14
def set_callback(self, address: int, callback: Callable) -> None:
    """Register a callback for a transport address."""
    ...