Updated reference configuration sample for `alarm`.

platypush/config/config.yaml

@@ -360,45 +360,61 @@ backend.http:
 # # both statically, i.e. through configuration snippets under the `alarm`
 # # section, and dynamically, i.e. with an `alarm.add` request with the
 # # configuration of the desired alarm.
+# 
 # alarm:
-#   alarms:
+#     # Media plugin that will be used to play the alarm audio.
-#     # The media plugin used to play the media. At least a supported media
+#     # If not specified, the first available configured media plugin
-#     # plugin (media.vlc, media.mpv, media.mplayer, media.gstreamer etc.) is
+#     # will be used.
-#     # required if you want to play a sound or other media with your alarms.
+#     media_plugin: media.vlc
-#     # Default: looks for the first available media plugin in the configuration.
-#     # media_plugin: media.vlc
 # 
-#     # This alarm will run every morning on weekdays
+#     alarms:
-#     morning_alarm:
+#         morning_alarm:
-#         # Notice the crontab-like syntax: every day at 8:00 AM, from Monday
+#             # Cron expression format: run every weekday at 7 AM
-#         # through Friday.
+#             when: '0 7 * * 1-5'
-#         when: '0 8 * * 1-5'
+#             media: ~/path/your_ringtone.mp3
+#             audio_volume: 10       # 10%
 # 
-#         # Alternatively, if `when` contains a number, it will be interpreted as
+#             # Repeat the played media resource until the alarm is
-#         # number of seconds after the alarm is loaded. In this case, this alarm
+#             # snoozed/dismissed (default: true)
-#         # will run one-shot one minute after the service starts.
+#             media_repeat: true
-#         # when: 60
 # 
-#         # Otherwise, ISO-8601 timestamp strings are also supported for one-shot
+#             # Wait 5 minutes between a snooze and another run
-#         # alarms.
+#             snooze_interval: 300
-#         # when: '2020-01-01T00:00:00'
 # 
-#         # The path or URL of a media file to play when the alarm starts. This is
+#             # After 10 minutes with no manual snooze/dismiss,
-#         # optional - the alarm can also be configured to play no sounds at all,
+#             # stop the alarm
-#         # or perhaps play the media directly within the context of the `actions`
+#             dismiss_interval: 600
-#         # configuration.
-#         media: ~/media/ringtones/alarm.mp3
 # 
-#         # Overrides the media_plugin configuration.
+#             # Actions to be executed when the alarm goes on
-#         # media_plugin: media.mpv
+#             actions:
+#                 - action: tts.say
+#                   args:
+#                       text: Good morning
 # 
-#         # List of actions to be executed when the alarm starts.
+#                 - action: light.hue.bri
-#         actions:
+#                   args:
-#           - action: tts.say
+#                       value: 1
-#             args:
-#               text: "Good morning, it's time to get up"
 # 
-#           - action: light.hue.on
+#                 - action: light.hue.bri
+#                   args:
+#                       value: 140
+#                       transitiontime: 150
+# 
+#         one_shot_alarm:
+#             # One-shot execution, with timestamp in ISO format
+#             when: '2020-02-18T07:00:00.000000'
+#             media: ~/path/your_ringtone.mp3
+#             actions:
+#                 - action: light.hue.on
+# 
+#         timer:
+#             # This alarm will execute the specified number of seconds
+#             # after being initialized (5 minutes after the plugin has
+#             # been initialized in this case)
+#             when: 300
+#             media: ~/path/your_ringtone.mp3
+#             actions:
+#                 - action: light.hue.on
 ###
 
 ###