The remote client class.

Hierarchy

  • Client
    • RemoteClient

Constructors

Properties

accesses: Accesses = ...

The Accesses class instance

actions: Actions = ...

The Actions class instance

airConditioners: AirConditioners = ...

The AirConditioners class instance

alarmSystems: AlarmSystems = ...

The AlarmSystems class instance

analyses: Analyses = ...

The Analyses class instance

blinds: Blinds = ...

The Blinds class instance

cameras: Cameras = ...

The Cameras class instance

clocks: Clocks = ...

The Clocks class instance

controlCircuits: ControlCircuits = ...

The ControlCircuits class instance

energyCosts: EnergyCosts = ...

The EnergyCosts class instance

energyManagers: EnergyManagers = ...

The EnergyManagers class instance

gekkoInfo: GekkoInfo = ...

The GekkoInfo class instance

globalAlarm: GlobalAlarm = ...

The GlobalAlarm class instance

heatingCircuits: HeatingCircuits = ...

The HeatingCircuits class instance

heatingSystems: HeatingSystems = ...

The HeatingSystems class instance

hotWaterCirculations: HotWaterCirculations = ...

The HotWaterCirculations class instance

hotWaterSystems: HotWaterSystems = ...

The HotWaterSystems class instance

lights: Lights = ...

The Lights class instance

loads: Loads = ...

The Loads class instance

logics: Logics = ...

The Logics class instance

multiRooms: MultiRooms = ...

The MultiRooms class instance

pools: Pools = ...

The Pools class instance

roomTemperatures: RoomTemperatures = ...

The RoomTemperatures class instance

saunas: Saunas = ...

The Saunas class instance

smsEmails: SmsEmails = ...

The SmsEmails class instance

stoves: Stoves = ...

The Stoves class instance

vents: Vents = ...

The Vents class instance

wallBoxes: WallBoxes = ...

The WallBoxes class instance

weather: Weather = ...

The Weather class instance

Accessors

Methods

  • Makes update request to the myGEKKO device API.

    Parameters

    • systemType: SystemType

      The myGEKKO device API endpoint.

    • itemId: string

      The item id.

    • query: string

      The query params.

    Returns Promise<string>

    Throws

    ClientError

  • Makes status request to the myGEKKO device API to get a single item trend by system.

    Parameters

    • systemType: SystemType

      The myGEKKO device API endpoint.

    • itemId: string

      The item id.

    • trendId: string

      The item trend id.

    • startDate: string

      The start date as valid date string.

    • endDate: string

      The end date as valid date string.

    • count: number

      The data count.

    Returns Promise<TrendItemResponse>

    Throws

    ClientError

  • Initialize the client and load the system and trend configurations.

    Returns Promise<void>

    Throws

    ClientError

  • Makes a http request.

    Type Parameters

    • T

    Parameters

    • endpoint: string

      The myGEKKO device API endpoint.

    Returns Promise<T>

    Throws

    ClientError

  • Rescan the myGEKKO device system and trend configurations.

    Returns Promise<void>

    Throws

    ClientError

Generated using TypeDoc