Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

AlarmClock

pgfeller edited this page Dec 19, 2014 · 21 revisions

Below you'll find two example on how to realize an alarm clock with openHAB. Example 1 does use only use one item to control the alarm time. Example II will control the hours and minutes seperately.

  • [References] (AlarmClock#references)

Alarm Clock - Example I

There is no 'time' widget and using numbers/dimmers/setpoints; if you do not want to have two items, one for hours and one for minutes this example is for you ...

Basically you are specifying the alarm time as a number from 0-600 mins (i.e. 0-10 hours). The base time is midnight, so this corresponds to a time between midnight and 10am. Obviously very easy to change the Setpoint config in your sitemap to extend or restrict this. I have it set to 'step' in 5 min increments, but you could make this 15 mins to make it easier to quickly set coarse alarm times if you wanted.

Whenever you change the alarm time mins item using the Setpoint widget, the alarm time is calculated and a display item is updated, so you can show the nicely formatted alarm time in the sitemap. This item is not used for anything other than display.

The reason I have two frames for displaying the alarm details is so I can merge both the alarm switch and time items into one sitemap widget. So if the alarm is enabled I hardcode the presence-on icon and display the alarm time, if it is disabled I hard-code the presence-off icon. By doing this I can display the alarm time and have an icon showing the alarm state. Drilling down into that frame gives you the option to disable the alarm and change the time. [1]

Items

Switch     Alarm_Master          "Master Alarm"       <presence>       (Alarms)
Number     Alarm_MasterTimeMins  "Master Alarm"       <clock>          (Alarms)
String     Alarm_MasterTime      "Master Alarm [%s]"  <clock>
Switch     Alarm_MasterEvent     "Master Alarm Event" <alarm>          (AlarmEvents)      { autoupdate="false" }

Rules

var Timer masterAlarmTime = null

rule "Master bedroom alarm time"
when
	Time cron "0 5 0 * * ?" or
	Item Alarm_MasterTimeMins received update
then
	var int minutes = (Alarm_MasterTimeMins.state as DecimalType).intValue()

	if (masterAlarmTime != null)
		masterAlarmTime.cancel()

	// work out when the alarm is to fire - start from midnight
	var DateTime alarmTime = parse(now.getYear() + "-" + now.getMonthOfYear() + "-" + now.getDayOfMonth() + "T00:00")

	// add the number of minutes selected
	alarmTime = alarmTime.plusMinutes(minutes)

	// if we have already past the alarm time then set it for the following day
	if (alarmTime.beforeNow)
		alarmTime = alarmTime.plusDays(1)

	// create a timer to execute the alarm at the specified time
	masterAlarmTime = createTimer(alarmTime) [| 
		if (Alarm_Master.state == ON && Holiday.state == OFF && now.getDayOfWeek() < 6) 
			Alarm_MasterEvent.sendCommand(ON)
	]

	// update the alarm display time    
	Alarm_MasterTime.sendCommand(String::format("%02d:%02d", alarmTime.getHourOfDay(), alarmTime.getMinuteOfHour()))
end

rule "Master bedroom alarm"
when
	Item Alarm_MasterEvent received command ON
then
	// do your alarm stuff - turn on radio, dim up lights, start the coffee machine...
end

Sitemap

Frame label="Alarm" {
	Text item=Alarm_MasterTime icon="presence-on" visibility=[Alarm_Master==ON] {
		Frame label="Master Alarm" {
			Switch item=Alarm_Master
			Text item=Alarm_MasterTime
			Setpoint item=Alarm_MasterTimeMins minValue=0 maxValue=600 step=5
		}
	}
	Text item=Alarm_MasterTime icon="presence-off" visibility=[Alarm_Master==OFF] {
		Frame label="Master Alarm" {
			Switch item=Alarm_Master
			Text item=Alarm_MasterTime
			Setpoint item=Alarm_MasterTimeMins minValue=0 maxValue=600 step=5
		}
	}
}

Alarm Clock - Example II

UI (greenT)

Below an example on how to create an alarm clock with openHAB.

alarm.items

Group   gWeckerWochentage "Wochentage"
Group   gWeckerZeit "Zeit"
Switch	weckerMontag	"Montag"	<switch>	(gWeckerWochentage)	
Switch	weckerDienstag	"Dienstag"	<switch>	(gWeckerWochentage)	
Switch	weckerMittwoch	"Mittwoch"	<switch>	(gWeckerWochentage)	
Switch	weckerDonnerstag	"Donnerstag"	<switch>	(gWeckerWochentage)	
Switch	weckerFreitag	"Freitag"	<switch>	(gWeckerWochentage)	
Switch	weckerSamstag	"Samstag"	<switch>	(gWeckerWochentage)	
Switch	weckerSonntag	"Sonntag"	<switch>	(gWeckerWochentage)	

String weckerZeitMessage "%s"

Number weckerZeitStunde "Stunde [%d]" <clock> (gWeckerZeit)
Number weckerZeitMinute "Minute [%d]" <clock> (gWeckerZeit)

alarm.rules

import org.openhab.core.library.types.*
import org.openhab.core.persistence.*
import org.openhab.model.script.actions.*
import org.openhab.action.squeezebox.*

var Timer Wecker

rule "WeckzeitUpdate"
when
    System started
    or Item weckerZeitStunde changed
    or Item weckerZeitMinute changed
then
  if ((weckerZeitStunde.state instanceof DecimalType) && (weckerZeitMinute.state instanceof DecimalType)) {

    var String msg = ""
    var stunde = weckerZeitStunde.state as DecimalType
    var minute = weckerZeitMinute.state as DecimalType
  
    if (stunde < 10) { msg = "0" } 
    msg = msg + weckerZeitStunde.state.format("%d") + ":"
    if (minute < 10) { msg = msg + "0" }
    msg = msg + weckerZeitMinute.state.format("%d")
    postUpdate(weckerZeitMessage,msg)
  
    var int weckzeit
    weckzeit = (weckerZeitStunde.state as DecimalType).intValue * 60 + (weckerZeitMinute.state as DecimalType).intValue
    weckzeit = weckzeit.intValue
  
    var int jetzt
    jetzt = now.getMinuteOfDay
    jetzt = jetzt.intValue
  
    var int delta
    if (Wecker != null) {
      Wecker.cancel
      Wecker = null
    }
  
    delta = (weckzeit - jetzt)
    delta = delta.intValue
  
    if (jetzt > weckzeit) { delta = delta + 1440 }
    
    Wecker = createTimer(now.plusMinutes(delta)) [|
        logInfo("wecker.rules", "Timer Event")
        var Number day = now.getDayOfWeek
        if (((day == 1) && (weckerMontag.state == ON))     ||
            ((day == 2) && (weckerDienstag.state == ON))   ||
            ((day == 3) && (weckerMittwoch.state == ON))   ||
            ((day == 4) && (weckerDonnerstag.state == ON)) ||
            ((day == 5) && (weckerFreitag.state == ON))    ||
            ((day == 6) && (weckerSamstag.state == ON))    ||
            ((day == 7) && (weckerSonntag.state == ON))
            ) {
            logInfo("wecker.rules", "Alarm")
            sendHttpGetRequest("http://192.168.10.100/ExecuteEvent.asp?Event=Wecker")
            sendCommand("gRollladen", "UP")
            createTimer(now.plusSeconds(5)) [|
              sendCommand("ZwaveShutterEGTV", "STOP")
            ]
        }
        Wecker.reschedule(now.plusHours(24))
    ]
    
  } else {
    // alarm clock not initialized ...
    postUpdate(weckerZeitStunde, 8)
    postUpdate(weckerZeitMinute, 15)
    postUpdate(weckerMontag, ON)
    postUpdate(weckerDienstag, ON)
    postUpdate(weckerMittwoch, ON)
    postUpdate(weckerDonnerstag, ON)
    postUpdate(weckerFreitag, ON)
    postUpdate(weckerSamstag, OFF)
    postUpdate(weckerSonntag, OFF)
    Wecker = null
  }
  
end

alarm.sitemap

sitemap alarmclock
{
    Frame label="System" {
            
        Text label="Wecker [%s]" item=weckerZeitMessage icon="clock" {
            Frame label="Zeit" {
                Setpoint item=weckerZeitStunde minValue=0 maxValue=23 step=1
                Setpoint item=weckerZeitMinute minValue=0 maxValue=55 step=5
            }
            Frame label="Wochentage" {
                Switch item=weckerMontag
                Switch item=weckerDienstag
                Switch item=weckerMittwoch
                Switch item=weckerDonnerstag
                Switch item=weckerFreitag
                Switch item=weckerSamstag
                Switch item=weckerSonntag
            }
        }
    }	
}

References

Installation


User Interfaces


Community

(link to openHAB forum)

Development



Misc


Samples

A good source of inspiration and tips from users gathered over the years. Be aware that things may have changed since they were written and some examples might not work correctly.

Please update the wiki if you do come across any out of date information.

Use case examples

Collections of Rules on a single page

Single Rules

Scripts


Release Notes

Clone this wiki locally