MitsuRunner

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

ftermit:
Windowsin komentokehoite = macilla "terminal"

====== Asenna ESPHome ======
  * ESPHome käyttää Python'ia, joten ensin tarvittaessa lataa ja asenna osoitteesta https://python.org/  
  * "komentokehote" ja asenna ESPHome antamalla komento: <code>pip3 install esphome</code>
  * ESPhome asentuu, asennuksessa mahdollisesti tulevista WARNINGeista ei tarvitse välittää. 
  * Nyt kehitysympäristö on koneellasi ja voit sulkea "komentokehotteen".

HUOM: Mitsurunner alkaen versiosta "Compatibility with ESPHome 2024.6.6 and later" on yhteensopiva uusien ESPHome-versioiden kanssa mutta ei toimi vanhemmilla ESPHome-versioilla. Uusimman ESPHome-version saat asennettua komentokehotteella <code>pip3 install esphome -U</code>

Ohje ESPhomen asennukseen: https://esphome.io/guides/installing_esphome.html

Lisäohjeita täältä: https://www.esphome.io/guides/getting_started_hassio.html

====== USB-serial-ajurin asennus ======
Asenna käyttämäsi alustan USB-serial-ajuri.

Esimerkeksi Wemos D1 mini käyttää CH340-piiriä, jonka ajurin saa valmistajan sivuilta 
  * windows https://www.wch-ic.com/downloads/CH341SER_ZIP.html
  * mac https://www.wch-ic.com/downloads/CH341SER_MAC_ZIP.html

====== Laitteiston testaus - HW_check ======
  * Lataa Mitsurunnerin koodi https://github.com/VeliML/MitsuRunner , paina "CODE" ja sitten "Download ZIP" 
  * Pura paketti haluamaasi kansioon
  * Muokkaa tiedostoa hw_check.yaml esim. Muistio- tai Textedit-ohjelmalla, vaihda "dallas_pin" ja "relay_pin" vastaamaan käyttämiäsi GPIO-pinnejä
  * Kytke kokoamasi laite USB-johdolla tietokoneeseesi
  * Avaa komentokehote. Siirry kansioon komennolla "cd kansion polku" esim. "cd /home/users/velho/mitsurunner"). Anna komento "esphome hw_check.yaml run"

* Jos käännös menee OK ja Wemos on kytketty USB-porttiin ohjelma latautuu ja käynnistyy
  * Rele naksuu (0,5s ON 5s välein)
  * Tietokoneen ruudulle tulostuu logi josta näkyy DS18B20-lämpötila-antureiden ID-tunnukset. Kopioi id:t talteen, tarvitset niitä myöhemmin.

====== MitsuRunner-ohjelman asennus ======
Lataa Mitsurunner osoitteesta https://github.com/VeliML/MitsuRunner , valitse siltä "CODE" valinnan alta "Download ZIP" 
Pura paketti haluamaasi kansioon.

Editoi ladatusta paketissa olevaa **//mitsu_conf.yaml//** -tiedostoa vastaamaan haluamaasi Mitsurunner-kokoonpanoa (HW-platform ja raportointitapa). Voit tehdä sen joko poistamalla tarpeettomat rivit tai lisäämällä/poistamalla rivin alun kommenttimerkkejä "#".

Alla esimerkkejä:

**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

**Päivittä parametrit käyttämiisi tiedostihin**
Tarkempia ohjeita parametrien päivitykseen on kussakin päivitettävässä tiedostossa.

**1.platform_wemos.yaml / platform_elite.yaml**
   *DS18B20-antureiden IDt
   *käytetyt GPIO-nastat (DS18B20 1-wire ja releohjaus)
   *HomeAssistant_API käytettäessä ota käyttöön HomeAssistant api. (jos käytät HA:ta MQTT:n kautta konfiguroi vain MQTT, ei HA_APIa)
   *lisäämällä kommenttimerkki "#" rivin  //"level: INFO"// alkuun tarkempaa trace-data, saattaa olla avuksi Mitsurunnerin asennusvaiheessa

**2.secrets.yaml / screts_sa.yaml**
   *WiFi-SSID ja password
   *manual_ip osoite (jos poistat manual_ip määritysrivit käytetään dynaamista IP-osoitetta)
   
**3.mqtt_Guru.yaml / mqtt_local.yaml**
   *username, client_id, password
   *prefix

**4. constants.h**
 tiedosto määrittelee Mitsurunnerin toimintaparametreja (ajastimia, lämpötila-rajoja). Yleensä oletusarvot toimivat hyvin, mutta tarvittaessa niitä voi myös muuttaa.

====Ohjelman kääntäminen, lataaminen ja testaaminen ESPTool-työkalulla====
  * Kytke Mitsurunner USB-johdolla, käännä ja asenna Mitsurunner koodi laitteesesi komennolla <code>esphome run mitsu_conf.yaml</code>. Ohjelman käynnistyttyä trace-log tulostuu näytölle.

Toiminnan tarkistaminen:
  *  Tarkista trace-logista
    * Mitsurunner on kytkeytynyt kotiverkkoosi
    * DS18B20-lämpötila-antureiden lämpötilat ovat oikein
    * Mitsurunner on kytkeytynyt MQTT-serveriin (jos MQTT on käytössä)
    * Määrittelemäsi tiedot päivittyvät MQTT-serverille

* Jos käytät IoT-Gurua ilman USB-yhteyttä trace-log ei tulostu näytölle. Voit kuitenkin nähdä login menemällä selaimella Mitsurunnerin IP-osoitteeseen.

====Ohjelman kääntäminen, lataaminen ja testaaminen HomeAssistant ESPHome_Builder-työkalulla===

Mitsurunner ohjelmiston voi kääntää ja ladata myös //HomeAssistant ESPHome_Builder//-työkalulla
Tähän on useita tapoja, alla on kuvattu yksi suoraviivainen tapa. Tällä tavalla tehdyn Mitsurunner-ohjelman voi ladata OTA:na ESPTool:lla tehdyn version päälle ilman USB-latausta.

1) Tee **HomeAssistant/esphome** hakemistoon uusi hakemisto **mitsu**

2) Kopio **mitsu_conf.yaml** hakemistossa määritellyt tiedostot **HomeAssistant/esphome/mitsu** hakemistoon

3) Editoi **mitsu_conf.yaml** tiedostoa määrittelemällä hakemisto missä tiedostot sijaitsevat.

<<: !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) Lisää editoimasi **mitsu_conf.yaml** tiedosto **HomeAssitant/esphome** hakemistoon.

5) Avaa //HomeAssistant ESPHome Builder//, siellä näkyy nyt "Device" nimellä **mitsu_conf**
Valitse **edit**, näet "mitsu_conf.yaml" tiedoston sisällön, ensimmäisellä kerralla lataus tehdään USB:n kautta seuraavasti:

6) Käännä koodi valitsemalla yläkulmasta **install**  -->  **Manual download**   -->  avautuu ikkuna jossa näet käännöksen etenemisen.
Jos/kun käännös menee virheittä talleta muodostunut **mitsurunner.bin** tiedosto ja sulje ikkuna

7) Valitse //ESPHome/Device// sivulla **Mitsurunner/Edit**
    * valitse uudestaan oikeasta yläkulmasta **install**
    * valitse **Plug into this computer** 
    * valitse **Open ESPHome Web**
    * valitse **Connect** 
    * valitse **USB-portti** 
    * valitse **Muodosta yhteys** 
    * valitse **Install**
    * valitse aiemmin tallettamasi **mitsurunner.bin** tiedosto 
    * valitse **Install**

Mitsurunner ohjelmisto on nyt ladattu ja Mitsurunneri pitäisi toimia. ESPHome/Device** Mitsurunner/logs** valinnalla näet Mitsurunnerin lähettämät trace_log tiedot.

Seuraavat lataukset voit tehdä OTA-yhteydellä
ESPHome/Device **Mitsurunner"/Edit**  **install** ==> **Wirelessly**

Kirijoitahan aakkoset vallan takaperoisesti ähvästä aahan isoilla kirijaimilla (kuusi kirijainta): Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: Public Domain