Ignition Project

An importable Ignition project archive that adds a waterly script library to your gateway. Bind the included sendDataToWaterly(tags) helper to any Gateway Scheduled or Timer event to post selected tag paths from any Ignition tag provider directly to WaterlyConnect — no intermediate server required.

Open API Reference Download Project ZIP

8.1+Ignition version

.zipImportable archive

0External servers needed

Prerequisites

Ignition 8.1+ Gateway with Designer access.
An Ignition tag provider with the tags you want to submit.
A Waterly-provided device ID, API token, and submission URL. Email support@waterly.com to request credentials.
Outbound HTTPS access from the Ignition host to the WaterlyConnect endpoint.

Import the Project

1
Open the Gateway Webpage. Navigate to Config ▸ System ▸ Projects.
2
Import. Click Import project…, select ignition_to_waterly.zip, and follow the prompts.
3
Verify. Check Status ▸ Gateway Scripts to confirm the project loaded. You can also verify via Designer ▸ Project Browser ▸ Scripting ▸ Script Library ▸ waterly.

Configure Credentials

In Designer, open Project Browser ▸ Scripting ▸ Script Library ▸ waterly and replace the placeholder constants at the top of the script:

# --- Waterly configuration ---
waterly_api_url     = "https://app.waterlyapp.com/connect/submit"
waterly_device_id   = "<WATERLY_DEVICE_ID>"
waterly_device_token = "<WATERLY_DEVICE_TOKEN>"
# -----------------------------

Do not commit your API token to source control. Store it only in the Designer configuration on your gateway.

Add a Gateway Event

1
In Designer, open Project Browser ▸ Scripting ▸ Gateway Events.
2
Add a Scheduled (specific times) or Timer (fixed rate) event. Give it a descriptive name and configure the timing.
3
Paste one of the example scripts below into the Script tab, enable the event, and Save the project.

Scheduled Event Script

Use a Scheduled event to run at specific times (e.g., midnight and noon). Available in Ignition 8.1.6+.

def onScheduledEvent():
    tags = [
        "[default]SiteA/WetWellLevel",
        "[default]SiteA/InfluentFlow",
        "[default]SiteA/PumpRuntime",
    ]
    waterly.sendDataToWaterly(tags)

Timer Event Script

Use a Timer event for a fixed heartbeat (e.g., every 60 000 ms). Set Delay and Delay Type in the event configuration.

tags = [
    "[default]SiteA/WetWellLevel",
    "[default]SiteA/InfluentFlow",
    "[default]SiteA/PumpRuntime",
]
waterly.sendDataToWaterly(tags)

Files

Project archive

Importable .zip containing the gateway script library and project manifest.

Download .zip

Script library

The waterly.py script that resolves tag paths, builds the payload, and POSTs to WaterlyConnect.

waterly/code.py

Package README

Step-by-step import, credential setup, event configuration, and troubleshooting notes.

Open README

Source folder

Full source path in the waterlyconnect-docs repository.

View on GitHub ↗