generated from ludeeus/integration_blueprint
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
48 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,52 +1,48 @@ | ||
| # Doorking 1812AP HACS Integration | ||
|
|
||
| Small module controlling a Doorking 1812AP via ethernet | ||
|
|
||
| # Notice | ||
|
|
||
| The component and platforms in this repository are not meant to be used by a | ||
| user, but as a "blueprint" that custom component developers can build | ||
| upon, to make more awesome stuff. | ||
|
|
||
| HAVE FUN! 😎 | ||
|
|
||
| ## Why? | ||
|
|
||
| This is simple, by having custom_components look (README + structure) the same | ||
| it is easier for developers to help each other and for users to start using them. | ||
|
|
||
| If you are a developer and you want to add things to this "blueprint" that you think more | ||
| developers will have use for, please open a PR to add it :) | ||
|
|
||
| ## What? | ||
|
|
||
| This repository contains multiple files, here is a overview: | ||
|
|
||
| | File | Purpose | Documentation | | ||
| | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | ||
| | `.devcontainer.json` | Used for development/testing with Visual Studio Code. | [Documentation](https://code.visualstudio.com/docs/remote/containers) | | ||
| | `.github/ISSUE_TEMPLATE/*.yml` | Templates for the issue tracker | [Documentation](https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository) | | ||
| | `.vscode/tasks.json` | Tasks for the devcontainer. | [Documentation](https://code.visualstudio.com/docs/editor/tasks) | | ||
| | `custom_components/integration_blueprint/*` | Integration files, this is where everything happens. | [Documentation](https://developers.home-assistant.io/docs/creating_component_index) | | ||
| | `CONTRIBUTING.md` | Guidelines on how to contribute. | [Documentation](https://help.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors) | | ||
| | `LICENSE` | The license file for the project. | [Documentation](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository) | | ||
| | `README.md` | The file you are reading now, should contain info about the integration, installation and configuration instructions. | [Documentation](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) | | ||
| | `requirements.txt` | Python packages used for development/lint/testing this integration. | [Documentation](https://pip.pypa.io/en/stable/user_guide/#requirements-files) | | ||
|
|
||
| ## How? | ||
|
|
||
| 1. Create a new repository in GitHub, using this repository as a template by clicking the "Use this template" button in the GitHub UI. | ||
| 1. Open your new repository in Visual Studio Code devcontainer (Preferably with the "`Dev Containers: Clone Repository in Named Container Volume...`" option). | ||
| 1. Rename all instances of the `integration_blueprint` to `custom_components/<your_integration_domain>` (e.g. `custom_components/awesome_integration`). | ||
| 1. Rename all instances of the `Integration Blueprint` to `<Your Integration Name>` (e.g. `Awesome Integration`). | ||
| 1. Run the `scripts/develop` to start HA and test out your new integration. | ||
|
|
||
| ## Next steps | ||
|
|
||
| These are some next steps you may want to look into: | ||
|
|
||
| - Add tests to your integration, [`pytest-homeassistant-custom-component`](https://github.com/MatthewFlamm/pytest-homeassistant-custom-component) can help you get started. | ||
| - Add brand images (logo/icon) to https://github.com/home-assistant/brands. | ||
| - Create your first release. | ||
| - Share your integration on the [Home Assistant Forum](https://community.home-assistant.io/). | ||
| - Submit your integration to [HACS](https://hacs.xyz/docs/publish/start). | ||
| # Doorking 1812AP | ||
|
|
||
| [![GitHub Release][releases-shield]][releases] | ||
| [![GitHub Activity][commits-shield]][commits] | ||
| [![License][license-shield]](LICENSE) | ||
|
|
||
| ![Project Maintenance][maintenance-shield] | ||
|
|
||
| [![Discord][discord-shield]][discord] | ||
| [![Community Forum][forum-shield]][forum] | ||
|
|
||
| This component only works with the Doorking 1812AP with an ethernet connection. | ||
| It connects to the Doorking over ethernet to get the status and open/close the gate. | ||
| I sniffed the traffic from the windows client to reverse "engineer" the protocol. | ||
|
|
||
| **This integration will set up the following platforms.** | ||
|
|
||
| | Platform | Description | | ||
| | -------- | ----------------------------------- | | ||
| | `switch` | Opens (on) or closes (off) the gate | | ||
|
|
||
| ## Installation | ||
|
|
||
| Manual Installation. To control your installation yourself, download the doorking-ha repo, and then copy the `custom_components/doorking_1812ap` directory into a corresponding `custom_components/doorking_1812ap` within your Home Assistant configuration directory. Then restart Home Assistant. | ||
|
|
||
| ## Configuration is done in the UI | ||
|
|
||
| <!----> | ||
|
|
||
| ## Contributions are welcome! | ||
|
|
||
| If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md) | ||
|
|
||
| --- | ||
|
|
||
| [integration_blueprint]: https://github.com/cameronr/doorking-ha | ||
| [buymecoffee]: https://www.buymeacoffee.com/ludeeus | ||
| [commits-shield]: https://img.shields.io/github/commit-activity/y/cameronr/doorking-ha.svg?style=for-the-badge | ||
| [commits]: https://github.com/cameronr/doorking-ha/commits/main | ||
| [discord]: https://discord.gg/Qa5fW2R | ||
| [discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge | ||
| [exampleimg]: example.png | ||
| [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge | ||
| [forum]: https://community.home-assistant.io/ | ||
| [license-shield]: https://img.shields.io/github/license/cameronr/doorking-ha.svg?style=for-the-badge | ||
| [maintenance-shield]: https://img.shields.io/badge/maintainer-Cameron%20Ring%20%40cameronr-blue.svg?style=for-the-badge | ||
| [releases-shield]: https://img.shields.io/github/release/cameronr/doorking-ha.svg?style=for-the-badge | ||
| [releases]: https://github.com/cameronr/doorking-ha/releases |
This file was deleted.
Oops, something went wrong.