https://github.com/ki-labs/beerbot

A never-ending supply of cold beer at KI labs to maintain employee happiness
https://github.com/ki-labs/beerbot

beer bot python raspberry-pi-3 slack

Last synced: about 4 hours ago
JSON representation

A never-ending supply of cold beer at KI labs to maintain employee happiness

• Host: GitHub
• URL: https://github.com/ki-labs/beerbot
• Owner: KI-labs
• License: mit
• Created: 2019-04-04T13:11:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T05:20:18.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T23:05:51.134Z (over 1 year ago)
• Topics: beer, bot, python, raspberry-pi-3, slack
• Language: Python
• Homepage: https://www.ki-labs.com/
• Size: 547 KB
• Stars: 30
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BeerBot

[![GitHub license](https://img.shields.io/badge/license-mit-green.svg)](https://github.com/KI-labs/BeerBot/master/LICENSE)

This repository is the central location for all things related to the beloved **BeerBot**.

Tread _carefully_ since this is an extremely important project within [KI labs](https://ki-labs.com/).

![alt text](assets/logo.png "BeerBot")

# Features

BeerBot is a slackbot capable of the following:

- checking beer (or bottled beverages) in the fridge

- identify and analyze whether bottled beverages are *cold*

- automatically alert when beer is running low

# Processing Pipeline

![alt text](assets/BeerBot.png "Pipeline")

# Installation 

BeerBot can be installed by cloning this repo and its python requirements.

```bash

$ pip3 install -r requirements.txt

```

# Configuration

Minimal configuration with a `.envrc` file based on `.envrc.template` is required in order to link with Slack.

- build a [slackbot](https://api.slack.com/bot-users)

```text

SLACK_OAUTH_TOKEN=

SLACK_BOT_OAUTH_TOKEN=

CHANNEL=

LISTEN_DELAY=1

ALERT_DELAY=10

MIN_BEER_THRESHOLD=5

DATA_DIR="/home/pi/BeerBot/data"

TZ="Europe/Berlin"

```

# Deployment

There are three scripts for running the BeerBot engine.

- `./beerbot.py`

  - engine for checking door state and image processing

- `./slackbot_alert.py`

  - responsible for alerting when beer supply is critically low

- `./slackbot_listener.py`

  - responsible for listening to when users want beer supply or coldness information

These processes are deployed with supervisor in `./supervisor/*.conf`, see [this](http://supervisord.org/installing.html) for installation and setup.