diff --git a/Firmware/CHANGELOG.md b/Firmware/CHANGELOG.md index 4e0f1196..3d928d83 100644 --- a/Firmware/CHANGELOG.md +++ b/Firmware/CHANGELOG.md @@ -1,10 +1,9 @@ -## [0.2.0] - UNRELEASED +## [0.2.0] - 2017-11-12 ### Added -* UART feature +* UART communication * Setting to select UART or Step/dir on GIPIO 1,2 * Basic Anti-cogging -### Changed ## [0.1.0] - 2017-08-26 ### Added diff --git a/Firmware/README.md b/Firmware/README.md index fb7f9c11..ec5d96f6 100644 --- a/Firmware/README.md +++ b/Firmware/README.md @@ -1,5 +1,9 @@ # ODriveFirmware +If you wish to use the latest release, please use the `master` branch (this is the default branch GitHub will present you with). + +If you are a developer, you are encouraged to use the `devel` branch, as it contains the latest features. + ### Table of contents diff --git a/README.md b/README.md index 9ed8752c..22b83ed3 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ This project is all about accurately driving brushless motors, for cheap. The aim is to make it possible to use inexpensive brushless motors in high performance robotics projects, like [this](https://www.youtube.com/watch?v=WT4E5nb3KtY). ## Getting Started -*References to hardware is with respect to v3.3. Other versions may still apply, but component designators may differ* - It is perfectly fine, and even recommended, to start testing with just a single motor and encoder. Make sure you have a good mechanical connection between the encdoer and the motor, slip can cause disasterous oscillations. All non-power I/O is 3.3V output and 5V tolerant on input, except: @@ -20,8 +18,9 @@ Wire up the encoder(s) to J4. The A,B phases are required, and the Z (index puls ![Image of ODrive all hooked up](https://docs.google.com/drawings/d/e/2PACX-1vTCD0P40Cd-wvD7Fl8UYEaxp3_UL81oI4qUVqrrCJPi6tkJeSs2rsffIXQRpdu6rNZs6-2mRKKYtILG/pub?w=1716&h=1281) -The currently supported command modes are USB and step/direction. +The currently supported command modes are USB, UART and step/direction. * If you are sending commands over USB, you can plug in a cable into the micro-USB port. +* If you are sending commands over UART, please see [Setting up UART](#setting-up-uart) * If you are using step/direction, please see [setting up step/direction](#setting-up-stepdirection) You can now: