@xyo-network/pentair-plugin 2.55.5 → 2.56.1

package/src/screenlogic/controller.ts

@@ -1,377 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { FindUnits, RemoteLogin, UnitConnection } from 'node-screenlogic'
-
-/* From https://github.com/schemers/homebridge-screenlogic */
-
-interface ControllerOptions {
-  ip_address?: string
-  log?: typeof console
-  password?: string
-  port?: number
-  username?: string
-}
-
-export class Controller {
-  static readonly HEAT_MODE_HEAT_PUMP = 3
-  static readonly HEAT_MODE_OFF = 0
-  static readonly HEAT_MODE_SOLAR = 1
-  static readonly HEAT_MODE_SOLAR_PREFERRED = 2
-  static readonly HEAT_MODE_UNCHANGED = 4
-
-  static readonly POOL_CIRCUIT_ID = 505
-  static readonly SPA_CIRCUIT_ID = 500
-
-  private readonly ip_address?: string
-  private readonly log: typeof console
-
-  private readonly password?: string
-  private readonly port?: number
-  private readonly username?: string
-
-  constructor(settings?: ControllerOptions) {
-    this.log = settings?.log ?? console
-    this.ip_address = settings?.ip_address
-    this.port = settings?.port
-    this.username = settings?.username
-    this.password = settings?.password
-  }
-
-  _getConnection(): Promise<UnitConnection> {
-    if (this.ip_address) {
-      return this._getConnectionByIPAddress()
-    } else if (this.username && this.password) {
-      return this._getConnectionByRemoteLogin()
-    } else {
-      return this._getConnectionByBroadcast()
-    }
-  }
-
-  /** get a connection by udp broadcast */
-  _getConnectionByBroadcast(): Promise<UnitConnection> {
-    return new Promise((resolve, reject) => {
-      const finder = new FindUnits()
-      finder
-        .on('serverFound', (server: { gatewayName: any }) => {
-          finder.close()
-          const connection = new UnitConnection(server)
-          connection.gatewayName = server.gatewayName
-          resolve(connection)
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      finder.search()
-    })
-  }
-
-  /** get a connection by IP address */
-  _getConnectionByIPAddress(): Promise<UnitConnection> {
-    return new Promise((resolve, _reject) => {
-      const connection = new UnitConnection(this.port || 80, this.ip_address, this.password)
-      connection.gatewayName = this.username ?? 'Pentair: XX-XX-XX'
-      resolve(connection)
-    })
-  }
-
-  /** find a unit by remote login */
-  _getConnectionByRemoteLogin(): Promise<UnitConnection> {
-    return new Promise((resolve, reject) => {
-      const remote = new RemoteLogin(this.username)
-      remote
-        .on('gatewayFound', (unit: { gatewayFound: any; ipAddr: any; port: any }) => {
-          remote.close()
-          if (unit && unit.gatewayFound) {
-            const connection = new UnitConnection(unit.port, unit.ipAddr, this.password)
-            connection.gatewayName = this.username
-            resolve(connection)
-          } else {
-            reject(new ControllerError('no remote unit found'))
-          }
-        })
-        .on('error', (err: Error) => {
-          reject(err)
-        })
-      remote.connect()
-    })
-  }
-
-  _getPoolConfig(connection: UnitConnection): Promise<PoolConfig> {
-    let softwareVersion = ''
-    return new Promise((resolve, reject) => {
-      connection
-        .once('version', (version: any) => {
-          softwareVersion = version.version
-          connection.getControllerConfig()
-        })
-        .once('controllerConfig', (poolConfig: any) => {
-          //this.log.debug('controllerConfig', poolConfig)
-          resolve(new PoolConfig(connection.gatewayName, softwareVersion, poolConfig))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.getVersion()
-    })
-  }
-
-  _getPoolStatus(connection: UnitConnection): Promise<PoolStatus> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('poolStatus', (status) => {
-          //this.log.debug('poolStatus', status)
-          resolve(new PoolStatus(status))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.getPoolStatus()
-    })
-  }
-
-  _login(connection: UnitConnection): Promise<void> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('loggedIn', () => {
-          resolve()
-        })
-        .once('loginFailed', () => {
-          reject(new ControllerError('unable to login'))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.connect()
-    })
-  }
-
-  _sendLightCommand(connection: UnitConnection, cmd: number): Promise<void> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('sentLightCommand', () => {
-          resolve()
-        })
-        .once('badParameter', () => {
-          reject(new ControllerError('bad parameter passed to send light command'))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.sendLightCommand(0, cmd)
-    })
-  }
-
-  _setCircuitState(connection: UnitConnection, circuitId: number, circuitState: boolean): Promise<void> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('circuitStateChanged', () => {
-          resolve()
-        })
-        .once('badParameter', () => {
-          reject(new ControllerError('bad parameter passed to set command'))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.setCircuitState(0, circuitId, circuitState ? 1 : 0)
-    })
-  }
-
-  _setHeatMode(connection: UnitConnection, bodyType: number, heatMode: number): Promise<void> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('heatModeChanged', () => {
-          resolve()
-        })
-        .once('badParameter', () => {
-          reject(new ControllerError('bad parameter passed to set command'))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.setHeatMode(0, bodyType, heatMode)
-    })
-  }
-
-  _setHeatPoint(connection: UnitConnection, bodyType: number, heatPoint: number): Promise<void> {
-    return new Promise((resolve, reject) => {
-      connection
-        .once('setPointChanged', () => {
-          resolve()
-        })
-        .once('badParameter', () => {
-          reject(new ControllerError('bad parameter passed to set command'))
-        })
-        .on('error', (err: any) => {
-          reject(err)
-        })
-      connection.setSetPoint(0, bodyType, heatPoint)
-    })
-  }
-
-  async getPoolConfig(): Promise<PoolConfig> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._getPoolConfig(connection)
-    } finally {
-      connection.close()
-    }
-  }
-
-  async getPoolStatus(): Promise<PoolStatus> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._getPoolStatus(connection)
-    } finally {
-      connection.close()
-    }
-  }
-
-  async sendLightCommand(cmd: number): Promise<void> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._sendLightCommand(connection, cmd)
-    } finally {
-      connection.close()
-    }
-  }
-
-  async setCircuitState(circuitId: number, circuitState: boolean): Promise<void> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._setCircuitState(connection, circuitId, circuitState)
-    } finally {
-      connection.close()
-    }
-  }
-
-  async setHeatMode(bodyType: number, heatMode: number): Promise<void> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._setHeatMode(connection, bodyType, heatMode)
-    } finally {
-      connection.close()
-    }
-  }
-
-  async setHeatPoint(bodyType: number, heatPoint: number): Promise<void> {
-    const connection = await this._getConnection()
-    try {
-      await this._login(connection)
-      return await this._setHeatPoint(connection, bodyType, heatPoint)
-    } finally {
-      connection.close()
-    }
-  }
-}
-
-export class ControllerError extends Error {}
-
-export interface PoolCircuitJson {
-  id: number
-  name: string
-}
-
-export class PoolCircuit implements PoolCircuitJson {
-  constructor(readonly id: number, readonly name: string) {}
-}
-
-export interface PoolConfigJson {
-  circuits: PoolCircuitJson[]
-  deviceId: string
-  gatewayName: string
-  hasPool: boolean
-  hasSpa: boolean
-  isCelsius: boolean
-  poolMaxSetPoint: number
-  poolMinSetPoint: number
-  softwareVersion: string
-  spaMaxSetPoint: number
-  spaMinSetPoint: number
-}
-
-export class PoolConfig implements PoolConfigJson {
-  circuits: PoolCircuit[] = []
-  readonly deviceId: string
-  readonly gatewayName: string
-  readonly hasPool: boolean
-  readonly hasSpa: boolean
-  readonly isCelsius: boolean
-  readonly poolMaxSetPoint: number
-  readonly poolMinSetPoint: number
-  readonly softwareVersion: string
-  readonly spaMaxSetPoint: number
-  readonly spaMinSetPoint: number
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  constructor(gatewayName: string, softwareVersion: string, config: any) {
-    this.gatewayName = gatewayName
-    this.deviceId = gatewayName.replace('Pentair: ', '')
-
-    this.softwareVersion = softwareVersion
-    this.isCelsius = config.degC
-    this.poolMinSetPoint = config.minSetPoint[0] ?? 0
-    this.poolMaxSetPoint = config.maxSetPoint[0] ?? 0
-    this.spaMinSetPoint = config.minSetPoint[1] ?? 0
-    this.spaMaxSetPoint = config.maxSetPoint[1] ?? 0
-    this.hasSpa = false
-    this.hasPool = false
-    this.circuits = []
-    for (const circuit of config.bodyArray) {
-      const poolCircuit = new PoolCircuit(circuit.circuitId, circuit.name)
-      this.circuits.push(poolCircuit)
-      if (poolCircuit.id === Controller.POOL_CIRCUIT_ID) {
-        this.hasPool = true
-      } else if (poolCircuit.id === Controller.SPA_CIRCUIT_ID) {
-        this.hasSpa = true
-      }
-    }
-  }
-}
-
-export class PoolStatus {
-  readonly airTemperature: number
-  readonly circuitState = new Map<number, number>()
-  readonly hasPool: boolean
-  readonly hasSpa: boolean
-  readonly isPoolActive: boolean
-  readonly isPoolHeating: boolean
-  readonly isSpaActive: boolean
-  readonly isSpaHeating: boolean
-  readonly poolHeatMode: number
-  readonly poolSetPoint: number
-  readonly poolTemperature: number
-  readonly spaHeatMode: number
-  readonly spaSetPoint: number
-  readonly spaTemperature: number
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  constructor(status: any) {
-    // save circuit state
-    this.circuitState = new Map()
-    for (const circuit of status.circuitArray) {
-      this.circuitState.set(circuit.id, circuit.state)
-    }
-
-    this.hasPool = this.circuitState.get(Controller.POOL_CIRCUIT_ID) !== undefined
-    this.hasSpa = this.circuitState.get(Controller.SPA_CIRCUIT_ID) !== undefined
-
-    this.poolTemperature = status.currentTemp[0]
-    this.poolSetPoint = status.setPoint[0]
-    this.isPoolActive = this.hasPool && status.isPoolActive()
-    this.isPoolHeating = this.hasPool && status.heatStatus[0] !== 0
-    this.poolHeatMode = status.heatMode[0]
-
-    this.spaTemperature = status.currentTemp[1]
-    this.spaSetPoint = status.setPoint[1]
-    this.isSpaActive = this.hasSpa && status.isSpaActive()
-    this.isSpaHeating = this.hasSpa && status.heatStatus[1] !== 0
-    this.spaHeatMode = status.heatMode[1]
-
-    this.airTemperature = status.airTemp
-  }
-}

package/src/screenlogic/index.ts

@@ -1 +0,0 @@
-export * from './controller'

package/src/screenlogic/types/index.d.ts

@@ -1,135 +0,0 @@
-declare module 'node-screenlogic' {
-  declare class EventEmitter {
-    eventNames(): string[]
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    on<T>(event: string, func: (data: T) => void)
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    once<T>(event: string, func: (data: T) => void)
-  }
-
-  declare class FindUnits extends EventEmitter {
-    constructor()
-
-    close()
-
-    foundServer(msg, remote)
-
-    search()
-
-    sendServerBroadcast()
-  }
-
-  declare class RemoteLogin extends EventEmitter {
-    constructor(systemName)
-    close()
-
-    connect()
-
-    onClientMessage(msg)
-
-    onConnected()
-  }
-
-  declare class UnitConnection extends EventEmitter {
-    //this is an arbitrary field added in code
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    gatewayName: any
-
-    constructor(server, address?, password?)
-
-    addClient(clientId, senderId?)
-
-    addNewScheduleEvent(scheduleType, senderId?)
-
-    cancelDelay(senderId?)
-
-    close()
-
-    connect()
-
-    deleteScheduleEventById(scheduleId, senderId?)
-
-    getChemHistoryData(fromTime, toTime, senderId?)
-
-    getChemicalData(senderId?)
-
-    getControllerConfig(senderId?)
-
-    getEquipmentConfiguration(senderId?)
-
-    getHistoryData(fromTime, toTime, senderId?)
-
-    getPoolStatus()
-
-    getPumpStatus(pumpId, senderId?)
-
-    getSaltCellConfig(senderId?)
-
-    getScheduleData(scheduleType, senderId?)
-
-    getSystemTime(senderId?)
-
-    getVersion(senderId?)
-
-    getWeatherForecast(senderId?)
-
-    login()
-
-    onClientMessage(msg)
-
-    onConnected()
-
-    pingServer(senderId?)
-
-    processData(msg)
-
-    removeClient(clientId, senderId?)
-
-    sendLightCommand(controllerId, command, senderId?)
-
-    setCircuitRuntimebyId(circuitId, runTime, senderId?)
-
-    setCircuitState(controllerId, circuitId, circuitState, senderId?)
-
-    setHeatMode(controllerId, bodyType, heatMode, senderId?)
-
-    setPumpFlow(pumpId, circuitId, setPoint, isRPMs, senderId?)
-
-    setSaltCellOutput(controllerId, poolOutput, spaOutput, senderId?)
-
-    setScheduleEventById(scheduleId, circuitId, startTime, stopTime, dayMask, flags, heatCmd, heatSetPoint, senderId?)
-
-    setSetPoint(controllerId, bodyType, temperature, senderId?)
-
-    setSystemTime(date, shouldAdjustForDST, senderId?)
-  }
-
-  declare const HEAT_MODE_DONTCHANGE
-  declare const HEAT_MODE_HEATPUMP
-  declare const HEAT_MODE_OFF
-  declare const HEAT_MODE_SOLAR
-  declare const HEAT_MODE_SOLARPREFERRED
-  declare const LIGHT_CMD_COLOR_BLUE
-  declare const LIGHT_CMD_COLOR_GREEN
-  declare const LIGHT_CMD_COLOR_MODE_AMERICAN
-  declare const LIGHT_CMD_COLOR_MODE_CARIBBEAN
-  declare const LIGHT_CMD_COLOR_MODE_PARTY
-  declare const LIGHT_CMD_COLOR_MODE_ROMANCE
-  declare const LIGHT_CMD_COLOR_MODE_ROYAL
-  declare const LIGHT_CMD_COLOR_MODE_SUNSET
-  declare const LIGHT_CMD_COLOR_PURPLE
-  declare const LIGHT_CMD_COLOR_RED
-  declare const LIGHT_CMD_COLOR_SET
-  declare const LIGHT_CMD_COLOR_SET_RECALL
-  declare const LIGHT_CMD_COLOR_SET_SAVE
-  declare const LIGHT_CMD_COLOR_SWIM
-  declare const LIGHT_CMD_COLOR_SYNC
-  declare const LIGHT_CMD_COLOR_WHITE
-  declare const LIGHT_CMD_LIGHTS_OFF
-  declare const LIGHT_CMD_LIGHTS_ON
-  declare const PUMP_TYPE_INTELLIFLOVF
-  declare const PUMP_TYPE_INTELLIFLOVS
-  declare const PUMP_TYPE_INTELLIFLOVSF
-}