mirror of
https://github.com/parnic/node-intellicenter.git
synced 2025-06-17 02:21:53 -05:00
Parnic
abe9ba7d95
The API all calls these objects so best to go with the flow. This is a breaking change.
16 lines
778 B
TypeScript
16 lines
778 B
TypeScript
import { ICRequest } from "./request.js";
|
|
/**
|
|
* Requests the configuration of bodies and circuits available to this controller.
|
|
*
|
|
* The response contains the list of bodies and circuits under the `answer` field.
|
|
* Each object has an `objnam` that should be used to reference that object for future requests,
|
|
* and `params`.`SNAME` is the user-entered friendly name that can be displayed for the object.
|
|
* `params`.`OBJTYP` will be either BODY or CIRCUIT depending on the object it's describing.
|
|
*
|
|
* Some objects, such as the Pool body, will have the `params`.`OBJLIST` array populated with
|
|
* a series of attached objects such as a chlorinator device.
|
|
*
|
|
* @returns the object used to issue this request
|
|
*/
|
|
export declare function GetSystemConfiguration(): ICRequest;
|