hap-model 1.2.0

HomeKit Accessory Protocol attribute database: accessory/service/characteristic model and HAP-defined types.
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

//! The typed accessory attribute tree: [`Accessory`] → [`Service`] →
//! [`Characteristic`].

use crate::format::{CharFormat, CharValue};
use crate::generated::{CharacteristicType, ServiceType};
use crate::perms::Perms;
use serde::Deserialize;

/// One accessory in the bridge/accessory database.
#[derive(Debug, Clone, PartialEq)]
pub struct Accessory {
    /// Accessory instance id (unique within the response).
    pub aid: u64,
    /// The accessory's services.
    pub services: Vec<Service>,
}

/// One service on an accessory.
#[derive(Debug, Clone, PartialEq)]
pub struct Service {
    /// Service instance id (unique within the accessory).
    pub iid: u64,
    /// The HAP service type (decoded from the short `type` UUID).
    pub service_type: ServiceType,
    /// The service's characteristics.
    pub characteristics: Vec<Characteristic>,
}

/// One characteristic on a service.
#[derive(Debug, Clone, PartialEq)]
pub struct Characteristic {
    /// Characteristic instance id (unique within the accessory).
    pub iid: u64,
    /// The HAP characteristic type (decoded from the short `type` UUID).
    pub char_type: CharacteristicType,
    /// The value format.
    pub format: CharFormat,
    /// Permissions.
    pub perms: Perms,
    /// The current value, if the accessory included one and it decoded under
    /// `format`. `None` if absent.
    pub value: Option<CharValue>,
    /// Optional unit string (e.g. `"percentage"`, `"celsius"`).
    pub unit: Option<String>,
    /// Optional minimum value constraint.
    pub min_value: Option<f64>,
    /// Optional maximum value constraint.
    pub max_value: Option<f64>,
    /// Optional step constraint.
    pub min_step: Option<f64>,
    /// Optional maximum length (for string/data formats).
    pub max_len: Option<u64>,
}

// ---- wire structs (private; mirror the JSON exactly) ----

#[derive(Debug, Deserialize)]
pub(crate) struct WireAccessories {
    pub accessories: Vec<WireAccessory>,
}

#[derive(Debug, Deserialize)]
pub(crate) struct WireAccessory {
    pub aid: u64,
    pub services: Vec<WireService>,
}

#[derive(Debug, Deserialize)]
pub(crate) struct WireService {
    pub iid: u64,
    #[serde(rename = "type")]
    pub type_: crate::uuid::Uuid,
    pub characteristics: Vec<WireCharacteristic>,
}

#[derive(Debug, Deserialize)]
pub(crate) struct WireCharacteristic {
    pub iid: u64,
    #[serde(rename = "type")]
    pub type_: crate::uuid::Uuid,
    pub format: CharFormat,
    pub perms: Perms,
    #[serde(default)]
    pub value: Option<serde_json::Value>,
    #[serde(default)]
    pub unit: Option<String>,
    #[serde(default, rename = "minValue")]
    pub min_value: Option<f64>,
    #[serde(default, rename = "maxValue")]
    pub max_value: Option<f64>,
    #[serde(default, rename = "minStep")]
    pub min_step: Option<f64>,
    #[serde(default, rename = "maxLen")]
    pub max_len: Option<u64>,
}