Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 1.85 KB

README.md

File metadata and controls

42 lines (32 loc) · 1.85 KB

MQTT Alarm Panel using Kivy

MQTT Alarm Panel is a UI built using Kivy for the Raspberry Pi. While the application can be modified to suit any kivy-capable hardware, its main purpose is to avoid using X and therefore save on limited Raspberry Pi resources.

Features

  1. Runs on Kivy/Python - No need to boot to Raspberry Pi desktop!
  2. Control of Manual MQTT Alarm in Home Assistant thanks to paho-mqtt
  3. GPIO control for a Piezo Buzzer thanks to RPi.GPIO
  4. Screen dimmer for night mode thanks to rpi_backlight
  5. Settings menu (Alarm Code + * to open)

Usage

After you have cloned the repo, edit settings.yaml and change details as required, then run sudo python main.py

Steps:

  1. cd ~
  2. git clone https://github.com/JediDork/MQTTAlarmPanel
  3. cd MQTTAlarmPanel
  4. sudo nano settings.yaml
  5. sudo python main.py

Some modules may need to be installed prior. Ensure you have the following before you run the application:

  • sudo pip install RPi.GPIO
  • sudo pip install rpi_backlight
  • sudo pip install paho-mqtt
  • sudo pip install pyyaml

Obviously Kivy and Python need to be installed too - see https://kivy.org/docs/installation/installation-rpi.html

The settings menu can be reached by typing your alarm code + * on the interface.

On Screen Keyboard: The easiest way to do this is to run the keyboard kivy example. Depending on how you installed kivy, the examples will be in your home directory or under cd /usr/local/share/kivy-examples/. This works for me:

  1. sudo python /usr/local/share/kivy-examples/keyboard/main.py
  2. Change the Current Keyboard Setting to "systemanddock", hit Set, then exit and reboot your pi
  3. Now when you tap on a textbox it should show the system keyboard!

Screenshots

alt text alt text

Currently in Development

  • Bug fix: Check for network connection prior to attempting connection to MQTT service