Class RainBirdService
Hierarchy
- EventEmitter
- RainBirdService
Index
Constructors
constructor
- new RainBirdService(
options: {
address: string;
password: string;
refreshRate?: number;
showRequestResponse: boolean;
syncTime: boolean;
},
): RainBirdServiceParameters
- options: {
address: string;
password: string;
refreshRate?: number;
showRequestResponse: boolean;
syncTime: boolean;
}
Returns RainBirdService
- options: {
Accessors
model
- get model(): string
Returns string
rainSetPointReached
- get rainSetPointReached(): boolean
Returns boolean
serialNumber
- get serialNumber(): string
Returns string
version
- get version(): string
Returns string
zones
- get zones(): number[]
Returns number[]
Methods
activateZone
Parameters
- zone: number
- duration: number
Returns void
deactivateAllZones
Returns void
deactivateZone
Parameters
- zone: number
Returns Promise<void>
emitLog
Parameters
- level: string
The log level.
- message: string
The log message.
Returns void
- level: string
enableZone
Parameters
- zone: number
- enabled: boolean
Returns void
getIrrigationDelay
Returns Promise<number>
init
Returns Promise<RainBirdMetaData>
isActive
Parameters
Optionalzone: number
Returns boolean
isInUse
Parameters
Optionalzone: number
Returns boolean
isProgramRunning
Parameters
- programId: string
Returns undefined | boolean
refreshStatus
Returns void
remainingDuration
Parameters
Optionalzone: number
Returns number
setIrrigationDelay
Parameters
- days: number
Returns Promise<void>
startProgram
Parameters
- programId: string
Returns Promise<void>
stopIrrigation
Returns Promise<void>
Emit a log event.