mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-03 09:00:28 +01:00
7bfa9be862
* Begin for-dummies programming guide * Delete getting-started-cli content * Seperate connection guide * Refactor instructions Have the Getting started guides link to the correct subguides when they need to explain how to do a common thing. * Apply suggestions from code review Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl> * Add physical connection note to hassio guide * Improve page titles * Mention lack of tested Mac instructions * Fix typos Co-authored-by: Oxan van Leeuwen <oxan@oxanvanleeuwen.nl>
112 lines
2.8 KiB
ReStructuredText
112 lines
2.8 KiB
ReStructuredText
Installing ESPHome Manually
|
|
===========================
|
|
|
|
Windows
|
|
-------
|
|
|
|
Download Python from `the official site <https://www.python.org/downloads/>`_.
|
|
|
|
.. figure:: images/python-win-installer.png
|
|
:align: center
|
|
:width: 75.0%
|
|
:alt: Python installer window with arrows pointing to "Add Python to PATH" and "Install Now"
|
|
|
|
Make sure you check "Add Python to PATH", and go all the way through the
|
|
installer.
|
|
|
|
Log out and back in, or restart your computer. Whichever is easiest.
|
|
|
|
Open the start menu and type ``cmd``. Press the enter key.
|
|
|
|
In the terminal that comes up, check that Python is installed:
|
|
|
|
.. code-block:: console
|
|
|
|
> python --version
|
|
Python 3.10.1
|
|
|
|
.. note::
|
|
|
|
Don't copy the ``>``. That's used to show that this is a command that goes
|
|
in the console, and to let you see what the expected results are (shown on
|
|
the next line without a ``>``)
|
|
|
|
Looks good? You can go ahead and install ESPHome:
|
|
|
|
.. code-block:: console
|
|
|
|
> pip3 install wheel
|
|
> pip3 install esphome
|
|
|
|
And you should be good to go! You can test that things are properly installed
|
|
with the following:
|
|
|
|
.. code-block:: console
|
|
|
|
> esphome version
|
|
Version: 2021.12.3
|
|
|
|
Mac
|
|
---
|
|
|
|
There are no tested installation instructions for Mac. ESPHome does support
|
|
Mac & will run with no problem.
|
|
|
|
Contributions are welcome!
|
|
|
|
The process will likely be similar to Windows. You can install Python from the
|
|
official site, and then install ESPHome with ``pip3 install esphome``. You can
|
|
then test that things are properly installed with the following:
|
|
|
|
.. code-block:: console
|
|
|
|
$ esphome version
|
|
Version: 2021.12.3
|
|
|
|
Linux
|
|
-----
|
|
|
|
Your distribution probably already has Python installed. Confirm that it is at
|
|
least version 3.7:
|
|
|
|
.. code-block:: console
|
|
|
|
$ python3 --version
|
|
Python 3.7.1
|
|
|
|
Looks good? You can go ahead and install ESPHome:
|
|
|
|
.. code-block:: bash
|
|
|
|
pip3 install --user esphome
|
|
|
|
.. caution::
|
|
|
|
Don't use ``sudo`` with pip. If you do, you'll run into trouble updating
|
|
your OS down the road.
|
|
|
|
For details, see `DontBreakDebian
|
|
<https://wiki.debian.org/DontBreakDebian#A.27make_install.27_can_conflict_with_packages>`_.
|
|
``pip install`` is equivalent to ``make install`` in this context. The
|
|
advice in the article applies to all Linux distributions, not just Debian.
|
|
|
|
At this point, you should be able confirm that ESPHome has been successfully installed:
|
|
|
|
.. code-block:: console
|
|
|
|
$ esphome version
|
|
Version: 2021.12.3
|
|
|
|
If you get an error like "Command not found", you need to add the binary to
|
|
your ``PATH`` using ``export PATH=$PATH:$HOME/.local/bin``.
|
|
|
|
To set this permanently, you can run ``echo 'export
|
|
PATH=$PATH:$HOME/.local/bin' >> $HOME/.bashrc``, then log out and back in.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :doc:`ESPHome index </index>`
|
|
- :doc:`getting_started_command_line`
|
|
- :ghedit:`Edit`
|