alarmdisplay-sample.conf

;-----------------------------------------------------------------------------
;
; vim: syntax=dosini
;
; Alarmdisplay sample configuration file
;
; Copyright (C) 2018 Florian Pose
;
; This file is part of Alarm Display.
;
; Alarm Display is free software: you can redistribute it and/or modify
; it under the terms of the GNU General Public License as published by
; the Free Software Foundation, either version 3 of the License, or
; (at your option) any later version.
;
; Alarm Display is distributed in the hope that it will be useful, but WITHOUT
; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
; more details.
;
; You should have received a copy of the GNU General Public License along with
; Alarm Display. If not, see <http://www.gnu.org/licenses/>.
;
;-----------------------------------------------------------------------------

[display]

;
; Title displayed in idle mode
; Default: Alarmdisplay
;
;title = Alarmdisplay

;
; Image search path
; Used by home_marker, destination_marker and logo.
; Default: images (relative to current directory)
;
;image_dir = images

;
; Logo to display
; Specify a path relative to image_dir.
; Default: empty (no logo)
;
;logo =

;
; Hide city display, if it matches this one
; Default: empty (always display city)
;
;home_town =

;
; Idle timeout [minutes]
; After an alarm, the screen goes back to idle display.
; Default: 30
;
;idle_timeout = 30

;
; Screen switch-off timeout [minutes]
; Default: 0 (never switch off)
;
;screen_timeout = 0

;
; Log path
; Default: /var/log/alarmdisplay.log
;
;log_path = /var/log/alarmdisplay.log

;-----------------------------------------------------------------------------

[sound]

;
; Alarm sound
; Default: None
;
;alarm =

;
; Sound delay [s]
; Default: 20
;
;delay = 20

;
; Text-to-speech delay [s]
; Default: 30
;
;tts_delay = 30

;
; Text-to-speech repetitions
; Default: 10
;
;tts_repetitions = 10

;
; Text-to-speech pad file
; Will be prepended and appended to the generated TTS file before playing
; Default: (none)
;
;tts_pad_file =

;
; Status sound
; Default: None
;
;status =

;-----------------------------------------------------------------------------

[maps]

;
; Directory with map tiles
; Default: tiles
;
;tiles_dir = tiles

;
; Marker for the home / start point of the route
; Specify a path relative to image_dir.
; The marker will be aligned at the center of the bottom line.
; Default: marker_home.png
;
;home_marker = marker_home.png

;
; Marker for the destination / end point of the route
; Specify a path relative to image_dir.
; The marker will be aligned at the center of the bottom line.
; Default: marker_dest.png
;
;destination_marker = marker_dest.png

;
; Color of the route line
; For accepted formats see http://doc.qt.io/qt-5/qcolor.html#setNamedColor
; Default: #400000c0
;
;route_color = #400000c0

;-----------------------------------------------------------------------------

[destination_map]

;
; Fixed zoom level for the destination map
; Larger values will show more details.
; see http://wiki.openstreetmap.org/wiki/Zoom_levels
; Default: 17
;
;zoom = 17

;
; Width of the route line [px]
; Default: 7
;
;route_width = 7

;-----------------------------------------------------------------------------

[route_map]

;
; Width of the route line [px]
; Default: 10
;
;route_width = 10

;-----------------------------------------------------------------------------

[route]

;
; Routing start point [deg]
; Default: empty (no route display)
;
;home_longitude =
;home_latitude =

;
; Maximum route map zoom level
; Default: 17
;
;max_zoom = 17

;
; OpenRouteService API Key
; see https://go.openrouteservice.org/documentation
; Default: empty (no route query)
;
;ors_api_key =

;-----------------------------------------------------------------------------

[report]

;
; Template path
; Default: 'report' in current directory
;
;template_dir = report

;
; Output path
; Default is current directory.
;
;output_dir = .

;
; Logo image (without file extension)
; Default: empty (no logo)
;
;logo =

;
; Print alarm report
; Default: False
;
;print = False

;
; Printer (default printer if empty)
;
;printer =

;
; Print options
; each passed with '-o' switch to 'lpr' command.
; Default: empty
;
;print_options =

;
; Number of copies to print
; Default is 1.
;
;copies = 1

;
; Wakeup document
; printed before alarm processing to wakeup sleeping printer
; Default: empty (no wakeup document)
;
;wakeup_document =

;
; Report timeout [s]
; Generate report at latest after this time, if not all alarm sources were
; received. Default is 60.
;
;timeout = 60

;-----------------------------------------------------------------------------

[pager]

;
; Serial port to connect to.
; Set empty to disable pager.
; Default: /dev/ttyUSB0
;
;device = /dev/ttyUSB0

;
; Do not use pager timestamp, but use host clock instead
; Default: False
;
;use_host_clock = False

;
; Time zone of timestamps in pager alarms
; Default: Europe/Berlin
;
;time_zone = Europe/Berlin

;-----------------------------------------------------------------------------

[email]

;
; Time zone of timestamps in eMail alarms
; Default: Europe/Berlin
;
;time_zone = Europe/Berlin

;
; IMAP4 host (SSL)
; Default: empty (no IMAP access)
;
;imap_host =

;
; IMAP4 user name
; Default: empty (no IMAP access)
;
;imap_user =

;
; IMAP4 password
; Default: empty (no IMAP access)
;
;imap_pass =

;
; Path to IMAP4 credentials file
; File must contain two lines, interpreted as username and password.
; If both imap_user/imap_pass and imap_cred are specified, explicit
; imap_user/imap_pass override imap_cred.
; Default: empty (no credentials file)
;
;imap_cred =

;-----------------------------------------------------------------------------

[websocket]

;
; Websocket URL
; Default: empty (no websocket connection)
;
;url =

;
; User for websocket authentication
; Default: (Hostname)
;
;user =

;
; Websocket authentication token
; Default: empty (no authentication)
;
;auth_token =

;-----------------------------------------------------------------------------

[status]

;
; Status display address
; Default: none
;
;address0 = FW KLV05 LF10 1

;
; Status display name
; Applies for the adress with the same number.
; Default: (address, see above)
;
;name0 = 5-LF10-1

;
; Status display image
; Applies for the adress with the same number.
; Default: none
;
;image0 =

;-----------------------------------------------------------------------------

[db]

;
; Path to store alarms
; Default: empty (do not store alarms)
;
;path =

;-----------------------------------------------------------------------------

[forward]

;
; Host name or adress to forward alarms to
; Multiple hosts can be declared with host1, host2, ...
; Default: empty (do not forward alarms)
;
;host0 =

;-----------------------------------------------------------------------------

[idle]

;
; Time period to cycle though historical alarms
; Default: 10
;
;history_period = 10

;
; Show map with weather warnings
; Default: True
;
;weather = True

;
; Show forest fire warning map
; Default: True
;
;forest = True

;
; Water heights URL
; Example: https://www.elwis.de/DE/dynamisch/gewaesserkunde/wasserstaende/wasserstaendeUebersichtGrafik.png.php?pegelId=9598e4cb-0849-401e-bba0-689234b27644&dfh=0
; Default: empty (no display)
;
;water_url =

;
; CalDAV Calendar URL
; Multiple instances are allowed (calendar0, calendar1, calendar2...)
;
;calendar0 =

;
; ICS Calendar URL
; Multiple instances are allowed (ics0, ics1, ics2...)
;
;ics0 =

;-----------------------------------------------------------------------------

[presence]

;
; Switch screen on at given time
;
; Format: DDD HH:MM
; DDD: Locale-dependent abbreviated day-of-week (Mo, Di, ...)
; HH: Hour (24 hour-format)
; MM: Minute
; Example: Do 19:30
; Default: empty
; Multiple instances are allowed (on0, on1, on2...)
;
;on0 = Do 19:30

;
; Switch screen off at given time
; See above.
;
;off0 = Do 23:30

;-----------------------------------------------------------------------------

[notify]

;
; Server URL to notify on events
;
;url =

;-----------------------------------------------------------------------------

[gpio]

;
; GPIO channel (board numbering) to switch on alarm
; Channel/Pin 11 means GPIO 17
;
;channel = -1

;
; Duration that the output is switched on
;
;on_time = 1

; Delay before the output is switched on [s]
;
;on_delay = 0

;-----------------------------------------------------------------------------