.. highlight:: java

BME280 Humidity
===============

The `Bme280Humidity <https://mbientlab.com/docs/metawear/android/2/com/mbientlab/metawear/module/Bme280Humidity.html>`_ class controls the humidity sensor on MetaEnvironment boards.

Humidity Sampling
-----------------

Calling `readHumidity <https://mbientlab.com/docs/metawear/android/2/com/mbientlab/metawear/module/Bme280Humidity.html#readHumidity(boolean)>`_ will return a float value representing the humidity percentage between 0 and 100.  You can use the :doc:`timer` module to schedule periodic readings of the humidity percentage.  The humidity sensor also supports oversampling, which is configured by calling `setOversampling <https://mbientlab.com/docs/metawear/android/2/com/mbientlab/metawear/module/Bme280Humidity.html#setOversampling(com.mbientlab.metawear.module.Bme280Humidity.OversamplingMode)>`_.

::

    import com.mbientlab.metawear.module.Bme280Humidity;
    
    final Bme280Humidity humidityModule= mwBoard.getModule(Bme280Humidity.class);
    humidityModule.routeData().fromSensor(false).stream("humidity").commit()
        .onComplete(new CompletionHandler<RouteManager>() {
            @Override
            public void success(RouteManager result) {
                result.subscribe("humidity", new RouteManager.MessageHandler() {
                    @Override
                    public void process(Message msg) {
                        Log.i("MainActivity", "Humidity percent: " + msg.getData(Float.class));
                    }
                });
                humidityModule.readHumidity(false);
            }
        });