Implementato supporto a zone non soggette a pioggia (con il parametro EVx_NORAIN)

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.5.1 - 28/10/2017
+- Added events managemets
+- Added support for zones not subject to rainfall (with parameter EVx_NORAIN)
+
 # 0.5.0 - 12/10/2017
 - Implemented driver subsystem for interfacing with other board
 - Added driver spb16ch for interfacing with "Smart Power Board 16 channel with RTC"

conf/piGarden.conf.example

@@ -8,6 +8,9 @@ LOG_OUTPUT_DRV_FILE="/tmp/piGarden.drv.log"
 # Status directory
 STATUS_DIR="/home/pi/piGarden/state"
 
+# Event directory
+EVENT_DIR="/home/pi/piGarden/events"
+
 # Posizione gpio
 GPIO="/usr/local/bin/gpio"
 
@@ -86,6 +89,7 @@ EV_TOTAL=6
 # Definizione delle elettrovalvole
 EV1_ALIAS="1" #
 EV1_GPIO=17   #		Physical 11 - wPi 0
+#EV1_NORAIN=1 # 	Non interrompe l'irrigazione di questa zona in caso di pioggia
 
 EV2_ALIAS="2" #
 EV2_GPIO=27   #		Physical 13 - wPi 2

conf/piGarden.conf.spb16ch.example

@@ -8,6 +8,9 @@ LOG_FILE_MAX_SIZE=1048576 # 1MB
 # Status directory
 STATUS_DIR="/home/pi/piGarden/state"
 
+# Event directory
+EVENT_DIR="/home/pi/piGarden/events"
+
 # Posizione gpio
 GPIO="/usr/local/bin/gpio"
 
@@ -85,6 +88,7 @@ EV_TOTAL=128
 # Definizione delle elettrovalvole
 EV1_ALIAS="Zona_1" #
 EV1_GPIO="drv:spb16ch:1"
+#EV1_NORAIN=1 #         Non interrompe l'irrigazione di questa zona in caso di pioggia
 
 EV2_ALIAS="Zona_2" #
 EV2_GPIO="drv:spb16ch:2"

events/check_rain_online_after/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/check_rain_online_before/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/check_rain_online_change/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/check_rain_sensor_after/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/check_rain_sensor_before/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/check_rain_sensor_change/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/ev_close_after/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/ev_close_before/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/ev_open_after/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/ev_open_before/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/init_after/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/init_before/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

events/scripts/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*custom*
+# Except this file
+!.gitignore

events/scripts/sendmail.sh

@@ -0,0 +1,69 @@
+#!/bin/bash
+#
+# Send mail on triggered event
+#
+# $1 = event
+# $2 = cause
+# $3 = time
+#
+# To send an email with this script you must install and configure ssmtp and mailutils:
+# sudo apt-get install ssmtp mailutils
+#
+# edit the configuration file /etc/ssmtp/ssmtp.conf and insert the below lines:
+#
+# root=postmaster
+# mailhub=smtp.gmail.com:587
+# hostname=guard
+# FromLineOverride=YES
+# AuthUser=your_mail@gmail.com
+# AuthPass=your_password
+# UseSTARTTLS=YES
+#
+
+EVENT="$1"
+
+TO="mail@destination.com"
+FROM="piGarden@your_domain.com"
+SUBJECT="piGarden notification mail: event $EVENT"
+BODY=""
+
+case "$EVENT" in
+	"init_before" | "init_after")
+		STATE="$2"
+		TIME=$3
+		BODY="PiGarden triggered new event\n\nEVENT: $EVENT\nTIME: $(/bin/date -d@$TIME)"
+		;;
+
+	"ev_open_before" | "ev_open_after")
+		ALIAS="$2"
+		FORCE="$3"
+		TIME=$4
+		BODY="PiGarden triggered new event\n\nEVENT: $EVENT\nZONE: $ALIAS\nFORCED IRRIGATION: $FORCE\nTIME: $(/bin/date -d@$TIME)"
+		;;
+
+	"ev_close_before" | "ev_close_after")
+		ALIAS="$2"
+		TIME=$3
+		BODY="PiGarden triggered new event\n\nEVENT: $EVENT\nZONE: $ALIAS\nTIME: $(/bin/date -d@$TIME)"
+		;;
+
+	"check_rain_sensor_before" | "check_rain_sensor_after" | "check_rain_sensor_change")
+		STATE="$2"
+		TIME=$3
+		BODY="PiGarden triggered new event\n\nEVENT: $EVENT\nSTATE: $ALIAS\nTIME: $(/bin/date -d@$TIME)"
+		;;
+
+	"check_rain_online_before" | "check_rain_online_after" | "check_rain_online_change")
+		STATE="$2"
+		TIME=$3
+		BODY="PiGarden triggered new event\n\nEVENT: $EVENT\nSTATE: $ALIAS\nTIME: $(/bin/date -d@$TIME)"
+		;;
+
+	*)
+		exit
+		;;
+
+esac
+
+echo -e "$BODY" | /usr/bin/mail -s "$SUBJECT" $TO -r $FROM &
+

events/scripts/testevent.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+#
+# Send mail on triggered event
+#
+# $1 = event
+EVENT="$1"
+P2="$2"
+P3="$3"
+P4="$4"
+P5="$5"
+
+echo "$(date) $EVENT $P2 $P3 $P4 $P5" >> /tmp/piGarden.testevent
+
+

events/scripts/testeventbreak.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+#
+# Send mail on triggered event
+#
+# $1 = event
+EVENT="$1"
+P2="$2"
+P3="$3"
+P4="$4"
+P5="$5"
+
+echo "testevent break $(date) $EVENT $P2 $P3 $P4 $P5" >> /tmp/piGarden.testevent
+
+exit 1

include/events.include.sh

@@ -0,0 +1,71 @@
+#
+# Triggered an event and executge associated scripts
+# $1 event
+#
+
+function trigger_event {
+
+	# check_rain_online_after
+	# check_rain_online_before
+	# check_rain_online_change
+	# check_rain_sensor_after
+	# check_rain_sensor_before
+	# check_rain_sensor_change
+	# ev_close_after
+	# ev_close_before
+	# ev_open_after
+	# ev_open_before
+	# init_after
+	# init_before
+
+	local EVENT="$1"
+	local CAUSE="$2"
+	local current_event_dir="$EVENT_DIR/$EVENT"
+
+	if [ -d "$current_event_dir" ]; then
+		local FILES="$current_event_dir/*"
+		for f in $FILES
+		do
+			if [ -x "$f" ]; then
+				case "$EVENT" in
+					"ev_open_before" | "ev_open_after")
+						ALIAS="$2"
+						FORCE="$3"
+						$f "$EVENT" "$ALIAS" "$FORCE" `date +%s`  &> /dev/null 
+						;;
+
+					"ev_close_before" | "ev_close_after")
+						ALIAS="$2"
+						$f "$EVENT" "$ALIAS" `date +%s`  &> /dev/null 
+						;;
+
+
+					"check_rain_sensor_before" | "check_rain_sensor_after" | "check_rain_sensor_change")
+						STATE="$2"
+						$f "$EVENT" "$STATE" `date +%s`  &> /dev/null 
+						;;
+
+					"check_rain_online_before" | "check_rain_online_after" | "check_rain_online_change")
+						STATE="$2"
+						$f "$EVENT" "$STATE" `date +%s`  &> /dev/null 
+						;;
+
+					*)
+						$f "$EVENT" "$CAUSE" `date +%s`  &> /dev/null 
+						;;
+				esac
+
+				local ec=$?
+				#echo "$EVENT ec=$ec" >> /tmp/piGarden.testevent
+				if [ $ec -ne 0 ]; then
+					log_write "Stop events chain for exit code $ec in $current_event_dir/$f"
+					return $ec
+				fi
+			fi
+		done
+
+	fi
+
+}
+
+

include/rain.include.sh

@@ -2,11 +2,16 @@
 # Controlla se se piove tramite http://api.wunderground.com/
 #
 function check_rain_online {
+
+	trigger_event "check_rain_online_before" ""
+
 	# http://www.wunderground.com/weather/api/d/docs?d=resources/phrase-glossary&MR=1
 	$CURL http://api.wunderground.com/api/$WUNDERGROUND_KEY/conditions/q/$WUNDERGROUND_LOCATION.json > $TMP_PATH/check_rain_online.json
 	local weather=`cat $TMP_PATH/check_rain_online.json | $JQ -M ".current_observation.weather"`
 	local current_observation=`cat $TMP_PATH/check_rain_online.json | $JQ -M ".current_observation"`
 	local local_epoch=`cat $TMP_PATH/check_rain_online.json | $JQ -M -r ".current_observation.local_epoch"`
+	local current_state_rain_online=""
+	local last_state_rain_online=`cat "$STATUS_DIR/last_state_rain_online" 2> /dev/null`
 	#echo $weather
 	#weather="[Light/Heavy] Drizzle"
 	if [ "$weather" = "null" ]; then
@@ -22,12 +27,19 @@ function check_rain_online {
 		 	[[ "$weather" == *"Thunderstorm"* ]] || 
 			[[ "$weather" == *"Drizzle"* ]]; 
 		then
-			#echo "ECCOMI!!!!!"
+			current_state_rain_online='rain'
 			echo $local_epoch > "$STATUS_DIR/last_rain_online"
-			#return $local_epoch	
+		else
+			current_state_rain_online='norain'
 		fi
 		echo "$current_observation" > "$STATUS_DIR/last_weather_online"
+		if [ "$current_state_rain_online" != "$last_state_rain_online" ]; then
+			echo "$current_state_rain_online" > "$STATUS_DIR/last_state_rain_online"
+			trigger_event "check_rain_online_change" "$current_state_rain_online"
+		fi
 	fi
+
+	trigger_event "check_rain_online_after" "$current_state_rain_online"
 }
 
 #
@@ -36,16 +48,25 @@ function check_rain_online {
 function check_rain_sensor {
 
 	if [ -n "$RAIN_GPIO" ]; then 
-		#local s=`$GPIO -g read $RAIN_GPIO`
+		trigger_event "check_rain_sensor_before" ""
+		local current_state_rain_sensor=""
+		local last_state_rain_sensor=`cat "$STATUS_DIR/last_state_rain_sensor" 2> /dev/null`
 		local s=`drv_rain_sensor_get $RAIN_GPIO`
 		if [ "$s" = "$RAIN_GPIO_STATE" ]; then
+			current_state_rain_sensor='rain'
 			local local_epoch=`date +%s`
 			echo $local_epoch > "$STATUS_DIR/last_rain_sensor"
 			log_write "check_rain_sensor - now it's raining ($local_epoch)"
-			return $local_epoch	
+			#return $local_epoch	
 		else
+			current_state_rain_sensor='norain'
 			log_write "check_rain_sensor - now is not raining"
 		fi
+		if [ "$current_state_rain_sensor" != "$last_state_rain_sensor" ]; then
+			echo "$current_state_rain_sensor" > "$STATUS_DIR/last_state_rain_sensor"
+			trigger_event "check_rain_sensor_change" "$current_state_rain_sensor"
+		fi
+		trigger_event "check_rain_sensor_after" "$current_state_rain_sensor"
 	else
 		log_write "Rain sensor not present"
 	fi
@@ -84,10 +105,12 @@ function close_all_for_rain {
 		do
 			local a=EV"$i"_ALIAS
 			local al=${!a}
+			local a=EV"$i"_NORAIN
+			local evnorain=${!a}
 			ev_status $al
 			local state=$?
 			#echo "$al = $state"
-			if [ "$state" = "1" ]; then
+			if [ "$state" = "1" ] && [ "$evnorain" != "1" ]; then
 				ev_close $al
 				log_write "close_all_for_rain - Close solenoid '$al' for rain"
 			fi

piGarden.sh

@@ -14,6 +14,8 @@ function initialize {
 
 	unlock
 
+	trigger_event "init_before" ""
+
 	# Inizializza i driver gpio
         for drv in "${list_drv[@]}"
         do
@@ -60,6 +62,7 @@ function initialize {
 		log_write "Rain sensor not present"
 	fi
 
+	trigger_event "init_after" ""
 	log_write "End initialize"
 
 }
@@ -82,7 +85,13 @@ function ev_open {
 
 	cron_del open_in $1 > /dev/null 2>&1
 
-	if [ ! "$2" = "force" ]; then
+	# Dall'alias dell'elettrovalvola recupero il numero e dal numero recupero gpio da usare
+	ev_alias2number $1
+	local EVNUM=$?
+	local g=`ev_number2gpio $EVNUM`
+	local EVNORAIN=`ev_number2norain $EVNUM`
+
+	if [ ! "$2" = "force" ] && [ "$EVNORAIN" != "1" ]; then
 		if [[ "$NOT_IRRIGATE_IF_RAIN_ONLINE" -gt 0 && -f $STATUS_DIR/last_rain_online ]]; then
 			local last_rain=`cat $STATUS_DIR/last_rain_online`
 			local now=`date +%s`
@@ -114,10 +123,12 @@ function ev_open {
 		state=2
 	fi
 
-	# Dall'alias dell'elettrovalvola recupero il numero e dal numero recupero gpio da usare
+	trigger_event "ev_open_before" "$1" "$2"
-	ev_alias2number $1
+	if [ $? -ne 0 ]; then
-	EVNUM=$?
+		log_write "Solenoid '$1' not open due to external event"
-	g=`ev_number2gpio $EVNUM`
+		message_write 'warning' "Solenoid not open due to external event"
+		return
+	fi
 
 	lock
 
@@ -136,6 +147,8 @@ function ev_open {
 
 	ev_set_state $EVNUM $state
 
+	trigger_event "ev_open_after" "$1" "$2"
+
 	unlock
 
 	log_write "Solenoid '$1' open"
@@ -214,6 +227,8 @@ function ev_close {
 	EVNUM=$?
 	g=`ev_number2gpio $EVNUM`
 
+	trigger_event "ev_close_before" "$1"
+
 	lock
 
 	# Gestisce l'apertura dell'elettrovalvola in base alla tipologia (monostabile / bistabile) 
@@ -231,6 +246,8 @@ function ev_close {
 
 	ev_set_state $EVNUM 0
 
+	trigger_event "ev_close_after" "$1"
+
 	unlock
 
 	log_write "Solenoid '$1' close"
@@ -372,11 +389,20 @@ function alias_exists {
 # $1 numero elettrovalvola
 #
 function ev_number2gpio {
-#	echo "numero ev $1"
+	local i=$1
-	i=$1
+	local g=EV"$i"_GPIO
-	g=EV"$i"_GPIO
+	local gv=${!g}
-	gv=${!g}
+	echo "$gv"
-#	echo "gv = $gv"
+}
+
+#
+# Recupera il valore norain associato ad una elettrovalvola
+# $1 numero elettrovalvola
+#
+function ev_number2norain {
+	local i=$1
+	local g=EV"$i"_NORAIN
+	local gv=${!g}
 	echo "$gv"
 }
 
@@ -756,7 +782,7 @@ function debug2 {
 
 VERSION=0
 SUB_VERSION=5
-RELEASE_VERSION=0
+RELEASE_VERSION=1
 
 DIR_SCRIPT=`dirname $0`
 NAME_SCRIPT=${0##*/}
@@ -782,15 +808,21 @@ fi
 . "$DIR_SCRIPT/include/cron.include.sh"
 . "$DIR_SCRIPT/include/socket.include.sh"
 . "$DIR_SCRIPT/include/rain.include.sh"
+. "$DIR_SCRIPT/include/events.include.sh"
 
 LAST_INFO_FILE="$STATUS_DIR/last_info"
-LAST_WARNING_FILE="$STATUS_DIR/last_worning"
+LAST_WARNING_FILE="$STATUS_DIR/last_warning"
 LAST_SUCCESS_FILE="$STATUS_DIR/last_success"
 
 if [ -z $LOG_OUTPUT_DRV_FILE ]; then
 	$LOG_OUTPUT_DRV_FILE="/dev/null"
 fi
 
+if [ -z "$EVENT_DIR" ]; then
+	EVENT_DIR="$DIR_SCRIPT/events"
+fi
+
+
 # Elimina il file di lock se più vecchio di 11 secondi
 if [ -f "$LOCK_FILE" ]; then
 	max_age_lock_file=11