OpenMotics HomeAssistant integration

Custom integration to control an OpenMotics platform via HomeAssistant

• INTRODUCTION
• HOW TO INSTALL
  • 1. Grant permissions to your OpenMotics installation
  • 2. Install Home Assistant Core
  • 3. Install the custom integration
  • 4. Configure the integration
• FREQUENTLY ASKED QUESTIONS
• CREDITS

INTRODUCTION

This custom component is developed for controlling an OpenMotics platform by using the cloud-sdk, officailly maintained by the OpenMotics Developer Team.

HOW TO INSTALL

1. Grant permissions to your OpenMotics installation

Login to cloud.openmotics.com

Remember to use your e-mail address as login.

Make sure your installation is at a recent firmware. Update if needed.

Create an additional user

Make sure the Client type is Confidential and the Grant type is Client credentials. The Redirect URI is not used right now and can have any value.

Copy the Client ID and Client secret as you'll need it to configure the integration in Home Assistant.

2. Install Home Assistant Core

See Home Assistant Official Installation Guide to install Home Assistant Core.

3. Install the custom integration

!!! HACS will be added in a later phase, please copy the custom_components folder for now !!!

Option 1: Copy Method

1. Download the openmotics-home-assistant repo.

2. Unzip it and copy the custom_components/openmotics folder to the Home Assistant configuration directory, for example ~/.homeassistant.

   

   The disadvantage of a manual installation is that you won't be notified about updates.

Option 2: HACS installation

1. See HACS Official Installation Guide and install HACS.

2. See Initial Configuration Guide and complete initial configuration.

3. Open Home Assistant. Click HACS > Integrations > ⋮ > Custom repositories.

   

4. Enter https://github.com/openmotics/home-assistant.git in the address bar at the bottom left of the window. Select Integration from the Category list and click ADD.

   

5. In the dialog box that appears, click INSTALL.

   

4. Configure the integration.

Make sure you restart Home Assistant after the installation (in HACS). After the restart, go to Configuration in the side menu in Home Assistant and select Integrations. Click on Add Integrations in the bottom right corner and search for Openmotics to install. This will open the configuration menu with the default settings.

Fill in the user_id and secret_id you have created in the first step.

Depending on your installation, the modules should be added to your Home Assistant automatically within a few seconds till 10 minutes.