.. EMS Gateway documentation master file, created by
   sphinx-quickstart on Mon Dec 30 13:48:50 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.
   (To preview pages from Visual Studio Code use CTRL+SHIFT+R)
   #
   # https://devguide.python.org/documenting/#style-guide
   # Section heading levels:
   # # with overline, for parts
   # * with overline, for chapters
   # =, for sections
   # -, for subsections
   # ^, for subsubsections
   # ", for paragraphs
   #
   # Formatting:
   # *italic*
   # **bold**
   # 
   # .. caution::
   # .. danger::
   # .. tip::
   # .. note::
   #

.. toctree::
   :maxdepth: 3
   :caption: Table of Contents
   :hidden:

   table-of-contents

.. toctree::
   :maxdepth: 3
   :caption: EMS BUS WI-FI GATEWAY
   :hidden:

   gateway/introduction
   gateway/how-the-gateway-works
   gateway/connecting-a-gateway
   gateway/connecting-a-gateway-s32
   gateway/connecting-a-gateway-e32
   gateway/connecting-a-gateway-premium-ii-p2
   gateway/connecting-a-gateway-standard-regular
   gateway/connecting-to-the-boiler
   gateway/connecting-to-specific-boilers-and-heatpumps
   gateway/connecting-to-your-network
   gateway/configuring-mqtt
   gateway/setting-tx-mode
   gateway/observing-ems-signal-quality
   gateway/all-web-interface-settings-ems-esp32
   gateway/all-web-interface-settings-ems-esp
   gateway/telnet-settings
   gateway/adding-external-sensors
   gateway/firmware-update-and-downgrade
   gateway/firmware-update-to-v2
   gateway/connecting-multipe-gateways
   gateway/compatibility
   gateway/troubleshooting
   gateway/i-bricked-my-gateway
   gateway/factory-reset
   gateway/hardware-details
   gateway/powering-a-gateway
   gateway/using-gateway-gpio
   gateway/upgrade-the-gateway-to-an-esp32


.. toctree::
   :maxdepth: 3
   :caption: Home Assistant configuration
   :hidden:

   gateway/home-assistant-configuration
   gateway/home-assistant-configuration-yaml
   gateway/home-assistant-configuration-yaml-2
   gateway/home-assistant-configuration-heating-circuits
   gateway/home-assistant-advanced-configuration

.. toctree::
   :maxdepth: 3
   :caption: Domoticz configuration
   :hidden:

   gateway/domoticz-configuration
   gateway/domoticz-or-home-assistant

.. toctree::
   :maxdepth: 3
   :caption: Other systems configuration
   :hidden:

   gateway/other-mqtt-systems-configuration
   gateway/loxone-configuration
   gateway/openhab-configuration
   gateway/iobroker-configuration   
   gateway/restful-api

.. toctree::
   :maxdepth: 3
   :caption: EMS INTERFACE BOARD
   :hidden:

   interface-board/introduction
   interface-board/board-connections
   interface-board/links-to-code

.. toctree::
   :maxdepth: 3
   :caption: EMS GATEWAY BASE BOARDS
   :hidden:

   base-boards/s32-base-board

.. toctree::
   :maxdepth: 3
   :caption: EMS BUS HAT FOR RASPBERRY PI
   :hidden:

   pi-hat/introduction
   pi-hat/board-connections
   pi-hat/serial-port-settings
   pi-hat/links-to-code

.. toctree::
   :maxdepth: 3
   :caption: iRT BUS MODS
   :hidden:

   irt/irt-bus-modification

.. toctree::
   :maxdepth: 3
   :caption: EMS BUS DOCUMENTATION
   :hidden:

   ems/introduction


#############################################
Welcome to the EMS bus product documentation!
#############################################

You can find all information about the EMS bus and EMS based products in this wiki.

The Gateway part of the wiki is based on the latest V3.4 firmware. If you are running an older firmware see the old wiki `HERE <https://bbqkees-electronics.nl/wiki-old>`_.

If you want to go back to the webshop click `HERE <https://bbqkees-electronics.nl/>`_.

You can also download this whole wiki as one `user manual in PDF <https://bbqkees-electronics.nl/user-manual-ems-gateway/>`_.

.. image:: images/logo_bbqkees-black-s.png
  :width: 400
  :alt: BBQKees Electronics webshop
  :target: https://bbqkees-electronics.nl/


Use the menu on the left or the search to find the information you need.
Some starting points:

- :ref:`EMS Bus Gateway information and instructions <EMS bus Wi-Fi Gateway>`

- :ref:`Information on the EMS interface boards <EMS interface boards>`

- :ref:`Information on the EMS bus HAT for Raspberry Pi <EMS bus HAT for Raspberry Pi>`

- :ref:`General info on the EMS bus <General info on the EMS bus>`

.. note::
  If you have a Gateway Premium II or older it is strongly recommended to upgrade the ESP8266 to an ESP32.
  Especially the HA MQTT Discovery function puts the ESP8266 to its limit. Also by upgrading you get a lot of new features and added stability.
  See :ref:`this page <Upgrade an ESP8266 Gateway with an ESP32>` for more information.

  For those who already have a Premium II or other ESP8266 Gateway and you would like to get a new ESP32 Gateway I can offer a nice discount.
  Send me an email via the contact form on the website.


Sometimes the menu on the left doesn't scroll properly.
Via the :ref:`Table of contents` below you can see it all.



:ref:`Table of contents`