Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for ThunderFly TFRPM01 tachometer sensor #673

Merged
merged 15 commits into from
Mar 5, 2020

Conversation

kaklik
Copy link
Contributor

@kaklik kaklik commented Mar 4, 2020

User documentation of RPM sensor added in following pull-request: PX4/PX4-Autopilot#14018

@kaklik kaklik marked this pull request as ready for review March 4, 2020 23:54
@hamishwillee
Copy link
Collaborator

Two of the images have large file sizes - can you please reduce the size so that there is less download cost for people with poor internet (e.g. across great wall in china). For example, for tfrpm01_electronics.jpg you can cut out all the empty whitespace around the image and resize width to about 500px and it shrinks to 79K without losing any information in rendered version.

@@ -0,0 +1,40 @@
# ThunderFly TFRPM01 tachometer sensor
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document will have to be added to en/SUMMARY.md or it will not render (just follow pattern of other docs).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Document listing added.


![Digital RPM sensor](../../images/tachometer_sensor.jpg)

For more information and recommended hardware see: [Tachometer Sensors](../sensor/rpm.md).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you look at the docs we typically have a parent page explaining what the sensor does, then "instances" below. Can you create a parent page under sensors for tachometers and then link to that (rather than going straight to your implementation).
Note, otherwise what happens is that these is no obvious way for people to extend and add other implementations.
The parent page can have most of the same info you have here and any generic config for tachometers - though it doesn't look like there is any of that (I assume PCF8583_POOL etc are specific to your tachometer?)

@hamishwillee hamishwillee changed the title Documentation of the new rpm sensor Docs for ThunderFly TFRPM01 tachometer sensor Mar 5, 2020
@hamishwillee hamishwillee merged commit c258145 into PX4:master Mar 5, 2020
@hamishwillee hamishwillee mentioned this pull request Mar 5, 2020
@hamishwillee
Copy link
Collaborator

Thanks @kaklik . I have merged this so I can update it further (see #676)

I still have some questions:

  1. You say "The sensor/probe hardware needs an pulse signal." - is there any definition of this signal? ie. voltage, max/min frequency etc? E.g. if someone wants to use a probe how can they check it is compatible?
  2. What diagnostics does the LED provide? ie. just "on/off" or something else? Good to add that information.
  3. Is there a purchase link we can add to "5100 Miniature Flange Mounting Proximity Sensor"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants