diff --git a/docs/upload/portal.md b/docs/upload/portal.md index 5a9a1e01e4..6fb2e9afac 100644 --- a/docs/upload/portal.md +++ b/docs/upload/portal.md @@ -1,36 +1,36 @@ -# Wifi and MQTT configuration +# WiFi and MQTT configuration -## Wifi and MQTT configuration portal for Wifi boards +## WiFi and MQTT configuration portal for WiFi boards -Once loaded into your ESP, and if you don't use the manual configuration, you have to set your network parameters with Wifi Manager portal. +Once loaded into your ESP, and if you don't use the manual configuration, you have to set your network parameters with WiFi Manager portal. -From your smartphone, search for  OpenMQTTGateway or OMG wifi network and connect to it with the `WifiManager_password` you have defined (the default password is **"your_password"**), or if you are using a device sold by Theengs or the macro `-DWM_PWD_FROM_MAC=true`, the password will be the last eight digits of the device MAC Address with upper case. +From your smartphone, search for  OpenMQTTGateway or OMG WiFi network and connect to it with the `WifiManager_password` you have defined (the default password is **"your_password"**), or if you are using a device sold by Theengs or the macro `-DWM_PWD_FROM_MAC=true`, the password will be the last eight digits of the device MAC Address with upper case. Example, the password would be `CCDDEEFF` for a MAC Address `AABBCCDDEEFF`. For Theengs devices, the MAC Address can be found on the device sticker, and for all the devices, it is printed on the serial monitor logs. -Once connected to the Wifi, a web page should appear. On Android, you may also have a popup asking you if you want to connect to it without an internet connection. Answer yes always/all the time. If the web page doesn't appear, click on the Wifi Access Point and "Manage router". +Once connected to the WiFi, a web page should appear. On Android, you may also have a popup asking you if you want to connect to it without an internet connection. Answer yes always/all the time. If the web page doesn't appear, click on the WiFi Access Point and "Manage router". -![Wifi manager menu](../img/OpenMQTTGateway_Wifi_Manager_menu.png) +![WiFi manager menu](../img/OpenMQTTGateway_Wifi_Manager_menu.png) * Click on Configure WiFi -![Wifi manager parameters](../img/OpenMQTTGateway_Wifi_Manager_enter_parameters.png) +![WiFi manager parameters](../img/OpenMQTTGateway_Wifi_Manager_enter_parameters.png) -* Select your wifi -* Set your wifi password +* Select your WiFi +* Set your WiFi password * Set your MQTT Server IP -* Set your MQTT Server Port +* Set your MQTT Server Port (default: 1883) * Set the MQTT secure connection box to select whether or not the connection should be secure * Copy/paste the MQTT server certificate in the MQTT server cert box (only required if using a secure connection), be sure to include the `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` markers -* Set your MQTT Server username (facultative) -* Set your MQTT Server password (facultative) -* Set your MQTT base topic if you need to change it (you must keep the / at the end) +* Set your MQTT Server username (optional) +* Set your MQTT Server password (optional) +* Set your MQTT base topic if you need to change it (you must keep the / at the end) (default: home/) * Set your gateway name if you need to change it -* Set your Over The Air password, this password is used for local and remote OTA +* Set your Over The Air password `ota_password`, this password is used for local and remote OTA - it is also the password being used for the WebUI login. (default: OTAPASSWORD) * Click on save -![Wifi manager save](../img/OpenMQTTGateway_Wifi_Manager_save.png) +![WiFi manager save](../img/OpenMQTTGateway_Wifi_Manager_save.png) The ESP restart and connect to your network. Note that your credentials are saved into the ESP memory, if you want to redo the configuration you have to erase the ESP memory with the flash download tool. @@ -42,7 +42,7 @@ home/OpenMQTTGateway/version Note that the web portal appears only on first boot, if you want to configure again the setting you can do a long press on TRIGGER_GPIO or [erase the settings](../use/gateway.md#erase-the-esp-settings). -## MQTT and network configuration for Ethernet and Wifi boards +## MQTT and network configuration for Ethernet and WiFi boards You can configure your MQTT server credentials and network configuration before building the application. It can be done either in Arduino or in Platformio IDE thought the User_config.h file. Note that with Platformio IDE you can also set your credentials into the platformio.ini file or an *_env.ini file, here is an example with the Olimex ESP32 gateway: