sonos-api 0.3.0

Type-safe Sonos API for UPnP device control via SOAP
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
//! AVTransport service event types and parsing
//!
//! Provides direct serde-based XML parsing with no business logic,
//! replicating exactly what Sonos produces for sonos-stream consumption.

use serde::{Deserialize, Serialize};
use std::net::IpAddr;

use crate::events::{xml_utils, EnrichedEvent, EventParser, EventSource};
use crate::{ApiError, Result, Service};

/// Minimal AVTransport event - direct serde mapping from UPnP event XML
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename = "propertyset")]
pub struct AVTransportEvent {
    #[serde(rename = "property")]
    property: AVTransportProperty,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
struct AVTransportProperty {
    #[serde(
        rename = "LastChange",
        deserialize_with = "xml_utils::deserialize_nested"
    )]
    last_change: AVTransportEventData,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename = "Event")]
pub struct AVTransportEventData {
    #[serde(rename = "InstanceID")]
    instance: AVTransportInstance,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
struct AVTransportInstance {
    #[serde(rename = "TransportState", default)]
    pub transport_state: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "TransportStatus", default)]
    pub transport_status: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "TransportPlaySpeed", default)]
    pub speed: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "CurrentTrackURI", default)]
    pub current_track_uri: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "CurrentTrackDuration", default)]
    pub track_duration: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "RelativeTimePosition", default)]
    pub rel_time: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "AbsoluteTimePosition", default)]
    pub abs_time: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "CurrentTrack", default)]
    pub rel_count: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "CurrentPlayMode", default)]
    pub play_mode: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "CurrentTrackMetaData", default)]
    pub track_metadata: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "NextTrackURI", default)]
    pub next_track_uri: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "NextTrackMetaData", default)]
    pub next_track_metadata: Option<xml_utils::ValueAttribute>,

    #[serde(rename = "NumberOfTracks", default)]
    pub queue_length: Option<xml_utils::ValueAttribute>,
}

impl AVTransportEvent {
    /// Get transport state
    pub fn transport_state(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .transport_state
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get transport status
    pub fn transport_status(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .transport_status
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get speed
    pub fn speed(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .speed
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get current track URI
    pub fn current_track_uri(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .current_track_uri
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get track duration
    pub fn track_duration(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .track_duration
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get relative time
    pub fn rel_time(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .rel_time
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get absolute time
    pub fn abs_time(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .abs_time
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get relative count
    pub fn rel_count(&self) -> Option<u32> {
        self.property
            .last_change
            .instance
            .rel_count
            .as_ref()
            .and_then(|v| v.val.parse().ok())
    }

    /// Get absolute count (not available)
    pub fn abs_count(&self) -> Option<u32> {
        None
    }

    /// Get play mode
    pub fn play_mode(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .play_mode
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get track metadata
    pub fn track_metadata(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .track_metadata
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get next track URI
    pub fn next_track_uri(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .next_track_uri
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get next track metadata
    pub fn next_track_metadata(&self) -> Option<String> {
        self.property
            .last_change
            .instance
            .next_track_metadata
            .as_ref()
            .map(|v| v.val.clone())
    }

    /// Get queue length
    pub fn queue_length(&self) -> Option<u32> {
        self.property
            .last_change
            .instance
            .queue_length
            .as_ref()
            .and_then(|v| v.val.parse().ok())
    }

    /// Convert parsed UPnP event to canonical state representation.
    pub fn into_state(&self) -> super::state::AVTransportState {
        super::state::AVTransportState {
            transport_state: self.transport_state(),
            transport_status: self.transport_status(),
            speed: self.speed(),
            current_track_uri: self.current_track_uri(),
            track_duration: self.track_duration(),
            track_metadata: self.track_metadata(),
            rel_time: self.rel_time(),
            abs_time: self.abs_time(),
            rel_count: self.rel_count(),
            abs_count: self.abs_count(),
            play_mode: self.play_mode(),
            next_track_uri: self.next_track_uri(),
            next_track_metadata: self.next_track_metadata(),
            queue_length: self.queue_length(),
        }
    }

    /// Parse from UPnP event XML using serde
    pub fn from_xml(xml: &str) -> Result<Self> {
        let clean_xml = xml_utils::strip_namespaces(xml);
        quick_xml::de::from_str(&clean_xml)
            .map_err(|e| ApiError::ParseError(format!("Failed to parse AVTransport XML: {e}")))
    }
}

/// Minimal parser implementation
pub struct AVTransportEventParser;

impl EventParser for AVTransportEventParser {
    type EventData = AVTransportEvent;

    fn parse_upnp_event(&self, xml: &str) -> Result<Self::EventData> {
        AVTransportEvent::from_xml(xml)
    }

    fn service_type(&self) -> Service {
        Service::AVTransport
    }
}

/// Create enriched event for sonos-stream integration
pub fn create_enriched_event(
    speaker_ip: IpAddr,
    event_source: EventSource,
    event_data: AVTransportEvent,
) -> EnrichedEvent<AVTransportEvent> {
    EnrichedEvent::new(speaker_ip, Service::AVTransport, event_source, event_data)
}

/// Create enriched event with registration ID
pub fn create_enriched_event_with_registration_id(
    registration_id: u64,
    speaker_ip: IpAddr,
    event_source: EventSource,
    event_data: AVTransportEvent,
) -> EnrichedEvent<AVTransportEvent> {
    EnrichedEvent::with_registration_id(
        registration_id,
        speaker_ip,
        Service::AVTransport,
        event_source,
        event_data,
    )
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_av_transport_parser_service_type() {
        let parser = AVTransportEventParser;
        assert_eq!(parser.service_type(), Service::AVTransport);
    }

    #[test]
    fn test_av_transport_event_creation() {
        let event_data = AVTransportEventData {
            instance: AVTransportInstance {
                transport_state: Some(xml_utils::ValueAttribute {
                    val: "PLAYING".to_string(),
                }),
                transport_status: Some(xml_utils::ValueAttribute {
                    val: "OK".to_string(),
                }),
                speed: Some(xml_utils::ValueAttribute {
                    val: "1".to_string(),
                }),
                current_track_uri: None,
                track_duration: None,
                rel_time: None,
                abs_time: None,
                rel_count: None,
                play_mode: None,
                track_metadata: None,
                next_track_uri: None,
                next_track_metadata: None,
                queue_length: None,
            },
        };

        let event = AVTransportEvent {
            property: AVTransportProperty {
                last_change: event_data,
            },
        };

        assert_eq!(event.transport_state(), Some("PLAYING".to_string()));
        assert_eq!(event.transport_status(), Some("OK".to_string()));
    }

    #[test]
    fn test_enriched_event_creation() {
        let ip: IpAddr = "192.168.1.100".parse().unwrap();
        let source = EventSource::UPnPNotification {
            subscription_id: "uuid:123".to_string(),
        };
        let event_data = AVTransportEvent {
            property: AVTransportProperty {
                last_change: AVTransportEventData {
                    instance: AVTransportInstance {
                        transport_state: Some(xml_utils::ValueAttribute {
                            val: "PLAYING".to_string(),
                        }),
                        transport_status: None,
                        speed: None,
                        current_track_uri: None,
                        track_duration: None,
                        rel_time: None,
                        abs_time: None,
                        rel_count: None,
                        play_mode: None,
                        track_metadata: None,
                        next_track_uri: None,
                        next_track_metadata: None,
                        queue_length: None,
                    },
                },
            },
        };

        let enriched = create_enriched_event(ip, source, event_data);

        assert_eq!(enriched.speaker_ip, ip);
        assert_eq!(enriched.service, Service::AVTransport);
        assert!(enriched.registration_id.is_none());
    }

    #[test]
    fn test_enriched_event_with_registration_id() {
        let ip: IpAddr = "192.168.1.100".parse().unwrap();
        let source = EventSource::UPnPNotification {
            subscription_id: "uuid:123".to_string(),
        };
        let event_data = AVTransportEvent {
            property: AVTransportProperty {
                last_change: AVTransportEventData {
                    instance: AVTransportInstance {
                        transport_state: Some(xml_utils::ValueAttribute {
                            val: "PLAYING".to_string(),
                        }),
                        transport_status: None,
                        speed: None,
                        current_track_uri: None,
                        track_duration: None,
                        rel_time: None,
                        abs_time: None,
                        rel_count: None,
                        play_mode: None,
                        track_metadata: None,
                        next_track_uri: None,
                        next_track_metadata: None,
                        queue_length: None,
                    },
                },
            },
        };

        let enriched = create_enriched_event_with_registration_id(42, ip, source, event_data);

        assert_eq!(enriched.registration_id, Some(42));
    }

    #[test]
    fn test_basic_xml_parsing() {
        let xml = r#"<e:propertyset xmlns:e="urn:schemas-upnp-org:event-1-0">
            <e:property>
                <LastChange>&lt;Event xmlns="urn:schemas-upnp-org:metadata-1-0/AVT/"&gt;
                    &lt;InstanceID val="0"&gt;
                        &lt;TransportState val="PLAYING"/&gt;
                        &lt;TransportStatus val="OK"/&gt;
                        &lt;CurrentTrack val="1"/&gt;
                        &lt;NumberOfTracks val="5"/&gt;
                    &lt;/InstanceID&gt;
                &lt;/Event&gt;</LastChange>
            </e:property>
        </e:propertyset>"#;

        let event = AVTransportEvent::from_xml(xml).unwrap();
        assert_eq!(event.transport_state(), Some("PLAYING".to_string()));
        assert_eq!(event.transport_status(), Some("OK".to_string()));
        assert_eq!(event.rel_count(), Some(1));
        assert_eq!(event.queue_length(), Some(5));
    }

    #[test]
    fn test_into_state_maps_all_fields() {
        let event = AVTransportEvent {
            property: AVTransportProperty {
                last_change: AVTransportEventData {
                    instance: AVTransportInstance {
                        transport_state: Some(xml_utils::ValueAttribute {
                            val: "PLAYING".to_string(),
                        }),
                        transport_status: Some(xml_utils::ValueAttribute {
                            val: "OK".to_string(),
                        }),
                        speed: Some(xml_utils::ValueAttribute {
                            val: "1".to_string(),
                        }),
                        current_track_uri: Some(xml_utils::ValueAttribute {
                            val: "x-sonos-spotify:track123".to_string(),
                        }),
                        track_duration: Some(xml_utils::ValueAttribute {
                            val: "0:03:45".to_string(),
                        }),
                        rel_time: Some(xml_utils::ValueAttribute {
                            val: "0:01:30".to_string(),
                        }),
                        abs_time: None,
                        rel_count: Some(xml_utils::ValueAttribute {
                            val: "1".to_string(),
                        }),
                        play_mode: Some(xml_utils::ValueAttribute {
                            val: "NORMAL".to_string(),
                        }),
                        track_metadata: None,
                        next_track_uri: None,
                        next_track_metadata: None,
                        queue_length: Some(xml_utils::ValueAttribute {
                            val: "5".to_string(),
                        }),
                    },
                },
            },
        };

        let state = event.into_state();

        assert_eq!(state.transport_state, Some("PLAYING".to_string()));
        assert_eq!(state.transport_status, Some("OK".to_string()));
        assert_eq!(state.speed, Some("1".to_string()));
        assert_eq!(
            state.current_track_uri,
            Some("x-sonos-spotify:track123".to_string())
        );
        assert_eq!(state.track_duration, Some("0:03:45".to_string()));
        assert_eq!(state.rel_time, Some("0:01:30".to_string()));
        assert_eq!(state.abs_time, None);
        assert_eq!(state.rel_count, Some(1));
        assert_eq!(state.play_mode, Some("NORMAL".to_string()));
        assert_eq!(state.queue_length, Some(5));
    }

    #[test]
    fn test_into_state_from_xml_round_trip() {
        let xml = r#"<e:propertyset xmlns:e="urn:schemas-upnp-org:event-1-0">
            <e:property>
                <LastChange>&lt;Event xmlns="urn:schemas-upnp-org:metadata-1-0/AVT/"&gt;
                    &lt;InstanceID val="0"&gt;
                        &lt;TransportState val="PLAYING"/&gt;
                        &lt;TransportStatus val="OK"/&gt;
                        &lt;CurrentTrack val="1"/&gt;
                        &lt;NumberOfTracks val="5"/&gt;
                    &lt;/InstanceID&gt;
                &lt;/Event&gt;</LastChange>
            </e:property>
        </e:propertyset>"#;

        let state = AVTransportEvent::from_xml(xml).unwrap().into_state();

        assert_eq!(state.transport_state, Some("PLAYING".to_string()));
        assert_eq!(state.transport_status, Some("OK".to_string()));
        assert_eq!(state.rel_count, Some(1));
        assert_eq!(state.queue_length, Some(5));
    }
}