NekoRMD is a Python library for controlling RMD series motors through a CAN interface. It provides a wide range of functions for motor control and monitoring.
Project description
NekoRMD python
TODO
- Position control
- Speed control
- New initialization algorithm (HIGH)
- Torque control
- Full telemetry getters support
- Write tests
- Translate the documentation into English and Ru
- Finish writing the remaining commands from the official documentation
- Publish in pip
- Many motors support (up to 3) using CAN
Installation
pip install neko-rmd
Configure CAN in your device: https://python-can.readthedocs.io/en/stable/installation.html
API
NekoRMD
The basic class for controlling RMD motors through a class object. When initializing in the constructor, it is mandatory to specify the CAN device address parameters and the motor type.
from NekoRMD.MotorType import MotorType
from NekoRMD.NekoRMD import NekoRMD
motor = NekoRMD(address=0x149, motor_type=MotorType.RMD8x_pro)
motor.setup()
- Initializes communication with the motor. Establishes a CAN connection with the motor and allows communication with it.
motor.init()
- Sends the command to turn on the motor.
Attention! After initializing the motor, it may not respond for 10 seconds! With a high degree of probability, your problems of non-fulfillment of motor commands are solved using time.sleep(10)
motor.restart()
- Перезагрузить мотор.
motor.wait(secunds=5)
- Задержка выполнения задач для конкретного мтора без блокировки других моторов и получения данных.
Control
motor.control.stop()
- Отправка команды остановки мотора.
motor.contol.freeze()
- Отправка команды заморозить мотор (мотор будет удерживать свою позицию).
motor.contol.unfreeze()
- Отправка команды разморозить мотор.
Speed control
motor.control.speed.set_speed(degrees_per_sec)
- Отправка команды управления мотором по скорости. Отправка аргумента 0 остановит мотор.
Position control
set_increment_position(self, max_speed, angle)
- Управление приращением позиции (многооборотный режим).
Параметры:
max_speed
(int): Максимальная скорость в RPM.angle
(int): Приращение угла в сотых долях градуса.
Пример:
motor.control.position.set_increment_position(max_speed=1000, angle=3600)
set_single_turn_position(self, direction, max_speed, angle)
- Управление положением на одном обороте.
Параметры:
direction
(int): Направление вращения (0x00 - по часовой стрелке, 0x01 - против часовой стрелки).max_speed
(int): Максимальная скорость в RPM.angle
(int): Угол управления в сотых долях градуса.
Пример:
motor.control.position.set_single_turn_position(0x01, 1000, 3800)
set_absolute_position(self, max_speed, angle)
- Управление абсолютной позицией (многооборотный режим).
Параметры:
max_speed
(int): Максимальная скорость в RPM.angle
(int): Абсолютный угол в сотых долях градуса.
Пример:
motor.control.position.set_absolute_position(max_speed=1000, angle=7200)
Получить текущую позиию мотора. Вернет timestamp, current_position
:
motor.control.position.get_position_data()
Вывод в консоль и логи позиции мотора:
motor.control.position.print_position_data(is_loop=True, subscriber="gRPC-monitor")
Torque control
Отправка команды управления моментом при 1 А:
motor.control.Torque.set_current(current = 1.0) # A
Telemetry
Получение данных экодера:
motor.telemetry.get_encoder()
Также возможно вывести в логи и консоль значения энкодера использовав метод print_encoder()
.
Получение значения PID:
motor.telemetry.get_PID()
Для вывода в консоль и логи используется метод print_PID()
.
Logs
Команду 8 byte CAN можно преобразовать в текстовое описание на EN-en и RU-ru языках вызвов методы класса logs
:
motor.logs.decode_motor_message(command)
Также для обработки и преобразования в текстовый формат ответов мотора можно использовать:
motor.logs.decode_motor_response(response)
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
Built Distribution
File details
Details for the file nekormd-0.1.0.tar.gz
.
File metadata
- Download URL: nekormd-0.1.0.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57286e319fe66b3a07df8a82bf7b0dcf20c5604ddce9832aa0da1d2156416b2c |
|
MD5 | 577a4d504cde79546582f060dde1fb9f |
|
BLAKE2b-256 | dd67c8735d2ae9b846dabdb9fd59dcb4850d5a80bf39e1ba2b132328c49976a5 |
File details
Details for the file NekoRMD-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: NekoRMD-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47adbb50fb9d66ba7a9892deebbce63f68aa8027c533f9022255cb956952bbe7 |
|
MD5 | 3c9a91bbabd5f54d416baeee87b99af7 |
|
BLAKE2b-256 | ebf9d55056564894b8b0c1129334fb4c4adfb4c8033005ce6ff8d2620aded05a |