edilkamin
    Preparing search index...

    Function configure

    • Configures the library for API interactions. Initializes API methods with a specified base URL.

      Parameters

      • OptionalbaseURL: string = API_URL

        The base URL for the API.

      Returns {
          deviceInfo: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<DeviceInfoType>;
          editDevice: (
              jwtToken: string,
              macAddress: string,
              deviceName?: string,
              deviceRoom?: string,
          ) => Promise<DeviceAssociationResponse>;
          getAlarmHistory: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<AlarmsLogType>;
          getAuto: (jwtToken: string, macAddress: string) => Promise<boolean>;
          getEnvironment1Temperature: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getEnvironment2Temperature: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getEnvironment3Temperature: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getEnvironmentTemperature: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getFan1Speed: (jwtToken: string, macAddress: string) => Promise<number>;
          getFan2Speed: (jwtToken: string, macAddress: string) => Promise<number>;
          getFan3Speed: (jwtToken: string, macAddress: string) => Promise<number>;
          getFanSpeed: (
              jwtToken: string,
              macAddress: string,
              fanIndex: 1 | 2 | 3,
          ) => Promise<number>;
          getLanguage: (jwtToken: string, macAddress: string) => Promise<number>;
          getMeasureUnit: (jwtToken: string, macAddress: string) => Promise<boolean>;
          getPelletAutonomyTime: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getPelletInReserve: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<boolean>;
          getPower: (jwtToken: string, macAddress: string) => Promise<boolean>;
          getPowerDistribution: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<PowerDistributionType>;
          getPowerLevel: (jwtToken: string, macAddress: string) => Promise<number>;
          getRegenerationData: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<RegenerationDataType>;
          getServiceCounters: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<ServiceCountersType>;
          getServiceStatus: (
              jwtToken: string,
              macAddress: string,
              thresholdHours?: number,
          ) => Promise<ServiceStatusType>;
          getServiceTime: (jwtToken: string, macAddress: string) => Promise<number>;
          getStandby: (jwtToken: string, macAddress: string) => Promise<boolean>;
          getStandbyTime: (jwtToken: string, macAddress: string) => Promise<number>;
          getTargetTemperature: (
              jwtToken: string,
              macAddress: string,
              envIndex: 1 | 2 | 3,
          ) => Promise<number>;
          getTotalCounters: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<TotalCountersType>;
          getTotalOperatingHours: (
              jwtToken: string,
              macAddress: string,
          ) => Promise<number>;
          getUsageAnalytics: (
              jwtToken: string,
              macAddress: string,
              serviceThreshold?: number,
          ) => Promise<UsageAnalyticsType>;
          registerDevice: (
              jwtToken: string,
              macAddress: string,
              serialNumber: string,
              deviceName?: string,
              deviceRoom?: string,
          ) => Promise<DeviceAssociationResponse>;
          setAirkare: (
              jwtToken: string,
              macAddress: string,
              enabled: boolean,
          ) => Promise<unknown>;
          setAuto: (
              jwtToken: string,
              macAddress: string,
              enabled: boolean,
          ) => Promise<unknown>;
          setEnvironment1Temperature: (
              jwtToken: string,
              macAddress: string,
              temperature: number,
          ) => Promise<unknown>;
          setEnvironment2Temperature: (
              jwtToken: string,
              macAddress: string,
              temperature: number,
          ) => Promise<unknown>;
          setEnvironment3Temperature: (
              jwtToken: string,
              macAddress: string,
              temperature: number,
          ) => Promise<unknown>;
          setFan1Speed: (
              jwtToken: string,
              macAddress: string,
              speed: number,
          ) => Promise<unknown>;
          setFan2Speed: (
              jwtToken: string,
              macAddress: string,
              speed: number,
          ) => Promise<unknown>;
          setFan3Speed: (
              jwtToken: string,
              macAddress: string,
              speed: number,
          ) => Promise<unknown>;
          setFanSpeed: (
              jwtToken: string,
              macAddress: string,
              fanIndex: 1 | 2 | 3,
              speed: number,
          ) => Promise<unknown>;
          setLanguage: (
              jwtToken: string,
              macAddress: string,
              languageCode: number,
          ) => Promise<unknown>;
          setMeasureUnit: (
              jwtToken: string,
              macAddress: string,
              isFahrenheit: boolean,
          ) => Promise<unknown>;
          setPower: (
              jwtToken: string,
              macAddress: string,
              value: number,
          ) => Promise<unknown>;
          setPowerLevel: (
              jwtToken: string,
              macAddress: string,
              level: number,
          ) => Promise<unknown>;
          setPowerOff: (jwtToken: string, macAddress: string) => Promise<unknown>;
          setPowerOn: (jwtToken: string, macAddress: string) => Promise<unknown>;
          setRelax: (
              jwtToken: string,
              macAddress: string,
              enabled: boolean,
          ) => Promise<unknown>;
          setStandby: (
              jwtToken: string,
              macAddress: string,
              enabled: boolean,
          ) => Promise<unknown>;
          setStandbyTime: (
              jwtToken: string,
              macAddress: string,
              minutes: number,
          ) => Promise<unknown>;
          setTargetTemperature: (
              jwtToken: string,
              macAddress: string,
              envIndex: 1 | 2 | 3,
              temperature: number,
          ) => Promise<unknown>;
      }

      • An object containing methods for interacting with the API.
      • deviceInfo: (jwtToken: string, macAddress: string) => Promise<DeviceInfoType>
      • editDevice: (
            jwtToken: string,
            macAddress: string,
            deviceName?: string,
            deviceRoom?: string,
        ) => Promise<DeviceAssociationResponse>
      • getAlarmHistory: (jwtToken: string, macAddress: string) => Promise<AlarmsLogType>
      • getAuto: (jwtToken: string, macAddress: string) => Promise<boolean>
      • getEnvironment1Temperature: (jwtToken: string, macAddress: string) => Promise<number>
      • getEnvironment2Temperature: (jwtToken: string, macAddress: string) => Promise<number>
      • getEnvironment3Temperature: (jwtToken: string, macAddress: string) => Promise<number>
      • getEnvironmentTemperature: (jwtToken: string, macAddress: string) => Promise<number>
      • getFan1Speed: (jwtToken: string, macAddress: string) => Promise<number>
      • getFan2Speed: (jwtToken: string, macAddress: string) => Promise<number>
      • getFan3Speed: (jwtToken: string, macAddress: string) => Promise<number>
      • getFanSpeed: (jwtToken: string, macAddress: string, fanIndex: 1 | 2 | 3) => Promise<number>
      • getLanguage: (jwtToken: string, macAddress: string) => Promise<number>
      • getMeasureUnit: (jwtToken: string, macAddress: string) => Promise<boolean>
      • getPelletAutonomyTime: (jwtToken: string, macAddress: string) => Promise<number>
      • getPelletInReserve: (jwtToken: string, macAddress: string) => Promise<boolean>
      • getPower: (jwtToken: string, macAddress: string) => Promise<boolean>
      • getPowerDistribution: (jwtToken: string, macAddress: string) => Promise<PowerDistributionType>
      • getPowerLevel: (jwtToken: string, macAddress: string) => Promise<number>
      • getRegenerationData: (jwtToken: string, macAddress: string) => Promise<RegenerationDataType>
      • getServiceCounters: (jwtToken: string, macAddress: string) => Promise<ServiceCountersType>
      • getServiceStatus: (
            jwtToken: string,
            macAddress: string,
            thresholdHours?: number,
        ) => Promise<ServiceStatusType>
      • getServiceTime: (jwtToken: string, macAddress: string) => Promise<number>
      • getStandby: (jwtToken: string, macAddress: string) => Promise<boolean>
      • getStandbyTime: (jwtToken: string, macAddress: string) => Promise<number>
      • getTargetTemperature: (jwtToken: string, macAddress: string, envIndex: 1 | 2 | 3) => Promise<number>
      • getTotalCounters: (jwtToken: string, macAddress: string) => Promise<TotalCountersType>
      • getTotalOperatingHours: (jwtToken: string, macAddress: string) => Promise<number>
      • getUsageAnalytics: (
            jwtToken: string,
            macAddress: string,
            serviceThreshold?: number,
        ) => Promise<UsageAnalyticsType>
      • registerDevice: (
            jwtToken: string,
            macAddress: string,
            serialNumber: string,
            deviceName?: string,
            deviceRoom?: string,
        ) => Promise<DeviceAssociationResponse>
      • setAirkare: (jwtToken: string, macAddress: string, enabled: boolean) => Promise<unknown>
      • setAuto: (jwtToken: string, macAddress: string, enabled: boolean) => Promise<unknown>
      • setEnvironment1Temperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<unknown>
      • setEnvironment2Temperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<unknown>
      • setEnvironment3Temperature: (jwtToken: string, macAddress: string, temperature: number) => Promise<unknown>
      • setFan1Speed: (jwtToken: string, macAddress: string, speed: number) => Promise<unknown>
      • setFan2Speed: (jwtToken: string, macAddress: string, speed: number) => Promise<unknown>
      • setFan3Speed: (jwtToken: string, macAddress: string, speed: number) => Promise<unknown>
      • setFanSpeed: (
            jwtToken: string,
            macAddress: string,
            fanIndex: 1 | 2 | 3,
            speed: number,
        ) => Promise<unknown>
      • setLanguage: (jwtToken: string, macAddress: string, languageCode: number) => Promise<unknown>
      • setMeasureUnit: (
            jwtToken: string,
            macAddress: string,
            isFahrenheit: boolean,
        ) => Promise<unknown>
      • setPower: (jwtToken: string, macAddress: string, value: number) => Promise<unknown>
      • setPowerLevel: (jwtToken: string, macAddress: string, level: number) => Promise<unknown>
      • setPowerOff: (jwtToken: string, macAddress: string) => Promise<unknown>
      • setPowerOn: (jwtToken: string, macAddress: string) => Promise<unknown>
      • setRelax: (jwtToken: string, macAddress: string, enabled: boolean) => Promise<unknown>
      • setStandby: (jwtToken: string, macAddress: string, enabled: boolean) => Promise<unknown>
      • setStandbyTime: (jwtToken: string, macAddress: string, minutes: number) => Promise<unknown>
      • setTargetTemperature: (
            jwtToken: string,
            macAddress: string,
            envIndex: 1 | 2 | 3,
            temperature: number,
        ) => Promise<unknown>
      const api = configure();
      const power = await api.getPower(jwtToken, macAddress);

    Settings

    Member Visibility