Quick-Start for OpenMacroRail

Install the OpenMacroRail Firmware from your browser

By clicking the Connect button below and following the instructions you will be able to install the OpenMacroRail firmware directly from your browser.

No need to install a bunch of software that you will never use again!

Step by step guide:

OpenMacroRail uses a microcontroller board, ESP32, that is not a part of the default Arduino family. Setting up the development environment for this board may feel a bit overwhelming to those who are not familiar with the process. Therefore, OpenMacroRail supports flashing pre-built firmware directly from your browser!

Install the OpenMacroRail Firmware:
  1. Make sure the ESP32 you want to flash is connected to your computer via USB
  2. Click the blue "Connect" button above
  3. Select the serial device that corresponds to your ESP32
    Select the serial device that corresponds to your ESP32
  4. Click the Install button. This will start flashing the latest release of the OpenMacroRail Firmware to your device.
    Connect to the WiFi network called OpenMacroRail-AP
  5. Wait for the installation to complete.
    Tip:

    Clicking "Logs & Console -> Reset Device" once the installation completes will help you find the IP address that the ESP32 is assigned by your network router once you have completed the steps in the next section.

Connect the OpenMacroRail to your preferred device:

Once the firmware is done flashing you can connect it to the device you want to use to control your OpenMacroRail. If this is your first time connecting to OpenMacroRail, or if OpenMacroRail can't find any known networks, the ESP32 will set up an access point named "OpenMacroRail-AP" that can be used to enter WiFi credentials for any available network.

  1. Connect to the WiFi network called OpenMacroRail-AP
    Connect to the WiFi network called OpenMacroRail-AP
  2. Wait for the prompt to load and click the Configure Wifi button
    Wait for the prompt to load and click the Configure Wifi button
  3. Select your prefered WiFi network and enter credentials
    Select your WiFi network and enter your credentials
  4. Make sure your device (phone, laptop, desktop computer) has re-connected to the network that OpenMacroRail is connected to.
    Warning:

    Connect to a 2.4 GHz network!
    Some network routers present two networks with the same name, where one is using a 2.4 GHz carrier frequency and the other is using 5 GHz. Your device may know both of these networks, so make sure it is connected to the 2.4 GHz version as this is the only type that is supported by ESP32.

  5. Plug 12V power in the power jack to enable the motor.
  6. You can now disconnect the USB cable and start using OpenMacroRail!
  7. In a web browser, enter the URL OpenMacroRail.local to access the user interface
    OpenMacroRail user interface shown on an iPhone
    Note:

    If this does not work, type in the IP address of OpenMacroRail instead. The IP address can be found by reconnecting the USB cable and clicking the Connect button on the top of this page, then "Logs & Console -> Reset Device"