Skip to main content

Easy😆 and fast💨 MODI Python API package.

Project description

pymodi


pyversion distribution documentation coverage maintainability license
image image Documentation Status Coverage Status Maintainability

Easy😆 and fast💨 MODI Python API package.

Features

  • Connect to the MODI network module and control input & output modules.
  • List serial ports of MODI network modules.
  • Turn on or off the PnP mode of MODI modules.
  • Get the position information of each modules.

Build Status

master develop
image image

System Support

System 3.6 3.7 3.8
Linux Build Status Build Status Build Status
Mac OS Build Status Build Status Build Status
Windows Build Status Build Status Build Status

Contribution Guidelines

We appreciate all contributions. If you are planning to report bugs, please do so at https://github.com/LUXROBO/pyMODI/issues. Feel free to fork our repository to your local environment, and please send us feedback by filing an issue.

If you want to contribute to pymodi, be sure to review the contribution guidelines. This project adheres to pymodi's code of conduct. By participating, you are expected to uphold this code.

Contributor Covenant

Quickstart

Install the latest pyMODI if you haven't installed it yet:

pip install -U pymodi --user

Import [modi]{.title-ref} package and create [MODI]{.title-ref} instance:

import modi
bundle = modi.MODI(nb_modules=1)

List connected modules:

bundle.modules

List connected LED modules and pick the first one:

bundle.leds # List.
bundle.leds[0] # Pick.

Let's blink the LED's light 5 times:

import time

led = bundle.leds[0]

for _ in range(5):
    led.set_on()
    time.sleep(1)
    led.set_off()
    time.sleep(1)

History

0.1.0 (2018-06-28)

  • First release on in-house GitLab.

0.1.1 (2018-07-20)

  • Requirements fix.
  • Packages' include path fix.

0.1.2 (2018-07-23)

  • Python 3.4 support.

0.2.0 (2018-07-25)

  • Speaker module support.
  • Display module support.

0.2.1 (2018-07-27)

  • Add speaker module's tune() and off() methods.
  • Remove duplicated codes.

0.3.0 (2018-07-28)

  • Support python 2.7.
  • Speed up the performance.

0.3.1 (2018-07-28)

  • Requirements fix.

0.4.0 (2018-08-20)

  • Performance improvement.
  • The first documentation complete.

0.5.0 (2018-08-22)

  • Change the project name to pyMODI.

0.5.1 (2018-11-07)

  • Fix #26 (No MODI network module connected) issue.

0.5.2 (2019-10-11)

  • Can control a pair of motors of the motor module by torque(), speed(), angle().

0.6.0 (2019-10-18)

  • Performance improvement.
  • Bug fixes.

0.7.0 (2020-01-23)

  • Implement individual motor control.
  • Implement set variable method in display.
  • Implement test cases for each modi modules.
  • Implement multiprocessing version of pymodi.
  • Bug fixes.

0.7.1 (2020-02-07)

  • Refactor file structures.
  • Bug fixes.

0.8.0 (2020-05-07)

  • Implement Can Message Handler.
  • Implement Topology Manager.
  • Improve connection reliability by separating receiving and sending operations.
  • Bug fixes.

Project details


Download files

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

Files for pymodi, version 0.8.0
Filename, size File type Python version Upload date Hashes
Filename, size pymodi-0.8.0-py2.py3-none-any.whl (26.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pymodi-0.8.0.tar.gz (29.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page