acassis commented on code in PR #15782: URL: https://github.com/apache/nuttx/pull/15782#discussion_r1946666316
########## Documentation/applications/sensors/accel_calib.rst: ########## @@ -0,0 +1,50 @@ +=========================== +``accel_calib`` Application +=========================== + +This application is intended for streaming delimited accelerometer data to the +console for consumption by the user's host machine. This allows the use of +calibration tools like `Magneto +<https://sites.google.com/view/sailboatinstruments1/a-download-magneto-v1-2?authuser=0>`_ +and `FreeIMU +<https://varesano.net/freeimu-magnetometer-and-accelerometer-calibration-gui-alpha-version-out/>`_ +for NuttX boards that have on-board accelerometers. + +This application works for any accelerometer that implements the :doc:`uorb +</components/drivers/special/sensors/sensors_uorb>` interface. + +Usage +===== + +Call the program with the name of the uORB accelerometer topic you wish to +calibrate, and you'll see the output start streaming to the console. + +Note that measurements are listed in XYZ order. + +.. code-block:: console + + nsh> accel_calib sensor_accel0 + Sampling frequency is 50Hz + 0.013160 -0.253640 9.955389 + 0.015553 -0.245266 9.961371 + 0.027517 -0.253640 9.984103 + ... + +While the application is running, you can read the stream or record it using +your host based serial monitor. + +Configuration Options +===================== + +``CONFIG_ACCEL_CALIB_SAMPLING_FREQ`` +------------------------------------ + +This option allows you to select a sampling frequency for the accelerometer in +Hz. By default it is 50Hz. + +``CONFIG_ACCEL_CALIB_DELIM`` +------------------------------------ + +This option allows you to select the delimeter to be used between measurements. +By default this is a tab, but you can select something like a comma for CSV +style records. Review Comment: @linguini1 suggestion: As an extra bonus, please include this trick to show how to send data from NuttX to a computer to visualize the accelerometer data: https://acassis.wordpress.com/2021/03/04/using-fifo-on-nuttx-to-send-data-from-your-board-to-computer/ Few people know it is possible and this is a really cool way to test sensors sending data from a NuttX board to the computer -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
