You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/installing_esphome.rst
+57-31Lines changed: 57 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,29 +22,39 @@ In the terminal that comes up, check that Python is installed:
22
22
23
23
.. code-block:: console
24
24
25
-
> python --version
26
-
Python 3.10.1
25
+
python --version
27
26
28
-
.. note::
27
+
It should show something like:
29
28
30
-
Don't copy the ``>``. That's used to show that this is a command that goes
31
-
in the console, and to let you see what the expected results are (shown on
32
-
the next line without a ``>``)
29
+
.. code-block:: console
30
+
31
+
Python 3.10.1
33
32
34
33
Looks good? You can go ahead and install ESPHome:
35
34
36
35
.. code-block:: console
37
36
38
-
> pip3 install wheel
39
-
> pip3 install esphome
37
+
pip3 install wheel
38
+
pip3 install esphome
40
39
41
40
And you should be good to go! You can test that things are properly installed
42
-
with the following:
41
+
with:
42
+
43
+
.. code-block:: console
44
+
45
+
esphome version
46
+
47
+
It should show something like:
43
48
44
49
.. code-block:: console
45
50
46
-
> esphome version
47
-
Version: 2021.12.3
51
+
Version: 2025.5.2
52
+
53
+
54
+
.. note::
55
+
56
+
You may additionally need to install git for the external components feature.
57
+
Download git from `the official link <https://git-scm.com/downloads>`_
48
58
49
59
Mac
50
60
---
@@ -62,24 +72,30 @@ An easy way for installation is via `Homebrew <https://brew.sh/>`_:
62
72
63
73
.. code-block:: console
64
74
65
-
$ brew install esphome
75
+
brew install esphome
66
76
67
77
Verify the installation:
68
78
69
79
.. code-block:: console
70
80
71
-
$ esphome version
72
-
Version: 2024.12.0
81
+
esphome version
82
+
83
+
It should show something like:
84
+
85
+
.. code-block:: console
86
+
87
+
Version: 2025.5.2
88
+
73
89
74
-
If you encounter any issues with Homebrew installation, please check the
75
-
`ESPHome Homebrew Formula <https://formulae.brew.sh/formula/esphome>`_ page
76
-
for additional information.
77
90
78
91
.. note::
79
92
80
-
Homebrew may not always provide the latest version immediately. Updating Homebrew will
81
-
automatically update ESPHome. If this is ok for you, Homebrew is the easiest way to
82
-
install ESPHome.
93
+
- If you encounter any issues with Homebrew installation, please check the
94
+
`ESPHome Homebrew Formula <https://formulae.brew.sh/formula/esphome>`_ page
95
+
for additional information.
96
+
- Homebrew may not always provide the latest version immediately. Updating Homebrew will
97
+
automatically update ESPHome. If this is ok for you, Homebrew is the easiest way to
98
+
install ESPHome.
83
99
84
100
**pip**
85
101
@@ -88,7 +104,7 @@ and may need additional dependencies and path settings. Setting up a virtual env
88
104
highly recommended. If you are not familiar with Python virtual environments, Homebrew
89
105
may be easier.
90
106
91
-
You will require Python 3.9 or newer. While your Mac may have a version of Python installed it may not be up-to-date.
107
+
You will require Python 3.10 or newer. While your Mac may have a version of Python installed it may not be up-to-date.
92
108
Python can be installed from the `official site <https://www.python.org/downloads>`_
93
109
or with Homebrew. Once Python is installed, create and activate a virtual environment and install ESPHome with pip:
94
110
@@ -110,19 +126,24 @@ Linux
110
126
-----
111
127
112
128
Your distribution probably already has Python installed. Confirm that it is at
113
-
least version 3.9:
129
+
least version 3.10:
130
+
131
+
.. code-block:: console
132
+
133
+
python3 --version
134
+
135
+
It should show something like:
114
136
115
137
.. code-block:: console
116
138
117
-
$ python3 --version
118
-
Python 3.9.15
139
+
Python 3.10.1
119
140
120
141
Looks good? Now create a virtual environment to contain ESPHome and it's dependencies.
121
142
122
143
.. code-block:: console
123
144
124
-
$ python3 -m venv venv
125
-
$ source venv/bin/activate
145
+
python3 -m venv venv
146
+
source venv/bin/activate
126
147
127
148
You may or may not see ``(venv)`` at the beginning of your prompt depending on your shell configuration. This indicates that you are in the virtual environment.
128
149
@@ -135,22 +156,27 @@ You can go ahead and install ESPHome:
135
156
.. caution::
136
157
137
158
Don't use ``sudo`` with pip. If you do, you'll run into trouble updating
0 commit comments