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

[P110] Move P133 VL53L0X from PluginPlayground to main repository #3493

Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
20b4153
[P110] Move P133 VL53L0X from PluginPlayground to main repository
tonhuisman Feb 6, 2021
8a8685e
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Feb 14, 2021
a1e2b2f
[P110] Add to Custom-sample.h
tonhuisman Feb 14, 2021
c13a68e
Merge branch 'feature/P110_VL53L0X_move_from_pluginplayground' of htt…
tonhuisman Feb 14, 2021
626ffd6
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Feb 17, 2021
4d0ee66
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 7, 2021
e4d7fb5
[P110] Add extra logging with model-id on init-errors
tonhuisman Mar 8, 2021
8f92fdd
Merge branch 'feature/P110_VL53L0X_move_from_pluginplayground' of htt…
tonhuisman Mar 8, 2021
3e7bf23
[P110] Add experimental support for VL53L1X
tonhuisman Mar 8, 2021
1697f53
[P110] Improve code readability
tonhuisman Mar 9, 2021
dea74df
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 14, 2021
3577bfc
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 27, 2021
7e9960b
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 27, 2021
4e3e30a
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 27, 2021
3e52da8
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Mar 31, 2021
fecc257
[P110] Removed check for unsupported VL53L1X, added range to plugin d…
tonhuisman Apr 5, 2021
f437a7b
Merge branch 'mega' into feature/P110_VL53L0X_move_from_pluginplayground
tonhuisman Apr 5, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/Hardware/Hardware.rst
@@ -1,3 +1,5 @@
.. _Hardware_page:

Hardware page
*************

Expand Down
88 changes: 88 additions & 0 deletions docs/source/Plugin/P110.rst
@@ -0,0 +1,88 @@
.. include:: ../Plugin/_plugin_substitutions_p11x.repl
.. _P110_page:

|P110_typename|
==================================================

|P110_shortinfo|

Plugin details
--------------

Type: |P110_type|

Name: |P110_name|

Status: |P110_status|

GitHub: |P110_github|_

Maintainer: |P110_maintainer|

Used libraries: |P110_usedlibraries|

Description
-----------

This I2C sensor with 2 ranges offers distance measurement based on a Laser Time-of-Flight sensor. Output result is in millimeters.

Configuration
--------------

.. image:: P110_DeviceConfiguration.png

**Name** A unique name should be entered here.

**Enabled** The device can be disabled or enabled. When not enabled the device should not use any resources.

I2C Options
^^^^^^^^^^^^

The available settings here depend on the build used. At least the **Force Slow I2C speed** option is available, but selections for the I2C Multiplexer can also be shown. For details see the :ref:`Hardware_page`

**I2C Address**: The address the device is using. Some boards holding this chip offer an extra connection SDO that can be used to select the address, other boards just allow to select the secondary address and keep that active until the next power-cycle of the sensor.

Device Settings
^^^^^^^^^^^^^^^^

**Timing**: The timing setting of the sensor determines the accuracy of the measurement. There are 3 options available:

.. image:: P110_TimingOptions.png

*Normal* The default value (80 msec.)

*Fast* A faster but less accurate measurement (20 msec.) Can be used with a high speed read interval (1-5 sec).

*Accurate* A slower but far more accurate measurement (320 msec.) For use with a longer read interval setting (30-60 sec).

**Range**: the measuring ranges:

.. image:: P110_RangeOptions.png

*Normal* For measurements in the 0 to 800 millimeter range.

*Long* For measurements in the 0 to 2000 millimeter range (but somewhat less accurate).

The Data Acquisition, Send to Controller and Interval settings are standard available configuration items. Send to Controller only when one or more Controllers are configured.

Values
^^^^^^

There is only 1 value available for this sensor, with the default name ``Distance``. A formula can be set to recalculate, f.e. to centimeters using ``%value%/10``. The number of decimals is by default set to 2, but for use with millimeters distance it can be set to 0, as no decimals are provided from the measurement.

.. Events
.. ~~~~~~

.. .. include:: P110_events.repl



Change log
----------

.. versionchanged:: 2.0
...

|added| 2021-02-06 Moved to main repository Plugin 110 from PluginPlayground Plugin 133

|added| 2021-02-06 Refactoring to allow multiple instances of the plugin (when using an I2C multiplexer)
Binary file added docs/source/Plugin/P110_DeviceConfiguration.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P110_RangeOptions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/Plugin/P110_TimingOptions.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/source/Plugin/_Plugin.rst
Expand Up @@ -130,6 +130,7 @@ There's three different released versions of ESP Easy:
":ref:`P106_page`","|P106_status|","P106"
":ref:`P107_page`","|P107_status|","P107"
":ref:`P108_page`","|P108_status|","P108"
":ref:`P110_page`","|P110_status|","P110"


Internal GPIO handling
Expand All @@ -154,6 +155,11 @@ Display

Plugins: |Plugin_Display|

Distance
--------

Plugins: |Plugin_Distance|

Dust
----

Expand Down
1 change: 1 addition & 0 deletions docs/source/Plugin/_plugin_categories.repl
@@ -1,6 +1,7 @@
.. |Plugin_Analog_input| replace:: :ref:`P002_page`, :ref:`P007_page`, :ref:`P025_page`, :ref:`P060_page`, :ref:`P097_page`
.. |Plugin_Communication| replace:: :ref:`P016_page`, :ref:`P020_page`, :ref:`P035_page`, :ref:`P044_page`, :ref:`P054_page`, :ref:`P071_page`, :ref:`P087_page`, :ref:`P089_page`, :ref:`P094_page`, :ref:`P101_page`
.. |Plugin_Display| replace:: :ref:`P012_page`, :ref:`P023_page`, :ref:`P036_page`, :ref:`P057_page`, :ref:`P073_page`, :ref:`P075_page`, :ref:`P095_page`
.. |Plugin_Distance| replace:: :ref:`P110_page`
.. |Plugin_Dust| replace:: :ref:`P018_page`, :ref:`P053_page`, :ref:`P056_page`
.. |Plugin_Energy_AC| replace:: :ref:`P076_page`, :ref:`P077_page`, :ref:`P078_page`, :ref:`P102_page`, :ref:`P108_page`
.. |Plugin_Energy_DC| replace:: :ref:`P027_page`, :ref:`P085_page`
Expand Down
1 change: 1 addition & 0 deletions docs/source/Plugin/_plugin_substitutions.repl
Expand Up @@ -9,3 +9,4 @@
.. include:: ../Plugin/_plugin_substitutions_p08x.repl
.. include:: ../Plugin/_plugin_substitutions_p09x.repl
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. include:: ../Plugin/_plugin_substitutions_p11x.repl
13 changes: 13 additions & 0 deletions docs/source/Plugin/_plugin_substitutions_p11x.repl
@@ -0,0 +1,13 @@
.. |P110_name| replace:: :cyan:`VL53L0X`
.. |P110_type| replace:: :cyan:`Distance`
.. |P110_typename| replace:: :cyan:`Distance - VL53L0X`
.. |P110_porttype| replace:: `.`
.. |P110_status| replace:: :yellow:`TESTING`
.. |P110_github| replace:: P110_VL53L0X.ino
.. _P110_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P110_VL53L0X.ino
.. |P110_usedby| replace:: `.`
.. |P110_shortinfo| replace:: `Time-of-Flight Distance sensor`
.. |P110_maintainer| replace:: `TD-er, clumsy-stefan, tonhuisman`
.. |P110_compileinfo| replace:: `.`
.. |P110_usedlibraries| replace:: `https://github.com/pololu/vl53l0x-arduino (local copy)`