https://github.com/frklan/homekit-esp32-fan
A homekit accessory
https://github.com/frklan/homekit-esp32-fan
Last synced: 12 months ago
JSON representation
A homekit accessory
- Host: GitHub
- URL: https://github.com/frklan/homekit-esp32-fan
- Owner: frklan
- License: other
- Created: 2020-12-06T16:03:23.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2020-12-06T16:07:55.000Z (over 5 years ago)
- Last Synced: 2025-03-15T02:16:37.111Z (over 1 year ago)
- Language: C
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Homekit Fan
A very basic test of the [Homekit SDK](https://github.com/espressif/esp-homekit-sdk). I broke out the Fan example from the Homekit SDK to it's own directory and setup the SDK as a component.
Currently the app will only flash a LED when the Fan is operated, I mostly used it to test out the SDK and understand how to build a Homekit accessory.
## Compiling
### Prerequisites
- [ESP-IDF](https://github.com/espressif/esp-idf)
- [Homekit SDK](https://github.com/espressif/esp-homekit-sdk)
- NodeMCU ESP32
Set the environment variable HOMEKIT_PATH ```HOMEKIT_PATH``` to the base path of the Homekit SDK.
## Building
As long as you have the ESP-IDF and Homekit SDK installed and a NodeMCU ESP32 connected, building and running this should be pretty straight formward, just do ```idf.py build flash monitor``` in the root folder.
The Homekit accessory needs to be provisioned onto your WIFI-net according to the instructions [here](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/provisioning/provisioning.html#provisioning-tools). After that it should be possible to add the accessory to the Home app.
## Contributing
Contributions are always welcome!
When contributing to this repository, please first discuss the change you wish to make via the issue tracker, email, or any other method with the owner of this repository before making a change.
Please note that we have a code of conduct, you are required to follow it in all your interactions with the project.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/frklan/[TBD]/tags).
## Authors
* **Fredrik Andersson** - [frklan](https://github.com/frklan)
## License
This project is licensed under the CC BY-NC-SA License - see the [LICENSE](LICENSE) file for details
For commercial/proprietary licensing, please contact the project owner