IRIS Home Assistant Add-On (HAOS)

InterSystems IRIS Community Edition HAOS Add-On

Run InterSystems IRIS inside of Home Assistant, as an add-on.  Before you dismiss this article possibly under the guise that this is just a gimmick, Id like you to step back and take a look at how easy it is to launch IRIS based applications using this platform.  If you look at Open Exchange, you will see dozens of dozens of applications worthy of launching while they are basically hung out to dry as gitware, and launchable if you want to get into a laptop battle with containerd or Docker.  With a simple git repo, and a specification, you can now build your app on IRIS, and make it launchable through a marketplace with limited hassle to your end users.  Run it along side Ollama and the LLM/LAM implementations, expose anything in IRIS as a sensor or expose an endpoint for interaction in your IRIS app to interact with anything you've connected to HAOS.  Wanna restart an IRIS production with a flick of a physical switch or Assisted AI? You can do it with this add-on, or your own, right alongside the home automation hackers.

Getting Started

We're Running HAOS, and we have checked the about box and confirmed our installation method to be "Home Assistant OS".

Installation

For Home Assistant OS, follow these steps:

• Add the repository to the Add On Store.
• Restart the Supervisor.
• Search for "InterSystems IRIS Community Add-ons" and install and start it.
• Launch the System Management Portal.

Add Repository

The repo for the iris-haos add-on is: 

https://github.com/sween/iris-haos

Navigate to the Add On Store and hit the three dots on the right upper corner and select "repositories"

Click add and close the dialog.

Restart the Supervisor

From the haos cli/shell, run:

ha addons reload

Back in the Add Ons store, you should IRIS listed and available.

Select the Add-On, Install and Start it.

You can post configure the port specifications or add new ones to your application, this one is just setup for the SMP.

The log should show an all too familiar output from messages.log from the container.

Next, select hit the "Open Web UI" Button, and we should be in business with IRIS running on HAOS!

This is made possible by the "network_mode": "host" directive in the add on, which will allow the ports to be exposed to the haos host.

Extra Credit

Scrape a metric from IRIS and display it in HAOS.

Add the following to your `configuration.yaml`:

sensor:
  - platform: rest
    name: iris_log_reads_per_sec
    resource: http://127.0.0.1:52773/api/monitor/metrics
    value_template: >
      {% set lines = value.split('\n') %}
      {% for line in lines %}
        {% if line.startswith('iris_log_reads_per_sec ') %}
          {{ line.split()[-1] }}
        {% endif %}
      {% endfor %}

for some reason, I had to restart the core to enable the sensor.

ha core restart

HAOS sensors can be built with simple rest calls, so here we are scraping the iris prometheus metrics api running on the iris add on inside HAOS.

Now that its a sensor, you can add it to dashboard, do automation based on its values, expose it to Ambient AI, automate away!

So the detail is in the github repo, but Im here to tell you it isnt much, take a peak in the repo, clone it or check it out on Open Exchange, but with a pair of files, and a container, you can build your own add ons too.

Here is the config:

{
  "name": "InterSystems IRIS Health Community (HAOS)",
  "version": "0.1.1",
  "slug": "irishealth",
  "description": "Runs InterSystems IRIS Health Community as a Home Assistant add-on",
  "startup": "services",
  "boot": "auto",
  "arch": ["amd64", "aarch64"],
  "ports": { "1972/tcp": 1972, "52773/tcp": 52773 },
  "icon": "https://raw.githubusercontent.com/sween/iris-haos/main/irishealth/icon.png",
  "options": {
    "endpoint": "http://localhost:52773/csp/sys/UtilHome.csp"
  },
  "schema": {
    "endpoint": "str"
  },
  "webui": "http://[HOST]:[PORT:52773]/csp/sys/UtilHome.csp"
}

Here is the Dockerfile:

FROM containers.intersystems.com/intersystems/irishealth-community:2025.1

Cheers!