Table of Contents

Software installation manual

The MitsuRunner source code can be downloaded here: https://github.com/VeliML/MitsuRunner/

ESPHome Installation Guide (Windows)

Install ESPHome Development Environment on a Windows Machine

Additional instructions can be found here: https://www.esphome.io/guides/getting_started_hassio.html

⇒ ESPHome will be installed (you can ignore any WARNINGs that may occur during installation). Now the development environment is on your machine, and you can close the “Command Prompt.”

Test your assembled device with the “hw_check” program: https://github.com/VeliML/MitsuRunner/blob/main/hw_check/hw_check.yaml

If the compilation is successful, the program will ask for the upload method (USB or OTI). Choose USB. ⇒ the code will be uploaded to the device via USB.

!! If the upload fails, make sure that the USB driver for WeMos_D1 is installed on your Windows machine.

After installing HW_check, check:


ESPHome Installation Guide (Linux)

As a Linux user, you probably know how to find the instructions yourself on the internet ;)

Instructions for installing ESPHome: https://esphome.io/guides/installing_esphome.html#linux Check the other instructions above.


MitsuRunner Software Installation Guide

Download Mitsurunner from https://github.com/VeliML/MitsuRunner , select “Download ZIP” under “CODE” Extract the package to a folder of your choice.

Edit mitsu_conf.yaml to match your Mitsurunner configuration (HW platform and reporting method). You can do this either by deleting unnecessary lines or by adding/removing comment characters “#” at the beginning of the line.

Some examples:

a) mitsu_conf.yaml for Wemos-Mitsurunner with IoT-Guru

 <<: !include platform_wemos.yaml             ## Update file!
 packages:
   wifi_base: !include secrets.yaml           ## Update file!
   dallas_base: !include dallas_hub.yaml
   mqtt_base: !include mqtt_Guru.yaml         ## Update file! 
   core_base: !include mitsurunner.yaml
 esphome:  
   includes:
     - constants.h
     - state.h

b) mitsu_conf.yaml for Sonoff_Elite-Mitsurunner with HomeAssistant

 <<: !include platform_elite.yaml             ## Update file!
 packages:
   wifi_base: !include secrets.yaml           ## Update file!
   dallas_base: !include dallas_hub.yaml     
   mqtt_base: !include mqtt_disabled.yaml 
   core_base: !include mitsurunner.yaml
 esphome:  
   includes:
     - constants.h
     - state.h

c) mitsu_conf.yaml for Wemos-Mitsurunner without WiFi-connention

 <<: !include platform_wemos.yaml             		## Update file!
 packages:
   wifi_base: !include secrets_sa.yaml        		## Update file!
   dallas_base: !include dallas_hub_status_Led.yaml     ## On-boad LED blinks regularly when the device is working properly.
   mqtt_base: !include mqtt_disabled.yaml 
   core_base: !include mitsurunner.yaml
 esphome:  
   includes:
     - constants.h
     - state.h

Update the parameters to the files you are using Detailed instructions for updating the parameters in each file.

1.platform_wemos.yaml / platform_elite.yaml

2.secrets.yaml / screts_sa.yaml

3.mqtt_Guru.yaml / mqtt_local.yaml

4. constants.h

file defines the operating parameters of Mitsurunner (timers, temperature limits). Usually the default values ​​work well, but you can also modify those if necessary.

Compiling, downloading and testing the program with ESPTool

program starts, trace-log is printed on the screen. From trace-log check:

Compiling, uploading and testing the program with the HomeAssistant ESPHome_Builder tool

Mitsurunner software can also be compiled and uploaded with HomeAssistant ESPHome_Builder tool There are several ways to do this, one straightforward way is described below. Mitsurunner program created in this way can be uploaded as OTA over the version created with ESPTool without USB upload.

1) Create a new directory mitsu in the HomeAssistant/esphome directory

2) Copy the files defined in mitsu_conf.yaml directory to the HomeAssistant/esphome/mitsu directory

3) Edit mitsu_conf.yaml file by specifying the directory where the files are located.

   <<: !include mitsu/platform_wemos.yaml
   packages:
   wifi_base: !include mitsu/secrets.yaml
   dallas_base: !include mitsu/dallas_hub.yaml
   mqtt_base: !include mitsu/mqtt_disabled.yaml
   core_base: !include mitsu/mitsurunner.yaml
   esphome:
   includes:
   - mitsu/constants.h
   - mitsu/state.h

4) Add the mitsu_conf.yaml file you edited to the HomeAssistant/esphome directory.

5) Open HomeAssistant ESPHome Builder, there you will now see “Device” as mitsu_conf Select edit, you will see the contents of the “mitsu_conf.yaml” file, the first time the download is done via USB as follows:

6) Compile the code by selecting install –> Manual download –> a window will open where you can see the progress of the compilation. If/when the translation goes without errors, save the generated mitsurunner.bin file and close the window

7) Select ESPHome/Device on the Mitsurunner/Edit

Mitsurunner software is now downloaded and Mitsurunner should work. By selecting ESPHome/Device Mitsurunner/logs you can see the trace_log data sent by Mitsurunner.

You can do the following downloads via OTA connection ESPHome/Device Mitsurunner“/Edit install =⇒ Wirelessly