From 6bb6d358f39c31b5486621b49da463f97226fea5 Mon Sep 17 00:00:00 2001 From: diogo464 Date: Tue, 9 Dec 2025 22:22:22 +0000 Subject: added README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7c773cb --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# embassy-ha + +Home Assistant MQTT device library for embassy. + +To create a device use the [`new`] function. +After the device is created you should create one or more entities using functions such as +[`create_button`]/[`create_sensor`]/... + +Once the entities have been created either [`run`] or [`connect_and_run`] should be called in a +seperate task. + +There are various examples you can run locally (ex: `cargo run --features tracing --example +button`) assuming you have a home assistant instance running. To run the examples the +environment variable `MQTT_ADDRESS` should be set to the mqtt server used by home assistant. + +License: MIT OR Apache-2.0 -- cgit