HACS support request

[hannesdelbeke]

would it be possible to add HACS support?
currently I don't understand the install step for home assistant

6) Optional -- Home Assistant integration

If you want to use Home Assistant to query and display the device status, paste the configuration fragment into your home assistant config.

where is this config? is it a file in the repo

link to docs on making a repo HACS compatible

[hannesdelbeke]

i found the config

MieleRESTServer/examples/homeassistant-configuration-fragment.yaml

Lines 1 to 27 in 662b649

	rest:
	- resource: http://[[YOUR_SERVER_IP_HERE]]:5001/generate-summary/washer
	scan_interval: 30
	sensor:
	- name: "washer"
	value_template: "{{ value_json.DecodedProgramPhase }}"
	json_attributes:
	- "Progress"
	- "DecodedProgramID"
	- "SignalDoor"
	- "Light"
	- "RemainingMinutes"
	- "ElapsedMinutes"
	- resource: http://[[YOUR_SERVER_IP_HERE]]:5001/generate-summary/dryer
	scan_interval: 30
	sensor:
	- name: "dryer"
	value_template: "{{ value_json.DecodedProgramPhase }}"
	json_attributes:
	- "Progress"
	- "DecodedProgramID"
	- "SignalDoor"
	- "Light"
	- "RemainingMinutes"
	- "ElapsedMinutes"

[hannesdelbeke]

i might try this with some copilot help. see how far i get.

---

What We're Building

We will turn the MieleRESTServer into an add-on for Home Assistant, so you can manage it through the Home Assistant interface without needing to use Docker commands.

---

1. Prepare Your Home Assistant Environment

• Access Add-Ons Directory:

  • If you haven’t already, enable "Advanced Mode" under your User Profile in Home Assistant.
  • Using File Editor, Samba Share, or SSH (whichever you're familiar with), navigate to the addons folder of your Home Assistant configuration.

  If it doesn’t exist, create it. For example:

  homeassistant/
  ├── addons/  <--- This is where we'll create the add-on folder
  

---

2. Create the Add-On Folder

Inside the addons directory:

• Create a folder named miele_rest_server.

  Your directory structure should look like:

  homeassistant/
  ├── addons/
      ├── miele_rest_server/
  

---

3. Add Configuration Files

In the miele_rest_server folder, we'll add three files:

i. config.json

This file tells Home Assistant how to manage the add-on. Create this file and add the content below:

{
  "name": "Miele REST Server",
  "description": "A REST server to integrate Miele devices with Home Assistant.",
  "version": "1.0",
  "slug": "miele_rest_server",
  "startup": "services",
  "arch": ["arm", "amd64", "i386"],
  "boot": "auto",
  "options": {},
  "schema": {},
  "ports": {
    "5001/tcp": 5001
  }
}

ii. Dockerfile

This file tells Docker how to take code from the MieleRESTServer and run it in a Home Assistant add-on.

Create this file and add the following from the MieleRESTServer repository:

FROM python:3.13-slim-bookworm

# Set working directory
WORKDIR /usr/src/app

# Copy files
COPY ./requirements.txt .
RUN pip install -r requirements.txt
COPY . .

# Run the server
CMD ["python3", "Server.py", "-b", "0.0.0.0", "-p", "5001"]

Explanation:

• requirements.txt specifies the Python packages to install.
• The CMD line starts the server on IP 0.0.0.0 (to make it accessible from your Home Assistant network) and port 5001.

Note: The Dockerfile we've added is already tailored to the MieleRESTServer. You shouldn't need to modify it unless you want to change ports/etc.

iii. (Optional) README.md

You can add notes about the add-on here. For now, leave it empty or write:

This add-on runs the MieleRESTServer to provide a REST interface for Home Assistant integration.

---

4. Build and Test the Add-On

Open the Home Assistant interface:

1. Navigate to Settings > Add-ons > Add-on Store.

2. Click on the ⋮ Menu (Top Right) and select Repositories.

3. Add your local folder as a repository by pasting in:

   /addons
   

4. Look for your "Miele REST Server" add-on in the list, install it, and hit Start.

---

5. Integrate It with Home Assistant

Use the Home Assistant YAML configuration to configure the sensors for the REST server.

Example:

rest:
  - resource: http://127.0.0.1:5001/generate-summary/washer
    scan_interval: 30
    sensor:
      - name: "Washer"
        value_template: "{{ value_json.DecodedProgramPhase }}"

---

This setup abstracts all the complexity. Now, you don’t need to touch Docker or its commands – everything from installation to starting the add-on is managed through Home Assistant. Let me know if something isn't clear, and I can guide you further!

[akappner]

Hi Hannes,

I have never used HACS, but I'm sure it's possible! Would you like to add HACS support? :) I would love to get a pull request from you that makes it easier to install on the offical Home Assistant OS!