diff --git a/platypush/config/config.yaml b/platypush/config/config.yaml index 08ebd79b..263e54ad 100644 --- a/platypush/config/config.yaml +++ b/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: -# # The media plugin used to play the media. At least a supported media -# # plugin (media.vlc, media.mpv, media.mplayer, media.gstreamer etc.) is -# # required if you want to play a sound or other media with your alarms. -# # Default: looks for the first available media plugin in the configuration. -# # media_plugin: media.vlc +# # Media plugin that will be used to play the alarm audio. +# # If not specified, the first available configured media plugin +# # will be used. +# media_plugin: media.vlc # -# # This alarm will run every morning on weekdays -# morning_alarm: -# # Notice the crontab-like syntax: every day at 8:00 AM, from Monday -# # through Friday. -# when: '0 8 * * 1-5' +# alarms: +# morning_alarm: +# # Cron expression format: run every weekday at 7 AM +# when: '0 7 * * 1-5' +# media: ~/path/your_ringtone.mp3 +# audio_volume: 10 # 10% # -# # Alternatively, if `when` contains a number, it will be interpreted as -# # number of seconds after the alarm is loaded. In this case, this alarm -# # will run one-shot one minute after the service starts. -# # when: 60 +# # Repeat the played media resource until the alarm is +# # snoozed/dismissed (default: true) +# media_repeat: true # -# # Otherwise, ISO-8601 timestamp strings are also supported for one-shot -# # alarms. -# # when: '2020-01-01T00:00:00' +# # Wait 5 minutes between a snooze and another run +# snooze_interval: 300 # -# # The path or URL of a media file to play when the alarm starts. This is -# # optional - the alarm can also be configured to play no sounds at all, -# # or perhaps play the media directly within the context of the `actions` -# # configuration. -# media: ~/media/ringtones/alarm.mp3 +# # After 10 minutes with no manual snooze/dismiss, +# # stop the alarm +# dismiss_interval: 600 # -# # Overrides the media_plugin configuration. -# # media_plugin: media.mpv +# # Actions to be executed when the alarm goes on +# actions: +# - action: tts.say +# args: +# text: Good morning # -# # List of actions to be executed when the alarm starts. -# actions: -# - action: tts.say -# args: -# text: "Good morning, it's time to get up" +# - action: light.hue.bri +# args: +# value: 1 # -# - 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 ### ###