Import

Author: LucAce

Makefile.inc

@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# install these files
+dist_python_DATA       += bme280/bme280.chart.py
+dist_pythonconfig_DATA += bme280/bme280.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += bme280/README.md bme280/Makefile.inc

README.md

@@ -0,0 +1,62 @@
+<!--
+title: "BME280 sensor monitoring with netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/bme280/README.md
+sidebar_label: "BME280"
+-->
+
+# BME280 sensor monitoring with netdata
+
+Displays a graph of the temperature, humidity, and pressure from a BME280 sensor.
+
+## Requirements
+ - Adafruit Circuit Python BME280 library
+ - Adafruit BME280 I2C Sensor (Product ID: 2652)
+ - Python 3 (Adafruit libraries are not Python 2.x compatible)
+
+
+It produces the following charts:
+1. **Temperature**
+2. **Humidity**
+3. **Pressure**
+
+## Configuration
+
+Allow the `netdata` user to access the I2C interface.
+
+```bash
+sudo usermod -a -G i2c netdata
+```
+
+Edit the `python.d/bme280.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata     # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/bme280.conf
+```
+
+Raspberry Pi Instructions:
+
+Hardware install:
+Connect the BME280 to the Raspberry Pi I2C pins
+
+Raspberry Pi 3B/4 Pins:
+
+- Board 3.3V (pin 1) to sensor VIN (pin 1)
+- Board SDA (pin 3) to sensor SDA (pin 2)
+- Board GND (pin 6) to sensor GND (pin 3)
+- Board SCL (pin 5) to sensor SCL (pin 4)
+
+You may also need to add two I2C pullup resistors if your board does not already have them. The Raspberry Pi
+does have internal pullup resistors but it doesn't hurt to add them anyway. You can use 2.2K - 10K but we will
+just use 10K. The resistors go from VDD to SCL and SDA each.
+
+Software install:
+- `sudo pip3 install adafruit-circuitpython-bme280`
+- `sudo usermod -a -G i2c netdata`
+- edit `/etc/netdata/netdata.conf`
+- find `[plugin:python.d]`
+- add  `command options = -ppython3`
+- save the file.
+- restart the netdata service.
+- check the dashboard.

bme280.chart.py

@@ -0,0 +1,94 @@
+# _*_ coding: utf-8 _*_
+# Description: BME280 netdata module
+# Author: LucAce
+# SPDX-License-Identifier: GPL-3.0-or-Later
+
+try:
+    import board
+    import busio
+    from adafruit_bme280 import basic as adafruit_bme280
+
+    HAS_BME280 = True
+except ImportError:
+    HAS_BME280 = False
+
+from bases.FrameworkServices.SimpleService import SimpleService
+
+# Default module values (can be overridden per job in `config`)
+update_every = 5
+
+# Default precision value
+precision_scaling = 100
+
+ORDER = [
+    'temperature',
+    'humidity',
+    'pressure',
+    'altitude'
+]
+
+CHARTS = {
+    'temperature': {
+        'options': [None, 'Temperature', 'celsius', 'temperature', 'bme280.temperature', 'line'],
+        'lines': [
+            ['temperature', 'temperature', 'absolute', 1, precision_scaling]
+        ]
+    },
+    'humidity': {
+        'options': [None, 'Relative Humidity', 'percent', 'humidity', 'bme280.humidity', 'line'],
+        'lines': [
+            ['humidity', 'humidity', 'absolute', 1, precision_scaling]
+        ]
+    },
+    'pressure': {
+        'options': [None, 'Barometric Pressure', 'hPa', 'pressure', 'bme280.pressure', 'line'],
+        'lines': [
+            ['pressure', 'pressure', 'absolute', 1, precision_scaling]
+        ]
+    },
+    'altitude': {
+        'options': [None, 'Altitude', 'meters', 'altitude', 'bme280.altitude', 'line'],
+        'lines': [
+            ['altitude', 'altitude', 'absolute', 1, precision_scaling]
+        ]
+    }
+}
+
+
+class Service(SimpleService):
+    def __init__(self, configuration=None, name=None):
+        SimpleService.__init__(self, configuration=configuration, name=name)
+        self.order = ORDER
+        self.definitions = CHARTS
+        self.i2c_address = int(self.configuration.get('i2c_address', '0x77'))
+        self.sea_level_pressure = float(self.configuration.get('sea_level_pressure', '1013.25'))
+        self.bme = None
+
+    def check(self):
+        if not HAS_BME280:
+            self.error("Could not find the Adafruit_CircuitPython_BME280 package.")
+            return False
+
+        try:
+            i2c = busio.I2C(board.SCL, board.SDA)
+            self.bme = adafruit_bme280.Adafruit_BME280_I2C(i2c, self.i2c_address)
+            self.bme.sea_level_pressure = self.sea_level_pressure
+
+        except ValueError as error:
+            self.error("Error on creating I2C shared bus: {0}".format(error))
+            return False
+
+        return True
+
+    def get_data(self):
+        try:
+            return {
+                'temperature': int(self.bme.temperature * precision_scaling),
+                'humidity': int(self.bme.relative_humidity * precision_scaling),
+                'pressure': int(self.bme.pressure * precision_scaling),
+                'altitude': int(self.bme.altitude * precision_scaling)
+            }
+
+        except (OSError, RuntimeError) as error:
+            self.error(error)
+            return None

bme280.conf

@@ -0,0 +1,74 @@
+# netdata python.d.plugin configuration for bme280 temperature/humidity/pressure/altitude sensor
+#
+# This file is in YaML format. Generally the format is:
+#
+# name: value
+#
+# There are 2 sections:
+#  - global variables
+#  - one or more JOBS
+#
+# JOBS allow you to collect values from multiple sources.
+# Each source will have its own set of charts.
+#
+# JOB parameters have to be indented (using spaces only, example below).
+
+# ----------------------------------------------------------------------
+# Global Variables
+# These variables set the defaults for all JOBs, however each JOB
+# may define its own, overriding the defaults.
+
+# update_every sets the default data collection frequency.
+# If unset, the python.d.plugin default is used.
+# update_every: 5
+
+# priority controls the order of charts at the netdata dashboard.
+# Lower numbers move the charts towards the top of the page.
+# If unset, the default for python.d.plugin is used.
+# priority: 60000
+
+# penalty indicates whether to apply penalty to update_every in case of failures.
+# Penalty will increase every 5 failed updates in a row. Maximum penalty is 10 minutes.
+# penalty: yes
+
+# autodetection_retry sets the job re-check interval in seconds.
+# The job is not deleted if check fails.
+# Attempts to start the job are made once every autodetection_retry.
+# This feature is disabled by default.
+# autodetection_retry: 0
+
+# ----------------------------------------------------------------------
+# JOBS (data collection sources)
+#
+# The default JOBS share the same *name*. JOBS with the same name
+# are mutually exclusive. Only one of them will be allowed running at
+# any time. This allows autodetection to try several alternatives and
+# pick the one that works.
+#
+# Any number of jobs is supported.
+#
+# All python.d.plugin JOBS (for all its modules) support a set of
+# predefined parameters. These are:
+#
+# job_name:
+#     name: myname            # the JOB's name as it will appear at the
+#                             # dashboard (by default is the job_name)
+#                             # JOBs sharing a name are mutually exclusive
+#     update_every: 1         # the JOB's data collection frequency
+#     priority: 60000         # the JOB's order on the dashboard
+#     penalty: yes            # the JOB's penalty
+#     autodetection_retry: 0  # the JOB's re-check interval in seconds
+#
+# Additionally to the above, example also supports the following:
+#
+# - none
+#
+# ----------------------------------------------------------------------
+# AUTO-DETECTION JOBS
+# only one of them will run (they have the same name)
+#
+# Set a custom I2C Address
+# i2c_address: 0x77
+#
+# Set a custom Sea Level Pressure (hPA)
+# sea_level_pressure: 1013.25