CLI Module API

This page documents the Python API for the CLI module. For user-facing CLI documentation, see the CLI Tool.

Main Entry Point

damiao_motor.cli.unified_main

unified_main() -> None

Unified CLI entry point with subcommands.

Main entry point for the damiao command-line tool. Provides a unified interface for scanning, configuring, and controlling DaMiao motors over CAN bus.

Available commands

• scan: Scan for connected motors
• send-cmd-mit: Send MIT control mode command
• send-cmd-pos-vel: Send POS_VEL control mode command
• send-cmd-vel: Send VEL control mode command
• send-cmd-force-pos: Send FORCE_POS control mode command
• set-zero-command: Send zero command continuously
• set-zero-position: Set current position to zero
• set-can-timeout: Set CAN timeout alarm time
• set-motor-id: Change motor receive ID
• set-feedback-id: Change motor feedback ID
• gui: Launch web-based GUI for motor control

Global options (available for all commands): - --version: Show version number and exit - --channel: CAN channel (default: can0) - --bustype: CAN bus type (default: socketcan) - --bitrate: CAN bitrate in bits per second (default: 1000000)

Examples:

# Scan for motors
damiao scan

# Send MIT command
damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5

# Set current position to zero
damiao set-zero-position --id 1

Source code in damiao_motor/cli/__init__.py

def unified_main() -> None:
    """
    Unified CLI entry point with subcommands.

    Main entry point for the `damiao` command-line tool. Provides a unified interface
    for scanning, configuring, and controlling DaMiao motors over CAN bus.

    Available commands:
        - scan: Scan for connected motors
        - send-cmd-mit: Send MIT control mode command
        - send-cmd-pos-vel: Send POS_VEL control mode command
        - send-cmd-vel: Send VEL control mode command
        - send-cmd-force-pos: Send FORCE_POS control mode command
        - set-zero-command: Send zero command continuously
        - set-zero-position: Set current position to zero
        - set-can-timeout: Set CAN timeout alarm time
        - set-motor-id: Change motor receive ID
        - set-feedback-id: Change motor feedback ID
        - gui: Launch web-based GUI for motor control

    Global options (available for all commands):
        - --version: Show version number and exit
        - --channel: CAN channel (default: can0)
        - --bustype: CAN bus type (default: socketcan)
        - --bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        # Scan for motors
        damiao scan

        # Send MIT command
        damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5

        # Set current position to zero
        damiao set-zero-position --id 1
        ```
    """
    parser = argparse.ArgumentParser(
        description="DaMiao Motor CLI Tool - Control and configure DaMiao motors over CAN bus",
        formatter_class=ColorizedHelpFormatter,
        epilog="""
For more information about a specific command, use:
  damiao <command> --help
        """,
    )

    # Global arguments
    parser.add_argument(
        "--version",
        action="version",
        version=f"{__version__}",
        help="Show version number",
    )
    parser.add_argument(
        "--channel",
        type=str,
        default="can0",
        help="CAN channel (default: can0)",
    )
    parser.add_argument(
        "--bustype",
        type=str,
        default="socketcan",
        help="CAN bus type (default: socketcan)",
    )
    parser.add_argument(
        "--bitrate",
        type=int,
        default=1000000,
        help="CAN bitrate in bits per second (default: 1000000). Only used when bringing up interface.",
    )

    subparsers = parser.add_subparsers(
        dest="command",
        help="Available commands",
        required=True,
        metavar="COMMAND",
        title="Commands",
        description="Use 'damiao <command> --help' for more information about a specific command."
    )

    # gui command (highlighted - listed first)
    gui_parser = subparsers.add_parser(
        "gui",
        help="Launch web-based GUI for motor control (recommended)",
        description="Launch the web-based GUI for viewing and controlling DaMiao motors.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Start GUI on default host and port (http://127.0.0.1:5000)
  damiao gui

  # Start GUI on custom port
  damiao gui --port 8080

  # Start GUI on all interfaces
  damiao gui --host 0.0.0.0

  # Start GUI with production server (requires waitress)
  damiao gui --production

  # Start GUI with debug mode
  damiao gui --debug
        """
    )
    gui_parser.add_argument(
        "--host",
        type=str,
        default="127.0.0.1",
        help="Host to bind to (default: 127.0.0.1)",
    )
    gui_parser.add_argument(
        "--port",
        type=int,
        default=5000,
        help="Port to bind to (default: 5000)",
    )
    gui_parser.add_argument(
        "--debug",
        action="store_true",
        help="Enable debug mode",
    )
    gui_parser.add_argument(
        "--production",
        action="store_true",
        help="Use production WSGI server (requires waitress)",
    )
    gui_parser.set_defaults(func=cmd_gui)

    # Helper function to add global arguments to subcommands
    def add_global_args(subparser):
        """Add global arguments to a subcommand parser."""
        subparser.add_argument(
            "--channel",
            type=str,
            default="can0",
            help="CAN channel (default: can0)",
        )
        subparser.add_argument(
            "--bustype",
            type=str,
            default="socketcan",
            help="CAN bus type (default: socketcan)",
        )
        subparser.add_argument(
            "--bitrate",
            type=int,
            default=1000000,
            help="CAN bitrate in bits per second (default: 1000000). Only used when bringing up interface.",
        )
        subparser.add_argument(
            "--motor-type",
            type=str,
            default="4340",
            choices=["4310", "4310P", "4340", "4340P", "6006", "8006", "8009", "10010L", "10010", "H3510", "G6215", "H6220", "JH11", "6248P", "3507"],
            dest="motor_type",
            help="Motor type for P/V/T presets (e.g. 4340, 4310, 3507). Defaults to 4340. Only needed for encoding commands; doesn't affect which motors are detected during scan.",
        )

    # scan command
    scan_parser = subparsers.add_parser(
        "scan",
        help="Scan for connected motors on CAN bus",
        description="Scan for connected motors on CAN bus by sending zero commands and listening for responses.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Scan default ID range (0x01-0x10) - motor-type is optional
  damiao scan

  # Scan specific motor IDs
  damiao scan --ids 1 2 3

  # Scan with longer listen duration
  damiao scan --duration 2.0

  # Scan with specific motor type (optional, defaults to 4310)
  damiao scan --motor-type 4340

  # Scan with debug output (print all raw CAN messages)
  damiao scan --debug
        """
    )
    scan_parser.add_argument(
        "--ids",
        type=int,
        nargs="+",
        metavar="ID",
        help="Motor IDs to test (e.g., --ids 1 2 3). If not specified, tests IDs 0x01-0x10.",
    )
    scan_parser.add_argument(
        "--duration",
        type=float,
        default=0.5,
        help="Duration to listen for responses in seconds (default: 0.5)",
    )
    scan_parser.add_argument(
        "--debug",
        action="store_true",
        help="Print all raw CAN messages for debugging.",
    )
    # Add global args (channel, bustype, bitrate) but NOT motor-type
    scan_parser.add_argument(
        "--channel",
        type=str,
        default="can0",
        help="CAN channel (default: can0)",
    )
    scan_parser.add_argument(
        "--bustype",
        type=str,
        default="socketcan",
        help="CAN bus type (default: socketcan)",
    )
    scan_parser.add_argument(
        "--bitrate",
        type=int,
        default=1000000,
        help="CAN bitrate in bits per second (default: 1000000). Only used when bringing up interface.",
    )
    # Motor type is optional for scan (defaults to 4310)
    scan_parser.add_argument(
        "--motor-type",
        type=str,
        default="4310",
        choices=["4310", "4310P", "4340", "4340P", "6006", "8006", "8009", "10010L", "10010", "H3510", "G6215", "H6220", "JH11", "6248P", "3507"],
        dest="motor_type",
        help="Motor type for P/V/T presets (default: 4310). Only used for encoding zero commands; doesn't affect which motors are detected.",
    )
    scan_parser.set_defaults(func=cmd_scan)

    # set-zero-command (renamed from set-zero)
    zero_parser = subparsers.add_parser(
        "set-zero-command",
        help="Send zero command to a motor",
        description="Send a zero command continuously to a motor.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Send zero command continuously (loops until Ctrl+C)
  damiao set-zero-command --id 1

  # With custom frequency
  damiao set-zero-command --id 1 --frequency 50.0
        """
    )
    zero_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID to send zero command to",
    )
    zero_parser.add_argument(
        "--frequency",
        type=float,
        default=100.0,
        help="Command frequency in Hz (default: 100.0)",
    )
    add_global_args(zero_parser)
    zero_parser.set_defaults(func=cmd_set_zero)

    # set-zero-position command
    zero_pos_parser = subparsers.add_parser(
        "set-zero-position",
        help="Set current position to zero",
        description="Set the current output shaft position to zero (save position zero).",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Set current position to zero
  damiao set-zero-position --id 1
        """
    )
    zero_pos_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    add_global_args(zero_pos_parser)
    zero_pos_parser.set_defaults(func=cmd_set_zero_position)

    # set-can-timeout command
    timeout_parser = subparsers.add_parser(
        "set-can-timeout",
        help="Set CAN timeout alarm time (register 9)",
        description="Set the CAN timeout alarm time in milliseconds. Register 9 uses units of 50 microseconds (1 unit = 50us).",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Set CAN timeout to 1000 ms
  damiao set-can-timeout --id 1 --timeout 1000
        """
    )
    timeout_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    timeout_parser.add_argument(
        "--timeout",
        type=int,
        required=True,
        dest="timeout_ms",
        help="Timeout in milliseconds (ms)",
    )
    add_global_args(timeout_parser)
    timeout_parser.set_defaults(func=cmd_set_can_timeout)

    # set-motor-id command
    set_motor_id_parser = subparsers.add_parser(
        "set-motor-id",
        help="Set motor receive ID (register 8)",
        description="Change the motor's receive ID (ESC_ID, register 8). This is the ID used to send commands to the motor.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Change motor ID from 1 to 2
  damiao set-motor-id --current 1 --target 2

Note: After changing the motor ID, you will need to use the new ID to communicate with the motor.
        """
    )
    set_motor_id_parser.add_argument(
        "--current",
        type=int,
        required=True,
        help="Current motor ID (to connect to the motor)",
    )
    set_motor_id_parser.add_argument(
        "--target",
        type=int,
        required=True,
        help="Target motor ID (new receive ID)",
    )
    add_global_args(set_motor_id_parser)
    set_motor_id_parser.set_defaults(func=cmd_set_motor_id)

    # set-feedback-id command
    set_feedback_id_parser = subparsers.add_parser(
        "set-feedback-id",
        help="Set motor feedback ID (register 7)",
        description="Change the motor's feedback ID (MST_ID, register 7). This is the ID used to identify feedback messages from the motor.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # Change feedback ID to 3 (using motor ID 1 to connect)
  damiao set-feedback-id --current 1 --target 3

Note: The motor will now respond with feedback using the new feedback ID.
        """
    )
    set_feedback_id_parser.add_argument(
        "--current",
        type=int,
        required=True,
        help="Current motor ID (to connect to the motor)",
    )
    set_feedback_id_parser.add_argument(
        "--target",
        type=int,
        required=True,
        help="Target feedback ID (new MST_ID)",
    )
    add_global_args(set_feedback_id_parser)
    set_feedback_id_parser.set_defaults(func=cmd_set_feedback_id)

    # send-cmd-mit command
    send_cmd_mit_parser = subparsers.add_parser(
        "send-cmd-mit",
        help="Send MIT control mode command to motor",
        description="Send MIT control mode command to motor. Loops continuously until Ctrl+C.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # MIT mode with all parameters
  damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5

  # With custom frequency
  damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5 --frequency 50.0
        """
    )
    send_cmd_mit_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    send_cmd_mit_parser.add_argument(
        "--position",
        type=float,
        required=True,
        help="Desired position (radians)",
    )
    send_cmd_mit_parser.add_argument(
        "--velocity",
        type=float,
        required=True,
        help="Desired velocity (rad/s)",
    )
    send_cmd_mit_parser.add_argument(
        "--stiffness",
        type=float,
        default=0.0,
        dest="stiffness",
        help="Stiffness (kp), range 0–500 (default: 0.0)",
    )
    send_cmd_mit_parser.add_argument(
        "--damping",
        type=float,
        default=0.0,
        dest="damping",
        help="Damping (kd), range 0–5 (default: 0.0)",
    )
    send_cmd_mit_parser.add_argument(
        "--feedforward-torque",
        type=float,
        default=0.0,
        dest="feedforward_torque",
        help="Feedforward torque (default: 0.0)",
    )
    send_cmd_mit_parser.add_argument(
        "--frequency",
        type=float,
        default=100.0,
        help="Command frequency in Hz (default: 100.0)",
    )
    add_global_args(send_cmd_mit_parser)
    send_cmd_mit_parser.set_defaults(func=cmd_send_cmd_mit)

    # send-cmd-pos-vel command
    send_cmd_pos_vel_parser = subparsers.add_parser(
        "send-cmd-pos-vel",
        help="Send POS_VEL control mode command to motor",
        description="Send POS_VEL control mode command to motor. Loops continuously until Ctrl+C.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # POS_VEL mode
  damiao send-cmd-pos-vel --id 1 --position 1.5 --velocity 2.0

  # With custom frequency
  damiao send-cmd-pos-vel --id 1 --position 1.5 --velocity 2.0 --frequency 50.0
        """
    )
    send_cmd_pos_vel_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    send_cmd_pos_vel_parser.add_argument(
        "--position",
        type=float,
        required=True,
        help="Desired position (radians)",
    )
    send_cmd_pos_vel_parser.add_argument(
        "--velocity",
        type=float,
        required=True,
        help="Desired velocity (rad/s)",
    )
    send_cmd_pos_vel_parser.add_argument(
        "--frequency",
        type=float,
        default=100.0,
        help="Command frequency in Hz (default: 100.0)",
    )
    add_global_args(send_cmd_pos_vel_parser)
    send_cmd_pos_vel_parser.set_defaults(func=cmd_send_cmd_pos_vel)

    # send-cmd-vel command
    send_cmd_vel_parser = subparsers.add_parser(
        "send-cmd-vel",
        help="Send VEL control mode command to motor",
        description="Send VEL control mode command to motor. Loops continuously until Ctrl+C.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # VEL mode
  damiao send-cmd-vel --id 1 --velocity 3.0

  # With custom frequency
  damiao send-cmd-vel --id 1 --velocity 3.0 --frequency 50.0
        """
    )
    send_cmd_vel_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    send_cmd_vel_parser.add_argument(
        "--velocity",
        type=float,
        required=True,
        help="Desired velocity (rad/s)",
    )
    send_cmd_vel_parser.add_argument(
        "--frequency",
        type=float,
        default=100.0,
        help="Command frequency in Hz (default: 100.0)",
    )
    add_global_args(send_cmd_vel_parser)
    send_cmd_vel_parser.set_defaults(func=cmd_send_cmd_vel)

    # send-cmd-force-pos command
    send_cmd_force_pos_parser = subparsers.add_parser(
        "send-cmd-force-pos",
        help="Send FORCE_POS control mode command to motor",
        description="Send FORCE_POS control mode command to motor. Loops continuously until Ctrl+C.",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  # FORCE_POS mode
  damiao send-cmd-force-pos --id 1 --position 1.5 --velocity-limit 50.0 --current-limit 0.8

  # With custom frequency
  damiao send-cmd-force-pos --id 1 --position 1.5 --velocity-limit 50.0 --current-limit 0.8 --frequency 50.0
        """
    )
    send_cmd_force_pos_parser.add_argument(
        "--id",
        type=int,
        required=True,
        dest="motor_id",
        help="Motor ID",
    )
    send_cmd_force_pos_parser.add_argument(
        "--position",
        type=float,
        required=True,
        help="Desired position (radians)",
    )
    send_cmd_force_pos_parser.add_argument(
        "--velocity-limit",
        type=float,
        required=True,
        dest="velocity_limit",
        help="Velocity limit (rad/s, 0-100)",
    )
    send_cmd_force_pos_parser.add_argument(
        "--current-limit",
        type=float,
        required=True,
        dest="current_limit",
        help="Torque current limit normalized (0.0-1.0)",
    )
    send_cmd_force_pos_parser.add_argument(
        "--frequency",
        type=float,
        default=100.0,
        help="Command frequency in Hz (default: 100.0)",
    )
    add_global_args(send_cmd_force_pos_parser)
    send_cmd_force_pos_parser.set_defaults(func=cmd_send_cmd_force_pos)

    args = parser.parse_args()

    # Execute the appropriate command
    try:
        args.func(args)
    except KeyboardInterrupt:
        print("\n\nInterrupted by user.")
        sys.exit(1)
    except Exception as e:
        print(f"\n\nError: {e}")
        sys.exit(1)

Command Handlers

damiao_motor.cli.commands.cmd_scan

cmd_scan(args) -> None

Handle 'scan' subcommand.

Scans for connected motors on the CAN bus by sending zero commands and listening for feedback.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - ids: Optional list of motor IDs to test (default: 0x01-0x10) - duration: Duration to listen for responses in seconds (default: 0.5) - bitrate: CAN bitrate in bits per second (default: 1000000) - debug: Print all raw CAN messages for debugging (default: False)	required

Examples:

# Scan default ID range (0x01-0x10)
damiao scan

# Scan specific motor IDs
damiao scan --ids 1 2 3

# Scan with longer listen duration
damiao scan --duration 2.0

# Scan with debug output
damiao scan --debug

Source code in damiao_motor/cli/commands.py

def cmd_scan(args) -> None:
    """
    Handle 'scan' subcommand.

    Scans for connected motors on the CAN bus by sending zero commands and listening for feedback.

    Args:
        args: Parsed command-line arguments containing:
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - ids: Optional list of motor IDs to test (default: 0x01-0x10)
            - duration: Duration to listen for responses in seconds (default: 0.5)
            - bitrate: CAN bitrate in bits per second (default: 1000000)
            - debug: Print all raw CAN messages for debugging (default: False)

    Examples:
        ```bash
        # Scan default ID range (0x01-0x10)
        damiao scan

        # Scan specific motor IDs
        damiao scan --ids 1 2 3

        # Scan with longer listen duration
        damiao scan --duration 2.0

        # Scan with debug output
        damiao scan --debug
        ```
    """
    # Print header and configuration in a single box
    print()
    top_border = f"{BOX_CORNER_TL}{BOX_HORIZONTAL * 78}{BOX_CORNER_TR}"
    print(top_border)
    # Header line
    header_text = f" {GREEN}DaMiao Motor Scanner{RESET}"
    print(f"{BOX_VERTICAL}{pad_with_ansi(header_text, 78)}{BOX_VERTICAL}")
    # Separator line
    print(f"{BOX_JOIN_LEFT}{BOX_HORIZONTAL * 78}{BOX_JOIN_RIGHT}")
    # Configuration lines
    config_lines = [
        f" CAN channel: {args.channel}",
        f" Bus type: {args.bustype}",
        f" Motor type: {args.motor_type} (for encoding only)",
        f" Testing motor IDs: {', '.join([hex(i) for i in args.ids]) if args.ids else '0x01-0x10 (default range)'}",
        f" Listen duration: {args.duration}s",
    ]
    if args.debug:
        config_lines.append(" Debug mode: ENABLED (printing all raw CAN messages)")

    for line in config_lines:
        print(f"{BOX_VERTICAL}{pad_with_ansi(line, 78)}{BOX_VERTICAL}")
    bottom_border = f"{BOX_CORNER_BL}{BOX_HORIZONTAL * 78}{BOX_CORNER_BR}"
    print(bottom_border)
    print()

    try:
        responded = scan_motors(
            channel=args.channel,
            bustype=args.bustype,
            motor_ids=args.ids,
            duration_s=args.duration,
            bitrate=args.bitrate,
            debug=args.debug,
            motor_type=args.motor_type,
        )

        # Print final summary
        print()
        if responded:
            # Combined scan summary box
            top_border = f"{BOX_CORNER_TL}{BOX_HORIZONTAL * 78}{BOX_CORNER_TR}"
            print(top_border)
            # Header line
            header_text = f" {GREEN}Scan Summary{RESET}"
            print(f"{BOX_VERTICAL}{pad_with_ansi(header_text, 78)}{BOX_VERTICAL}")
            # Separator line
            print(f"{BOX_JOIN_LEFT}{BOX_HORIZONTAL * 78}{BOX_JOIN_RIGHT}")
            # Summary lines
            summary_lines = [
                f" Found {len(responded)} motor(s):"
            ]
            for motor_id in sorted(responded):
                summary_lines.append(f"   • Motor ID: 0x{motor_id:02X} ({motor_id})")
            for line in summary_lines:
                print(f"{BOX_VERTICAL}{pad_with_ansi(line, 78)}{BOX_VERTICAL}")
            bottom_border = f"{BOX_CORNER_BL}{BOX_HORIZONTAL * 78}{BOX_CORNER_BR}"
            print(bottom_border)
        else:
            summary_lines = [
                "No motors responded.",
                "",
                "Check:",
                "  • CAN interface is up (e.g., sudo ip link set can0 up type can bitrate 1000000)",
                "  • Motors are powered and connected",
                "  • Motor IDs match the tested range",
            ]
            print_warning_box("Scan Summary - No Motors Found", summary_lines, width=80)

    except KeyboardInterrupt:
        print("\n\nInterrupted by user.")
    except Exception as e:
        print(f"\n\nError: {e}")
        raise

damiao_motor.cli.commands.cmd_send_cmd_mit

cmd_send_cmd_mit(args) -> None

Handle 'send-cmd-mit' subcommand.

Sends MIT control mode command to motor. Loops continuously until Ctrl+C.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - position: Desired position (radians) (required) - velocity: Desired velocity (rad/s) (required) - stiffness: Stiffness (kp) (default: 0.0) - damping: Damping (kd) (default: 0.0) - feedforward_torque: Feedforward torque (default: 0.0) - frequency: Command frequency in Hz (default: 100.0) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5

Source code in damiao_motor/cli/commands.py

def cmd_send_cmd_mit(args) -> None:
    """
    Handle 'send-cmd-mit' subcommand.

    Sends MIT control mode command to motor. Loops continuously until Ctrl+C.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - position: Desired position (radians) (required)
            - velocity: Desired velocity (rad/s) (required)
            - stiffness: Stiffness (kp) (default: 0.0)
            - damping: Damping (kd) (default: 0.0)
            - feedforward_torque: Feedforward torque (default: 0.0)
            - frequency: Command frequency in Hz (default: 100.0)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        damiao send-cmd-mit --id 1 --position 1.5 --velocity 0.0 --stiffness 3.0 --damping 0.5
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Send MIT Command")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print(f"Control Mode: MIT")
    print(f"  Position: {args.position:.6f} rad")
    print(f"  Velocity: {args.velocity:.6f} rad/s")
    print(f"  Stiffness (kp): {args.stiffness:.6f}")
    print(f"  Damping (kd): {args.damping:.6f}")
    print(f"  Feedforward Torque: {args.feedforward_torque:.6f} Nm")
    print(f"Frequency: {args.frequency} Hz")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)
        motor.ensure_control_mode("MIT")

        print(f"Sending MIT command continuously (press Ctrl+C to stop)...")
        print(f"  CAN ID: 0x{args.motor_id:03X}")
        print(f"  Frequency: {args.frequency} Hz")
        print()

        interval = 1.0 / args.frequency if args.frequency > 0 else 0.01

        try:
            while True:
                motor.send_cmd(
                    target_position=args.position,
                    target_velocity=args.velocity,
                    stiffness=args.stiffness,
                    damping=args.damping,
                    feedforward_torque=args.feedforward_torque,
                    control_mode="MIT"
                )
                controller.poll_feedback()

                if motor.state:
                    print_motor_state(motor.state)

                time.sleep(interval)
        except KeyboardInterrupt:
            print("\n\nStopped by user.")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        print("Shutting down controller...")
        controller.shutdown()

damiao_motor.cli.commands.cmd_send_cmd_pos_vel

cmd_send_cmd_pos_vel(args) -> None

Handle 'send-cmd-pos-vel' subcommand.

Sends POS_VEL control mode command to motor. Loops continuously until Ctrl+C.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - position: Desired position (radians) (required) - velocity: Desired velocity (rad/s) (required) - frequency: Command frequency in Hz (default: 100.0) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

damiao send-cmd-pos-vel --id 1 --position 1.5 --velocity 2.0

Source code in damiao_motor/cli/commands.py

def cmd_send_cmd_pos_vel(args) -> None:
    """
    Handle 'send-cmd-pos-vel' subcommand.

    Sends POS_VEL control mode command to motor. Loops continuously until Ctrl+C.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - position: Desired position (radians) (required)
            - velocity: Desired velocity (rad/s) (required)
            - frequency: Command frequency in Hz (default: 100.0)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        damiao send-cmd-pos-vel --id 1 --position 1.5 --velocity 2.0
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Send POS_VEL Command")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print(f"Control Mode: POS_VEL")
    print(f"  Position: {args.position:.6f} rad")
    print(f"  Velocity: {args.velocity:.6f} rad/s")
    print(f"Frequency: {args.frequency} Hz")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)
        motor.ensure_control_mode("POS_VEL")

        print(f"Sending POS_VEL command continuously (press Ctrl+C to stop)...")
        print(f"  CAN ID: 0x{0x100 + args.motor_id:03X}")
        print(f"  Frequency: {args.frequency} Hz")
        print()

        interval = 1.0 / args.frequency if args.frequency > 0 else 0.01

        try:
            while True:
                motor.send_cmd(
                    target_position=args.position,
                    target_velocity=args.velocity,
                    control_mode="POS_VEL"
                )
                controller.poll_feedback()

                if motor.state:
                    print_motor_state(motor.state)

                time.sleep(interval)
        except KeyboardInterrupt:
            print("\n\nStopped by user.")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        print("Shutting down controller...")
        controller.shutdown()

damiao_motor.cli.commands.cmd_send_cmd_vel

cmd_send_cmd_vel(args) -> None

Handle 'send-cmd-vel' subcommand.

Sends VEL control mode command to motor. Loops continuously until Ctrl+C.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - velocity: Desired velocity (rad/s) (required) - frequency: Command frequency in Hz (default: 100.0) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

damiao send-cmd-vel --id 1 --velocity 3.0

Source code in damiao_motor/cli/commands.py

def cmd_send_cmd_vel(args) -> None:
    """
    Handle 'send-cmd-vel' subcommand.

    Sends VEL control mode command to motor. Loops continuously until Ctrl+C.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - velocity: Desired velocity (rad/s) (required)
            - frequency: Command frequency in Hz (default: 100.0)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        damiao send-cmd-vel --id 1 --velocity 3.0
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Send VEL Command")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print(f"Control Mode: VEL")
    print(f"  Velocity: {args.velocity:.6f} rad/s")
    print(f"Frequency: {args.frequency} Hz")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)
        motor.ensure_control_mode("VEL")

        print(f"Sending VEL command continuously (press Ctrl+C to stop)...")
        print(f"  CAN ID: 0x{0x200 + args.motor_id:03X}")
        print(f"  Frequency: {args.frequency} Hz")
        print()

        interval = 1.0 / args.frequency if args.frequency > 0 else 0.01

        try:
            while True:
                motor.send_cmd(
                    target_velocity=args.velocity,
                    control_mode="VEL"
                )
                controller.poll_feedback()

                if motor.state:
                    print_motor_state(motor.state)

                time.sleep(interval)
        except KeyboardInterrupt:
            print("\n\nStopped by user.")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        print("Shutting down controller...")
        controller.shutdown()

damiao_motor.cli.commands.cmd_send_cmd_force_pos

cmd_send_cmd_force_pos(args) -> None

Handle 'send-cmd-force-pos' subcommand.

Sends FORCE_POS control mode command to motor. Loops continuously until Ctrl+C.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - position: Desired position (radians) (required) - velocity_limit: Velocity limit (rad/s, 0-100) (required) - current_limit: Torque current limit normalized (0.0-1.0) (required) - frequency: Command frequency in Hz (default: 100.0) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

damiao send-cmd-force-pos --id 1 --position 1.5 --velocity-limit 50.0 --current-limit 0.8

Source code in damiao_motor/cli/commands.py

def cmd_send_cmd_force_pos(args) -> None:
    """
    Handle 'send-cmd-force-pos' subcommand.

    Sends FORCE_POS control mode command to motor. Loops continuously until Ctrl+C.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - position: Desired position (radians) (required)
            - velocity_limit: Velocity limit (rad/s, 0-100) (required)
            - current_limit: Torque current limit normalized (0.0-1.0) (required)
            - frequency: Command frequency in Hz (default: 100.0)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        damiao send-cmd-force-pos --id 1 --position 1.5 --velocity-limit 50.0 --current-limit 0.8
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Send FORCE_POS Command")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print(f"Control Mode: FORCE_POS")
    print(f"  Position: {args.position:.6f} rad")
    print(f"  Velocity Limit: {args.velocity_limit:.6f} rad/s")
    print(f"  Current Limit: {args.current_limit:.6f}")
    print(f"Frequency: {args.frequency} Hz")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)
        motor.ensure_control_mode("FORCE_POS")

        print(f"Sending FORCE_POS command continuously (press Ctrl+C to stop)...")
        print(f"  CAN ID: 0x{0x300 + args.motor_id:03X}")
        print(f"  Frequency: {args.frequency} Hz")
        print()

        interval = 1.0 / args.frequency if args.frequency > 0 else 0.01

        try:
            while True:
                motor.send_cmd(
                    target_position=args.position,
                    velocity_limit=args.velocity_limit,
                    current_limit=args.current_limit,
                    control_mode="FORCE_POS"
                )
                controller.poll_feedback()

                if motor.state:
                    print_motor_state(motor.state)

                time.sleep(interval)
        except KeyboardInterrupt:
            print("\n\nStopped by user.")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        print("Shutting down controller...")
        controller.shutdown()

damiao_motor.cli.commands.cmd_set_zero

cmd_set_zero(args) -> None

Handle 'set-zero-command' subcommand.

Sends a zero command to a motor continuously. Loops until interrupted with Ctrl+C.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID to send zero command to (required) - frequency: Command frequency in Hz (default: 100.0) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

# Send zero command continuously
damiao set-zero-command --id 1

# With custom frequency
damiao set-zero-command --id 1 --frequency 50.0

Source code in damiao_motor/cli/commands.py

def cmd_set_zero(args) -> None:
    """
    Handle 'set-zero-command' subcommand.

    Sends a zero command to a motor continuously.
    Loops until interrupted with Ctrl+C.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID to send zero command to (required)
            - frequency: Command frequency in Hz (default: 100.0)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        # Send zero command continuously
        damiao set-zero-command --id 1

        # With custom frequency
        damiao set-zero-command --id 1 --frequency 50.0
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Set Zero Command")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)

        # Ensure control mode is set to MIT (register 10 = 1) for zero command
        try:
            motor.ensure_control_mode("MIT")
        except Exception as e:
            print(f"⚠ Warning: Could not verify/set control mode: {e}")
            print(f"  Continuing anyway, but motor may not respond correctly.")

        print(f"Sending zero command continuously (press Ctrl+C to stop)...")
        print(f"  Command: pos=0, vel=0, torq=0, kp=0, kd=0")
        print(f"  Frequency: {args.frequency} Hz")
        print()

        interval = 1.0 / args.frequency if args.frequency > 0 else 0.01

        try:
            while True:
                motor.set_zero_command()
                controller.poll_feedback()

                if motor.state:
                    print_motor_state(motor.state)

                time.sleep(interval)
        except KeyboardInterrupt:
            print("\n\nStopped by user.")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        print("Shutting down controller...")
        controller.shutdown()

damiao_motor.cli.commands.cmd_set_zero_position

cmd_set_zero_position(args) -> None

Handle 'set-zero-position' subcommand.

Sets the current output shaft position to zero (save position zero).

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Examples:

# Set current position to zero
damiao set-zero-position --id 1

Source code in damiao_motor/cli/commands.py

def cmd_set_zero_position(args) -> None:
    """
    Handle 'set-zero-position' subcommand.

    Sets the current output shaft position to zero (save position zero).

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Examples:
        ```bash
        # Set current position to zero
        damiao set-zero-position --id 1
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Set Zero Position")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)

        print(f"Setting current position to zero...")
        motor.set_zero_position()
        print(f"✓ Position zero set")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        controller.shutdown()

damiao_motor.cli.commands.cmd_set_can_timeout

cmd_set_can_timeout(args) -> None

Handle 'set-can-timeout' subcommand.

Sets the CAN timeout alarm time (register 9) in milliseconds.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - motor_id: Motor ID (required) - timeout_ms: Timeout in milliseconds (required) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Note

Register 9 stores timeout in units of 50 microseconds: 1 register unit = 50 microseconds.

The timeout is internally converted from milliseconds to register units using: register_value = timeout_ms × 20

Examples: - 1000 ms = 20,000 register units - 50 ms = 1,000 register units

The value is stored to flash memory after setting.

Examples:

# Set CAN timeout to 1000 ms
damiao set-can-timeout --id 1 --timeout 1000

Source code in damiao_motor/cli/commands.py

def cmd_set_can_timeout(args) -> None:
    """
    Handle 'set-can-timeout' subcommand.

    Sets the CAN timeout alarm time (register 9) in milliseconds.

    Args:
        args: Parsed command-line arguments containing:
            - motor_id: Motor ID (required)
            - timeout_ms: Timeout in milliseconds (required)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Note:
        Register 9 stores timeout in units of 50 microseconds: **1 register unit = 50 microseconds**.

        The timeout is internally converted from milliseconds to register units using:
        register_value = timeout_ms × 20

        Examples:
        - 1000 ms = 20,000 register units
        - 50 ms = 1,000 register units

        The value is stored to flash memory after setting.

    Examples:
        ```bash
        # Set CAN timeout to 1000 ms
        damiao set-can-timeout --id 1 --timeout 1000
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Set CAN Timeout")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Motor ID: 0x{args.motor_id:02X} ({args.motor_id})")
    print(f"Timeout: {args.timeout_ms} ms")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        motor = controller.add_motor(motor_id=args.motor_id, feedback_id=0x00, motor_type=args.motor_type)

        print(f"Setting CAN timeout to {args.timeout_ms} ms (register 9)...")
        motor.set_can_timeout(args.timeout_ms)

        # Store parameters to flash
        print("Storing parameters to flash...")
        try:
            motor.store_parameters()
            print("✓ Parameters stored to flash")
        except Exception as e:
            print(f"⚠ Warning: Could not store parameters: {e}")

        print()
        print(f"✓ CAN timeout set to {args.timeout_ms} ms")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        controller.shutdown()

damiao_motor.cli.commands.cmd_set_motor_id

cmd_set_motor_id(args) -> None

Handle 'set-motor-id' subcommand.

Changes the motor's receive ID (ESC_ID, register 8). This is the ID used to send commands to the motor.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - current: Current motor ID (to connect to the motor) (required) - target: Target motor ID (new receive ID) (required) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Note

After changing the motor ID, you will need to use the new ID to communicate with the motor. The value is stored to flash memory after setting.

Examples:

# Change motor ID from 1 to 2
damiao set-motor-id --current 1 --target 2

Source code in damiao_motor/cli/commands.py

def cmd_set_motor_id(args) -> None:
    """
    Handle 'set-motor-id' subcommand.

    Changes the motor's receive ID (ESC_ID, register 8). This is the ID used to send commands to the motor.

    Args:
        args: Parsed command-line arguments containing:
            - current: Current motor ID (to connect to the motor) (required)
            - target: Target motor ID (new receive ID) (required)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Note:
        After changing the motor ID, you will need to use the new ID to communicate with the motor.
        The value is stored to flash memory after setting.

    Examples:
        ```bash
        # Change motor ID from 1 to 2
        damiao set-motor-id --current 1 --target 2
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Set Motor ID (Receive ID)")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Current Motor ID: 0x{args.current:02X} ({args.current})")
    print(f"Target Motor ID: 0x{args.target:02X} ({args.target})")
    print("=" * 60)
    print()

    if args.current == args.target:
        print("Current and target IDs are the same. No change needed.")
        return

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        # Use current ID to connect
        motor = controller.add_motor(motor_id=args.current, feedback_id=0x00, motor_type=args.motor_type)

        print(f"Reading current register values...")
        time.sleep(0.1)
        controller.poll_feedback()

        # Read current receive ID (register 8)
        try:
            current_receive_id = motor.get_register(8, timeout=1.0)
            print(f"Current Receive ID (register 8): {int(current_receive_id)} (0x{int(current_receive_id):02X})")
        except Exception as e:
            print(f"⚠ Warning: Could not read register 8: {e}")
            print("  Proceeding with write anyway...")

        print(f"Writing new Receive ID (register 8) = {args.target} (0x{args.target:02X})...")
        motor.write_register(8, args.target)

        # Store parameters to flash
        print("Storing parameters to flash...")
        try:
            motor.store_parameters()
            print("✓ Parameters stored to flash")
        except Exception as e:
            print(f"⚠ Warning: Could not store parameters: {e}")

        print()
        print(f"✓ Motor ID changed from 0x{args.current:02X} to 0x{args.target:02X}")
        print(f"  Note: You may need to reconnect using the new ID: 0x{args.target:02X}")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        controller.shutdown()

damiao_motor.cli.commands.cmd_set_feedback_id

cmd_set_feedback_id(args) -> None

Handle 'set-feedback-id' subcommand.

Changes the motor's feedback ID (MST_ID, register 7). This is the ID used to identify feedback messages from the motor.

Parameters:

Name	Type	Description	Default
args		Parsed command-line arguments containing: - current: Current motor ID (to connect to the motor) (required) - target: Target feedback ID (new MST_ID) (required) - channel: CAN channel (default: can0) - bustype: CAN bus type (default: socketcan) - bitrate: CAN bitrate in bits per second (default: 1000000)	required

Note

The motor will now respond with feedback using the new feedback ID. The value is stored to flash memory after setting.

Examples:

# Change feedback ID to 3 (using motor ID 1 to connect)
damiao set-feedback-id --current 1 --target 3

Source code in damiao_motor/cli/commands.py

def cmd_set_feedback_id(args) -> None:
    """
    Handle 'set-feedback-id' subcommand.

    Changes the motor's feedback ID (MST_ID, register 7). This is the ID used to identify feedback messages from the motor.

    Args:
        args: Parsed command-line arguments containing:
            - current: Current motor ID (to connect to the motor) (required)
            - target: Target feedback ID (new MST_ID) (required)
            - channel: CAN channel (default: can0)
            - bustype: CAN bus type (default: socketcan)
            - bitrate: CAN bitrate in bits per second (default: 1000000)

    Note:
        The motor will now respond with feedback using the new feedback ID.
        The value is stored to flash memory after setting.

    Examples:
        ```bash
        # Change feedback ID to 3 (using motor ID 1 to connect)
        damiao set-feedback-id --current 1 --target 3
        ```
    """
    print("=" * 60)
    print("DaMiao Motor - Set Feedback ID (MST_ID)")
    print("=" * 60)
    print(f"CAN channel: {args.channel}")
    print(f"Current Motor ID: 0x{args.current:02X} ({args.current})")
    print(f"Target Feedback ID: 0x{args.target:02X} ({args.target})")
    print("=" * 60)
    print()

    # Check and bring up CAN interface if needed
    if args.bustype == "socketcan":
        if not check_and_bring_up_can_interface(args.channel, bitrate=args.bitrate):
            print(f"⚠ Warning: Could not verify {args.channel} is ready. Continuing anyway...")

    controller = DaMiaoController(channel=args.channel, bustype=args.bustype)

    try:
        # Use current motor ID to connect
        motor = controller.add_motor(motor_id=args.current, feedback_id=0x00, motor_type=args.motor_type)

        print(f"Reading current register values...")
        time.sleep(0.1)
        controller.poll_feedback()

        # Read current feedback ID (register 7)
        try:
            current_feedback_id = motor.get_register(7, timeout=1.0)
            print(f"Current Feedback ID (register 7): {int(current_feedback_id)} (0x{int(current_feedback_id):02X})")
        except Exception as e:
            print(f"⚠ Warning: Could not read register 7: {e}")
            print("  Proceeding with write anyway...")

        print(f"Writing new Feedback ID (register 7) = {args.target} (0x{args.target:02X})...")
        motor.write_register(7, args.target)

        # Store parameters to flash
        print("Storing parameters to flash...")
        try:
            motor.store_parameters()
            print("✓ Parameters stored to flash")
        except Exception as e:
            print(f"⚠ Warning: Could not store parameters: {e}")

        print()
        print(f"✓ Feedback ID changed to 0x{args.target:02X}")
        print(f"  Note: Motor will now respond with feedback ID 0x{args.target:02X}")

    except Exception as e:
        print(f"Error: {e}")
        raise
    finally:
        controller.shutdown()

Utility Functions

damiao_motor.cli.display.scan_motors

scan_motors(channel: str = 'can0', bustype: str = 'socketcan', motor_ids: list[int] | None = None, duration_s: float = 3.0, bitrate: int = 1000000, debug: bool = False, *, motor_type: str = '4310') -> Set[int]

Scan for connected motors by sending zero commands and listening for feedback.

Parameters:

Name	Type	Description	Default
channel	str	CAN channel (e.g., "can0")	'can0'
bustype	str	CAN bus type (e.g., "socketcan")	'socketcan'
motor_ids	list[int] | None	List of motor IDs to test. If None, tests IDs 0x01-0x10.	None
duration_s	float	How long to listen for responses (seconds)	3.0
motor_type	str	Motor type for P/V/T presets (e.g. 4340, 4310, 3507). Defaults to "4310". Only used for encoding zero commands; doesn't affect which motors are detected.	'4310'

Returns:

Type	Description
Set[int]	Set of motor IDs that responded with feedback.

Source code in damiao_motor/cli/display.py

def scan_motors(
    channel: str = "can0",
    bustype: str = "socketcan",
    motor_ids: list[int] | None = None,
    duration_s: float = 3.0,
    bitrate: int = 1000000,
    debug: bool = False,
    *,
    motor_type: str = "4310",
) -> Set[int]:
    """
    Scan for connected motors by sending zero commands and listening for feedback.

    Args:
        channel: CAN channel (e.g., "can0")
        bustype: CAN bus type (e.g., "socketcan")
        motor_ids: List of motor IDs to test. If None, tests IDs 0x01-0x10.
        duration_s: How long to listen for responses (seconds)
        motor_type: Motor type for P/V/T presets (e.g. 4340, 4310, 3507). 
                    Defaults to "4310". Only used for encoding zero commands; 
                    doesn't affect which motors are detected.

    Returns:
        Set of motor IDs that responded with feedback.
    """
    if motor_ids is None:
        motor_ids = list(range(0x01, 0x11))  # Test IDs 1-16

    # Open scan status box (80 chars wide, 78 interior)
    print(f"{BOX_CORNER_TL}{BOX_HORIZONTAL * 78}{BOX_CORNER_TR}")

    # Check and bring up CAN interface if needed (only for socketcan)
    if bustype == "socketcan":
        line_text = f" Checking CAN interface {channel}..."
        print(f"{BOX_VERTICAL}{pad_with_ansi(line_text, 78)}{BOX_VERTICAL}")
        if not check_and_bring_up_can_interface(channel, bitrate=bitrate):
            warning_text = f" {YELLOW}⚠ Warning: Could not verify {channel} is ready. Continuing anyway...{RESET}"
            print(f"{BOX_VERTICAL}{pad_with_ansi(warning_text, 78)}{BOX_VERTICAL}")
        else:
            # Verify interface is actually up and working
            verify_result = subprocess.run(
                ["ip", "link", "show", channel],
                capture_output=True,
                text=True,
                check=False,
            )
            if verify_result.returncode == 0 and "state UP" in verify_result.stdout:
                ready_text = f" {GREEN}✓ CAN interface {channel} is ready{RESET}"
                print(f"{BOX_VERTICAL}{pad_with_ansi(ready_text, 78)}{BOX_VERTICAL}")
            else:
                warning_text = f" {YELLOW}⚠ Warning: {channel} may not be properly configured{RESET}"
                print(f"{BOX_VERTICAL}{pad_with_ansi(warning_text, 78)}{BOX_VERTICAL}")

    controller = DaMiaoController(channel=channel, bustype=bustype)

    # Flush any pending messages from the bus
    line_text = f" Flushing CAN bus buffer..."
    print(f"{BOX_VERTICAL}{pad_with_ansi(line_text, 78)}{BOX_VERTICAL}")
    flushed_count = controller.flush_bus()
    if flushed_count > 0:
        flushed_text = f"   {GREEN}Flushed {flushed_count} pending message(s) from bus{RESET}"
        print(f"{BOX_VERTICAL}{pad_with_ansi(flushed_text, 78)}{BOX_VERTICAL}")
    else:
        line_text = f"   Bus buffer is clean"
        print(f"{BOX_VERTICAL}{pad_with_ansi(line_text, 78)}{BOX_VERTICAL}")

    motors: dict[int, DaMiaoMotor] = {}

    # Create motor instances for all IDs we want to test
    for motor_id in motor_ids:
        try:
            motor = controller.add_motor(motor_id=motor_id, feedback_id=0x00, motor_type=motor_type)
            motors[motor_id] = motor
        except ValueError:
            # Motor already exists, skip
            pass

    # Send zero command to all motors
    line_text = f" Sending zero command to {len(motors)} potential motor IDs..."
    print(f"{BOX_VERTICAL}{pad_with_ansi(line_text, 78)}{BOX_VERTICAL}")
    try:
        for motor in motors.values():
            motor.send_cmd(target_position=0.0, target_velocity=0.0, stiffness=0.0, damping=0.0, feedforward_torque=0.0)
            if debug:
                # Print sent command in debug mode
                cmd_data = motor.encode_cmd_msg(0.0, 0.0, 0.0, 0.0, 0.0)
                data_hex = " ".join(f"{b:02X}" for b in cmd_data)
                sent_text = f"   [SENT] 0x{motor.motor_id:03X} [{data_hex}]"
                print(f"{BOX_VERTICAL}{pad_with_ansi(sent_text, 78)}{BOX_VERTICAL}")
    except Exception as e:
        error_str = str(e)
        if "Error Code 80" in error_str or "No buffer space available" in error_str or "[Errno 80]" in error_str:
            error_lines = [
                "Original error: " + str(e),
                "",
                "This error typically indicates:",
                "  • No CAN device (motor) is connected to the bus",
                "  • Motor(s) are not powered on",
                "  • CAN interface hardware issue",
                "",
                "Please check:",
                "  1. Motor(s) are properly connected to the CAN bus",
                "  2. Motor(s) are powered on",
                "  3. CAN interface hardware is working correctly",
                "  4. CAN bus termination resistors (120Ω) are installed at both ends",
            ]
            print_error_box("[ERROR CODE 80] No buffer space available when sending commands", error_lines, width=70)
            # Clean up and exit gracefully
            try:
                controller.bus.shutdown()
            except:
                pass
            sys.exit(1)
        else:
            raise

    # Listen for feedback
    line_text = f" Listening for responses for {duration_s} seconds..."
    print(f"{BOX_VERTICAL}{pad_with_ansi(line_text, 78)}{BOX_VERTICAL}")
    start_time = time.perf_counter()
    responded_ids: Set[int] = set()
    debug_messages = []  # Collect debug messages if debug mode is enabled
    # Track seen motor IDs and arbitration IDs for conflict detection
    seen_motor_ids: Set[int] = set()  # Track decoded motor IDs (logical_id)
    seen_arbitration_ids: Set[int] = set()  # Track arbitration IDs
    # Collect conflicts to group them at the end
    conflicted_motor_ids: Set[int] = set()  # Motor IDs that appeared multiple times
    conflicted_arbitration_ids: Set[int] = set()  # Arbitration IDs that appeared multiple times
    # Collect motor register information for table display
    motor_registers: Dict[int, Dict[int, float | int]] = {}  # motor_id -> {rid -> value}

    while time.perf_counter() - start_time < duration_s:
        # Debug mode: collect and print raw messages immediately
        if debug:
            # Read and collect raw messages, then process normally
            while True:
                msg = controller.bus.recv(timeout=0)
                if msg is None:
                    break
                data_hex = " ".join(f"{b:02X}" for b in msg.data)
                debug_msg = f"  0x{msg.arbitration_id:03X} [{data_hex}]"
                debug_messages.append(debug_msg)
                # Print immediately in debug mode
                print(debug_msg)
                # Process the message manually for debug mode
                if len(msg.data) == 8:
                    logical_id = msg.data[0] & 0x0F
                    arb_id = msg.arbitration_id

                    # Check for motor ID conflict (same decoded motor ID seen twice)
                    if logical_id in seen_motor_ids:
                        conflicted_motor_ids.add(logical_id)

                    # Check for arbitration ID conflict (same arbitration ID seen twice)
                    if arb_id in seen_arbitration_ids:
                        conflicted_arbitration_ids.add(arb_id)

                    seen_motor_ids.add(logical_id)
                    seen_arbitration_ids.add(arb_id)

                    motor = controller._motors_by_feedback.get(logical_id)
                    if motor is not None:
                        motor.decode_sensor_feedback(bytes(msg.data), arbitration_id=arb_id)
        else:
            # Normal mode: read messages, check conflicts, then process
            while True:
                msg = controller.bus.recv(timeout=0)
                if msg is None:
                    break

                if len(msg.data) == 8:
                    logical_id = msg.data[0] & 0x0F
                    arb_id = msg.arbitration_id

                    # Check for motor ID conflict (same decoded motor ID seen twice)
                    if logical_id in seen_motor_ids:
                        conflicted_motor_ids.add(logical_id)

                    # Check for arbitration ID conflict (same arbitration ID seen twice)
                    if arb_id in seen_arbitration_ids:
                        conflicted_arbitration_ids.add(arb_id)

                    seen_motor_ids.add(logical_id)
                    seen_arbitration_ids.add(arb_id)

                    # Process through controller
                    motor = controller._motors_by_feedback.get(logical_id)
                    if motor is not None:
                        motor.decode_sensor_feedback(bytes(msg.data), arbitration_id=arb_id)

        # Check which motors have received feedback
        for motor_id, motor in motors.items():
            if motor.state and motor.state.get("can_id") is not None:
                # Print once per motor when first detected
                if motor_id not in responded_ids:
                    state_name = motor.state.get("status", "UNKNOWN")
                    pos = motor.state.get("pos", 0.0)
                    arb_id = motor.state.get("arbitration_id")
                    if arb_id is not None:
                        motor_text = f"   {GREEN}✓ Motor ID 0x{motor_id:02X}{RESET} responded (arb_id: 0x{arb_id:03X}, state: {state_name}, pos: {pos:.3f})"
                        print(f"{BOX_VERTICAL}{pad_with_ansi(motor_text, 78)}{BOX_VERTICAL}")
                    else:
                        motor_text = f"   {GREEN}✓ Motor ID 0x{motor_id:02X}{RESET} responded (state: {state_name}, pos: {pos:.3f})"
                        print(f"{BOX_VERTICAL}{pad_with_ansi(motor_text, 78)}{BOX_VERTICAL}")

                responded_ids.add(motor_id)

        time.sleep(0.01)

    # Print conflicts (grouped)
    if conflicted_motor_ids:
        error_lines = [
            "Multiple motors responded with the same motor ID.",
            "This indicates multiple motors are configured with the same motor ID.",
            f"Conflicted Motor IDs: {', '.join(f'0x{mid:02X}' for mid in sorted(conflicted_motor_ids))}"
        ]
        print_error_box("[ERROR] Motor ID Conflicts Detected", error_lines)

    if conflicted_arbitration_ids:
        warning_lines = [
            "Same arbitration ID seen multiple times.",
            "This may indicate a CAN bus configuration issue.",
            f"Conflicted Arbitration IDs: {', '.join(f'0x{aid:03X}' for aid in sorted(conflicted_arbitration_ids))}"
        ]
        print_warning_box("[WARNING] Arbitration ID Conflicts Detected", warning_lines)

    # Close the scan status box
    print(f"{BOX_CORNER_BL}{BOX_HORIZONTAL * 78}{BOX_CORNER_BR}")

    # Read all registers from detected motors if no motor ID conflicts
    if not conflicted_motor_ids and responded_ids:
        print("Reading register parameters from detected motors...")
        for motor_id in sorted(responded_ids):
            motor = motors.get(motor_id)
            if motor is not None:
                try:
                    registers = motor.read_all_registers(timeout=0.05)
                    motor_registers[motor_id] = registers
                except Exception as e:
                    print(f"  {YELLOW}⚠ Failed to read registers from motor 0x{motor_id:02X}: {e}{RESET}")
        print()

    # Print motor register table if no motor ID conflicts
    if not conflicted_motor_ids and motor_registers:
        # Start register table box
        print()
        top_border = f"{BOX_CORNER_TL}{BOX_HORIZONTAL * 78}{BOX_CORNER_TR}"
        print(top_border)
        # Header line
        header_text = f" {GREEN}Detected Motors - Register Parameters{RESET}"
        print(f"{BOX_VERTICAL}{pad_with_ansi(header_text, 78)}{BOX_VERTICAL}")

        # Group registers by motor
        for motor_id in sorted(motor_registers.keys()):
            registers = motor_registers[motor_id]
            # Separator line before motor section
            print(f"{BOX_JOIN_LEFT}{BOX_HORIZONTAL * 78}{BOX_JOIN_RIGHT}")
            # Motor ID header - use pad_with_ansi to account for color codes
            motor_id_text = f" {GREEN}Motor ID: 0x{motor_id:02X} ({motor_id}){RESET}"
            print(f"{BOX_VERTICAL}{pad_with_ansi(motor_id_text, 78)}{BOX_VERTICAL}")
            # Separator line
            print(f"{BOX_JOIN_LEFT}{BOX_HORIZONTAL * 78}{BOX_JOIN_RIGHT}")
            # Table header - adjust column widths to fit within 78 chars
            # Format: " RID(4) Var(10) Desc(32) Value(12) Type(8) Access(6)" = 78 total
            # Calculation: 1+4+1+10+1+32+1+12+1+8+1+6 = 78
            header_content = f" {'RID':<4} {'Variable':<10} {'Description':<32} {'Value':<12} {'Type':<8} {'Access':<6}"
            print(f"{BOX_VERTICAL}{pad_with_ansi(header_content, 78)}{BOX_VERTICAL}")
            # Header separator
            print(f"{BOX_JOIN_LEFT}{BOX_HORIZONTAL * 78}{BOX_JOIN_RIGHT}")

            for rid in sorted(registers.keys()):
                if rid not in REGISTER_TABLE:
                    continue

                reg_info = REGISTER_TABLE[rid]
                value = registers[rid]

                # Format value based on type
                if isinstance(value, str) and value.startswith("ERROR"):
                    value_str = value
                elif reg_info.data_type == "float":
                    value_str = f"{float(value):.2f}"
                else:
                    value_str = str(int(value))

                # Truncate long descriptions to fit (32 chars for desc column)
                desc = reg_info.description[:30] + ".." if len(reg_info.description) > 32 else reg_info.description

                # Format table row - match header column widths
                row_content = f" {rid:<4} {reg_info.variable:<10} {desc:<32} {value_str:<12} {reg_info.data_type:<8} {reg_info.access:<6}"
                print(f"{BOX_VERTICAL}{pad_with_ansi(row_content, 78)}{BOX_VERTICAL}")

        # Close the box
        print(f"{BOX_CORNER_BL}{BOX_HORIZONTAL * 78}{BOX_CORNER_BR}")

    # Print debug summary if messages were collected
    if debug and debug_messages:
        print()
        print_section_header(f"DEBUG: Total {len(debug_messages)} raw CAN messages received", width=80)
        print(f"{BOX_CORNER_BL}{BOX_HORIZONTAL * 78}{BOX_CORNER_BR}")

    # Cleanup
    try:
        controller.bus.shutdown()
    except:
        pass

    return responded_ids