Oasis Mini for Home Assistant

Home Assistant integration for Oasis Mini kinetic sand art devices.

Installation

There are two main ways to install this custom component within your Home Assistant instance:

1. Using HACS (see https://hacs.xyz/ for installation instructions if you do not already have it installed):

   

   1. Use the convenient My Home Assistant link above, or, from within Home Assistant, click on the link to HACS
   2. Click on Integrations
   3. Click on the vertical ellipsis in the top right and select Custom repositories
   4. Enter the URL for this repository in the section that says Add custom repository URL and select Integration in the Category dropdown list
   5. Click the ADD button
   6. Close the Custom repositories window
   7. You should now be able to see the Oasis Mini card on the HACS Integrations page. Click on INSTALL and proceed with the installation instructions.
   8. Restart your Home Assistant instance and then proceed to the Configuration section below.

2. Manual Installation:

   1. Download or clone this repository
   2. Copy the contents of the folder custom_components/oasis_mini into the same file structure on your Home Assistant instance
      • An easy way to do this is using the Samba add-on, but feel free to do so however you want
   3. Restart your Home Assistant instance and then proceed to the Configuration section below.

While the manual installation above seems like less steps, it's important to note that you will not be able to see updates to this custom component unless you are subscribed to the watch list. You will then have to repeat each step in the process. By using HACS, you'll be able to see that an update is available and easily update the custom component.

Configuration

There is a config flow for this Oasis Mini integration. After installing the custom component, use the convenient My Home Assistant link above.

Alternatively:

1. Go to Configuration->Integrations
2. Click + ADD INTEGRATION to setup a new integration
3. Search for Oasis Mini and click on it
4. You will be guided through the rest of the setup process via the config flow

Options

After this integration is set up, you can configure the integration to connect to the Kinetic Oasis cloud API. This will allow pulling in certain details (such as track name and image) that are otherwise not available.

---

Support Me

I'm not employed by Kinetic Oasis, and provide this custom component purely for your own enjoyment and home automation needs.

If you already own an Oasis Mini, found this integration useful and want to donate, consider sponsoring me on GitHub or buying me a coffee ☕ (or beer 🍺) instead by using the link below: