Skip to main content

Use odrive motion controller with CAN inteface

Project description

Asyncio driver for ODrive V3.6

Command ODrive over CAN with a simple interface.

Source code: https://gitlab.com/roxautomation/components/odrive-can

Documentation: https://roxautomation.gitlab.io/components/odrive-can

Features

  • designed to work with asyncio
  • implements full odrive can protocol.
  • includes OdriveMock class for device simulation
  • cli tools for message inspection, backup and demo's.

Installation

pip install odrive-can

Basic usage

import asyncio
from odrive_can import ODriveCAN, CanMsg
from odrive_can.tools import UDP_Client

AXIS_ID = 0
INTERFACE = "vcan0"
SETPOINT = 50

udp = UDP_Client()  # send data to UDP server for plotting


def feedback_callback_fcn(msg: CanMsg, caller: ODriveCAN):
    """called on position estimate"""
    print(msg)
    udp.send(msg.data)


async def main():
    """connect to odrive"""
    drv = ODriveCAN(axis_id=AXIS_ID, interface=INTERFACE)

    # set up callback (optional)
    drv.feedback_callback = feedback_callback_fcn

    # start
    await drv.start()

    # check errors (raises exception if any)
    drv.check_errors()

    # set controller mode
    drv.set_controller_mode("POSITION_CONTROL", "POS_FILTER")

    # reset encoder
    drv.set_linear_count(0)

    # set axis state
    await drv.set_axis_state("CLOSED_LOOP_CONTROL")

    # set position gain
    drv.set_pos_gain(3.0)

    for _ in range(2):
        # setpoint
        drv.set_input_pos(SETPOINT)
        await asyncio.sleep(5.0)
        drv.set_input_pos(-SETPOINT)
        await asyncio.sleep(5.0)

    drv.set_input_pos(0.0)


asyncio.run(main())

CLI interface

Usage: odrive_can [OPTIONS] COMMAND [ARGS]...

Options:
--help  Show this message and exit.

Commands:
backup   Backup config to config folder
demo     demonstration of control modes
info     Print package info
inspect  Inspect and decode ODrive CAN messages
mock     Mock ODrive CAN interface

Using virtual devices

  1. create a virtual can adapter (see docs)
  2. in first terminal run odrive_can mock
  3. in second terminal run odrive_can inspect vcan0

Position control demo

odrive_can demo position --interface vcan0

Live plotting data

Demo scripts send data as json to udp://localhost:5005 . This data can be visualized with plotjuggler

(sender code is found in tools.UDP_Client)

Development

Virtual environment

create virtual envrionment with make venv

Devcontainer

  • docker folder contains devcontainer environment.
  • .devcontainer is VSCode devcontainer environment

Support

commercial support is available through www.roxautomation.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odrive_can-0.10.0.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

odrive_can-0.10.0-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file odrive_can-0.10.0.tar.gz.

File metadata

  • Download URL: odrive_can-0.10.0.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for odrive_can-0.10.0.tar.gz
Algorithm Hash digest
SHA256 1ef9d7137484c038c3e96c4a3cfa64b02589200d876d19b923ecbb961231e96b
MD5 8b451c13e62f4c8ddb0cf391618e6785
BLAKE2b-256 723e9ab67486d165e1a08502b0548fa7becb4e672a2af1a0846678ad8aff55ef

See more details on using hashes here.

File details

Details for the file odrive_can-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: odrive_can-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 32.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for odrive_can-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c2fbdbec350df931f33b1d73e12b6beda62dea040544fc7ebb6091a7f1601eb0
MD5 29f232c70b8036876fefba44e8f9cac9
BLAKE2b-256 85ce4e9d557f839b92c355848b9265a42eb6f1f7781dff72e97dafcf5828a584

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page