-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Absolute Encoder and Wind-Vane-Absolute-Encoder Docs
- Loading branch information
1 parent
867d241
commit b26ed51
Showing
3 changed files
with
52 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
.. _common-absolute-encoder: | ||
[copywiki destination="rover"] | ||
|
||
===== | ||
Absolute Encoder | ||
===== | ||
|
||
This article describes how to attach an absolute encoder so that your vehicle can sense angular position. This is used most commonly | ||
for :ref:`wind-vane sensors <wind-vane>` for sailing rovers. | ||
|
||
Currently, only AS5048B Encoders are supported. | ||
|
||
AutoPilot connection | ||
-------------------- | ||
Connect the encoder to the autopilot's I2C Port using standard connections. | ||
|
||
Autopilot Configuration | ||
----------------------- | ||
|
||
Connect to the autopilot with a ground station and set these parameters and then reload the parameters. | ||
|
||
- :ref:`AENC_TYPE <AENC_TYPE>` = 1 (Enable) | ||
|
||
After reloading parameters, set the following parameters: | ||
|
||
- :ref:`AENC_BUS <AENC_BUS>` - set this to the serial bus ID for the I2C bus you've connected to. | ||
- :ref:`AENC_ADDR <AENC_ADDR>` - set this to the I2C Address of your sensor (defaults to 64 for AS5048B). | ||
- :ref:`AENC_OFFS <AENC_OFFS>` - set this to apply an offset in degrees to the zero position. | ||
- :ref:`AENC_DIR <AENC_DIR>` - set this to -1 if you need to reverse the direction of rotation for the encoder. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
.. _wind-vane-absolute-encoder: | ||
|
||
======================= | ||
Absolute Encoder Wind Vane | ||
======================= | ||
|
||
An absolute encoder can be configured as the wind-vane direction source. In order to use this option, you must first configure | ||
the absolute encoder as described in the :ref:`Absolute Encoder library <common-absolute-encoder>` documentation. | ||
|
||
To select the absolute encoder as the win-dvane direction source, set :ref:`WNDVN_TYPE <WNDVN_TYPE>` = 4. Then, select the absolute | ||
encoder instance via the :ref:`WNDVN_DIR_PIN <WNDVN_DIR_PIN>` parameter (0=AbsoluteEncoder1, 1=AbsoluteEncoder2). | ||
|
||
|
||
Wind Vane Construction | ||
++++++++++++++++++++++ | ||
A 3D-Printable model for an absolute encoder win-vane is available on `thingiverse <https://www.thingiverse.com/thing:4247123>`__. This example | ||
uses an AS5048B breakout board and diametrically polarized magnet available `here <https://www.digikey.com/en/products/detail/ams/AS5048A-TS_EK_AB/3188612>`__. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters