-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,32 @@ | ||
# Version 2.0 | ||
|
||
The MachineMotion Python API V2.0 aims at simplifying the interfaces to the digital input / outputs and the encoder position. | ||
|
||
## Compatibility | ||
|
||
The Python API V2 requires MachineMotion version V1.12 or newer. | ||
|
||
Please use [mm-python-api V1.6.7](https://github.com/VentionCo/mm-python-api/releases/tag/v1.6.7) for prior version of MachineMotion software. | ||
|
||
## Interface changes | ||
- **Obsoleted interfaces** | ||
- attachControlDevice | ||
- dettachControlDevice | ||
- readControlDevice | ||
- writecontrolDevice | ||
- **New interfaces:** | ||
- isIoExpanderAvailable(device) | ||
- digitalRead(device, pin) | ||
- digitalWrite(device, pin, value) | ||
- readEncoderRealtimePosition(device) | ||
|
||
|
||
# Version 1.6.7 | ||
|
||
Date: July 16<sup>th</sup>, 2019 | ||
|
||
## Improvements: | ||
- Added support for Python3 and Python2. | ||
- Updated the REAMDME to include the new MQTT library dependency. | ||
|
||
|
||
# Version: 1.6.6 | ||
|
||
Date: July 4<sup>th</sup> 2019 | ||
|
||
## Bug Fixes: | ||
- Fix distance of movement smaller then requested on linear axis. | ||
|
||
## Improvements: | ||
- All examples import statement are now version independant. | ||
|
||
<br><br> | ||
# Version: 1.6.5 | ||
|
||
Date: June 4<sup>th</sup> 2019 | ||
|
||
## Bug Fixes: | ||
- Fix Line Number mismatch with the help of the 'resend' message | ||
- Fix application hang on termination | ||
|
||
## New Features: | ||
- Support for the rotatory indexer with constants for mechanical gain. | ||
|
||
## Improvements: | ||
- Added more examples for each sensor port for the different control devices functions. | ||
- Auto reconnect on connection loss | ||
- Instead of starting a new thread each 0.1 seconds, we now start one thread at the beginning and keep it alive forever to receive messages from the server | ||
|
||
## Python API Version 4.2 | ||
Date: September 8<sup>th</sup> 2021 | ||
|
||
Python API supports Python 3.7.3 and older. Python-API v4.2 has been updated to support the following: | ||
|
||
- For Linux and Mac machines, it is now possible to install the Python api system-wide. To update or install a Python API version, navigate to the folder with the new Python API and run: | ||
|
||
`make install` | ||
- Simplified declaration of a new MachineMotion object. Creation of a MachineMotionv2 can be done as follows: | ||
|
||
`mm = MachineMotionV2()` | ||
|
||
`mm = MachineMotionV2OneDrive()` | ||
- Push Button and Power Switch modules are now supported. | ||
- Axes containing multiple drives can be configured and controlled as one. | ||
- Combined moves with the 4th drive are now allowed. | ||
- Enclosed ball screw is now supported. | ||
- Some function names have been changed to reflect MachineLogic naming. The old names are deprecated, but will still work. These functions are: | ||
- emitSpeed -> setSpeed | ||
- emitAcceleration -> setAcceleration | ||
- emitRelativeMove -> moveRelative | ||
- emitAbsoluteMove -> moveToPosition | ||
- emitCombinedAxesRelativeMove -> moveRelativeCombined | ||
- emitCombinedAxesAbsoluteMove -> moveToPositionCombined | ||
- emitContinuousMove -> moveContinuous | ||
- emitHome -> moveToHome | ||
- emitHomeAll -> moveToHomeAll | ||
- There is no directions field in moveRelative, moveRelativeCombined. Simply put a positive or negative distance to set the direction of movement. | ||
- moveToHome is not a blocking function. To block a script while homing, simply add a waitForMotionCompletion when desired. | ||
|
||
## Known Issues | ||
- If using the python API to control motors, you must first configure your actuators with the python API. Failure to do so can result in unexpected behaviour. |