bencevans/node-sonos

# sonos

Sonos library to control (almost) everything from your sonos devices

**Requires:**

+ module:'./Service'
+ module:'../Helpers'

* * *

## Class: AlarmClock

Create a new instance of AlarmClock

### sonos.AlarmClock.CreateAlarm(options)

Create an alarm, but using the sonos app it advised (because you most likely cannot set the ProgramMetaData correctly)

**Parameters**:

**options**: `Object`, An object with all the required settings

+ **options.StartLocalTime**: `String`, Time string when you want the alarm to sound.

+ **options.Duration**: `String`, How many minutes should the alarm sound.

+ **options.Recurrance**: `String`, What should the recurrence be ['DAILY','ONCE','WEEKDAYS']

+ **options.Enabled**: `String`, Should the alarm be enabled ['1','0']

+ **options.RoomUUID**: `String`, The UUID of the room `RINCON_xxxxxxxxxxxx01400`

+ **options.ProgramURI**: `String`, The programUri you want, this is the difficult part. `x-rincon-buzzer:0` for ringer

+ **options.ProgramMetaData**: `String`, The metadata for the programURI, this is the hard part.

+ **options.PlayMode**: `String`, The playmode ['??','SHUFFLE']

+ **options.Volume**: `String`, What should the volume be

+ **options.IncludeLinkedZones**: `String`, Should linked zones be included? ['0', '1']

**Returns**: `Object`, parsed response object

### sonos.AlarmClock.DestroyAlarm(id)

Delete an alarm

**Parameters**:

**id**: `String`, the id of the alarm you want to delete

**Returns**: `Object`, parsed response object

### sonos.AlarmClock.ListAlarms()

Get all the alarms known to sonos

**Returns**: `Object`

### sonos.AlarmClock.SetAlarm(id, enabled)

Enable/disable an alarm

**Parameters**:

**id**: `String`, the id of the alarm you want to set

**enabled**: `Boolean`, Should the alarm be enabled or not

**Returns**: `Object`, parsed response object

### sonos.AlarmClock.PatchAlarm(id, options)

Update only some properties of an Alarm

**Parameters**:

**id**: `String`, the id of the alarm you want to update

**options**: `Object`, An object with the settings you wish to update

+ **options.StartLocalTime**: `String`, Time string when you want the alarm to sound.

+ **options.Duration**: `String`, How many minutes should the alarm sound.

+ **options.Recurrance**: `String`, What should the recurrence be ['DAILY','ONCE','WEEKDAYS']

+ **options.Enabled**: `String`, Should the alarm be enabled ['1','0']

+ **options.RoomUUID**: `String`, The UUID of the room `RINCON_xxxxxxxxxxxx01400`

+ **options.ProgramURI**: `String`, The programUri you want, this is the difficult part. `x-rincon-buzzer:0` for ringer

+ **options.ProgramMetaData**: `String`, The metadata for the programURI, this is the hard part.

+ **options.PlayMode**: `String`, The playmode ['??','SHUFFLE']

+ **options.Volume**: `String`, What should the volume be

+ **options.IncludeLinkedZones**: `String`, Should linked zones be included? ['0', '1']

**Returns**: `Object`, parsed response object

* * *