Merge remote-tracking branch 'madcowswe/devel' into feature/CAN

2026-09-22 16:14:37 +08:00 · 2018-10-07 13:33:15 -04:00
parent 2f76d3c284 5a22821bcd
commit 3e4610a068
8 changed files with 54 additions and 36 deletions
@@ -1,8 +1,9 @@
 # Unreleased Features
 Please add a note of your changes below this heading if you make a Pull Request.

-# Unreleased
+# Releases

+## [0.4.5] - 2018-10-06
 ### Added
 * **Trapezoidal Trajectory Planner**
 * Hook to execute protocol property written callback
@@ -24,7 +25,6 @@ Please add a note of your changes below this heading if you make a Pull Request.
 * An issue where the axis state machine would jump in and out of idle when there is an error
 * There is a [bug](https://github.com/ARM-software/CMSIS_5/issues/267) in the arm fast math library, which gives spikes in the output of arm_cos_f32 for input values close to -pi/2. We fixed the bug locally, and hence are using "our_arm_cos_f32".

-# Releases
 ## [0.4.4] - 2018-09-18
 ### Fixed
 * Serious reliability issue with USB communication where packets on Native and the CDC interface would collide with each other.
@@ -15,9 +15,9 @@ public:
        ERROR_CURRENT_MEASUREMENT_TIMEOUT = 0x08,
        ERROR_BRAKE_RESISTOR_DISARMED = 0x10, //<! the brake resistor was unexpectedly disarmed
        ERROR_MOTOR_DISARMED = 0x20, //<! the motor was unexpectedly disarmed
-        ERROR_MOTOR_FAILED = 0x40,
+        ERROR_MOTOR_FAILED = 0x40, // Go to motor.hpp for information, check odrvX.axisX.motor.error for error value 
        ERROR_SENSORLESS_ESTIMATOR_FAILED = 0x80,
-        ERROR_ENCODER_FAILED = 0x100,
+        ERROR_ENCODER_FAILED = 0x100, // Go to encoder.hpp for information, check odrvX.axisX.encoder.error for error value
        ERROR_CONTROLLER_FAILED = 0x200,
        ERROR_POS_CTRL_DURING_SENSORLESS = 0x400,
        ERROR_ESTOP_REQUESTED = 0x800
@@ -25,13 +25,13 @@ GEM
    execjs (2.7.0)
    faraday (0.14.0)
      multipart-post (>= 1.2, < 3)
-    ffi (1.9.23)
+    ffi (1.9.24)
    forwardable-extended (2.6.0)
    gemoji (3.0.0)
    github-pages (181)
      activesupport (= 4.2.9)
      github-pages-health-check (= 1.4.0)
-      jekyll (= 3.7.3)
+      jekyll (= 3.7.4)
      jekyll-avatar (= 0.5.0)
      jekyll-coffeescript (= 1.1.1)
      jekyll-commonmark-ghpages (= 0.1.5)
@@ -85,7 +85,7 @@ GEM
    http_parser.rb (0.6.0)
    i18n (0.9.5)
      concurrent-ruby (~> 1.0)
-    jekyll (3.7.3)
+    jekyll (3.7.4)
      addressable (~> 2.4)
      colorator (~> 1.0)
      em-websocket (~> 0.5)
@@ -134,7 +134,7 @@ GEM
      jekyll (~> 3.3)
    jekyll-remote-theme (0.2.3)
      jekyll (~> 3.5)
-      rubyzip (>= 1.2.1, < 3.0)
+      rubyzip (>= 1.2.2, < 3.0)
      typhoeus (>= 0.7, < 2.0)
    jekyll-sass-converter (1.5.2)
      sass (~> 3.4)
@@ -27,3 +27,9 @@ sections:
        url: configuring-vscode
      - title: Configuring Eclipse
        url: configuring-eclipse
+  - title: Component Guides
+    docs:
+      - title: Motor Guide
+        url: https://docs.google.com/spreadsheets/d/12vzz7XVEK6YNIOqH0jAz51F5VUpc-lJEs3mmkWP1H4Y
+      - title: Encoder Guide
+        url: https://docs.google.com/spreadsheets/d/1OBDwYrBb5zUPZLrhL98ezZbg94tUsZcdTuwiVNgVqpU
@@ -1,15 +1,7 @@
 # Encoders

 ## Known and Supported Encoders
-Contributions to this table highly encouraged!
-
-Encoder|Manufacturer|Output|Index|Max CPR|Max RPM|Voltage|Supported|Price|Link|Datasheet
-:--|:--|:--|:-:|:-:|:-:|:-:|:--|:--|:--|:--
-AMT102|CUI|Quadrature|Yes|8192 (2048 * 4)|-|5V|Yes|-|-|-
-AMT203|CUI|Quadrature + Absolute|Yes|4096 (1024 * 4)|-|5V|Quadrature Only|-|-|-
-AS5047P|AMS|Quadrature + Absolute|Yes|4096 (1024 * 4)|28k|3.3V or 5V|Quadrature Only|-|-|-
-E6B2-CWZ6C|Omron|Quadrature|Yes|8000 (2000 * 4)|-|5-24V|Yes|-|-|[Datasheet](http://www.ia.omron.com/products/family/487/)
-J733|-|Quadrature|No|2400 (600 * 4)|-|5-24V|Yes|-|-|-
+Check out the [ODrive Encoder Guide](https://docs.google.com/spreadsheets/d/1OBDwYrBb5zUPZLrhL98ezZbg94tUsZcdTuwiVNgVqpU).

 ## Encoder Calibration

@@ -24,7 +24,7 @@ permalink: /

 ### You will need:
 * One or two [brushless motors](https://docs.google.com/spreadsheets/d/12vzz7XVEK6YNIOqH0jAz51F5VUpc-lJEs3mmkWP1H4Y). It is fine, even recommended, to start testing with just a single motor and encoder.
-* One or two [quadrature incremental encoder(s)](encoders)
+* One or two [encoder(s)](https://docs.google.com/spreadsheets/d/1OBDwYrBb5zUPZLrhL98ezZbg94tUsZcdTuwiVNgVqpU)
 * A power resistor. A good starting point would be the 50W resistor included with your ODrive.
  <details><summary markdown="span">Do I really need a power resistor? What values to choose?</summary><div markdown="block">

@@ -128,11 +128,11 @@ Try step 5 again
 ```

 ## Firmware
-#### ODrive v3.5 and later
-Your board should come preflashed with firmware. If you run into problems, follow the instructions [here](odrivetool.md#device-firmware-update) on the DFU procedure before you continue.
+**ODrive v3.5 and later**<br>
+Your board should come preflashed with firmware. If you run into problems, follow the instructions [here](odrivetool.md#device-firmware-update) on the DFU procedure before you continue.</div>

-#### ODrive v3.4 and earlier
-Your board does **not** come preflashed with any firmware. Follow the instructions [here](odrivetool.md#device-firmware-update) on the STP Link procedure before you continue.
+**ODrive v3.4 and earlier**<br>
+Your board does **not** come preflashed with any firmware. Follow the instructions [here](odrivetool.md#device-firmware-update) on the STP Link procedure before you continue.</div>

 ## Start `odrivetool`
 To launch the main interactive ODrive tool, type `odrivetool` <kbd>Enter</kbd>. Connect your ODrive and wait for the tool to find it. Now you can, for instance type `odrv0.vbus_voltage` <kbd>Enter</kbd> to inpect the boards main supply voltage.
@@ -158,27 +158,27 @@ You can read more about `odrivetool` [here](odrivetool.md).

 ### 1. Set the limits:
 <details><summary markdown="span">Wait, how do I set these?</summary><div markdown="block">
-
 In the previous step we started `odrivetool`. In there, you can assign variables directly by name.

 For instance, to set the current limit of M0 to 10A you would type: `odrv0.axis0.motor.config.current_lim = 10` <kbd>Enter</kbd>
 </div></details>

-#### Current limit
+**Current limit**<br>
 `odrv0.axis0.motor.config.current_lim` [A].  
 The default current limit, for safety reasons, is set to 10A. This is quite weak, but good for making sure the drive is stable. Once you have tuned the oDrive, you can increase this to 75A to increase performance. Note that above 75A, you must change the current amplifier gains. You do this by requesting a different current range. i.e. for 90A on M0: `odrv0.axis0.motor.config.requested_current_range = 90` [A], then save the configuration and reboot as the gains are written out to the DRV (MOSFET driver) only during startup.

 *Note: The motor current and the current drawn from the power supply is not the same in general. You should not look at the power supply current to see what is going on with the motor current.*
-    
 <details><summary markdown="span">Ok, so tell me how it actually works then...</summary><div markdown="block">
 The current in the motor is only connected to the current in the power supply _sometimes_ and other times it just cycles out of one phase and back in the other. This is what the modulation magnitude is (sometimes people call this duty cycle, but that's a bit confusing because we use SVM not straight PWM). When the modulation magnitude is 0, the average voltage seen across the motor phases is 0, and the motor current is never connected to the power supply. When the magnitude is 100%, it is always connected, and at 50% it's connected half the time, and cycled in just the motor half the time.

 The largest effect on modulation magnitude is speed. There are other smaller factors, but in general: if the motor is still it's not unreasonable to have 50A in the motor from 5A on the power supply. When the motor is spinning close to top speed, the power supply current and the motor current will be somewhat close to each other.
-    </div></details>
-#### Velocity limit
+</div></details>
+
+**Velocity limit**<br>
 `odrv0.axis0.controller.config.vel_limit` [counts/s].  
 The motor will be limited to this speed. Again the default value is quite slow.
-#### Calibration current
+
+**Calibration current**<br>
 You can change `odrv0.axis0.motor.config.calibration_current` [A] to the largest value you feel comfortable leaving running through the motor continuously when the motor is stationary. If you are using a small motor (i.e. 15A current rated) you may need to reduce `calibration_current` to a value smaller than the default.

 ### 2. Set other hardware parameters
@@ -190,7 +190,6 @@ This is the number of **magnet poles** in the rotor, **divided by two**. To find
 If you can't see them, try sliding a magnet around the rotor, and counting how many times it stops. This will be the number of **pole pairs**. If you use a magnetic piece of metal instead of a magnet, you will get the number of **magnet poles**.
 `odrv0.axis0.motor.config.motor_type`  
 This is the type of motor being used. Currently two types of motors are supported: High-current motors (`MOTOR_TYPE_HIGH_CURRENT`) and gimbal motors (`MOTOR_TYPE_GIMBAL`).
-
 <details><summary markdown="span">Which <code>motor_type</code> to choose?</summary><div markdown="block">

 If you're using a regular hobby brushless motor like [this](https://hobbyking.com/en_us/turnigy-aerodrive-sk3-5065-236kv-brushless-outrunner-motor.html) one, you should set `motor_mode` to `MOTOR_TYPE_HIGH_CURRENT`. For low-current gimbal motors like [this](https://hobbyking.com/en_us/turnigy-hd-5208-brushless-gimbal-motor-bldc.html) one, you should choose `MOTOR_TYPE_GIMBAL`. Do not use `MOTOR_TYPE_GIMBAL` on a motor that is not a gimbal motor, as it may overheat the motor or the ODrive.
@@ -199,15 +198,15 @@ If you're using a regular hobby brushless motor like [this](https://hobbyking.co
 If 100's of mA of current noise is "small" for you, you can choose `MOTOR_TYPE_HIGH_CURRENT`.
 If 100's of mA of current noise is "large" for you, and you do not intend to spin the motor very fast (Ω * L << R), and the motor is fairly large resistance (1 ohm or larger), you can chose `MOTOR_TYPE_GIMBAL`.
 If 100's of mA current noise is "large" for you, _and_ you intend to spin the motor fast, then you need to replace the shunt resistors on the ODrive.
-
 </div></details> <br> 

 *Note: When using gimbal motors,* `current_lim` *and* `calibration_current` *actually mean "voltage limit" and "calibration voltage", since we don't use current feedback. This means that if you set it to 10, it means 10V, despite the name of the parameter.*

-#### If using encoder
+**If using encoder**<br>
 `odrv0.axis0.encoder.config.cpr`: Encoder Count Per Revolution [CPR]  
 This is 4x the Pulse Per Revolution (PPR) value. Usually this is indicated in the datasheet of your encoder.
-#### If not using encoder
+
+**If not using encoder**<br>
 * If you wish to run in sensorless mode, please see [Setting up sensorless](commands.md#setting-up-sensorless).
 * If you are using hall sensor feedback, please see the [hoverboard motor example](hoverboard.md).

@@ -244,10 +243,12 @@ Let's get motor 0 up and running. The procedure for motor 1 is exactly the same,

 ### Other control modes
 The ODrive also supports velocity control and current (torque) control.
-#### Velocity control
+
+**Velocity control**<br>
 Set `odrv0.axis0.controller.config.control_mode = CTRL_MODE_VELOCITY_CONTROL`.  
 You can now control the velocity with `odrv0.axis0.controller.vel_setpoint = 5000` [count/s].
-#### Current control
+
+**Current control**<br>
 Set `odrv0.axis0.controller.config.control_mode = CTRL_MODE_CURRENT_CONTROL`.  
 You can now control the current with `odrv0.axis0.controller.current_setpoint = 3` [A].

@@ -5,6 +5,20 @@ Each step is acompanied by some explanation so hopefully you can carry over some

 [![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/ponx_U4xhoM/0.jpg)](https://www.youtube.com/watch?v=ponx_U4xhoM) <br> Click above to play video.

+### Hoverboard motor wiring
+Hoverboard motors come with three motor phases (usually colored yellow, blue, green) which are thicker, and a set of 5 thinner wires for the hall sensor feedback (usually colored red, yellow, blue, green, black).
+
+You may wire the motor phases in any order into a motor connector on the ODrive, as we will calibrate the phase alignment later anyway. Wire the hall feedback into the ODrive J2 conenctor (make sure that the motor channel number matches) as follows:
+
+| Hall wire | J2 signal |
+|-----------|-----------|
+| Red       | 5V        |
+| Yellow    | A         |
+| Blue      | B         |
+| Green     | Z         |
+| Black     | GND       |
+
+
 ### Hoverboard motor configuration
 Standard 6.5 inch hoverboard hub motors have 30 permanent magnet poles, and thus 15 pole pairs. If you have a different motor you need to count the magnets or have a reliable datasheet for this information.
 ```txt
@@ -38,7 +38,7 @@ The axis error may say that some other component has failed. Say it reports `ERR

 * `ERROR_INVALID_STATE = 0x01`

-Typically returned along with another error. Resolve that error and then reboot using `odrv0.reboot()` or remoivng power, waiting 5 seconds and restoring power to return to normal operating. 
+You tried to run a state before you are allowed to. Typically you tried to run encoder calibration or closed loop control before the motor was calibrated, or you tried to run closed loop control before the encoder was calibrated.

 * `ERROR_DC_BUS_UNDER_VOLTAGE = 0x02`

@@ -66,7 +66,12 @@ Out[2]: 1.408751450071577e-05
 In [3]: odrv0.axis0.motor.config.phase_resistance
 Out[3]: 0.029788672924041748
 ```
-Some motors will have a considerably different phase resistance and inductance than this. For example, gimbal motors, some small motors (e.g. < 10A peak current). If you think this applies to you try increasing `odrv0.axis0.motor.config.resistance_calib_max_voltage` from its default value of 1 using odrive tool and repeat the motor calibration process. If your motor has a small peak current draw (e.g. < 20A) you can also try decreasing `odrv0.axis0.motor.config.calibration_current` from its default value of 10A.
+Some motors will have a considerably different phase resistance and inductance than this. For example, gimbal motors, some small motors (e.g. < 10A peak current). If you think this applies to you try increasing `odrv0.axis0.motor.config.resistance_calib_max_voltage` from its default value of 1 using odrivetool and repeat the motor calibration process. If your motor has a small peak current draw (e.g. < 20A) you can also try decreasing `odrv0.axis0.motor.config.calibration_current` from its default value of 10A.
+
+In general, you need
+```text
+resistance_calib_max_voltage > calibration_current * phase_resistance`.
+```

 * `ERROR_DRV_FAULT = 0x0008`