solaredge/lib.rs
1//! # Asynchronous SolarEdge API client for Rust
2//!
3//! Enables access to the SolarEdge equipment [API](https://www.solaredge.com/sites/default/files/se_monitoring_api.pdf)
4//! (solar panels, inverters, meters) with the nice typed Rust interface.
5//!
6//! The library requires an HTTP client but is client-agnostic. You can use any client that implements
7//! [`HttpClientAdapter`](https://docs.rs/http-adapter/*/http_adapter/trait.HttpClientAdapter.html) trait.
8//! Check [http-adapter-reqwest](https://crates.io/crates/http-adapter-reqwest) for an implementation based
9//! on [reqwest](https://crates.io/crates/reqwest).
10//!
11//! Sample usage with [http-adapter-reqwest](https://crates.io/crates/http-adapter-reqwest):
12//! ```
13//! use solaredge::{Client, SitesList, SortOrder, FilterSiteStatus};
14//! use http_adapter_reqwest::ReqwestAdapter;
15//!
16//! async fn run() -> Result<(), Box<dyn std::error::Error>> {
17//! let client = Client::<ReqwestAdapter>::new("API_KEY");
18//! let version = client.version_current().await?;
19//! let mut p = SitesList::default();
20//! p.size = Some(32);
21//! p.sort_order = Some(SortOrder::Ascending);
22//! p.status = Some(&[FilterSiteStatus::Active, FilterSiteStatus::Pending]);
23//! let sites = client.sites_list(&p).await?;
24//! Ok(())
25//! }
26//! ```
27
28pub use api::enums::*;
29pub use api::request::*;
30pub use api::response;
31pub use client::Client;
32pub use error::Error;
33
34pub mod api;
35pub mod client;
36mod error;