Note: Remote access via OTC token is now supported on OpenSprinkler 3.x (firmware v2.2.0 and beyond) as well as OpenSprinkler Pi / Beagle / Linux (firmware v2.2.1 and beyond). This feature is NOT available for OpenSprinkler 2.x.

Introduction

OpenThings Cloud (OTC) token allows remote access of your OpenSprinkler. With OTC, the controller and your mobile app / UI communicate with each other via the OpenThings cloud server. This eliminates the need for port forwarding (which is difficult or impossible to set up particularly for mobile routers). Before proceeding, make sure you have the minimum necessary firmware installed: at least version 2.2.0 for OpenSprinkler 3.x; and at least version 2.2.1 for OpenSprinkler Pi / Beagle / Linux. If not, please follow the instructions here to upgrade your firmware.


Also note that once you have OTC set up for remote access, you no longer need to use the controller's local IP address (which only works while you are on the same network as the controller). With OTC, you can access your controller anywhere, whether you are at home or elsewhere. In the app / UI, you DO need to add a new site / device using the OTC token, and once that's done, you can delete your existing site added using OpenSprinkler's IP address (of course if you choose to keep it that's also fine, knowing that the IP-based site can only work locally and NOT remotely).


Step A: Create an OTC Token

  1. Go to www.openthings.io and log in using your opensprinkler.com login email/username and password. If you do not yet have an opensprinkler.com account, please 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. Once you log in to openthings.io, you will see the dashboard. On the left side of the dashboard, click
    My OpenThings Devices
    See the image below for illustration.
    Do NOT click on My OpenThings Blynk Devices (that's for creating Blynk token, not OTC token).
  3. Next, type in a device description, select 'OpenSprinkler' from the dropdown list, then click on Add New Device. See the image below for illustration.This will create a new OpenSprinkler device, and you will see the OTC token illustrated above. The token is 32-characters long. You will need to copy and paste this token to your OpenSprinkler settings (explained below).

Step B: Update OpenSprinkler Settings

  1. You will need to change settings on your OpenSprinkler device to enable the OTC token: at the homepage of your controller, click the lower-right corner icon to go to 'Edit Options', and click the Integration tab. Choose Enable. Then copy/paste your entire OTC token (32 characters long) into the box. The default OTC server is ws.cloud.openthings.io and the default port is 80. You can leave them as is. See the image below for illustration.
  2. Submit the changes. Then reboot your OpenSprinkler. You are all set.
  3. To verify if OTC cloud connection is valid, after the controller is rebooted, at the homepage, swipe left to right (or click the upper-left corner icon) to open the left-side menu, then click System Diagnostics. At the bottom of the panel you will see the OTC status. If it says 'Connected' that means the connection is successful. If it says 'Connecting...' you may wait for 30 seconds or so and check again. The status 'Not enabled' means OTC is not enabled, and 'Disconnected' means the connection has failed. See image below for illustration.


Step C: Use the OTC Token for remote access

The OpenSprinkler mobile app / UI supports adding a device by its OTC token. To do so, simply add a new device and choose OpenThings Cloud as the Connection Type. After adding this new device, you can delete your old site added using the controller's IP address, because OTC works both remotely and locally.



Alternatively, you can also go to https://ui.opensprinkler.com in a web browser and add a device by its OTC token.


The third options is: you can open a browser and type in:

https://cloud.openthings.io/forward/v1/your_token

where your_token is your OTC token. This will allow you to remotely access the controller as well. You can bookmark this link in your browser or on a smartphone device, add this link to the homepage.