rainbird

<!DOCTYPE html><html class="default" lang="en" data-base="."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>rainbird</title><meta name="description" content="Documentation for rainbird"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="assets/style.css"><link rel="stylesheet" href="assets/highlight.css"><script defer="" src="assets/main.js"></script><script async="" src="assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="assets/dmt/dmt-components.css"><link rel="stylesheet" href="assets/dmt/dmt-theme.css"><script src="assets/dmt/dmt-components.js" type="module"></script><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div> <main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="index.html" class="title">rainbird</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><div class="dmt-title-header-flex"><h1>rainbird</h1></div></div><div class="tsd-panel tsd-typography"><a id="api-guide" class="tsd-anchor"></a><h1 class="tsd-anchor-link">API Guide<a href="#api-guide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1>This guide describes the methods, properties & events of the RainBird service. <a id="methods" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li> <code>RainBirdService({ address: string, password: string, refreshRate?: number, showRequestResponse: boolean, syncTime: boolean})</code> Instantiates the RainBirdService class. Parameters: <ul> <li><code>address</code>: controller's local IP Address. Mandatory</li> <li><code>password</code>: controller's password. Mandatory</li> <li><code>refreshRate</code>: how often to request status from controller (in secords). Optional. Default is 0 (never check)</li> <li><code>showRequestResponse</code>: include requests & responses in log events. Mandatory</li> <li><code>syncTime</code>: sync the machine time to the controller. Mandatory</li> </ul> <pre><code class="typescript">import { RainBirdService, LogLevel, EventType } from 'RainBird'; // Create the RainBird service const rainbird = new RainBirdService({ address: '10.0.0.123', password: 'mypassword', refreshRate: 90, showRequestResponse: true, syncTime: true, }); </code><button type="button">Copy</button></pre> </li> <li> <code>init(): Promise<RainBirdMetaData></code> Performs various initialisations for the service. This is typically done once immediately after instantiating the service. It performs the following: <ul> <li>Retrieves the RainBird's model, version, serial number & available zones</li> <li>Checks that its in the correct state to be controlled</li> <li>Sets up the status & sync time jobs</li> <li>Returns various metadata about the RainBird</li> </ul> <pre><code class="typescript">// Initialise the RainBird service var metadata = await rainbird.init(); </code><button type="button">Copy</button></pre> </li> <li> <code>isActive(zone?: number): boolean</code> Returns true if the specified zone is active (i.e. currently running or queued to run). If no zone number is supplied then will check if any zone is active. Parameters: <ul> <li><code>zone</code>: zone number. Optional</li> </ul> <pre><code class="typescript">// Is Zone 1 currently running or queued to run var isZone1Active = rainbird.isActive(1); </code><button type="button">Copy</button></pre> </li> <li> <code>isInUse(zone?: number): boolean</code> Returns true if the specified zone is currently running (does not check if it's queued). If no zone number is supplied then will check if any zone is running. Parameters: <ul> <li><code>zone</code>: zone number. Optional</li> </ul> <pre><code class="typescript">// Is Zone 1 current running? var isZone1Running = rainbird.isInUse(1); </code><button type="button">Copy</button></pre> </li> <li> <code>remainingDuration(zone?: number): number</code> Returns the amount of time (in seconds) remaining for the specified zone. If no zone number is supplied then will return the total for all active zones. Parameters: <ul> <li><code>zone</code>: zone number. Optional</li> </ul> <pre><code class="typescript">// Get the remaining time for Zone 1 var zone1TimeLeft = rainbird.remainingDuration(1); </code><button type="button">Copy</button></pre> </li> <li> <code>activateZone(zone: number, duration: number): void</code> Places the specified zone and duration into a queue. The zone will begin running for the specified duration once all other zones ahead in the queue have completed. Parameters: <ul> <li><code>zone</code>: zone number. Mandatory</li> <li><code>duration</code>: The amount of time (in seconds) for the zone to run. Mandatory.</li> </ul> <pre><code class="typescript">// Active Zone 1 for 10 minutes (600 seconds) rainbird.activateZone(1, 600); </code><button type="button">Copy</button></pre> </li> <li> <code>deactivateZone(zone: number): Promise<void></code> Stops the specified zone or removes it from the queue. Parameters: <ul> <li><code>zone</code>: zone number. Mandatory</li> </ul> <pre><code class="typescript">// Stop Zone 1 if its running or remove it from the queue await rainbird.deactivateZone(1); </code><button type="button">Copy</button></pre> </li> <li> <code>deactivateAllZones(): void</code> Stops the currently running zone and removes any others that are in the queue. <pre><code class="typescript">// Stop all zones await rainbird.deactivateAllZones(1); </code><button type="button">Copy</button></pre> </li> <li> <code>startProgram(programId: string): Promise<void></code> Starts the specified RainBird program. Parameters: <ul> <li><code>programId</code>: The program identifier (letters A - D). Mandatory</li> </ul> <pre><code class="typescript">// Start program A await rainbird.startProgram('A'); </code><button type="button">Copy</button></pre> </li> <li> <code>isProgramRunning(programId: string): boolean | undefined</code> Returns true if the specified program is currently running. Parameters: <ul> <li><code>programId</code>: The program identifier (letters A - D). Mandatory</li> </ul> <pre><code class="typescript">// Is program A running? var isProgramArunning = await rainbird.isProgramRunning('A'); </code><button type="button">Copy</button></pre> </li> <li> <code>stopIrrigation(): Promise<void></code> Performs a Stop Irrigation command on the RainBird. <pre><code class="typescript">// Stop Irrigation await rainbird.stopIrrigation(); </code><button type="button">Copy</button></pre> </li> <li> <code>getIrrigatinDelay(): Promise<number></code> Returns the Irrigation Delay remaining (in days). <pre><code class="typescript">// Get Irrigation Delay days remaining var delayDaysLeft = await rainbird.getIrrigatinDelay(); </code><button type="button">Copy</button></pre> </li> <li> <code>setIrrigationDelay(days: number): Promise<void></code> Set the number of days to delay the irrigation. Parameters: <ul> <li><code>days</code>: number of days to delay irrigation (1 - 14). Mandatory</li> </ul> <pre><code class="typescript">// Set Irrigation Delay to 5 days await rainbird.setIrrigationDelay(5); </code><button type="button">Copy</button></pre> </li> </ul> <a id="properties" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li> <code>model: string</code> Returns the model number of the RainBird controller. <pre><code class="typescript">// Get the RainBird model number var model = rainbird.model; </code><button type="button">Copy</button></pre> </li> <li> <code>version: string</code> Returns the version of the RainBird controller. <pre><code class="typescript">// Get the RainBird version number var version = rainbird.version; </code><button type="button">Copy</button></pre> </li> <li> <code>serialNumber: string</code> Returns the serial number of the RainBird controller. <pre><code class="typescript">// Get the RainBird serial number var serialNumber = rainbird.serialNumber; </code><button type="button">Copy</button></pre> </li> <li> <code>zones: number[]</code> Returns the available zones of the RainBird controller in an array. <pre><code class="typescript">// Get the RainBird zones var zones = rainbird.zones; </code><button type="button">Copy</button></pre> </li> <li> <code>rainSetPointReached: boolean</code> Returns true if the rain sensor's set point has been reached. <pre><code class="typescript">// Is the rain sensor's set point reached? var setPointReached = rainbird.rainSetPointReached; </code><button type="button">Copy</button></pre> </li> </ul> <a id="events" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Events<a href="#events" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul> <li> <code>log</code> Raised when API wants to notify client of a specific log level & message. <pre><code class="typescript">// Handle log events rainbird.on(EventType.LOG, (log) => { console.log(`${log.level}: ${log.message}`); }); </code><button type="button">Copy</button></pre> </li> <li> <code>status</code> Raised when API wants to notify client of a status change <pre><code class="typescript">// Handle status events rainbird.on(EventType.STATUS, () => { console.log('RainBird status changed'); }); </code><button type="button">Copy</button></pre> </li> <li> <code>rain_sensor_state</code> Raised when API wants to notify client of a change to the rain sensor's state <pre><code class="typescript">// Handle status events rainbird.on(EventType.RAIN_SENSOR_STATE, () => { console.log('Rain sensor state has changed'); }); </code><button type="button">Copy</button></pre> </li> </ul> </div></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility">Member Visibility<ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open="" class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details" tabindex="-1"><a href="#api-guide">API Guide</a><ul><li><a href="#methods">Methods</a></li><li><a href="#properties">Properties</a></li><li><a href="#events">Events</a></li></ul></div></details></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="modules.html">rainbird</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>