From 5e53e48156d8f1d5e2899fbab965fb0629916fc0 Mon Sep 17 00:00:00 2001 From: Wesley Moore Date: Wed, 17 Jan 2024 21:41:02 +1000 Subject: [PATCH] Add README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a46be2 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +esphome-proto +============= + +[ESPHome native API][native-api] protocol data structures generated from +[protobuf files] in [the Python client][aioesphomeapi]. + +## Regenerating + +In order to avoid each consumer of this crate having to regenerate the Rust +source and pull in build-time dependencies on the protobuf code generator the +generated files are committed into this repository. + +To regenerate the files run `make codegen`. + +[native-api]: https://esphome.io/components/api.html +[protobuf files]: https://github.com/esphome/esphome/blob/dev/esphome/components/api/api.proto +[aioesphomeapi]: https://github.com/esphome/aioesphomeapi