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

//! This library aims to enable communicating with _Philips Hue_ lights via the correspnding Bridge.
//!
//! # Examples
//! A short overview of the most common use cases of this library.
//! ### Initial Setup
//! ```no_run
//! let bridge = hueclient::Bridge::discover_required()
//!     .register_user("mycomputer") // Press the bridge before running this
//!     .unwrap();
//! println!("the username was {}", bridge.username); // handy for later
//! ```
//! ### Second run
//! ```no_run
//! const USERNAME: &str = "the username that was generated in the previous example";
//! let bridge = hueclient::Bridge::discover_required()
//!    .with_user(USERNAME);
//! ```
//! ### Good night
//! ```no_run
//! # const USERNAME: &str = "the username that was generated in the previous example";
//! # let bridge = hueclient::Bridge::discover_required()
//! #   .with_user(USERNAME);
//! let cmd = hueclient::CommandLight::default().off();
//! for light in &bridge.get_all_lights().unwrap() {
//!     bridge.set_light_state(light.id, &cmd).unwrap();
//! }
//! ```

/// Represents any of the ways that usage of this library may fail.
#[derive(thiserror::Error, Debug)]
pub enum HueError {
    /// Returned when a network error occurs.
    #[error("An error occurred while performing an HTTP request")]
    Reqwest(#[from] reqwest::Error),
    /// Returned on a JSON failure, which will usually be a problem with deserializing the bridge
    /// response.
    #[error("An error occurred while manipulating JSON")]
    SerdeJson(#[from] serde_json::Error),
    /// Returned when discovery.meethue.com returns an invalid IP-address.
    #[error("An error occurred while parsing an address")]
    AddrParse(#[from] std::net::AddrParseError),
    /// Returned when the SSDP probe fails to scan the current network for a bridge.
    #[error("An error occurred during SSDP discovery")]
    SSDP(#[from] ssdp_probe::SsdpProbeError),
    /// Returned when the Bridge returns a response that does not confirm to the API spec.
    #[error("A protocol error occurred: {}", msg)]
    ProtocolError {
        /// An error message describing the failure.
        msg: String,
    },
    /// Returned when the Bridge returns an error response
    #[error("The bridge reported error code {}: {}", code, msg)]
    BridgeError {
        /// The error code.
        code: usize,
        /// An error message describing the failure.
        msg: String,
    },
    /// Returned when discovering a bridge in the local network fails.
    #[error("A discovery error occurred: {}", msg)]
    DiscoveryError {
        /// An error message describing the failure.
        msg: String,
    },
}

impl HueError {
    pub(crate) fn protocol_err(err: impl std::fmt::Display) -> Self {
        Self::ProtocolError {
            msg: err.to_string(),
        }
    }
}

/// A type alias used for convenience and consiceness throughout the library.
pub type Result<T> = std::result::Result<T, HueError>;

mod bridge;
mod command_parser;
mod disco;

pub use bridge::*;
pub use command_parser::*;