mirror of
https://github.com/odriverobotics/ODrive.git
synced 2026-09-22 16:14:37 +08:00
make docs TOC consistent
This commit is contained in:
@@ -2,6 +2,16 @@
|
||||
|
||||
We will use the `<odrv>` as a placeholder for any ODrive object. Every ODrive controller is an ODrive object. In `odrivetool` this is usually `odrv0`. Furthermore we use `<axis>` as a placeholder for any axis, which is an attribute of an ODrive object (for example `odrv0.axis0`). An axis represents where the motors are connected. (axis0 for M0 or axis1 for M1)
|
||||
|
||||
### Table of contents
|
||||
<!-- TOC depthFrom:2 depthTo:2 -->
|
||||
|
||||
- [Per-Axis commands](#per-axis-commands)
|
||||
- [System monitoring commands](#system-monitoring-commands)
|
||||
- [General system commands](#general-system-commands)
|
||||
- [Setting up sensorless](#setting-up-sensorless)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Per-Axis commands
|
||||
|
||||
For the most part, both axes on the ODrive can be controlled independently.
|
||||
|
||||
@@ -7,8 +7,7 @@ permalink: /
|
||||
# Getting Started
|
||||
|
||||
### Table of contents
|
||||
|
||||
<!-- MarkdownTOC depth=2 autolink=true bracket=round -->
|
||||
<!-- TOC depthFrom:2 depthTo:2 -->
|
||||
|
||||
- [Hardware Requirements](#hardware-requirements)
|
||||
- [Wiring up the ODrive](#wiring-up-the-odrive)
|
||||
@@ -18,7 +17,7 @@ permalink: /
|
||||
- [Position control of M0](#position-control-of-m0)
|
||||
- [What's next?](#whats-next)
|
||||
|
||||
<!-- /MarkdownTOC -->
|
||||
<!-- /TOC -->
|
||||
|
||||
## Hardware Requirements
|
||||
|
||||
|
||||
+4
-7
@@ -5,19 +5,16 @@
|
||||
The ODrive can be controlled over various ports and protocols. If you're comfortable with embedded systems development, you can also run custom code directly on the ODrive. For that refer to the [developer documentation](developer-guide.md).
|
||||
|
||||
### Table of contents
|
||||
|
||||
<!-- MarkdownTOC depth=2 autolink=true bracket=round -->
|
||||
<!-- TOC depthFrom:2 depthTo:2 -->
|
||||
|
||||
- [Pinout](#pinout)
|
||||
- [Native Protocol](#native-protocol)
|
||||
- [ASCII Protocol](#ascii-protocol) (and Arduino)
|
||||
- [ASCII protocol](#ascii-protocol)
|
||||
- [Step/direction](#stepdirection)
|
||||
- [RC PWM input](#rc-pwm-input) (coming soon)
|
||||
- [RC PWM input](#rc-pwm-input)
|
||||
- [Ports](#ports)
|
||||
- [USB](#usb)
|
||||
- [UART](#uart)
|
||||
|
||||
<!-- /MarkdownTOC -->
|
||||
<!-- /TOC -->
|
||||
|
||||
## Pinout
|
||||
|
||||
|
||||
@@ -2,6 +2,18 @@
|
||||
|
||||
The ODrive Tool is the accompanying PC program for the ODrive. It's main purpose is to provide an interactive shell to control the device manually, as well as some supporting functions like firmware update.
|
||||
|
||||
### Table of contents
|
||||
<!-- TOC depthFrom:2 depthTo:2 -->
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Multiple ODrives](#multiple-odrives)
|
||||
- [Configuration Backup](#configuration-backup)
|
||||
- [Device Firmware Update](#device-firmware-update)
|
||||
- [Flashing with an STLink](#flashing-with-an-stlink)
|
||||
- [Liveplotter](#liveplotter)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Installation
|
||||
|
||||
Refer to the [Getting Started guide](getting-started#downloading-and-installing-tools).
|
||||
|
||||
+14
-1
@@ -1,5 +1,18 @@
|
||||
# Troubleshooting
|
||||
|
||||
Table of Contents:
|
||||
<!-- TOC depthFrom:2 depthTo:2 -->
|
||||
|
||||
- [Error codes](#error-codes)
|
||||
- [Common Axis Errors](#common-axis-errors)
|
||||
- [Common Motor Errors](#common-motor-errors)
|
||||
- [Common Encoder Errors](#common-encoder-errors)
|
||||
- [USB Connectivity Issues](#usb-connectivity-issues)
|
||||
- [Firmware Issues](#firmware-issues)
|
||||
- [Other issues that may not produce an error code](#other-issues-that-may-not-produce-an-error-code)
|
||||
|
||||
<!-- /TOC -->
|
||||
|
||||
## Error codes
|
||||
If your ODrive is not working as expected, run `odrivetool` and type `hex(<axis>.error)` <kbd>Enter</kbd> where `<axis>` is the axis that isn't working. This will display a [hexadecimal](https://en.wikipedia.org/wiki/Hexadecimal) representation of the error code. Each bit represents one error flag.
|
||||
|
||||
@@ -96,7 +109,7 @@ Check that your encoder is a model that has an index pulse. If your encoder does
|
||||
* Try a different USB cable
|
||||
* Try routing your USB cable so that it is far away from the motor and PSU cables to reduce EMI
|
||||
|
||||
## **Firmware Issues**
|
||||
## Firmware Issues
|
||||
|
||||
### Failure to build the firmware when running `make`
|
||||
- Clear out temporary files from previous compiles by first running `make clean` to prevent conflicts.
|
||||
|
||||
Reference in New Issue
Block a user