esphome-client 0.1.5

#![doc(
    html_logo_url = "https://avatars.githubusercontent.com/u/91469139?s=128",
    html_favicon_url = "https://avatars.githubusercontent.com/u/91469139?s=256"
)]
#![cfg_attr(any(doc, test), doc = include_str!("../README.md"))]
#![cfg_attr(not(any(doc, test)), doc = env!("CARGO_PKG_NAME"))]
#![deny(nonstandard_style, rustdoc::all, trivial_casts, trivial_numeric_casts)]
#![forbid(non_ascii_idents, unsafe_code)]
#![deny(
    clippy::cfg_not_test,
    clippy::dbg_macro,
    clippy::empty_drop,
    clippy::equatable_if_let,
    clippy::empty_structs_with_brackets,
    clippy::empty_enum_variants_with_brackets,
    clippy::exit,
    clippy::todo,
    clippy::unwrap_used
)]
#![warn(
    clippy::absolute_paths,
    clippy::as_conversions,
    clippy::allow_attributes_without_reason,
    clippy::as_pointer_underscore,
    clippy::as_ptr_cast_mut,
    clippy::assertions_on_result_states,
    clippy::branches_sharing_code,
    clippy::clear_with_drain,
    clippy::clone_on_ref_ptr,
    clippy::collection_is_never_read,
    clippy::create_dir,
    clippy::debug_assert_with_mut_call,
    clippy::default_union_representation,
    clippy::derive_partial_eq_without_eq,
    clippy::doc_include_without_cfg,
    clippy::fallible_impl_from,
    clippy::filetype_is_file,
    clippy::float_cmp_const,
    clippy::fn_to_numeric_cast_any,
    clippy::get_unwrap,
    clippy::if_then_some_else_none,
    clippy::implicit_clone,
    clippy::imprecise_flops,
    clippy::infinite_loop,
    clippy::iter_on_empty_collections,
    clippy::iter_on_single_items,
    clippy::iter_over_hash_type,
    clippy::iter_with_drain,
    clippy::large_include_file,
    clippy::large_stack_frames,
    clippy::let_underscore_untyped,
    clippy::literal_string_with_formatting_args,
    clippy::lossy_float_literal,
    clippy::map_err_ignore,
    clippy::map_with_unused_argument_over_ranges,
    clippy::mem_forget,
    clippy::missing_assert_message,
    clippy::missing_const_for_fn,
    clippy::module_name_repetitions,
    clippy::multiple_inherent_impl,
    clippy::multiple_unsafe_ops_per_block,
    clippy::mutex_atomic,
    clippy::mutex_integer,
    clippy::needless_collect,
    clippy::needless_pass_by_ref_mut,
    clippy::needless_raw_strings,
    clippy::non_zero_suggestions,
    clippy::nonstandard_macro_braces,
    clippy::option_if_let_else,
    clippy::or_fun_call,
    clippy::panic_in_result_fn,
    clippy::partial_pub_fields,
    clippy::pathbuf_init_then_push,
    clippy::pedantic,
    clippy::precedence_bits,
    clippy::pub_without_shorthand,
    clippy::rc_buffer,
    clippy::rc_mutex,
    clippy::read_zero_byte_vec,
    clippy::redundant_clone,
    clippy::redundant_type_annotations,
    clippy::renamed_function_params,
    clippy::ref_patterns,
    clippy::rest_pat_in_fully_bound_structs,
    clippy::return_and_then,
    clippy::same_name_method,
    clippy::semicolon_inside_block,
    clippy::set_contains_or_insert,
    clippy::shadow_unrelated,
    clippy::significant_drop_in_scrutinee,
    clippy::significant_drop_tightening,
    clippy::str_to_string,
    clippy::string_add,
    clippy::string_lit_as_bytes,
    clippy::string_lit_chars_any,
    clippy::string_slice,
    clippy::suboptimal_flops,
    clippy::suspicious_operation_groupings,
    clippy::suspicious_xor_used_as_pow,
    clippy::tests_outside_test_module,
    clippy::too_long_first_doc_paragraph,
    clippy::trailing_empty_array,
    clippy::transmute_undefined_repr,
    clippy::trivial_regex,
    clippy::try_err,
    clippy::undocumented_unsafe_blocks,
    clippy::unimplemented,
    clippy::uninhabited_references,
    clippy::unnecessary_safety_comment,
    clippy::unnecessary_safety_doc,
    clippy::unnecessary_self_imports,
    clippy::unnecessary_struct_initialization,
    clippy::unused_peekable,
    clippy::unused_result_ok,
    clippy::unused_trait_names,
    clippy::unwrap_in_result,
    clippy::use_debug,
    clippy::use_self,
    clippy::useless_let_if_seq,
    clippy::verbose_file_reads,
    clippy::while_float,
    ambiguous_negative_literals,
    closure_returning_async_block,
    future_incompatible,
    impl_trait_redundant_captures,
    let_underscore_drop,
    macro_use_extern_crate,
    meta_variable_misuse,
    missing_copy_implementations,
    missing_debug_implementations,
    missing_docs,
    redundant_lifetimes,
    rust_2018_idioms,
    single_use_lifetimes,
    unit_bindings,
    unnameable_types,
    unreachable_pub,
    unstable_features,
    unused,
    variant_size_differences
)]

mod client;
#[cfg(feature = "discovery")]
/// Module for discovering ESPHome devices on the local network, only available with the "discovery" feature.
pub mod discovery;
/// Error types for the library.
pub mod error;
mod proto;

pub use client::{EspHomeClient, EspHomeClientBuilder, EspHomeClientWriteStream};
/// Re-export of types that can be used with the ESPHome API.
pub mod types {
    pub use super::proto::*;
}
pub use proto::API_VERSION;

/// This is a helper function to convert GATT UUIDs from the format used in ESPHome: [u64, u64] to a byte array.
///
/// # Errors
///
/// Will return error if uuid is not exactly 2 u64 values.
pub fn convert_gatt_uuid(uuid: &[u64]) -> Result<Vec<u8>, &'static str> {
    if uuid.len() != 2 {
        return Err("UUID must be exactly 2 u64 values");
    }
    let high = uuid[0];
    let low = uuid[1];
    Ok([high.to_be_bytes(), low.to_be_bytes()].concat())
}

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

    #[test]
    fn test_convert_gatt_uuid_valid() {
        let uuid = [0x1122_3344_5566_7788, 0x99aa_bbcc_ddee_ff00];
        let result = convert_gatt_uuid(&uuid).unwrap();
        let expected = [
            0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee,
            0xff, 0x00,
        ];
        assert_eq!(result, expected);
    }

    #[test]
    fn test_convert_gatt_uuid_invalid_length_empty() {
        let uuid: [u64; 0] = [];
        assert_eq!(
            convert_gatt_uuid(&uuid),
            Err("UUID must be exactly 2 u64 values")
        );
    }

    #[test]
    fn test_convert_gatt_uuid_invalid_length_one() {
        let uuid = [0x1234_5678_9abc_def0];
        assert_eq!(
            convert_gatt_uuid(&uuid),
            Err("UUID must be exactly 2 u64 values")
        );
    }

    #[test]
    fn test_convert_gatt_uuid_invalid_length_three() {
        let uuid = [1, 2, 3];
        assert_eq!(
            convert_gatt_uuid(&uuid),
            Err("UUID must be exactly 2 u64 values")
        );
    }
}