Skip to content

Commit

Permalink
use correct property names in IMU documentation (fixes #26)
Browse files Browse the repository at this point in the history
  • Loading branch information
falkoschindler committed Jan 17, 2024
1 parent 0558375 commit 51ecb78
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"[python]": {
"editor.defaultFormatter": "ms-python.python",
"editor.codeActionsOnSave": {
"source.organizeImports": true
"source.organizeImports": "explicit"
}
}
}
10 changes: 5 additions & 5 deletions docs/module_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,11 +171,11 @@ The constructor expects up to five arguments:
- `address`: client address of the MCP (0x28 or 0x29, default: 0x28)
- `clk_speed`: I2C clock speed (default: 100000)

| Properties | Description | Data type |
| ------------- | ----------------------------------- | --------- |
| `imu.accel_x` | acceleration in x direction (m/s^2) | `float` |
| `imu.accel_y` | acceleration in y direction (m/s^2) | `float` |
| `imu.accel_z` | acceleration in z direction (m/s^2) | `float` |
| Properties | Description | Data type |
| ----------- | ----------------------------------- | --------- |
| `imu.acc_x` | acceleration in x direction (m/s^2) | `float` |
| `imu.acc_y` | acceleration in y direction (m/s^2) | `float` |
| `imu.acc_z` | acceleration in z direction (m/s^2) | `float` |

## CAN interface

Expand Down

0 comments on commit 51ecb78

Please sign in to comment.