Commit 5d442aa2 authored by Hermann Mayer's avatar Hermann Mayer
Browse files

[Config][Docs] Added motion_sensor_locktime and actor_command config... 

[Config][Docs] Added motion_sensor_locktime and actor_command config parameters. Added a Makefile to the man page directory. (See #6)
parent ba0a71dd

.editorconfig

+1 −1
Original line number Diff line number Diff line
@@ -14,6 +14,6 @@ trim_trailing_whitespace = true 
indent_style = space

indent_size = 2



[Makefile,Makefile.shared]

[Makefile]

trim_trailing_whitespace = true

indent_style = tab

Makefile

+5 −0
Original line number Diff line number Diff line
@@ -3,6 +3,9 @@ include Makefile.shared 
BINS = $(patsubst src/test/%.c,%,$(wildcard src/test/*.c))

TEST_BINS = $(BINS:%=test-%)



MAN_PAGES = $(patsubst docs/man/%,%,$(wildcard docs/man/*.[0-9]))

DOCS = $(MAN_PAGES:%=docs-%)



build:

	$(MAKE) build -C src/

clean:
@@ -11,6 +14,8 @@ test: 
	$(MAKE) test -C src/test/

$(TEST_BINS):

	$(MAKE) $@ -C src/test/

$(DOCS):

	$(MAKE) $@ -C docs/man/

all: build



.PHONY: all clean test

Makefile.shared

+2 −1
Original line number Diff line number Diff line
@@ -3,7 +3,8 @@ export PRINTF := printf 
export RM := rm

export FIND := find

export GCC := gcc

export MAN := man

XML_CONF := xml2-config



export CFLAGS = $(shell $(XML_CONF) --cflags) -Wall -Werror -g

export INCLUDES = $(shell $(XML_CONF) --libs) -lcurl -lcrypto -lconfig
 
export INCLUDES = $(shell $(XML_CONF) --libs) -lcurl -lcrypto -lconfig -lbcm2835

docs/man/Makefile

0 → 100644
+8 −0
Original line number Diff line number Diff line 
PAGE_FILES = $(wildcard *.[0-9])

PAGES = $(PAGE_FILES:%=docs-%)



$(PAGES): PAGE = $(@:docs-%=%)

$(PAGES): docs-%:%

	$(MAN) ./$(PAGE)



.PHONY: $(PAGES)d

docs/man/avm-motion-trigger.conf.5

+39 −8
Original line number Diff line number Diff line
@@ -59,10 +59,26 @@ This value is a" 
    This parameter will specify be the default actor for

.BR "avmctl".



.B "actor_command"



    The specified command will be send to the actor in case a motion

    was detected. Available commands are:

.RI "`" "on" "`, `" "off" "`, `" "toggle" "`."

    Defaults to

.RI "`" "on" "`."

This parameter is

.I ignored by

.BR "avmctl".

    This value is a

.IR "string".



.B "turn_device_off_after"



    Turn off the device after n seconds (eg. 10 minutes).

    0 will disable automatic turn off.  This parameter is

    Specifying

.IR "0" " will disable automatic turn off. Defaults to "

.IR "0".

    This parameter is

.I ignored by

.BR "avmctl".

This value is a
@@ -74,7 +90,21 @@ This value is a" 


    The daemon takes care of a PIR motion trigger if the value of the light is

    below the specified threshold. 0 will disable the light sensor check.

    With a 10-bit ADC (eg. MCP3008) the range is 0-1023.  This parameter is

    With a 10-bit ADC (eg. MCP3008) the range is 0-1023.

    This parameter is

.I ignored by

.BR "avmctl".

This value is a

.IR "integer".



.B "motion_sensor_locktime"



    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

.IR "30" " seconds."

    This parameter is

.I ignored by

.BR "avmctl".

This value is a
@@ -85,7 +115,8 @@ This value is a" 
.B "motion_sensor_gpio"



    Specify a GPIO pin for the PIR motion sensor. The daemon assumes a state

    change from LOW to HIGH represents a recognized motion. This parameter is

    change from LOW to HIGH represents a recognized motion.

    This parameter is

.I ignored by

.BR "avmctl".

This value is a