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.7.0.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odrive_can-0.7.0-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: odrive_can-0.7.0.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for odrive_can-0.7.0.tar.gz
Algorithm Hash digest
SHA256 f85623fb3b63e8845ca124288403018ab1f5b10c71f8ca8bd8d908e92093d404
MD5 685375a9023b8565301f07c49a2d82b4
BLAKE2b-256 5f50a2e8745d7f842e734dfdd0b34480fe8ef9c5439bdfa876dbc94ade7e1004

See more details on using hashes here.

File details

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

File metadata

  • Download URL: odrive_can-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 30.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for odrive_can-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 37b8e6b2bea99dd188e1c566291708a53c3dccea1ad1e750e777d2baf448ee40
MD5 d71b371cad38615b99003a7db8145bd5
BLAKE2b-256 a615418363c56089fc40b20e56e72a7bd6f88e2d490744a00cb19ce16636ad39

See more details on using hashes here.

Supported by

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