feux07 / bme280ctl

BME280ctl is a self-hosted Telegram bot on Raspberry Pi that is used to retrieve temperature, humidity, and pressure data from the BME280 sensor.

BME280ctl

BME280ctl is a self-hosted Telegram bot on Raspberry Pi that is used to retrieve temperature, humidity, and pressure data from the BME280 sensor.
Report Bug · Request Feature

Table of Contents

• Table of Contents
• Getting Started
  • Prerequisites
  • Wiring with I2C
  • Installation
• Usage
• Resources
• License
• Contact

Getting Started

Prerequisites

• Raspberry Pi
• BME280 Sensor
• NodeJS version >= 12.18.2
• Telegram Bot with API Token
• Docker version >= 19.03 (optional)

Wiring with I2C

• RPI 3V3 to sensor VIN
• RPI 3V3 to sensor CS
• RPI GND to sensor GND
• RPI SCL to sensor SCK
• RPI SDA to sensor SDI

Installation

1. Clone the repo

git clone https://github.com/feux07/bme280ctl.git

2. Go to project directory

cd bme280ctl

3. Install NPM packages

npm install

Usage

1. Create .env file with following environment variables

TELEGRAM_BOT_TOKEN = YOUR_TELEGRAM_BOT_TOKEN
TELEGRAM_TARGET_CHAT_ID = YOUR_TELEGRAM_TARGET_CHAT_ID
TELEGRAM_ADMIN_USER=YOUR_TELEGRAM_ADMIN_USERNAME
READ_SENSOR_CRON_EXP="* * * * *"
SCHEDULED_NOTIFICATION_CRON_EXP="0 7 * * *"

2. Start application with following command

node start.js

• Or start with Docker Compose

docker-compose up -d

Resources

• Adafruit BME280 Humidity + Barometric Pressure + Temperature Sensor Breakout

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Website