diff --git a/common/source/docs/common-absolute-encoder.rst b/common/source/docs/common-absolute-encoder.rst new file mode 100644 index 0000000000..c7a5d31680 --- /dev/null +++ b/common/source/docs/common-absolute-encoder.rst @@ -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 ` 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 ` = 1 (Enable) + +After reloading parameters, set the following parameters: + +- :ref:`AENC_BUS ` - set this to the serial bus ID for the I2C bus you've connected to. +- :ref:`AENC_ADDR ` - set this to the I2C Address of your sensor (defaults to 64 for AS5048B). +- :ref:`AENC_OFFS ` - set this to apply an offset in degrees to the zero position. +- :ref:`AENC_DIR ` - set this to -1 if you need to reverse the direction of rotation for the encoder. + + diff --git a/rover/source/docs/wind-vane-absolute-encoder.rst b/rover/source/docs/wind-vane-absolute-encoder.rst new file mode 100644 index 0000000000..51a413e7e2 --- /dev/null +++ b/rover/source/docs/wind-vane-absolute-encoder.rst @@ -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 ` documentation. + +To select the absolute encoder as the win-dvane direction source, set :ref:`WNDVN_TYPE ` = 4. Then, select the absolute +encoder instance via the :ref:`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 `__. This example +uses an AS5048B breakout board and diametrically polarized magnet available `here `__. diff --git a/rover/source/docs/wind-vane.rst b/rover/source/docs/wind-vane.rst index 2d73debef1..3744f03409 100644 --- a/rover/source/docs/wind-vane.rst +++ b/rover/source/docs/wind-vane.rst @@ -27,7 +27,7 @@ to a alternative sensor. Note that any change to the _TYPE parameters will requi Wind Direction ---------------------- -Wind direction can be directly sensed through the use of an analogue voltage input. However it is also possible to use a fixed wind direction, +Wind direction can be directly sensed through the use of a directional sensor. However it is also possible to use a fixed wind direction, this is not recommended for long term use, but will allow testing of sailboats without the need for specialist sensors. The wind vane type can be selected with :ref:`WNDVN_TYPE `. The wind direction is filtered using a low pass filter, the frequency of this filter can be set using :ref:`WNDVN_DIR_FILT `. If the wind direction is oscillating this frequency can be reduced. This will reduce the effect @@ -42,6 +42,8 @@ the vehicle will have no new information about wind direction. Analogue Wind Vane Home Heading + Absolute Encoder Wind Vane + NMEA Wind Speed @@ -59,4 +61,4 @@ speed is filtered using a low pass filter, the frequency of this filter can be s RPM Modern Devices rev-p Connecting Bluetooth Windvane to ArduPilot - + NMEA