Skip to content

nidble/minim_alarm

Repository files navigation

🍄 Minim Alarm

hacs release downloads

Buy Me A Coffee

What is Minim Alarm ?

Minim Alarm is a custom component to connect your Minim Alarm with Home Assistant.

Minim Alarm target is to provide you with all the sensors and the Alarm control panel of Home Assistant needed to manager your system.

Features

  • List all the Binary Sensors expsosed by Minim
  • Create your Alarm control panel using your custom scenarios
  • Manage the configuration via GUI

Installation

HACS

Minim Alarm is installable via HACS (Home Assistant Community Store) adding the name of the repo to the custom repo. If you want to try and add a custom repository to HACS do the following:

three dots

  1. Click on the 3 dots in the top right corner.
  2. Select "Custom repositories"
  3. Add the URL to the repository ( https://github.com/nidble/minim_alarm/ ).
  4. Select the correct type (Integration).
  5. Click the "ADD" button.

three dots

Manual

  1. Download the custom component files: Download the necessary files for the custom component. In this case the latest release of this component: https://github.com/nidble/minim_alarm/releases/latest

  2. Place the files in your Home Assistant configuration directory: Move the downloaded folder into your Home Assistant's custom_components directory.

    • If it doesn't exist, create it within your main Home Assistant configuration directory.
    • The final file structure should look something like this:
      <config directory>
      └── custom_components
          └── minim_alarm
              └──  __init__.py
                  └── sensor.py
                  └── ... other files
      
  3. Restart Home Assistant: Restart Home Assistant to load the new custom component.

Configuration

  1. Go to the integration dashboard and search inim (or click here): add integration

  2. Click on add integration

  3. Fill the popup with all the informations.

authentication

  1. Add the panel to the panels

authentication

Note: The client ID can be anything from "homeassistant" to an UUID, just do not include special characters or spaces.

To gather the DeviceID follow the steps here

Discover your device ID

To discover your device ID you can use the method MinimCloud.get_devices_list from pyMinim library. To do so you can use the script in the tool path following the example:

Install the requirements:

git clone https://github.com/nidble/pyinim
cd pyinim
python -m venv venv
source venv/bin/activate
pip install -r tools/requirements.txt

List the devices id:

python tools/inim_cli.py --username <YOUR_INIM_USERNAME> --password <YOUR_INIM_PASSWORD> --list deviceid

List the scenarios id:

python tools/inim_cli.py --username <YOUR_INIM_USERNAME> --password <YOUR_INIM_PASSWORD> --list scenarios

List the areas id:

python tools/inim_cli.py --username <YOUR_INIM_USERNAME> --password <YOUR_INIM_PASSWORD> --list areas

Test

pip install virtualenv  # (if you don't already have virtualenv installed, see https://virtualenv.pypa.io/en/latest/installation.html)
virtualenv venv # to create your new environment (called 'venv' here)
source venv/bin/activate # to enter the virtual environment
pip install -r requirements.test.txt

Disclaimer

This project has no relation with the Inim company.

This integration is using python module pyinim which is an unofficial module for achieving interoperability with Inim APIs.

Author is in no way affiliated with Inim.

All the api requests used within the pyinim library are available and published on the internet (examples linked above) and the pyinim module is purely just a wrapper around those https requests.

Author does not guarantee functionality of this integration and is not responsible for any damage.

All product names, trademarks and registered trademarks in this repository, are property of their respective owners.