Giter Site home page Giter Site logo

acjacobson / beerbot Goto Github PK

View Code? Open in Web Editor NEW

This project forked from ki-labs/beerbot

0.0 0.0 0.0 558 KB

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

Home Page: https://www.ki-labs.com/

License: MIT License

Python 100.00%

beerbot's Introduction

BeerBot

GitHub 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.

alt text

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

Installation

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

$ pip3 install -r requirements.txt

Configuration

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

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 for installation and setup.

beerbot's People

Contributors

jfri3d avatar nithishr avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.