{"id":13,"date":"2019-11-05T17:08:49","date_gmt":"2019-11-05T17:08:49","guid":{"rendered":"https:\/\/www.galagaking.org\/?p=13"},"modified":"2020-01-11T15:45:24","modified_gmt":"2020-01-11T15:45:24","slug":"esphome-workshop","status":"publish","type":"post","link":"https:\/\/www.galagaking.org\/nl\/2019\/11\/05\/esphome-workshop\/","title":{"rendered":"ESPHome \u2013 Introductie"},"content":{"rendered":"

Install ESPHome<\/h2>\n\n\n\n

We will use ESPHome to create the binaries for the ESP8266 module. ESPHome will create a binary from a \u2018YAML\u2019 script file. ESPHome is written in Python and is using \u2018PlatformIO\u2019 to build the software. If you installed already some components, you may skip these steps.<\/p>\n\n\n\n

Install Python<\/h2>\n\n\n\n

If you already installed Python, you should check your python version:<\/p>\n\n\n\n

 python --version<\/pre>\n\n\n\n
It should be >2.6. If not, install python. Refer to www.python.org<\/a>, current release 3.8: https:\/\/www.python.org\/downloads\/release\/python-380\/<\/a><\/p>\n\n\n\n
Depending\non your local OS choose Mac or Windows Web installer:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
To install\nthe Windows web-based installer, download the file and start it from the\n\u2018Download\u2019 directory:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Check the\n\u2018Add Python 3.8 to PATH\u2019 check box and choose \u2018Install Now\u2019<\/p>\n\n\n\n
Choose \u2018Install\nNow\u2019.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
After\ninstallation choose \u2018Disable path length limit\u2019 (just in case) and \u2018Close\u2019.<\/p>\n\n\n\n
Check your setup by opening a CMD window entering the \u2018python –version\u2019 command:<\/p>\n\n\n\n
python --version<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Start the installation of esphome:<\/p>\n\n\n\n
pip install esphome<\/pre>\n\n\n\n
This will\ninstall all the components needed.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Now you can\ncreate your first \u2018YAML\u2019 file.<\/p>\n\n\n\n
Create a\nworking directory in your home or documents directory and select this\ndirectory:<\/p>\n\n\n\n
CD <documentsdir>\nmd esphome\ncd esphome\nesphome myfirst.yaml wizard<\/pre>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The Wizard\nis helpful in creating your first YAML file. First enter a chosen name for your\nnode. This name will be broadcasted in the WiFi network, so choose a unique\none!<\/p>\n\n\n\n
Step 2 is\nasking for the platform (ESP32 or ESP8266). Choose, depending on your hardware.<\/p>\n\n\n\n
In case of\nthe workshop you should enter ESP8266, and Nodemcuv2 or d1_mini (WEMOS).<\/p>\n\n\n\n
Step 3,\nenter your Wifi credentials (SSID and password)<\/p>\n\n\n\n
In Step 4\nyou can enter a password for the OTA setup. In case of an untrusted network\nthis will give you some more security<\/p>\n\n\n\n
Now your\nYAML file will be created, it is an ASCII file which can be edited by your\nfavourite editor (or notepad):<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
This file\ncan be edited here, so any configuration changes can be done from here.<\/p>\n\n\n\n
Now the\nmagic will start. Connect an USB cable to your ESP8266 board and enter:<\/p>\n\n\n\n
esphome myfirst.yaml run<\/pre>\n\n\n\n
This will\ncompile your yaml file, create and upload the binary firmware to your module.\nCompilation will take some time, because platform and libraries should be\nloaded first. After compilation you get the option to upload the file:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Choose the\nCOM port (you should first upload the code by USB). After uploading the ESP\nwill reboot and try connect to the given SSID. The USB port will now act as a\nlogging port and esphome will display the messages:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The Blinking Led<\/h2>\n\n\n\n
The Hello\nWorld example of IoT \/ The Embedded world. So here we go:<\/p>\n\n\n\n
To\nconfigure the options from your ESP module, you have to add some lines to the\nYAML file. Open the YAML file with notepad or any other editor. Add the\nfollowing lines:<\/p>\n\n\n\n
web_server:\n  port: 80\nswitch:\n  - platform: gpio\n    name: \"LED\"\n    pin:\n      number: 16\n      inverted: yes<\/pre>\n\n\n\n
Be aware of\nthe spacing, you should use two spaces for every intended line! 16 is the GPIO\npin from the build-in LED in the NodeMCU v2 board. You should change if needed\nfor WEMOS (GPIO pin 2).<\/p>\n\n\n\n
Now you can\nagain upload the code:<\/p>\n\n\n\n
esphome myfirst.yaml run<\/pre>\n\n\n\n
Upload\nshould be possible now with OTA (over the air programming). Important to check\nthe uniqueness of your nodename. USB cable is a safe option, but give it a try.<\/p>\n\n\n\n
Now try to connect to your node: http:\/\/myfirstnode<\/a> , you should enter here your given name in step 1 of your project, be aware this will only work if everyone in the same network uses a different name.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Now you can\ntoggle the LED by clicking the \u2018Toggle\u2019 button. The debug screen will give more\ninformation.<\/p>\n\n\n\n
Reading a BMP280 sensor<\/h2>\n\n\n\n
Check out https:\/\/esphome.io\/<\/a> , you see a lot of integrations\npossible. Choose any sensor you like, add it to some spare pins of your ESP\nmodule, add the configuration to the YAML file and here you go!<\/p>\n\n\n\n
BMP280\nsensor<\/p>\n\n\n\n
This sensor\nis connected by i2c bus. Connect GND to GND, VCC to 3v3 (BEWARE: the sensor\ncan\u2019t handle 5V!!), SDA to D2 (Wemos) or GPIO4, SCL to D1 (Wemos) or GPIO5.<\/p>\n\n\n\n
First\ninstall i2c in yaml, and then add the sensor:<\/p>\n\n\n\n
i2c:\n  sda: 4 #D2 Wemos\n  scl: 5 #D1 Wemos\n  scan: True\nsensor:\n  - platform: bmp280\n    temperature:\n      name: \"BMP280 temperature\"\n    pressure:\n      name: \"BMP280 pressure\"\n    address: 0x76\n    update_interval: 60s <\/pre>\n\n\n\n
After\nuploading the code, the startup logging will show the i2c bus scan (due to\n\u2018scan: true\u2019), check if the sensor is found here:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Check if\nyour sensor shows up here, may be you should change the address (0x76 to 0x77)\ndepending on your hardware.<\/p>\n\n\n\n
Automagically\nthe sensor values show up in the webserver:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Publish to MQTT<\/h2>\n\n\n\n
To publish\nyour data outside the \u2018Home Assistant\u2019 environment, you can use the common MQTT\ninterface. You may use your own, local, MQTT server like Mosquito on your PI,\nor use a public one like \u2018HiveMQ\u2019. If you use an external service, be aware\nthat anyone can read the results. Add the following lines to the YAML file:<\/p>\n\n\n\n
mqtt:
  broker: broker.hivemq.com<\/pre>\n\n\n\n
You should remove\nthe \u2018API\u2019 line, or add a # (\u2018comment\u2019):<\/p>\n\n\n\n
# Enable Home Assistant API
#api:<\/pre>\n\n\n\n
After\nuploading, all the results from sensors, state of switches and even debugging\nmessages are published to the MQTT server. The syntax is straight forward:<\/p>\n\n\n\n
<name of your esp, as used in \u2018step 1\u2019>\/sensor\/bmp280_temperature\/state<\/strong> is the topic used for the BMP temperature. You could change your ESP name to be unique.<\/p>\n\n\n\n
Now you can\ngo to http:\/\/www.hivemq.com\/demos\/websocket-client\/<\/a> and \u2018Add new Topic subscription\u2019.\nIf you enter here the <name of your ESP>\/# , all the messages from your\nESP will be shown:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
NodeRed<\/h2>\n\n\n\n
Now we can\npick up this data in other platforms, like NodeRed<\/p>\n\n\n\n
Add a MQTT\ninput node:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
The topic\nshould start with your node name. The server should be broker.hivemq.com.<\/p>\n\n\n\n
If you\nconnect a debug or gauge component, the value will be shown in your dashboard:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>","protected":false},"excerpt":{"rendered":"
Install ESPHome We will use ESPHome to create the binaries for the ESP8266 module. ESPHome will create a binary from a \u2018YAML\u2019 script file. ESPHome is written in Python and is using \u2018PlatformIO\u2019 to build the software. If you installed already some components, you may skip these steps. Install Python If you already installed Python, […]<\/p>","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"enabled":false},"version":2}},"categories":[1],"tags":[2,3,4,7],"class_list":["post-13","post","type-post","status-publish","format-standard","hentry","category-homeassistant","tag-esp8266","tag-esphome","tag-mqtt","tag-nodered"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/posts\/13","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/comments?post=13"}],"version-history":[{"count":0,"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/posts\/13\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/media?parent=13"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/categories?post=13"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.galagaking.org\/nl\/wp-json\/wp\/v2\/tags?post=13"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}