node-intellicenter/esm/messages/notify.d.ts

NodeJS library for communicating with a Pentair IntelliCenter controller

import { ICRequest } from "./request.js";
/**
 * Requests to subscribe for updates to the given keys.
 *
 * Keys and objnam should be given matching an objnam known to the controller and a key for that object.
 * {@linkcode ICParam} fields are the known list of keys available to subscribe to.
 *
 * The response contains an acknowledgement of success or failure. When the given keys change, the `Unit` will
 * emit a `"notify"` event with an {@linkcode ICResponse} payload for the new values.
 *
 * @param objnam the name of the object to subscribe to updates on
 * @param keys the key or list of keys to subscribe to updates on this object for
 * @returns the object used to issue this request
 */
export declare function SubscribeToUpdates(objnam: string, keys: string | string[]): ICRequest;