dieKlingel Kiosk

This repository contains a kiosk application for the dieKlinge project. The kiosk is a simple user interface, for the front of your doorbell. It has some basic possibilities to customize the user interface. As soon as someone rings the bell or enters a passcode to unlock the door, the kiosk will emit an event/action-trigger using the dieKlingel mqtt api.

Getting Started

Install the latest build from snapcraft

sudo snap install dieklingel-kiosk

Configure the kiosk:

sudo snap set dieklingel-kiosk <key>=<value>

Key	Value	Example
clip	{LEFT},{TOP},{RIGHT},{BOTTOM}	10,6,35,16
timeout	Seconds	30
mqtt.uri	Url	mqtt://server.dieklingel.com/dieklingel/name/main/
mqtt.username	String	user1
mqtt.password	String	password1

Run the kiosk

sudo snap install ubuntu-frame
sudo snap set ubuntu-frame daemon=true

sudo snap set dieklingel-kiosk daemon=true

Signs

Add your signs in format of .rfwtxt. Signs are parsed from the directrory /var/snap/dieklingel-kiosk/current in alphabetical order. All files with extension .rfwtxt are parsed. A file should be in rfw format, see rfw package and the example in conf/00_sign.rfwtxt.

Events

If someone rings the bell the kiosk will emit an action-trigger to $DIEKLINGEL_MQTT_URI/actions/execute within the following payload:

{
  "pattern": "ring",
  "environment": {
    "SIGN": "<custom, set in <sign>.rfwtxt>"
  }
}

and when the passcode is enterd an action-trigger to $DIEKLINGEL_MQTT_URI/actions/execute is send, with the following payload:

{
  "pattern": "unlock",
  "environment": {
    "PASSCODE": "<the passcode>"
  }
}