Repository navigation
Home
Welcome! Everything you need to use rusteero, the async Rust client for the Eero mesh Wi-Fi
cloud API — a port of the Python eero-api
library at v8.4.1.
| Page | What you'll learn |
|---|---|
| 📖 Rust API | The Client → EeroApi → Transport layers, builder options, every domain accessor, caching, network targeting, errors |
| ⚙️ Configuration |
Session sources, credential stores and the schema-2 record, transport options, logging |
| 🔧 Troubleshooting | 401s, premium gating, local validation errors, writes that return 200 and change nothing, keyring on headless Linux |
| 🔀 Migration | Upgrading from rusteero 2.x to 3.0.0, and from 1.0.0 to 2.0.0 |
[dependencies]
rusteero = "3"📦 Build from source
git clone https://github.com/fulviofreitas/rusteero.git
cd rusteero
cargo build
cargo test --all-featuresuse rusteero::auth::flow::LoginFlow;
use rusteero::Client;
use std::io::Write;
#[tokio::main]
async fn main() -> Result<(), rusteero::Error> {
let pending = LoginFlow::new(None)?.start("you@example.com").await?;
print!("Code: ");
std::io::stdout().flush().ok();
let mut code = String::new();
std::io::stdin().read_line(&mut code).ok();
let session = pending.verify(code.trim()).await?;
// ClientBuilder::build is async: it may load a stored session from a configured
// CredentialStore.
let client = Client::builder().session(Some(session)).build().await?;
let networks = client.get_networks(false).await?; // raw {meta, data} envelope
for n in networks.data()["networks"].as_array().into_iter().flatten() {
println!("📶 {}: {}", n["name"], n["status"]);
}
Ok(())
}Client cache + network-id resolution + parent envelopes (eero-api: EeroClient)
└─ EeroApi 37 domain accessors over one shared transport (eero-api: EeroAPI)
└─ Transport headers, credential placement, status → Error, refresh-and-replay
- Every endpoint returns
Result<Envelope, Error>over the untouched{"meta": …, "data": …}wire payload (clear_profile_schedulereturns one envelope per deleted pause). - Method names are the Python names verbatim, in
snake_case, so a method can be searched for by name across both libraries. - Every resource argument accepts a bare id, an API path or an absolute API-host URL; domain
methods take a
parentenvelope wherever the Python method accepts one (parent=, or a cached envelope in place of the id), so the request follows the link the API published. - Errors are classified against the API's closed catalogue of
meta.errorstrings; every error carrieserror_code(),envelope()and, when a response produced it,status()(a server-sideValidationexcepted). - Every request carries the current Eero iOS app's
User-Agent(eero-ios/2026.8.1 (iPhone; iOS 18.5)), which the API reads to decide which capabilities to advertise;consts::LEGACY_USER_AGENTrestores the previous one.
| Resource | URL |
|---|---|
| 📦 crates.io | https://crates.io/crates/rusteero |
| 📦 GitHub | fulviofreitas/rusteero |
| 🐛 Issues | Report a bug |
| 📋 Changelog | CHANGELOG.md |
| ✅ Parity | PARITY.md |
| 🐍 Python original | eero-api |
rusteero is a Rust port of eero-api by
@fulviofreitas, which is itself a modern revamp of the
original eero-client by
@343max. The Rust login/verify handshake was cross-checked
against eero-rs by @ssnover,
an earlier Rust adaptation of the same original client. No code was copied from any of
them — the designs, endpoint tables and behaviours are derived from eero-api, whose MIT
notice is reproduced in the repository's
NOTICE file. eero-rs carries
no licence and was consulted as a reference only.
What's new (relative to eero-api):
- Native async Rust on
tokio+reqwest(rustls), no Python runtime - Same raw
{meta, data}JSON contract, plus anEnvelopehelper (meta(),data(),data_as::<T>(),into_value()) - Interactive email/SMS code flow separated from the client (
LoginFlow→PendingLogin→Session), so headless and CI consumers can inject a pre-obtained session token - Pluggable
CredentialStoretrait: system keyring (optional feature), file, memory, chained, or your own; the persisted record is the same JSON record aseero-api's, so a session created byeeroctlworks unchanged - Session tokens are
SecretStrings and never appear inDebugoutput, logs or error messages - Storage failures surface as a typed
StorageErrorwith aWarn/Fatalpolicy, instead of being swallowed; a write the store accepted but did not keep isStorageError::NotRetained - Every wire endpoint is a route constant, so upstream API drift is a one-line fix
- Path segments and link values are validated before a URL is built, and the credential is withheld from any request that would leave the configured API origin (scheme, host and port)
Unofficial Project: This library uses reverse-engineered APIs and is not affiliated with or endorsed by Eero or Amazon.
Amazon Login Limitation: If your Eero account uses Amazon for login, this library may not work directly due to API limitations. See Troubleshooting for the workaround.
- Use the sidebar to navigate between pages
- Code blocks have a copy button
- Each page has a table of contents