Skip to main content

moteus brushless controller library and tools

Project description

Python bindings for moteus brushless controller

These bindings permit communication and control of moteus brushless controllers.

To use

pip3 install moteus  # or 'moteus-pi3hat' on a pi3hat

See a simple example of the API in use at: simple.py

Theory

Interactions with a controller are mediated through the moteus.Controller object. When constructed with the constructor argument transport=None (the default) it attempts to find some suitable link on your host system, typically the first fdcanusb or socketcan bus it locates.

Single controller imperative operation can be conducted by using await Controller.set_stop(), await Controller.set_position(), and await Controller.query().

Bus-optimized usage

To optimize bus usage, it is possible to command multiple controllers simultaneously. In this mode, a "transport" must be manually constructed.

import asyncio
import math
import moteus

async def main():
    transport = moteus.Fdcanusb()
    c1 = moteus.Controller(id = 1)
    c2 = moteus.Controller(id = 2)

    while True:
        print(await transport.cycle([
          c1.make_position(position=math.nan, query=True),
          c2.make_position(position=math.nan, query=True),
        ]))

asyncio.run(main())

All of the "set_" methods have a "make_" variant which is suitable to pass to a Transport's cycle method.

This mechanism only improves performance for non-fdcanusb links, such as a pi3hat.

An example use of this mechanism can be found at: pi3hat_multiservo.py

Position mode commands

Controller.set_position and Controller.make_position have arguments which exactly mirror the fields documented in docs/reference.md. Omitting them (or specifying None), results in them being omitted from the resulting register based command.

  • position
  • velocity
  • feedforward_torque
  • kp_scale
  • maximum_torque
  • stop_position
  • watchdog_timeout

Finally, the query argument controls whether information is queried from the controller or not.

Controlling resolution

The resolution of commands, and of returned query data, is controlled by optional constructor arguments to Controller. By default, the commands are all F32, and the query requests a subset of fields as INT16. Here is an example of setting those.

pr = moteus.PositionResolution()
pr.position = moteus.INT16
pr.velocity = moteus.INT16
pr.kp_scale = moteus.F32
pr.kd_scale = moteus.F32

qr = moteus.QueryResolution()
qr.mode = moteus.INT8
qr.position = moteus.F32
qr.velocity = moteus.F32
qr.torque = moteus.F32

c = moteus.Controller(position_resolution=pr, query_resolution=qr)

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

moteus-0.3.87.tar.gz (53.2 kB view details)

Uploaded Source

Built Distribution

moteus-0.3.87-py3-none-any.whl (61.5 kB view details)

Uploaded Python 3

File details

Details for the file moteus-0.3.87.tar.gz.

File metadata

  • Download URL: moteus-0.3.87.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for moteus-0.3.87.tar.gz
Algorithm Hash digest
SHA256 988f264c330a17d63219c49dd2365bdaff97156be3ab6c5eaa204b45dca621e8
MD5 0c7899f75cc67265202696290a4b0c85
BLAKE2b-256 a449dc3b7fee0da3a2f121296044b033496bc77312daa458480b5092419039b0

See more details on using hashes here.

File details

Details for the file moteus-0.3.87-py3-none-any.whl.

File metadata

  • Download URL: moteus-0.3.87-py3-none-any.whl
  • Upload date:
  • Size: 61.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for moteus-0.3.87-py3-none-any.whl
Algorithm Hash digest
SHA256 c7be68e527fdf64a3a12446d736b1008bfca211a6928b79a3abcf2fb1af17e49
MD5 36dc516e11b205747899b1fe95582371
BLAKE2b-256 a7a62d7c867b5f75b474675d1ef11d2edb46d4bb460c853cbf6ae89d47e2e84c

See more details on using hashes here.

Supported by

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