Merge branch 'fw-v0.5.2rc1'

Merge v0.5.2rc1 branch into master

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps and configuration necessary to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows 10]
+ - odrivetool Version (`odrivetool --version`)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/compile.yaml

@@ -108,9 +108,22 @@ jobs:
           mv tup_build.sh tup_build.bat # in reality this is a .bat script on windows
           .\tup_build.bat
 
-  #code-checks:
-  #  runs-on: ubuntu-latest
-  #  steps:
+  code-checks:
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Check that we're not using std::isnan
+        run: |
+          cd ${{ github.workspace }}/Firmware
+
+          if grep 'std::isnan' -R .; then
+            echo "Don't use std::isnan because it's not compatible with '-ffast-math'. Use is_nan() instead."
+            return 1;
+          fi
+
   #    TODO:
   #     - check if enums.py is consistent with yaml
   #     - clang-format check

.github/workflows/nightly.yaml

@@ -15,9 +15,16 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Install odrivetool
+        shell: bash
         run: |
-          pip install monotonic # TODO: this is dishonest. Must be removed as soon as v0.5.0 is published!
-          pip install odrive
+          pip3 list | grep setuptools || echo "setuptools not installed" # show version
+          pip3 install setuptools # TODO: this should be a dependency of odrive
+          pip3 install odrive
+        env:
+          # TODO: this is a workaround for https://github.com/pypa/setuptools/issues/2353 and we
+          # can remove it as soon as python3-setuptools on GitHub's ubuntu-latest
+          # moves to version 50.1+.
+          SETUPTOOLS_USE_DISTUTILS: stdlib
 
       # This one currently fails because Github Actions runs pip as non-root
       #- name: Check if udev rules were set up properly
@@ -27,7 +34,7 @@ jobs:
       # This step is mentioned in the user guide
       - name: Add ~/.local/bin to path
         if: matrix.os == 'ubuntu-latest'
-        run: echo "::add-path::~/.local/bin"
+        run: echo "~/.local/bin" >> $GITHUB_PATH
 
       - name: Launch odrivetool
         # This returns a non-zero exit code if the odrivetool throws an exception

.gitignore

@@ -3,9 +3,6 @@ __pycache__/
 *.py[cod]
 *$py.class
 
-# C extensions
-*.so
-
 # Unit test / coverage reports
 htmlcov/
 .tox/
@@ -65,4 +62,4 @@ Firmware/Tests/bin/
 # GUI
 GUI/dist_electron
 GUI/node_modules
-GUI/build
+GUI/build

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "Firmware/Private"]
+	path = Firmware/Private
+	url = [email protected]:madcowswe/ODrivePrivate.git
+	branch = submodule

CHANGELOG.md

@@ -1,6 +1,95 @@
 # Unreleased Features
 Please add a note of your changes below this heading if you make a Pull Request.
 
+# Releases
+## [0.5.2] - 2021-05-21
+
+### Fixed
+* spinout error is no longer sticky and doesn't trigger on static torque loads due to I^2*R electrical power
+* Step and direction mode resets position when entering closed loop just like `input_pos` does
+* CAN baud rate setting is now correctly handled
+* `odrivetool dfu` works properly when an ODrive is flashed with the `dfu` switch set to "dfu".
+* `odrivetool dfu` now erases the entire flash memory before flashing firmware. This ensures that old configuration parameters are erased.
+* ASCII and the Native Protocol do not run at the same time on a UART interface. See `odrv0.config.uart0_protocol` and the `STREAM_PROTOCOL_TYPE` enums for details.
+
+### Added
+* `sc` command to ascii protocol to run `odrv.clear_errors()`
+* Added phase balance check to motor calibration and MOTOR_ERROR_UNBALANCED_PHASES to error enums
+* Added polarity and phase offset calibration for hall effect encoders
+* [Mechanical brake support](docs/mechanical-brakes.md)
+* Added periodic sending of encoder position on CAN
+* Support for UART1 on GPIO3 and GPIO4. UART0 (on GPIO1/2) and UART1 can currently not be enabled at the same time.
+* Thermistors now have a 2nd order lowpass filter applied to reduce noise
+* 2-norm current clamping is used for AC induction motors
+* Added spinout detection to detect incorrect encoder offset and CONTROLLER_ERROR_SPINOUT_DETECTED to error enums.
+* Added AARCH64 support to libfibre
+* Tuning input mode added to provide sinusoidal position, velocity, or torque stimulus. See INPUT_MODE_TUNING and the controller class for details.
+* Added torque mirroring to INPUT_MODE_MIRROR
+* `mechanical_power_bandwidth`, `electrical_power_bandwidth`, `spinout_electrical_power_threshold`, `spinout_mechanical_power_threshold` added to `controller.config` for spinout detection.
+* `mechanical_power` and `electrical_power` added to `controller`.
+
+### Changed
+* Step/dir performance improved! Dual axis step rates up to 250kHz have been tested
+* Apply_config is called for encoders after a successful direction find
+* Full calibration sequence now includes hall polarity calibration if a hall effect encoder is used
+* Modified encoder offset calibration to work correctly when calib_scan_distance is not a multiple of 4pi
+* Moved thermistors from being a top level object to belonging to Motor objects. Also changed errors: thermistor errors rolled into motor errors
+* Use DMA for DRV8301 setup
+* Make NVM configuration code more dynamic so that the layout doesn't have to be known at compile time.
+* GPIO initialization logic was changed. GPIOs now need to be explicitly set to the mode corresponding to the feature that they are used by. See `<odrv>.config.gpioX_mode`.
+* Previously, if two components used the same interrupt pin (e.g. step input for axis0 and axis1) then the one that was configured later would override the other one. Now this is no longer the case (the old component remains the owner of the pin).
+* New control loop architecture:
+  1. TIM8 update interrupt handler (CNT = 0) runs at a high priority and invokes the system level function `sample_cb()` to sample all timing critical inputs (currently only encoder state).
+  2. TIM8 update interrupt handler (CNT = 0) raises an NVIC flag to kick off a lower priority interrupt.
+  3. The control loop interrupt handler checks if all ADC measurements are ready and informs both motor objects about the current measurements.
+  4. The control loop interrupt handler invokes the system level function `control_loop_cb()` which updates all components (encoders, estimators, torque controllers, etc). The data paths between the components are configured by the Axis threads based on the requested state. This replaces the previous architecture where the components were updated inside the Axis threads in `Axis::run_control_loop()`.
+  5. Meanwhile the TIM1 and TIM8 updates for CNT = 3500 will have fired. The control loop interrupt handler thus reads the new ADC measurements and informs both motor objects that a DC calibration event has happened.
+  6. Finally, the control loop interrupt invokes `pwm_update_cb` on both motors to make them update their PWM timing registers.
+* Components that need low level control over PWM timings are implemented by inheriting from the `PhaseControlLaw` interface. Three components currently inherit this interface: `FieldOrientedController`, `ResistanceMeasurementControlLaw` and `InductanceMeasurementControlLaw`.
+* The FOC algorithm is now found in foc.cpp and and is presumably capable of running at a different frequency than the main control tasks (not relevant for ODrive v3).
+* ACIM estimator was consolidated into a separate component `<odrv>.acim_estimator`.
+* The Automatic Output Enable (AOE) flag of TIM1/TIM8 is used to achieve glitch-free motor arming.
+* Sensorless mode was merged into closed loop control mode. Use `<axis>.enable_sensorless_mode` to disable the use of an encoder.
+* More informative profiling instrumentation was added.
+* A system-level error property was introduced.
+* Added `torque_mirror_ratio` and use it to feed-forward `controller_.torque_output` in `INPUT_MODE_MIRROR`
+* Accumulate integer steps in step/dir to avoid float precision errors
+* Circular setpoint mode must be enabled when the step/dir interface is used.
+
+### API Migration Notes
+* `axis.config.turns_per_step` changed to `axis.controller.config.steps_per_circular_range`
+* `odrive.axis.fet_thermistor`, `odrive.axis.motor_thermistor` moved to `odrive.axis.motor` object
+* `enable_uart` and `uart_baudrate` were renamed to `enable_uart0` and `uart0_baudrate`.
+* `enable_i2c_instead_of_can` was replaced by the separate settings `enable_i2c0` and `enable_can0`.
+* `<axis>.motor.gate_driver` was moved to `<axis>.gate_driver`.
+* `<axis>.min_endstop.pullup` and `<axis>.max_endstop.pullup` were removed. Use `<odrv>.config.gpioX_mode = GPIO_MODE_DIGITAL / GPIO_MODE_DIGITAL_PULL_UP / GPIO_MODE_DIGITAL_PULL_DOWN` instead.
+* `<axis>.config.can_node_id` was moved to `<axis>.config.can.node_id`
+* `<axis>.config.can_node_id_extended` was moved to `<axis>.config.can.is_extended`
+* `<axis>.config.can_heartbeat_rate_ms` was moved to `<axis>.config.can.heartbeat_rate_ms`
+* `<odrv>.get_oscilloscope_val()` was moved to `<odrv>.oscilloscope.get_val()`.
+* Several error flags from `<odrv>.<axis>.error` were removed. Some were moved to `<odrv>.error` and some are no longer relevant because implementation details changed.
+* Several error flags from `<odrv>.<axis>.motor.error` were removed. Some were moved to `<odrv>.error` and some are no longer relevant because implementation details changed.
+* `<axis>.lockin_state` was removed as the lockin implementation was replaced by a more general open loop control block (currently not exposed on the API).
+* `AXIS_STATE_SENSORLESS_CONTROL` was removed. Use `AXIS_STATE_CLOSED_LOOP_CONTROL` instead with `<odrv>.enable_sensorless_mode = True`.
+* `<axis>.config.startup_sensorless_control` was removed. Use `<axis>.config.startup_closed_loop_control` instead with `<odrv>.enable_sensorless_mode = True`.
+* `<axis>.clear_errors()` was replaced by the system-wide function `<odrv>.clear_errors()`.
+* `<axis>.armed_state` was replaced by `<axis>.is_armed`.
+* Several properties in `<axis>.motor.current_control` were changed to read-only.
+* `<axis>.motor.current_control.Ibus` was moved to `<axis>.motor.I_bus`.
+* `<axis>.motor.current_control.max_allowed_current` was moved to `<axis>.motor.max_allowed_current`.
+* `<axis>.motor.current_control.overcurrent_trip_level` was removed.
+* `<axis>.motor.current_control.acim_rotor_flux` was moved to `<axis>.acim_estimator.rotor_flux`.
+* `<axis>.motor.current_control.async_phase_vel` was moved to `<axis>.acim_estimator.stator_phase_vel`.
+* `<axis>.motor.current_control.async_phase_offset` was moved to `<axis>.acim_estimator.phase`.
+* `<axis>.motor.timing_log` was removed in favor of `<odrv>.task_times` and `<odrv>.<axis>.task_times`.
+* `<axis>.motor.config.direction` was moved to `<axis>.encoder.config.direction`.
+* `<axis>.motor.config.acim_slip_velocity` was moved to `<axis>.acim_estimator.config.slip_velocity`.
+* Several properties were changed to readonly.
+* `<axis>.encoder.config.offset` was renamed to ``<axis>.encoder.config.phase_offset`
+* `<axis>.encoder.config.offset_float` was renamed to ``<axis>.encoder.config.phase_offset_float`
+* `<odrv>.config.brake_resistance == 0.0` is no longer a valid way to disable the brake resistor. Use `<odrv>.config.enable_brake_resistor` instead. A reboot is necessary for this to take effect.
+* `<odrv>.can.set_baud_rate()` was removed. The baudrate is now automatically updated when writing to `<odrv>.can.config.baud_rate`.
+
 # Releases
 ## [0.5.1] - 2020-09-27
 ### Added
@@ -18,6 +107,8 @@ Please add a note of your changes below this heading if you make a Pull Request.
 * `axis.motor.get_inverter_temp()`, `axis.motor.inverter_temp_limit_lower` and `axis.motor.inverter_temp_limit_upper` have been moved to seperate fet thermistor object under `axis.fet_thermistor`. `get_inverter_temp()` function has been renamed to `temp` and is now a read-only property.
 * `axis.config.counts_per_step` is now `axis.config.turns_per_step`
 * Outputs of `axis.sensorless_estimator` are now in turns/s instead of electrical rad/s
+* Fixed bug of high current during lockin-ramp caused by `motor::update()` expecting a torque command instead of current
+* Fixed bug where commanded velocity was extremely high just after sensorless ramp when using `input_mode` INPUT_MODE_VEL_RAMP caused by `vel_setpoint` and `axis.config.sensorless_ramp.vel` being in different units
 
 ### Fixed
 * Fixed bug of high current during lockin-ramp caused by `motor::update()` expecting a torque command instead of current

Dockerfile

@@ -7,16 +7,22 @@ RUN add-apt-repository ppa:team-gcc-arm-embedded/ppa
 RUN add-apt-repository ppa:jonathonf/tup
 RUN apt-get update
 RUN apt-get -y upgrade
-RUN apt-get -y install gcc-arm-embedded openocd tup python3.7 build-essential git
+RUN apt-get -y install gcc-arm-embedded openocd tup python3.7 python3-yaml python3-jinja2 python3-jsonschema build-essential git
 
 # Build step below does not know about debian's python naming schemme
 RUN ln -s /usr/bin/python3.7 /usr/bin/python
 
-# Copy the firmware tree into the container
-RUN mkdir ODrive
-COPY . ODrive
+RUN mkdir -p ODrive
 WORKDIR ODrive/Firmware
 
-# Hack around Tup's dependency on FUSE
-RUN tup generate build.sh
-RUN ./build.sh
+# Must attach the firmware tree into the container
+CMD \
+	# Regenerate python interface
+	python interface_generator_stub.py \
+	--definitions odrive-interface.yaml \
+	--template ../tools/enums_template.j2 \
+	--output ../tools/odrive/enums.py && \
+	# Hack around Tup's dependency on FUSE
+	tup init && \
+	tup generate build.sh && \
+	./build.sh

Firmware/.gitignore

@@ -26,3 +26,6 @@ STM32CubeMX
 
 #gdb log
 openocd.log
+
+# OS-specific files
+.DS_Store

Firmware/.vscode/c_cpp_properties.json

@@ -3,21 +3,35 @@
         {
             "name": "Win32",
             "includePath": [
+                "${workspaceFolder}/Private/**",
                 "${workspaceFolder}/**"
             ],
             "defines": [
-                "STM32F405xx",
+                "__arm__",
+                "STM32F722xx",
+                "FPU_FPV5",
                 "USE_HAL_DRIVER",
-                "HW_VERSION_MAJOR=3",
-                "HW_VERSION_MINOR=6",
-                "HW_VERSION_VOLTAGE=56",
-                "USB_PROTOCOL_NATIVE",
+                "HW_VERSION_MAJOR=4",
+                "HW_VERSION_MINOR=1",
+                "HW_VERSION_VOLTAGE=58",
+                "FIBRE_ENABLE_SERVER",
+                "FIBRE_ENABLE_CLIENT",
                 "__weak=\"__attribute__((weak))\"",
                 "__packed=\"__attribute__((__packed__))\"",
                 "__GNUC__"
             ],
-            "intelliSenseMode": "gcc-x64",
-            "compilerPath": "\"${ARM_GCC_ROOT}/bin/arm-none-eabi-g++.exe\" -mthumb -mcpu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard -specs=nosys.specs -specs=nano.specs -u _printf_float -u _scanf_float",
+            "intelliSenseMode": "gcc-arm",
+            "compilerPath": "arm-none-eabi-g++.exe",
+            "compilerArgs": [
+                "-mthumb",
+                "-mcpu=cortex-m7",
+                "-mfpu=fpv5-sp-d16",
+                "-mfloat-abi=hard",
+                "-specs=nosys.specs",
+                "-specs=nano.specs",
+                "-u _printf_float",
+                "-u _scanf_float"
+            ],
             "cStandard": "c11",
             "cppStandard": "c++17"
         },
@@ -27,16 +41,20 @@
                 "${workspaceFolder}/**"
             ],
             "defines": [
+                "__arm__",
                 "STM32F405xx",
+                "FPU_FPV4",
                 "USE_HAL_DRIVER",
-                "HW_VERSION_MAJOR=3",
-                "HW_VERSION_MINOR=6",
-                "HW_VERSION_VOLTAGE=56",
+                "HW_VERSION_MAJOR=4",
+                "HW_VERSION_MINOR=1",
+                "HW_VERSION_VOLTAGE=58",
+                "FIBRE_ENABLE_SERVER",
+                "FIBRE_ENABLE_CLIENT",
                 "__weak=\"__attribute__((weak))\"",
                 "__packed=\"__attribute__((__packed__))\"",
                 "__GNUC__"
             ],
-            "intelliSenseMode": "gcc-x64",
+            "intelliSenseMode": "gcc-arm",
             "compilerPath": "arm-none-eabi-g++ -mthumb -mcpu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard -specs=nosys.specs -specs=nano.specs -u _printf_float -u _scanf_float",
             "cStandard": "c11",
             "cppStandard": "c++17"
@@ -47,16 +65,20 @@
                 "${workspaceFolder}/**"
             ],
             "defines": [
+                "__arm__",
                 "STM32F405xx",
+                "FPU_FPV4",
                 "USE_HAL_DRIVER",
-                "HW_VERSION_MAJOR=3",
-                "HW_VERSION_MINOR=4",
-                "HW_VERSION_VOLTAGE=24",
+                "HW_VERSION_MAJOR=4",
+                "HW_VERSION_MINOR=1",
+                "HW_VERSION_VOLTAGE=58",
+                "FIBRE_ENABLE_SERVER",
+                "FIBRE_ENABLE_CLIENT",
                 "__weak=\"__attribute__((weak))\"",
                 "__packed=\"__attribute__((__packed__))\"",
                 "__GNUC__"
             ],
-            "intelliSenseMode": "gcc-x64",
+            "intelliSenseMode": "gcc-arm",
             "cStandard": "c11",
             "cppStandard": "c++17"
         }