Commit c8d015aa authored by Hermann Mayer's avatar Hermann Mayer

[Dist][Docs] Fixed a markup glitch on a man page. Updated the dist configuration. (See #15)

parent e0bd56b4
......@@ -7,9 +7,12 @@
# The hostname/ip[:port] of the fritzbox without protocol scheme or URI paths,
# by default "fritz.box"
# hostname = "";
#
# The username of the fritzbox which is able to perform smart home management
# According to the documentation from AVM this setting can be empty, by default empty
# According to the documentation from AVM this setting can be empty, by default
# empty
# username = "";
#
# The plaintext password of the fritzbox, by default 0000
# password = "";
......@@ -18,9 +21,11 @@
#
# The Actor Identification Number of the AVM Smart Switch to control
ain = "FF:FF:FF:FF:FF:FF";
#
# Turn off the device after n seconds
# 0 will disable automatic turn off, defaults to 0
turn_device_off_after = 600;
#
# The specified command will be send to the actor in case a motion
# was detected. Available commands are: `on`, `off`, `toggle`.
# Defaults to `on`.
......@@ -34,22 +39,37 @@ turn_device_off_after = 600;
# light is below the specified threshold
# 0 will disable the light sensor check
# light_sensor_thold = 500;
#
# If you set the turn_device_off_after parameter to 0 you probably want
# to build a toggle-by-motion setup. In this case it is advisable to specify
# a time range which prevent jitter triggering. So no action is performed
# for n seconds after a motion was detected. Defaults to 30 seconds.
# motion_sensor_locktime = 0;
#
# With this parameter you are able to enforce a sleeping interval (in seconds) if
# the current ambient light level is greater than the configured threshold.
# Defaults to 30 seconds.
# too_bright_timeout = 30;
#
# With this parameter you can control the time window between the first and the
# backup request (in seconds). 0 will disable this timeout. Defaults to 1 second.
# backup_action_timeout = 1;
#
# If even the backup request fails then we can't do much more about it. With this
# parameter you can put the daemon to sleep for a specified interval (in seconds).
# 0 will disable this timeout. Defaults to 30 seconds.
# failed_backup_action_timeout = 30;
#
# With this configuration parameter you can specify in which state the configured
# actor should be when the daemon is going to send an action to it. This parameter
# accepts the following values:
# "on", "off", and "unkown". Defaults to "unknown".
# desired_actor_state = "off";
#
# With this parameter you can set a timeout (in seconds) if the desired actor
# state check is configured and the states differs. 0 will disable this timeout.
# Defaults to 30 seconds.
# desired_actor_state_missmatch_timeout = 30;
#
# Sensor ports
......@@ -57,9 +77,11 @@ turn_device_off_after = 600;
# Specify a GPIO pin for the PIR motion sensor
# The daemon assumes a state change from LOW to HIGH represents a recognized motion
motion_sensor_gpio = 17;
#
# The daemon assumes to read the light level from a MCP3008 which is connected
# to the SPI bus. With this setting you can choose the Linux kernel SPI device
# the daemon should use. Defaults to "/dev/spidev0.0".
# light_sensor_device = "/dev/spidev0.0";
#
# With this setting you can configure which channel of the chip will be read out.
# light_sensor_channel = 0;
......@@ -193,7 +193,7 @@ current state of the actor will be queried if a motion was detected and the
light sensor check passed (if configured). If the desired actor state differs
from the current actor state, the action will be canceled. This parameter
accepts the following values:
.IR "on", "off", and "unkown". Defaults to
.IR "on" ", " "off" ", and " "unkown" ". Defaults to"
.IR "unknown".
This parameter is
.I ignored by
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment