From ddffc2cc31a6ce54398d57565d3b01e66d482d6f Mon Sep 17 00:00:00 2001 From: documentation-deploy-action Date: Fri, 6 Dec 2024 11:29:13 +0000 Subject: [PATCH] :memo: docs: Update generated documentation --- functions/configure.html | 2 +- functions/deviceInfo.html | 2 +- functions/getEnvironmentTemperature.html | 2 +- functions/getPower.html | 2 +- functions/getTargetTemperature.html | 2 +- functions/setPower.html | 2 +- functions/setPowerOff.html | 2 +- functions/setPowerOn.html | 2 +- functions/setTargetTemperature.html | 2 +- functions/signIn.html | 2 +- interfaces/CommandsType.html | 4 ++-- interfaces/DeviceInfoType.html | 4 ++-- interfaces/StatusType.html | 4 ++-- interfaces/TemperaturesType.html | 4 ++-- interfaces/UserParametersType.html | 4 ++-- variables/API_URL.html | 2 +- 16 files changed, 21 insertions(+), 21 deletions(-) diff --git a/functions/configure.html b/functions/configure.html index 3f92b8b..c3f1346 100644 --- a/functions/configure.html +++ b/functions/configure.html @@ -7,4 +7,4 @@

Returns {
    deviceInfo: (
        jwtToken: string,
        macAddress: string,
    ) => Promise<DeviceInfoType>;
    getEnvironmentTemperature: (
        jwtToken: string,
        macAddress: string,
    ) => Promise<number>;
    getPower: (jwtToken: string, macAddress: string) => Promise<boolean>;
    getTargetTemperature: (
        jwtToken: string,
        macAddress: string,
    ) => Promise<number>;
    setPower: (
        jwtToken: string,
        macAddress: string,
        value: number,
    ) => Promise<AxiosResponse<any, any>>;
    setPowerOff: (
        jwtToken: string,
        macAddress: string,
    ) => Promise<AxiosResponse<any, any>>;
    setPowerOn: (
        jwtToken: string,
        macAddress: string,
    ) => Promise<AxiosResponse<any, any>>;
    setTargetTemperature: (
        jwtToken: string,
        macAddress: string,
        temperature: number,
    ) => Promise<AxiosResponse<any, any>>;
}

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/deviceInfo.html b/functions/deviceInfo.html index 5dc5f19..a865a08 100644 --- a/functions/deviceInfo.html +++ b/functions/deviceInfo.html @@ -4,4 +4,4 @@

Returns Promise<DeviceInfoType>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getEnvironmentTemperature.html b/functions/getEnvironmentTemperature.html index 37c5258..4722c14 100644 --- a/functions/getEnvironmentTemperature.html +++ b/functions/getEnvironmentTemperature.html @@ -4,4 +4,4 @@

Returns Promise<number>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getPower.html b/functions/getPower.html index 7415316..9c0af20 100644 --- a/functions/getPower.html +++ b/functions/getPower.html @@ -4,4 +4,4 @@

Returns Promise<boolean>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getTargetTemperature.html b/functions/getTargetTemperature.html index 765ee38..b270b71 100644 --- a/functions/getTargetTemperature.html +++ b/functions/getTargetTemperature.html @@ -4,4 +4,4 @@

Returns Promise<number>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/setPower.html b/functions/setPower.html index 190dcdc..0612c45 100644 --- a/functions/setPower.html +++ b/functions/setPower.html @@ -5,4 +5,4 @@

Returns Promise<AxiosResponse<any, any>>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/setPowerOff.html b/functions/setPowerOff.html index dc98703..7f4eb47 100644 --- a/functions/setPowerOff.html +++ b/functions/setPowerOff.html @@ -7,4 +7,4 @@

Example

const response = await api.setPowerOff(jwtToken, macAddress);
console.log(response);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/setPowerOn.html b/functions/setPowerOn.html index 8735177..2e39a97 100644 --- a/functions/setPowerOn.html +++ b/functions/setPowerOn.html @@ -7,4 +7,4 @@

Example

const response = await api.setPowerOn(jwtToken, macAddress);
console.log(response);
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/setTargetTemperature.html b/functions/setTargetTemperature.html index 9ea3673..a6d4a10 100644 --- a/functions/setTargetTemperature.html +++ b/functions/setTargetTemperature.html @@ -5,4 +5,4 @@

Returns Promise<AxiosResponse<any, any>>

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/signIn.html b/functions/signIn.html index a89b2f4..eebf50d 100644 --- a/functions/signIn.html +++ b/functions/signIn.html @@ -7,4 +7,4 @@

Throws

  • If sign-in fails or no tokens are retrieved.
-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/interfaces/CommandsType.html b/interfaces/CommandsType.html index 0bfc436..6383ede 100644 --- a/interfaces/CommandsType.html +++ b/interfaces/CommandsType.html @@ -1,2 +1,2 @@ -CommandsType | edilkamin

Interface CommandsType

interface CommandsType {
    power: boolean;
}

Properties

power -

Properties

power

power: boolean

Settings

Member Visibility

On This Page

Properties
+CommandsType | edilkamin

Interface CommandsType

interface CommandsType {
    power: boolean;
}

Properties

power +

Properties

power

power: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/DeviceInfoType.html b/interfaces/DeviceInfoType.html index 241b8fa..d654e6d 100644 --- a/interfaces/DeviceInfoType.html +++ b/interfaces/DeviceInfoType.html @@ -1,3 +1,3 @@ -DeviceInfoType | edilkamin

Interface DeviceInfoType

interface DeviceInfoType {
    nvm: { user_parameters: UserParametersType };
    status: StatusType;
}

Properties

nvm +DeviceInfoType | edilkamin

Interface DeviceInfoType

interface DeviceInfoType {
    nvm: { user_parameters: UserParametersType };
    status: StatusType;
}

Properties

nvm status -

Properties

nvm

nvm: { user_parameters: UserParametersType }

status

status: StatusType

Settings

Member Visibility

On This Page

Properties
+

Properties

nvm

nvm: { user_parameters: UserParametersType }

status

status: StatusType

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/StatusType.html b/interfaces/StatusType.html index 8b73da5..5a2dc64 100644 --- a/interfaces/StatusType.html +++ b/interfaces/StatusType.html @@ -1,3 +1,3 @@ -StatusType | edilkamin

Interface StatusType

interface StatusType {
    commands: CommandsType;
    temperatures: TemperaturesType;
}

Properties

commands +StatusType | edilkamin

Interface StatusType

interface StatusType {
    commands: CommandsType;
    temperatures: TemperaturesType;
}

Properties

commands temperatures -

Properties

commands

commands: CommandsType

temperatures

temperatures: TemperaturesType

Settings

Member Visibility

On This Page

Properties
+

Properties

commands

commands: CommandsType

temperatures

temperatures: TemperaturesType

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/TemperaturesType.html b/interfaces/TemperaturesType.html index 565bfa0..1095702 100644 --- a/interfaces/TemperaturesType.html +++ b/interfaces/TemperaturesType.html @@ -1,3 +1,3 @@ -TemperaturesType | edilkamin

Interface TemperaturesType

interface TemperaturesType {
    board: number;
    enviroment: number;
}

Properties

board +TemperaturesType | edilkamin

Interface TemperaturesType

interface TemperaturesType {
    board: number;
    enviroment: number;
}

Properties

board enviroment -

Properties

board

board: number

enviroment

enviroment: number

Settings

Member Visibility

On This Page

Properties
+

Properties

board

board: number

enviroment

enviroment: number

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/UserParametersType.html b/interfaces/UserParametersType.html index 694670f..beb3bf4 100644 --- a/interfaces/UserParametersType.html +++ b/interfaces/UserParametersType.html @@ -1,6 +1,6 @@ -UserParametersType | edilkamin

Interface UserParametersType

interface UserParametersType {
    enviroment_1_temperature: number;
    enviroment_2_temperature: number;
    enviroment_3_temperature: number;
    is_auto: boolean;
    is_sound_active: boolean;
}

Properties

enviroment_1_temperature +UserParametersType | edilkamin

Interface UserParametersType

interface UserParametersType {
    enviroment_1_temperature: number;
    enviroment_2_temperature: number;
    enviroment_3_temperature: number;
    is_auto: boolean;
    is_sound_active: boolean;
}

Properties

enviroment_1_temperature enviroment_2_temperature enviroment_3_temperature is_auto is_sound_active -

Properties

enviroment_1_temperature

enviroment_1_temperature: number

enviroment_2_temperature

enviroment_2_temperature: number

enviroment_3_temperature

enviroment_3_temperature: number

is_auto

is_auto: boolean

is_sound_active

is_sound_active: boolean

Settings

Member Visibility

On This Page

Properties
+

Properties

enviroment_1_temperature

enviroment_1_temperature: number

enviroment_2_temperature

enviroment_2_temperature: number

enviroment_3_temperature

enviroment_3_temperature: number

is_auto

is_auto: boolean

is_sound_active

is_sound_active: boolean

Settings

Member Visibility

On This Page

Properties
diff --git a/variables/API_URL.html b/variables/API_URL.html index 2bc7015..8376133 100644 --- a/variables/API_URL.html +++ b/variables/API_URL.html @@ -1 +1 @@ -API_URL | edilkamin

Variable API_URLConst

API_URL: "https://fxtj7xkgc6.execute-api.eu-central-1.amazonaws.com/prod/"

Settings

Member Visibility
+API_URL | edilkamin

Variable API_URLConst

API_URL: "https://fxtj7xkgc6.execute-api.eu-central-1.amazonaws.com/prod/"

Settings

Member Visibility