Mycodo App Home Assistant Integration
Overview
This integration allows you to connect and control your Mycodo App with Home Assistant.
Installation
Install with HACS (Recommended)
- Add the URL to this repository as a custom integration in HACS.
- Search for "Mycodo App Integration" and install it.
- Restart Home Assistant.
Manual Installation
- Open the directory for your Home Assistant configuration (where you find
configuration.yaml
).
- If you do not have a
custom_components
directory there, create it.
- In the
custom_components
directory, create a new folder called mycodo
.
- Download all the files from the
custom_components/mycodo/
directory in this repository.
- Place the downloaded files in the newly created
mycodo
directory.
- Restart Home Assistant.
- In the Home Assistant UI, go to "Configuration" -> "Integrations" and click "+" to add a new integration.
- Search for "Mycodo App" and follow the on-screen instructions.
Obtaining the Token
To integrate your Mycodo App with Home Assistant, you need an API token. Follow these steps to obtain the token:
- Log in to your Mycodo App.
- Click on the "Settings" button.
- Navigate to "Configure".
- Go to "Users" in the side menu.
- In the "Users" section, click on the "Generate API Key" button.
- Copy the generated token and keep it secure.
<img
src='images/get_token.png'
width='1000pt'
/>
Once you have the token, you can configure the integration in Home Assistant by providing the token during the setup process.
Configuration
- In Home Assistant, go to "Configuration" -> "Integrations".
- Select "Mycodo App" and enter the following details:
- IP Address: Enter the IP address of your Mycodo App.
- API Token: Enter the API token you obtained earlier.
- App Name: Enter a name for your Mycodo App.
- Protocol: Select whether your app uses
HTTP
or HTTPS
(default is HTTPS
).
- Complete the configuration by following the on-screen instructions.
For more detailed instructions, refer to the documentation in this repository.
Support
If you encounter any issues or have questions, please open an issue in this repository.