Note: Remote access via OTC token is now supported on OpenSprinkler v3 (firmware v2.2.0 and later) as well as OpenSprinkler Pi / Linux (firmware v2.2.1 and later). This feature is NOT supported for OpenSprinkler v2.

Introduction

The OpenThings Cloud (OTC) token enables remote access of your OpenSprinkler. With OTC, communication between the controller and your mobile app /UI is facilitated through the OpenThings cloud server, eliminating the need for port forwarding. This is especially userful for mobile routers where port forwarding can be difficult or impossible to set up.


Before proceeding, ensure that you have the required firmware: at least version 2.2.0 for OpenSprinkler v3; and at least version 2.2.1 for OpenSprinkler Pi / Linux. If your firmware version is lower, please follow the instructions here to upgrade.


Once OTC is set up, you no longer need to use the controller's local IP address (which only works on the same network). With OTC, you can access your controller from anywhere. In the app / UI, you'll need to add a new site / device using the OTC token. After that, you can delete the site linked to the controller's IP address (though you may keep it if you wish, knowing that the IP-based site will only work locally and NOT remotely).


Step A: Create an OTC Token

  1. Visit www.openthings.io and log in using your opensprinkler.com email/username and password. If you don't yet have an opensprinkler.com account, go to www.opensprinkler.com and click on 'My Account' at the top, then register for a new user account. The two websites share the same log in.

  2. After logging into www.openthings.io, you will see the dashboard. On the left side of the dashboard, click
    My OpenThings Devices
    see the image below. Do NOT click on My OpenThings Blynk Devices (that's for creating Blynk token, not OTC).
  3. To add a new OpenSprinkler device:
    • Enter a device description
    • Select "OpenSprinkler" from the dropdown list.
    • Click "Add New Device" (see image below for reference).
  4. This will create a new OpenSprinkler device, generating a 32-character OTC token. You will need to copy and paste this token into your OpenSprinkler settings (explained below).

Step B: Update OpenSprinkler Settings

To activate the OTC token:

  1. On the homepage of your controller, tap the lower-right corner icon to open "Edit Options", navigate to the Integration tab.
  2. Choose Enable, then copy/paste your entire 32-character OTC token into the box. The default OTC server is ws.cloud.openthings.io and the default port is 80. You can leave these they are.
  3. Submit the changes. Reboot your OpenSprinkler. You are all set!
  4. To verify if OTC cloud connection is successful: After the controller reboots, from the homepage, swipe left to right (or click the upper-left corner icon) to open the left-side menu, then select System Diagnostics, and check the OTC status there.
    • "Connected" --> OTC setup is successful.
    • "Connecting..." --> Wait about 30 seconds and check again.
    • "Not enabled" --> OTC is not enabled, recheck your settings.
    • "Disconnected" --> The connection has failed (possibly due to loss of Internet connection, or your router's firewall settings).


Step C: Use the OTC Token for remote access

The OpenSprinkler mobile app and UI allow you to add a device using its OTC token. To do so:

  • Add a new device, select OpenThings Cloud as the Connection Type.
  • Once the new device is added, you may delete your old site that was connected via the controller's IP address -- OTC works both remotely and locally.



Alternative Access Methods:

In addition to using the mobile app / UI, you may also:

  • Visit https://ui.opensprinkler.com in any web browser and add a device using its OTC token.
  • Direct URL access: Open a web browser and enter the following URL:
    https://cloud.openthings.io/forward/v1/your_token
    replace your_token with your actual OTC token. This provides direct remote access to your controller. You can bookmark this link in your browser or add it to your smartphone's home screen for quick access.