diff --git a/components/sensor/bmi160.rst b/components/sensor/bmi160.rst new file mode 100644 index 000000000..0b55c6143 --- /dev/null +++ b/components/sensor/bmi160.rst @@ -0,0 +1,84 @@ +BMI160 Accelerometer/Gyroscope Sensor +====================================== + +.. seo:: + :description: Instructions for setting up BMI160 Accelerometer and Gyroscope sensors. + :image: bmi160.jpg + +The ``bmi160`` sensor platform allows you to use your BMI160 Accelerometer/Gyroscope +(`datasheet `__, +`SparkFun`_) sensors with +ESPHome. The :ref:`I²C Bus ` is +required to be set up in your configuration for this sensor to work. + +This component only does some basic filtering and no calibration. Due to the complexity of +this sensor and the amount of possible configuration options, you should probably +create a custom component by copying and modifying the existing code if you want a specific +new feature. Supporting all possible use-cases would be quite hard. + + +.. figure:: images/bmi160-full.jpg + :align: center + :width: 50.0% + + BMI160 Accelerometer/Gyroscope Sensor. + +.. _SparkFun: https://www.sparkfun.com/products/18794 + +.. figure:: images/bmi160-ui.png + :align: center + :width: 80.0% + +.. code-block:: yaml + + # Example configuration entry + sensor: + - platform: bmi160 + address: 0x68 + update_interval: 60s + acceleration_x: + name: "BMI160 Accel X" + acceleration_y: + name: "BMI160 Accel Y" + acceleration_z: + name: "BMI160 Accel z" + gyroscope_x: + name: "BMI160 Gyro X" + gyroscope_y: + name: "BMI160 Gyro Y" + gyroscope_z: + name: "BMI160 Gyro z" + temperature: + name: "BMI160 Temperature" + +Configuration variables: +------------------------ + +- **address** (*Optional*, int): Manually specify the I²C address of the sensor. Defaults to ``0x68``, may also be ``0x69``. +- **acceleration_x** (*Optional*): Use the X-Axis of the Accelerometer. All options from + :ref:`Sensor `. +- **acceleration_y** (*Optional*): Use the Y-Axis of the Accelerometer. All options from + :ref:`Sensor `. +- **acceleration_z** (*Optional*): Use the Z-Axis of the Accelerometer. All options from + :ref:`Sensor `. +- **gyroscope_x** (*Optional*): Use the X-Axis of the Gyroscope. All options from + :ref:`Sensor `. +- **gyroscope_y** (*Optional*): Use the Y-Axis of the Gyroscope. All options from + :ref:`Sensor `. +- **gyroscope_z** (*Optional*): Use the Z-Axis of the Gyroscope. All options from + :ref:`Sensor `. +- **temperature** (*Optional*): Use the internal temperature of the sensor. All options from + :ref:`Sensor `. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the sensor. Defaults to ``60s``. + +- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation. + +See Also +-------- + +- :ref:`sensor-filters` +- :doc:`template` +- :doc:`ultrasonic` +- :apiref:`bmi160/bmi160.h` +- `i2cdevlib `__ by `Jeff Rowberg `__ +- :ghedit:`Edit` diff --git a/components/sensor/images/bmi160-full.jpg b/components/sensor/images/bmi160-full.jpg new file mode 100644 index 000000000..1871abc09 Binary files /dev/null and b/components/sensor/images/bmi160-full.jpg differ diff --git a/components/sensor/images/bmi160-ui.png b/components/sensor/images/bmi160-ui.png new file mode 100644 index 000000000..a523730e3 Binary files /dev/null and b/components/sensor/images/bmi160-ui.png differ diff --git a/images/bmi160.jpg b/images/bmi160.jpg new file mode 100644 index 000000000..750b99630 Binary files /dev/null and b/images/bmi160.jpg differ diff --git a/index.rst b/index.rst index 3776eb038..354322acc 100644 --- a/index.rst +++ b/index.rst @@ -391,10 +391,11 @@ Motion .. imgtable:: APDS9960, components/sensor/apds9960, apds9960.jpg, Colour & Gesture + BMI160, components/sensor/bmi160, bmi160.jpg, Accelerometer & Gyroscope + LD2410, components/sensor/ld2410, ld2410.jpg, Motion & Presence MPU6050, components/sensor/mpu6050, mpu6050.jpg, Accelerometer & Gyroscope MPU6886, components/sensor/mpu6886, mpu6886.jpg, Accelerometer & Gyroscope RuuviTag, components/sensor/ruuvitag, ruuvitag.jpg, Temperature & Humidity & Accelerometer - LD2410, components/sensor/ld2410, ld2410.jpg, Motion & Presence Thermocouple