From a29d84d7542f8f380082888b182f365e476938fd Mon Sep 17 00:00:00 2001 From: documentation-deploy-action Date: Tue, 3 Dec 2024 20:53:38 +0000 Subject: [PATCH] :memo: docs: Update generated documentation --- functions/configure.html | 2 +- functions/deviceInfo.html | 2 +- functions/setPower.html | 2 +- functions/setPowerOff.html | 2 +- functions/setPowerOn.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 +- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/functions/configure.html b/functions/configure.html index 0e222d4..b83cf0a 100644 --- a/functions/configure.html +++ b/functions/configure.html @@ -1 +1 @@ -configure | edilkamin

Function configure

  • configure(
        baseURL?: string,
    ): {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<DeviceInfoType, any>>;
        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>>;
    }

  • Parameters

    • baseURL: string = API_URL

    Returns {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<DeviceInfoType, any>>;
        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>>;
    }

Settings

Member Visibility
+configure | edilkamin

Function configure

  • configure(
        baseURL?: string,
    ): {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<DeviceInfoType, any>>;
        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>>;
    }

  • Parameters

    • baseURL: string = API_URL

    Returns {
        deviceInfo: (
            jwtToken: string,
            macAddress: string,
        ) => Promise<AxiosResponse<DeviceInfoType, any>>;
        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>>;
    }

Settings

Member Visibility
diff --git a/functions/deviceInfo.html b/functions/deviceInfo.html index 5615fea..474d9a6 100644 --- a/functions/deviceInfo.html +++ b/functions/deviceInfo.html @@ -1 +1 @@ -deviceInfo | edilkamin

Function deviceInfo

  • deviceInfo(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<DeviceInfoType, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<DeviceInfoType, any>>

Settings

Member Visibility
+deviceInfo | edilkamin

Function deviceInfo

  • deviceInfo(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<DeviceInfoType, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<DeviceInfoType, any>>

Settings

Member Visibility
diff --git a/functions/setPower.html b/functions/setPower.html index c9deaee..b84cade 100644 --- a/functions/setPower.html +++ b/functions/setPower.html @@ -1 +1 @@ -setPower | edilkamin

Function setPower

  • setPower(
        jwtToken: string,
        macAddress: string,
        value: number,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string
    • value: number

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
+setPower | edilkamin

Function setPower

  • setPower(
        jwtToken: string,
        macAddress: string,
        value: number,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string
    • value: number

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
diff --git a/functions/setPowerOff.html b/functions/setPowerOff.html index 69fcffc..945ed9c 100644 --- a/functions/setPowerOff.html +++ b/functions/setPowerOff.html @@ -1 +1 @@ -setPowerOff | edilkamin

Function setPowerOff

  • setPowerOff(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
+setPowerOff | edilkamin

Function setPowerOff

  • setPowerOff(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
diff --git a/functions/setPowerOn.html b/functions/setPowerOn.html index af02663..6641d95 100644 --- a/functions/setPowerOn.html +++ b/functions/setPowerOn.html @@ -1 +1 @@ -setPowerOn | edilkamin

Function setPowerOn

  • setPowerOn(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
+setPowerOn | edilkamin

Function setPowerOn

  • setPowerOn(
        jwtToken: string,
        macAddress: string,
    ): Promise<AxiosResponse<any, any>>

  • Parameters

    • jwtToken: string
    • macAddress: string

    Returns Promise<AxiosResponse<any, any>>

Settings

Member Visibility
diff --git a/functions/signIn.html b/functions/signIn.html index b44eb34..c0d1f55 100644 --- a/functions/signIn.html +++ b/functions/signIn.html @@ -1,2 +1,2 @@ signIn | edilkamin

Function signIn

Sign in to return the JWT token.

-
  • signIn(username: string, password: string): Promise<string>

  • Parameters

    • username: string
    • password: string

    Returns Promise<string>

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/interfaces/CommandsType.html b/interfaces/CommandsType.html index 853425c..ee41621 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 6243012..fed861e 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 3bbff18..8c2b009 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 00eff67..adf16cf 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 e7f01e2..7ce97a3 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 7d0b947..edd11d3 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