Alarm Clock Plugin - AmyAssist/Amy GitHub Wiki

Plugin info

The Alarm Clock plugin provides the alarm functionality.
This plugin makes it possible to set, delete, activate, deactivate and edit alarms.

All alarms are stored in the registry

Plugin features

The following segments will explain the various features the plugin provides. The commands presented will have agf form as there are sometimes too many possible alternatives for one command to list them entirely. For all possible command variation see in AlarmclockSpeech.aim.xml You can read all about the agf form and dialogs here.

Creating alarms

There are multiple working speech commands to create an alarm. You can set the alarms for today and tomorrow.

1: (set|create) alarm (at|for|on) (#|quarter|half) (past|to) # [am|pm] (today|tomorrow)

The # have to be replaced with your desired numbers. This is a very intuitive way to create an alarm, close to the natural English language.

2: (set|create) alarm (at|for|on) # oh # [am|pm] (today|tomorrow)

The first # represents the hour of the alarm, ranging from 0 to 23. It is also possible to only use the numbers from 0 to 12 with the addition of am or pm.
The second # stands for the minute of the alarm, ranging from 0 to 60.
The alarm will ring at the given hour, the given minute and 0 seconds of the next occurence of the set time of day.

3: (set|create) alarm (at|for|on) # oh clock [am|pm] (today|tomorrow)

Use this command if you want to set your alarm on a specific hour but not a minute.
The # represents the hour of the alarm. The minute will default to 0

Creating an alarm will allocate it a unique alarm id, which will be incremented independently everytime one of these objects is created. Gaps, which arise through deleting some alarms are automatically filled if you set new alarms.

Deleting alarms

The command to delete an alarm is delete alarm #, where the # corresponds to the id of the alarm.
If you wish to delete all alarms, use the command reset alarms

Activate and deactivate alarms

When setting an alarm, it is initially activated and will ring at the given time.
To deactivate an alarm, use deactivate alarm #, the hashtag representing the id of the alarm. This command will deactivate the corresponding alarm so it will not go off.
Regarding the activation of alarms, use the command activate alarm #, the # referring to the corresponding alarm id.

Output of alarms

If you wish to get details of your set alarms, use the command get alarm #, where the hashtag is representing the alarm id. This command will give you the time when it will ring and if it is activated.
It is also possible, to get every alarm with the command get all alarms
This command will give you the id, ring time and state of activation of every alarm that is stored.

Edit alarms

To edit the time of an existing alarm to your liking, use the command edit alarm # to # oh #
The first hashtag in the command refers to the alarm id, the second and third for the new hour and minute of the alarm.