From 74937326d313ae741c42207035ebcf8c09aa9e01 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Fri, 9 Jul 2021 22:04:10 -0400 Subject: sensor_angle: Add support for bulk querying of spi angle sensors Signed-off-by: Kevin O'Connor --- docs/Config_Reference.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'docs/Config_Reference.md') diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index a0eecf01..0add9aed 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -4001,6 +4001,33 @@ serial: # Auto cancel print when ping varation is above this threshold ``` +### [angle] + +Magnetic hall angle sensor support for reading stepper motor angle +shaft measurements using a1333, as5047d, or tle5012b SPI chips. The +measurements are available via the [API Server](API_Server.md) and +[motion analysis tool](Debugging.md#motion-analysis-and-data-logging). + +``` +[angle my_angle_sensor] +sensor_type: +# The type of the magnetic hall sensor chip. Available choices are +# "a1333", "as5047d", and "tle5012b". This parameter must be +# specified. +#sample_period: 0.000400 +# The query period (in seconds) to use during measurements. The +# default is 0.000400 (which is 2500 samples per second). +cs_pin: +# The SPI enable pin for the sensor. This parameter must be provided. +#spi_speed: +#spi_bus: +#spi_software_sclk_pin: +#spi_software_mosi_pin: +#spi_software_miso_pin: +# See the "common SPI settings" section for a description of the +# above parameters. +``` + ## Common bus parameters ### Common SPI settings -- cgit v1.2.3-70-g09d2