Quick Start

Device configuration and updates are done using AutomationManager.

To begin you first load the MPP firmware onto the ESP device (see Flashing Firmware) and connect it to your wifi (using a reserved IP address in your router DHCP service is best). Record the device IP address.

  1. Open AM Manager

  2. Touch menu>ESP8266 Devices to open the MppDevice manager

  3. Touch the search button (or menu>Find MppDevices) and enter the IP address you recorded above if the device is not already known.

  4. All known MppESP8266 devices will be shown (use "Forget" for any devices that are no longer used/valid).

  5. Use "Update" and/or "Properties" to configure the device.

The MppArduino app can also be used for base and device specific updates, and to configure the device properties (e.g. pin configuration). See: MppArduino.

The old LUA based MPP V1 and V3 configuration and updates page is here: V1/V2 Configuration. Do not use this for new devices, it's legacy support only.

Quick Start

  1. Prepare to flash your ESP8266, see Firmware.

  2. Download the desired bin files from MPPV3 Files & Flashing. MppDevice.bin is a good starting choice.

  3. Use your favorite flashing tool, e.g. Espressif's ESP8266 DOWNLOAD Tool, ESP8266Flasher.exe, the Arduino IDE, the Eclipse IDE with an arduino extension, etc.

  4. Flash the bin file to address 0. NOTE the bin files work with 1MB (8Mbit) ESP8266 chips or larger. SPIFFS is not used/needed.

  5. Reset/restart the device

  6. Setup the device:

    1. Attach a serial port monitor such as MppArduino or the Arduino or Eclipse IDE

    2. Use the serial monitor at 115200 bps

    3. Enter "help" on the command line (no quotes) to verify. If the board doesn't respond, try resetting it to look for error messages. If the error response is garbled try again at 76800.

    4. Once the device is responding use the command "sta {ssid} {password}" (without the braces) to configure your WIFI.

    5. Reset, use the command "wifi" to see the assigned device IP, then visit that page with a web browser, AM, or MppArduino to configure the device MPP properties.

  7. Decide on the desired device type (e.g. is it to be a relay using MppRelay.bin or sensor using MppSensor.bin?). Use OTA (see below) to upload the new binary.

  8. Usually AM will find the device automatically, or touch the "Find new Devices" menu. The device will have it's default name of "Mpp{DeviceType}_{DeviceMAC}" in AM (which is sorted alphabetically). You can manage the device (properties and firmware) from AM in the "ESP8266 Devices" menu. If the device isn't found:

    1. Find the IP of your device. Easiest is with MppArduino, click "Status" in the Wifi section and note it either from the log window or in the top menu. Or look in your router's status page to find the new device.

    2. Use AM Find/Manual Search/ Finding MppDevices and enter that IP.

For Over The Air (OTA) updating:

    1. Use MppArduino under the "IP" menu (enter the device IP if it's not connected via USB) or load the device's web page.

    2. Select the desired bin file and click "Upload Firmware".

    3. Watch the progress in the MppArduino log or at the bottom of the web page (chrome)

    4. Check the OTA page confirmation.

    5. The device will restart with the new firmware, use the "Back" button to refresh the device web page. Don't use "Refresh"!

    6. Configure the properties as necessary using the web page or AM/ESP8266 Devices (AM has help text to understand the configuration properties).

For wifi recovery or first time configuration without USB:

  1. If the device is not in wifi recover mode, hold the device button (if available) for 15s. If the device AP does not appear after a few minutes you'll need to use the serial port.

  2. Connect your PC/Tablet/Phone to the device AP using password "MppDevice"

  3. Use a web browser to visit the device page at 192.168.4.1. If the page doesn't load use the serial port.

  4. Configure the device wifi and reboot.

If the device does not have a restart button, MppDevices are configured for restart/recovery by default. Power cycle the device 5 times, waiting 3s after each power on / power off. On the 6th powerup the device should start broadcasting it's AP as above.


Note that most flashers will also let you erase the entire flash if necessary. OTA will flash just the sketch.


The bin files are built for 1MB (8Mbit) or larger flash devices. This should be sufficient for most of the firmware below (see the files sizes). If you need to use more flash or other parameters you will need to build your own firmware using one of the methods below.


Troubleshooting


Use MppArduino to observe the startup sequence. If the characters are garbled try using 74880bps to see if there are boot errors. A CHKSUM error means the flash did not work.


If the flash works but OTA does is flashing, use your flash tool to fully erase the chip flash then flash again with the desired BIN file.


This page is very helpful in resolving problems: NodeMCU Flashing Instructions. In particular note the flash-mode for your device, the flash size needed, and the SDK Init Data section. esp_init_data_default.bin is available from the MPP V2 base page and from other sites on the web.


For firmware related troubleshooting see: Firmware.