Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rroemhild committed Nov 28, 2019
1 parent a1a33c1 commit 2f3d1a8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/introduction/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ You can download the Microhomie firmware from the `GitHub release page <https://
esptool --port PORT --baud 460800 write_flash --flash_size=detect --verify -fm dio 0x0 microhomie-esp8266-v2.2.0.bin
Continue with the `configuration`_ and the `Quick start with a simple LED node`_ sections.


Install Microhomie on the ESP32
===============================
Expand Down Expand Up @@ -79,14 +81,16 @@ For example we have an `mpfshell <https://github.com/wendlers/mpfshell>`_ script
mpfshell ttyUSB0 -s esp32_install.mpf
Continue with the `Configuration <#configuration>`_ and the `Quick start with a simple LED node <#quick-start-with-a-simple-led-node>`_ sections.
Continue with the `configuration`_ and the `Quick start with a simple LED node`_ sections.


Configuration
=============

To configure your Microhomie device create a ``settings.py`` file from the ``settings.example.py`` file, make your changes and copy the file to your ESP8266 device.

Reference: :ref:`reference_homie_settings`


Quick start with a simple LED node
==================================
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
.. module:: settings
:synopsis: Module to configure Microhomie

This module is to confgiure the home device. For reference see the example settings file in the repository.
This module is to configure the home device. For reference see the example settings file in the repository.


Mandatory
Expand Down

0 comments on commit 2f3d1a8

Please sign in to comment.