hap-model 1.0.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

//! HomeKit accessory attribute database — Milestone 6 of `hap-rust`.
//!
//! `hap-model` is transport-agnostic. It parses the `/accessories` JSON into
//! a typed [`Accessory`] → [`Service`] → [`Characteristic`] tree and builds /
//! parses the `/characteristics` request and response bodies. It never touches
//! the network: the controller (`hap-controller`, M7) executes the requests
//! this crate produces over a secure session.
//!
//! # Example
//!
//! ```
//! use hap_model::parse_accessories;
//!
//! let body = br#"{"accessories":[{"aid":1,"services":[
//!     {"iid":1,"type":"3E","characteristics":[
//!         {"iid":2,"type":"23","format":"string","perms":["pr"],"value":"Lamp"}
//!     ]}
//! ]}]}"#;
//! let accessories = parse_accessories(body).unwrap();
//! assert_eq!(accessories[0].aid, 1);
//! ```
//!
//! The doc-test uses `unwrap()`; real library code must propagate the
//! [`Result`] instead.

#![forbid(unsafe_code)]

pub mod database;
pub mod error;
pub mod format;
pub mod perms;
pub mod tree;
pub mod uuid;

mod accessories;
mod characteristics;
mod generated;

pub use accessories::parse_accessories;
pub use characteristics::{
    build_read_request, build_subscribe_request, build_write_request, parse_read_response, CharRead,
};
pub use database::{AccessoryDatabase, Request, RequestExecutor};
pub use error::{ModelError, Result};
pub use format::{CharFormat, CharValue};
pub use generated::{CharacteristicType, ServiceType};
pub use perms::Perms;
pub use tree::{Accessory, Characteristic, Service};
pub use uuid::Uuid;