https://github.com/natekspencer/hacs-oasis_mini

Home Assistant integration for Oasis Mini kinetic sand art canvas devices.
https://github.com/natekspencer/hacs-oasis_mini

hacs hacs-custom home-assistant home-assistant-custom-component home-assistant-integration home-automation kinetic-oasis kinetic-sand kinetic-sand-art oasis-mini

Last synced: 2 months ago
JSON representation

Home Assistant integration for Oasis Mini kinetic sand art canvas devices.

• Host: GitHub
• URL: https://github.com/natekspencer/hacs-oasis_mini
• Owner: natekspencer
• License: mit
• Created: 2024-07-06T23:57:28.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T16:50:12.000Z (3 months ago)
• Last Synced: 2024-10-24T18:16:36.158Z (2 months ago)
• Topics: hacs, hacs-custom, home-assistant, home-assistant-custom-component, home-assistant-integration, home-automation, kinetic-oasis, kinetic-sand, kinetic-sand-art, oasis-mini
• Language: Python
• Homepage:
• Size: 103 KB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Release](https://img.shields.io/github/v/release/natekspencer/hacs-oasis_mini?style=for-the-badge)](https://github.com/natekspencer/hacs-oasis_mini/releases)

[![Buy Me A Coffee/Beer](https://img.shields.io/badge/Buy_Me_A_☕/🍺-F16061?style=for-the-badge&logo=ko-fi&logoColor=white&labelColor=grey)](https://ko-fi.com/natekspencer)

[![HACS Custom](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)

![Downloads](https://img.shields.io/github/downloads/natekspencer/hacs-oasis_mini/total?style=flat-square)

![Latest Downloads](https://img.shields.io/github/downloads/natekspencer/hacs-oasis_mini/latest/total?style=flat-square)

  

  

# 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):

   [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=natekspencer&repository=hacs-oasis_mini&category=integration)

   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](https://www.home-assistant.io/getting-started/configuration/#editing-configuration-via-sambawindows-networking), 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

[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=oasis_mini)

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](https://github.com/sponsors/natekspencer) or buying me a coffee ☕ (or beer 🍺) instead by using the link below: