Class TadoX

TadoX class provides functions to interact with the TadoX API, including user authentication and various home and device management operations.

Example: Fetch user information (javascript)

// Import the TadoX client
const { TadoX } = require("node-tado-client");

// Create a new TadoX instance
var tado = new TadoX();

// Set a cllabck to catch token changes
tado.setTokenCallback(console.log);

// Authenticate with the Tado API
 const [verify, futureToken] = await tado.authenticate("refresh_token");

 if (verify) {
   console.log("------------------------------------------------");
   console.log("Device authentication required.");
   console.log("Please visit the following website in a browser.");
   console.log("");
   console.log(`  ${verify.verification_uri_complete}`);
   console.log("");
   console.log(
     `Checks will occur every ${verify.interval}s up to a maximum of ${verify.expires_in}s`,
   );
   console.log("------------------------------------------------");
 }
 await futureToken;

 const me = await tado.getMe();
 console.log(me);

Hierarchy

BaseTado
- TadoX

Index

Constructors

constructor

new TadoX(): TadoX
Returns TadoX
Inherited from BaseTado.constructor
- Defined in src/base.ts:55

Accessors

token

get token(): Token | undefined
Get the latest Oauth Token and Refresh Token

Returns Token | undefined
The latest token
Inherited from BaseTado.token
- Defined in src/base.ts:157

Methods

addEnergyIQMeterReading

addEnergyIQMeterReading(
    home_id: number,
    date: string,
    reading: number,
): Promise<AddEnergiIQMeterReadingResponse>
Adds an energy IQ meter reading for a given home.
Parameters
- home_id: number
  The ID of the home.
- date: string
  The date of the meter reading in ISO format.
- reading: number
  The meter reading value.
Returns Promise<AddEnergiIQMeterReadingResponse>
A promise that resolves to the response of the API call.
Inherited from BaseTado.addEnergyIQMeterReading
- Defined in src/base.ts:874

addEnergyIQTariff

addEnergyIQTariff(
    home_id: number,
    unit: IQUnit,
    startDate: string,
    endDate: string,
    tariffInCents: number,
): Promise<void>
Adds a new energy IQ tariff for a specified home.
Parameters
- home_id: number
  The identifier of the home.
- unit: IQUnit
  The unit of energy measurement.
- startDate: string
  The start date of the tariff in ISO format.
- endDate: string
  The end date of the tariff in ISO format.
- tariffInCents: number
  The tariff amount in cents.
Returns Promise<void>
A promise that resolves to the API response.

Throws
TadoError if the unit is not valid.
Inherited from BaseTado.addEnergyIQTariff
- Defined in src/base.ts:797

apiCall

apiCall<R, T = unknown>(url: string, method?: Method, data?: T): Promise<R>
Makes an API call to the provided URL with the specified method and data.
Type Parameters
- R
  The type of the response
- T = unknown
  The type of the request body
Parameters
- url: string
  The endpoint to which the request is sent. If the URL contains "https", it will be used as is.
- method: Method = "get"
  The HTTP method to use for the request (e.g., "get", "post").
- Optionaldata: T
  The payload to send with the request, if applicable.
Returns Promise<R>
A promise that resolves to the response data.
Inherited from BaseTado.apiCall
- Defined in src/base.ts:242

apiCallX

apiCallX<R, T = unknown>(url: string, method?: Method, data?: T): Promise<R>
Makes an API call to the provided TadoX URL with the specified method and data.
Type Parameters
- R
  The type of the response
- T = unknown
  The type of the request body
Parameters
- url: string
  The endpoint to which the request is sent. If the URL contains "https", it will be used as is.
- method: Method = "get"
  The HTTP method to use for the request (e.g., "get", "post").
- Optionaldata: T
  The payload to send with the request, if applicable.
Returns Promise<R>
A promise that resolves to the response data.
- Defined in src/tadox.ts:68

authenticate

authenticate(
refreshToken?: string,
timeout?: number,
): Promise<[DeviceVerification | undefined, Promise<Token>]>
Authenticate with the Oauth server. A refresh token may be supplied to bypass the device auth flow if it is still valid, otherwise the device flow is initiaited.
Parameters
- OptionalrefreshToken: string
  Attempt to use this refresh token to re-authenticate
- Optionaltimeout: number
  Ignore the Tado provided timeout for device auth and use this value
Returns Promise<[DeviceVerification | undefined, Promise<Token>]>
A promise that resolves to either a DeviceVerification object for device auth flows and a promise of a token, or an undefined auth flow and a promise of a token, if the refresh token was supplied
Inherited from BaseTado.authenticate
- Defined in src/base.ts:189

createInvitation

createInvitation(home_id: number, email: string): Promise<Invitation>
Creates an invitation for a specified home.
Parameters
- home_id: number
  The unique identifier of the home to which the invitation will be sent.
- email: string
  The email address of the invitee.
Returns Promise<Invitation>
A promise that resolves to an Invitation object.
Inherited from BaseTado.createInvitation
- Defined in src/base.ts:440

createPushNotificationRegistration

createPushNotificationRegistration(
    home_id: number,
    mobile_device_id: number,
    token: string,
): Promise<PushNotificationRegistration>
Creates a push notification registration for a given home and mobile device.

Note: Do not use this unless you know what you are doing, you might want to consider registering a dummy device.
Parameters
- home_id: number
  The identifier for the home.
- mobile_device_id: number
  The identifier for the mobile device.
- token: string
  The push notification token for the device.
Returns Promise<PushNotificationRegistration>
A promise that resolves to the push notification registration (AWS SNS Endpoint ARN).
Inherited from BaseTado.createPushNotificationRegistration
- Defined in src/base.ts:567

deleteEnergyIQMeterReading

deleteEnergyIQMeterReading(home_id: number, reading_id: number): Promise<void>
Deletes a specific energy meter reading for a given home.
Parameters
- home_id: number
  The unique identifier of the home.
- reading_id: number
  The unique identifier of the meter reading to be deleted.
Returns Promise<void>
A promise that resolves when the meter reading has been successfully deleted.
Inherited from BaseTado.deleteEnergyIQMeterReading
- Defined in src/base.ts:893

deleteInvitation

deleteInvitation(home_id: number, token: string): Promise<void>
Deletes an invitation associated with a home.
Parameters
- home_id: number
  The unique identifier of the home.
- token: string
  The token associated with the invitation.
Returns Promise<void>
A promise that resolves when the invitation is successfully deleted.
Inherited from BaseTado.deleteInvitation
- Defined in src/base.ts:464

disableFlowTemperatureOptimization

disableFlowTemperatureOptimization(home_id: number): Promise<string>
Disable Flow Temperature Optimization settings.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<string>
if changed.
- Defined in src/tadox.ts:311

enableFlowTemperatureOptimization

enableFlowTemperatureOptimization(home_id: number): Promise<string>
Enable Flow Temperature Optimization settings.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<string>
if changed.
- Defined in src/tadox.ts:299

getActionableDevices

getActionableDevices(home_id: number): Promise<ActionableDevice[]>
Retrieve actionable devices.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
Returns Promise<ActionableDevice[]>
A promise that resolves to a list of actionable devices.
- Defined in src/tadox.ts:99

getAirComfort

getAirComfort(home_id: number): Promise<AirComfort>
Retrieves the air comfort details for a given home.
Parameters
- home_id: number
  The ID of the home for which to get the air comfort details.
Returns Promise<AirComfort>
A promise that resolves to an AirComfort object containing the air comfort details.
- Defined in src/tadox.ts:336

getAirComfortDetailed

getAirComfortDetailed(home_id: number): Promise<AirComfortDetailed>
Fetches detailed air comfort information for a specific home.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<AirComfortDetailed>
A promise that resolves to detailed air comfort data.
Inherited from BaseTado.getAirComfortDetailed
- Defined in src/base.ts:732

getAwayConfiguration

getAwayConfiguration(
home_id: number,
room_id: number,
): Promise<XRoomAwayConfiguration>
Retrieves the away configuration for a specific home and zone.
Parameters
- home_id: number
  The unique identifier of the home.
- room_id: number
  The unique identifier of the zone within the home.
Returns Promise<XRoomAwayConfiguration>
A promise that resolves to the away configuration object.
- Defined in src/tadox.ts:247

getBoilerSystemInformation

getBoilerSystemInformation(system_id: number): Promise<BoilerSystemInformation>
Retrieves information about the specified boiler system. This includes model name, image used by the app, and manufacturer names.
Parameters
- system_id: number
  The unique identifier of the boiler system as retrieved in getHomeHeatingSystem.
Returns Promise<BoilerSystemInformation>
A promise that resolves to an object containing the boiler system information.
Example
```
const heatingSystem = await tado.getHomeHeatingSystem(1907);
const boilerInformation = await tado.getBoilerSystemInformation(heatingSystem.boiler.id);
console.log(
  `Your boiler model is ${boilerInformation.modelName} manufactured by ${boilerInformation.manufacturers[0].name}`,
);
```
Inherited from BaseTado.getBoilerSystemInformation
- Defined in src/base.ts:954

getEnergyIQConsumptionDetails

getEnergyIQConsumptionDetails(
    home_id: number,
    month: number,
    year: number,
): Promise<EnergyIQConsumptionDetails>
Retrieves energy consumption details for a specified home, month, and year.
Parameters
- home_id: number
  The unique identifier of the home.
- month: number
  The specific month for which the consumption details are requested.
- year: number
  The specific year for which the consumption details are requested.
Returns Promise<EnergyIQConsumptionDetails>
A promise resolving to the energy consumption details for the specified time period.
Inherited from BaseTado.getEnergyIQConsumptionDetails
- Defined in src/base.ts:746

getEnergyIQMeterReadings

getEnergyIQMeterReadings(home_id: number): Promise<EnergyIQMeterReadings>
Fetches the Energy IQ meter readings for a specified home.
Parameters
- home_id: number
  The unique identifier of the home for which the meter readings are to be retrieved.
Returns Promise<EnergyIQMeterReadings>
A promise that resolves to the Energy IQ meter readings for the specified home.
Inherited from BaseTado.getEnergyIQMeterReadings
- Defined in src/base.ts:862

getEnergyIQOverview

getEnergyIQOverview(
    home_id: number,
    month: number,
    year: number,
): Promise<EnergyIQOverview>
Fetches the energy consumption overview for a specified home, month, and year.
Parameters
- home_id: number
  The unique identifier of the home.
- month: number
  The month for which the energy overview is needed.
- year: number
  The year for which the energy overview is needed.
Returns Promise<EnergyIQOverview>
A promise that resolves to an EnergyIQOverview object containing the energy consumption details.
Inherited from BaseTado.getEnergyIQOverview
- Defined in src/base.ts:765

getEnergyIQTariff

getEnergyIQTariff(home_id: number): Promise<EnergyIQTariffs>
Fetches the EnergyIQ tariff for a given home.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<EnergyIQTariffs>
A promise that resolves to the EnergyIQTariffs object.
Inherited from BaseTado.getEnergyIQTariff
- Defined in src/base.ts:782

getEnergySavingsReport

getEnergySavingsReport(
    home_id: number,
    year: number,
    month: number,
    countryCode: string,
): Promise<EnergySavingReport>
Fetches the energy savings report for a specific home and time period.
Parameters
- home_id: number
  The unique identifier of the home.
- year: number
  The year for the report.
- month: number
  The month for the report.
- countryCode: string
  The country code of the home.
Returns Promise<EnergySavingReport>
A promise that resolves to the energy savings report.
Example: Get the energy savings report for the current month
```
const today = new Date();
const countryCode = await tado.getHome(home_id).address.country;
const report = await this tado.getEnergySavingsReport(home_id, today.getFullYear(), today.getMonth() + 1)
```
Inherited from BaseTado.getEnergySavingsReport
- Defined in src/base.ts:917

getFeatures

getFeatures(home_id: number): Promise<XFeatures>
Fetches the features supported by the home.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
Returns Promise<XFeatures>
A promise that resolves to a list of features.
- Defined in src/tadox.ts:89

getFlowTemperatureOptimization

getFlowTemperatureOptimization(
home_id: number,
): Promise<FlowTemperatureOptimization>
Get the Flow Temperature Optimization settings.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<FlowTemperatureOptimization>
Flow Temperature Optimization settings.
- Defined in src/tadox.ts:289

getHeatingCircuits

getHeatingCircuits(home_id: number): Promise<HeatingCircuit>
Retrieves the heating circuits associated with a given home based on the home ID.
Parameters
- home_id: number
  The ID of the home for which to retrieve heating circuits.
Returns Promise<HeatingCircuit>
A promise that resolves to a HeatingCircuit object.
Inherited from BaseTado.getHeatingCircuits
- Defined in src/base.ts:494

getHome

getHome(home_id: number): Promise<Home>
Fetches and returns the home details for the specified home ID.
Parameters
- home_id: number
  The ID of the home to be retrieved.
Returns Promise<Home>
A promise that resolves to the details of the home.
Inherited from BaseTado.getHome
- Defined in src/base.ts:326

getHomeHeatingSystem

getHomeHeatingSystem(home_id: number): Promise<HeatingSystem>
Retrieves the heating system information for a specific home.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<HeatingSystem>
A promise that resolves to the heating system information of the specified home.
Inherited from BaseTado.getHomeHeatingSystem
- Defined in src/base.ts:934

getHomeSummary

getHomeSummary(home_id: number): Promise<XHomeSummary>
Fetches a subset of the home info.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
Returns Promise<XHomeSummary>
A promise that resolves to home summary data.
- Defined in src/tadox.ts:79

getIncidentDetection

getIncidentDetection(home_id: number): Promise<HomeIncidentDetection>
Fetches incident detection details for the specified home.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<HomeIncidentDetection>
A promise that resolves to the incident detection details of the home.
Inherited from BaseTado.getIncidentDetection
- Defined in src/base.ts:349

getInstallations

getInstallations(home_id: number): Promise<Installation[]>
Fetches the list of installations for a given home.
Parameters
- home_id: number
  The ID of the home for which to fetch installations.
Returns Promise<Installation[]>
A promise that resolves to an array of installations.
Inherited from BaseTado.getInstallations
- Defined in src/base.ts:408

getInvitation

getInvitation(home_id: number, token: string): Promise<Invitation>
Retrieves an invitation based on the provided home ID and token.
Parameters
- home_id: number
  The ID of the home for which the invitation is to be retrieved.
- token: string
  The unique token (invitation id) associated with the invitation.
Returns Promise<Invitation>
A promise that resolves to the invitation details.
Inherited from BaseTado.getInvitation
- Defined in src/base.ts:429

getInvitations

getInvitations(home_id: number): Promise<Invitation[]>
Fetches the list of invitations for a specified home.
Parameters
- home_id: number
  The ID of the home for which to retrieve invitations.
Returns Promise<Invitation[]>
A promise that resolves to an array of Invitation objects.
Inherited from BaseTado.getInvitations
- Defined in src/base.ts:418

getMe

getMe(): Promise<Me>
Fetches the current user data.

Returns Promise<Me>
A promise that resolves to the user data.
Inherited from BaseTado.getMe
- Defined in src/base.ts:316

getMobileDevice

getMobileDevice(
home_id: number,
mobile_device_id: number,
): Promise<MobileDevice>
Fetches a mobile device associated with the given home ID and mobile device ID.
Parameters
- home_id: number
  The ID of the home.
- mobile_device_id: number
  The ID of the mobile device.
Returns Promise<MobileDevice>
A promise that resolves to the mobile device data.
Inherited from BaseTado.getMobileDevice
- Defined in src/base.ts:514

getMobileDeviceGeoLocationConfig

getMobileDeviceGeoLocationConfig(
home_id: number,
mobile_device_id: number,
): Promise<MobileDeviceGeoLocationConfig>
Fetches the geo-location configuration for a specific mobile device in a home.
Parameters
- home_id: number
  The unique identifier of the home.
- mobile_device_id: number
  The unique identifier of the mobile device.
Returns Promise<MobileDeviceGeoLocationConfig>
A promise that resolves to the mobile device's geo-location configuration.
Inherited from BaseTado.getMobileDeviceGeoLocationConfig
- Defined in src/base.ts:590

getMobileDevices

getMobileDevices(home_id: number): Promise<MobileDevice[]>
Retrieves a list of mobile devices associated with a given home ID.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<MobileDevice[]>
A promise that resolves to an array of MobileDevice objects.
Inherited from BaseTado.getMobileDevices
- Defined in src/base.ts:503

getMobileDeviceSettings

getMobileDeviceSettings(
home_id: number,
mobile_device_id: number,
): Promise<MobileDeviceSettings>
Fetches the settings for a specific mobile device within a given home.
Parameters
- home_id: number
  The unique identifier of the home.
- mobile_device_id: number
  The unique identifier of the mobile device.
Returns Promise<MobileDeviceSettings>
A promise that resolves to the mobile device's settings.
Inherited from BaseTado.getMobileDeviceSettings
- Defined in src/base.ts:525

getRatelimit

getRatelimit(): RateLimit | undefined
Get the Tado API rate limit information

Returns RateLimit | undefined
RateLimit if an API call has occured
Inherited from BaseTado.getRatelimit
- Defined in src/base.ts:175

getRooms

getRooms(home_id: number): Promise<XRoom[]>
Fetches the rooms for a given home.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
Returns Promise<XRoom[]>
A promise that resolves to a list of room states.
- Defined in src/tadox.ts:119

getRoomsAndDevices

getRoomsAndDevices(home_id: number): Promise<XRoomsAndDevices[]>
Retrieves a list of rooms and devices associated with the given home ID.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<XRoomsAndDevices[]>
A promise that resolves to an object containing rooms and devices.
- Defined in src/tadox.ts:109

getRoomState

getRoomState(home_id: number, room_id: number): Promise<XRoom>
Fetches the state of a specified room in a home.
Parameters
- home_id: number
  The ID of the home.
- room_id: number
  The ID of the room within the home.
Returns Promise<XRoom>
A promise that resolves to a room's state.
- Defined in src/tadox.ts:130

getRunningTimes

getRunningTimes(
    home_id: number,
    from: string,
    to: string,
    aggregate: RunningTimeAggregation,
    summary_only: true,
): Promise<RunningTimesSummaryOnly>
Retrieves the running times for a specific home within a given date range.
Parameters
- home_id: number
  The unique identifier for the home.
- from: string
  The start date of the range in ISO 8601 format.
- to: string
  The end date of the range in ISO 8601 format.
- aggregate: RunningTimeAggregation
  The method of aggregation for the running times.
- summary_only: true
  Indicates that only a summary of the running times is to be returned.
Returns Promise<RunningTimesSummaryOnly>
A promise that resolves to a summary of the running times.
Inherited from BaseTado.getRunningTimes
- Defined in src/base.ts:610
getRunningTimes(
    home_id: number,
    from: string,
    to: string,
    aggregate: RunningTimeAggregation,
    summary_only: false,
): Promise<RunningTimes>
Retrieves the running times of a specific home within a specified date range.
Parameters
- home_id: number
  The unique identifier of the home.
- from: string
  The start date of the range in ISO 8601 format.
- to: string
  The end date of the range in ISO 8601 format.
- aggregate: RunningTimeAggregation
  The type of aggregation to apply to the running times.
- summary_only: false
  If false, detailed running times are included; otherwise, only the summary is provided.
Returns Promise<RunningTimes>
A promise that resolves to the running times data for the specified home and date range.
Inherited from BaseTado.getRunningTimes
- Defined in src/base.ts:627

getState

getState(home_id: number): Promise<State>
Fetches the state of a home based on the provided home ID.
Parameters
- home_id: number
  The unique identifier of the home for which the state is to be retrieved.
Returns Promise<State>
A promise that resolves to the state of the specified home.
Inherited from BaseTado.getState
- Defined in src/base.ts:484

getUsers

getUsers(home_id: number): Promise<User[]>
Fetches the list of users associated with a given home.
Parameters
- home_id: number
  The ID of the home for which to fetch users.
Returns Promise<User[]>
A promise that resolves to an array of User objects.
Inherited from BaseTado.getUsers
- Defined in src/base.ts:474

getWeather

getWeather(home_id: number): Promise<Weather>
Fetches the weather information for a specified home.
Parameters
- home_id: number
  The unique identifier of the home for which to retrieve the weather data.
Returns Promise<Weather>
A promise that resolves to a Weather object containing the weather information for the specified home.
Inherited from BaseTado.getWeather
- Defined in src/base.ts:398

isAnyoneAtHome

isAnyoneAtHome(home_id: number): Promise<boolean>
Checks if anyone is at home based on the geo-tracking data of mobile devices.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<boolean>
A promise that resolves to a boolean indicating if any tracked device is at home.
Inherited from BaseTado.isAnyoneAtHome
- Defined in src/base.ts:688

isDomesticHotWaterCapable

isDomesticHotWaterCapable(home_id: number): Promise<boolean>
Check if home is hot water capable.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<boolean>
True if the home is hot water capable, false otherwise.
- Defined in src/tadox.ts:276

isEarlyStartEnabled

isEarlyStartEnabled(home_id: number): Promise<boolean>
Checks if the early start feature is enabled for a given home.
Parameters
- home_id: number
  The unique identifier of the home.
Returns Promise<boolean>
A promise that resolves to a boolean indicating whether the early start feature is enabled.
Inherited from BaseTado.isEarlyStartEnabled
- Defined in src/base.ts:372

manualControl

manualControl(
    home_id: number,
    room_id: number,
    power: Power,
    termination: number | XTermination,
    temperature?: number,
): Promise<unknown>
Sets manual control for a specific room in a home.
Parameters
- home_id: number
  The identifier of the home.
- room_id: number
  The identifier of the room within the home.
- power: Power
  The power state, either 'ON' or 'OFF'.
- termination: number | XTermination
  The termination condition for the overlay. Options include 'MANUAL', 'NEXT_TIME_BLOCK', or a number representing duration in seconds.
- Optionaltemperature: number
  The desired temperature for the overlay, in celsius.
Returns Promise<unknown>
A promise that resolves to the created zone overlay.
- Defined in src/tadox.ts:166

performQuickAction

performQuickAction(home_id: number, action: XQuickAction): Promise<string>
Perform a predefined quick action on all rooms.
Parameters
- home_id: number
  The ID of the home.
- action: XQuickAction
  The action to perform.
Returns Promise<string>
A promise that resolves on completion.
- Defined in src/tadox.ts:141

resendInvitation

resendInvitation(home_id: number, token: string): Promise<void>
Resends an invitation to a specific home.
Parameters
- home_id: number
  The ID of the home for which the invitation is to be resent.
- token: string
  The token representing the invitation to be resent.
Returns Promise<void>
A promise that resolves once the invitation has been resent.
Inherited from BaseTado.resendInvitation
- Defined in src/base.ts:453

resumeSchedule

resumeSchedule(home_id: number, room_id: number): Promise<string>
Resumes the schedule for a specific room in a home.
Parameters
- home_id: number
  The unique identifier of the home.
- room_id: number
  The unique identifier of the room within the home.
Returns Promise<string>
A promise that resolves when the operation is complete.
- Defined in src/tadox.ts:152

setAwayConfiguration

setAwayConfiguration(
    home_id: number,
    room_id: number,
    config: Omit<XRoomAwayConfiguration, "roomId">,
): Promise<XRoomAwayConfiguration>
Sets the away configuration for a specified zone in the home.
Parameters
- home_id: number
  The unique identifier of the home.
- room_id: number
  The unique identifier of the zone within the home.
- config: Omit<XRoomAwayConfiguration, "roomId">
  The configuration settings for away mode.
Returns Promise<XRoomAwayConfiguration>
A promise that resolves when the configuration has been successfully set.
- Defined in src/tadox.ts:262

setAwayRadius

setAwayRadius(home_id: number, away_radius_meters: number): Promise<void>
Sets the away radius for a specific home.
Parameters
- home_id: number
  The ID of the home.
- away_radius_meters: number
  The away radius in meters.
Returns Promise<void>
A promise that resolves when the away radius is successfully set.
Inherited from BaseTado.setAwayRadius
- Defined in src/base.ts:337

setChildlock

setChildlock(
    home_id: number,
    serial_no: string,
    child_lock: boolean,
): Promise<void>
Set device child lock status.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
- serial_no: string
  The serial number of the device.
- child_lock: boolean
  Boolean value to enable or disable the child lock.
Returns Promise<void>
A promise that resolves when the operation is complete.
- Defined in src/tadox.ts:216

setDeviceTemperatureOffset

setDeviceTemperatureOffset(
    home_id: number,
    serial_no: string,
    temperatureOffset: number,
): Promise<void>
Set device child lock status.
Parameters
- home_id: number
  The ID of the home for which to fetch the zones.
- serial_no: string
  The serial number of the device.
- temperatureOffset: number
  The temperature offset to be set, in degrees Celsius.
Returns Promise<void>
A promise that resolves when the operation is complete.
- Defined in src/tadox.ts:230

setEarlyStart

setEarlyStart(home_id: number, enabled: boolean): Promise<void>
Sets the early start feature for a specified home.
Parameters
- home_id: number
  The unique identifier of the home.
- enabled: boolean
  A boolean indicating whether the early start feature should be enabled or disabled.
Returns Promise<void>
A promise that resolves when the early start setting has been successfully updated.
Inherited from BaseTado.setEarlyStart
- Defined in src/base.ts:386

setFlowTemperatureOptimization

setFlowTemperatureOptimization(
home_id: number,
temperature: number,
): Promise<string>
Set the Flow Temperature Optimization max temperature.
Parameters
- home_id: number
  The unique identifier of the home.
- temperature: number
  The max. temperature.
Returns Promise<string>
if changed.
- Defined in src/tadox.ts:324

setGeoTracking

setGeoTracking(
    home_id: number,
    mobile_device_id: number,
    geoTrackingEnabled: boolean,
): Promise<MobileDeviceSettings>
Sets the geo-tracking settings for a specified mobile device in a given home.
Parameters
- home_id: number
  The ID of the home.
- mobile_device_id: number
  The ID of the mobile device.
- geoTrackingEnabled: boolean
  A flag indicating whether geo-tracking should be enabled.
Returns Promise<MobileDeviceSettings>
A promise that resolves to the updated mobile device settings.
Inherited from BaseTado.setGeoTracking
- Defined in src/base.ts:540

setIncidentDetection

setIncidentDetection(home_id: number, enabled: boolean): Promise<void>
Enables or disables incident detection for a specified home.
Parameters
- home_id: number
  The unique identifier of the home.
- enabled: boolean
  Indicates whether incident detection should be enabled (true) or disabled (false).
Returns Promise<void>
A promise that resolves when the operation is complete.
Inherited from BaseTado.setIncidentDetection
- Defined in src/base.ts:360

setPresence

setPresence(home_id: number, presence: StatePresence): Promise<void>
Updates the presence status for a specified home.
Parameters
- home_id: number
  The unique identifier for the home.
- presence: StatePresence
  The new presence state which must be "HOME", "AWAY", or "AUTO".
Returns Promise<void>
Resolves when the presence status has been successfully updated.

Throws
TadoError if the supplied presence state is not "HOME", "AWAY", or "AUTO".
Inherited from BaseTado.setPresence
- Defined in src/base.ts:665

setTokenCallback

setTokenCallback(cb?: (token: Token) => void): void
Set the callback function that is called when the Oauth token changes.
Parameters
- Optionalcb: (token: Token) => void
  The callback function
Returns void
Inherited from BaseTado.setTokenCallback
- Defined in src/base.ts:166

updateEnergyIQTariff

updateEnergyIQTariff(
    home_id: number,
    tariff_id: string,
    unit: IQUnit,
    startDate: string,
    endDate: string,
    tariffInCents: number,
): Promise<EnergyIQTariffInfo>
Updates the Energy IQ tariff for a specified home.
Parameters
- home_id: number
  The unique identifier for the home.
- tariff_id: string
  The unique identifier for the tariff.
- unit: IQUnit
  The unit of the tariff, either "m3" or "kWh."
- startDate: string
  The start date of the tariff in the format 'YYYY-MM-DD.'
- endDate: string
  The end date of the tariff in the format 'YYYY-MM-DD.'
- tariffInCents: number
  The tariff rate in cents.
Returns Promise<EnergyIQTariffInfo>
A promise that resolves to the response of the API call.

Throws
TadoError if the unit is not "m3" or "kWh."
Inherited from BaseTado.updateEnergyIQTariff
- Defined in src/base.ts:832

updatePresence

updatePresence(home_id: number): Promise<void | "already up to date">
Updates the presence state of the specified home.

This method checks if anyone is currently at home and compares it with the current presence state. If there is a discrepancy, it updates the presence state accordingly. If the presence state is already accurate, it returns a message indicating no change was needed.
Parameters
- home_id: number
  The unique identifier of the home whose presence state is to be updated.
Returns Promise<void | "already up to date">
A promise that resolves when the operation is complete, or returns a message if the presence state was already accurate.
Inherited from BaseTado.updatePresence
- Defined in src/base.ts:712

Class TadoX

Example: Fetch user information (javascript)

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns TadoX

Accessors

token

Returns Token | undefined

Methods

addEnergyIQMeterReading

Parameters

Returns Promise<AddEnergiIQMeterReadingResponse>

addEnergyIQTariff

Parameters

Returns Promise<void>

Throws

apiCall

Type Parameters

Parameters

Returns Promise<R>

apiCallX

Type Parameters

Parameters

Returns Promise<R>

authenticate

Parameters

Returns Promise<[DeviceVerification | undefined, Promise<Token>]>

createInvitation

Parameters

Returns Promise<Invitation>

createPushNotificationRegistration

Parameters

Returns Promise<PushNotificationRegistration>

deleteEnergyIQMeterReading

Parameters

Returns Promise<void>

deleteInvitation

Parameters

Returns Promise<void>

disableFlowTemperatureOptimization

Parameters

Returns Promise<string>

enableFlowTemperatureOptimization

Parameters

Returns Promise<string>

getActionableDevices

Parameters

Returns Promise<ActionableDevice[]>

getAirComfort

Parameters

Returns Promise<AirComfort>

getAirComfortDetailed

Parameters

Returns Promise<AirComfortDetailed>

getAwayConfiguration

Parameters

Returns Promise<XRoomAwayConfiguration>

getBoilerSystemInformation

Parameters

Returns Promise<BoilerSystemInformation>

Example

getEnergyIQConsumptionDetails

Parameters

Returns Promise<EnergyIQConsumptionDetails>

getEnergyIQMeterReadings

Parameters

Returns Promise<EnergyIQMeterReadings>

getEnergyIQOverview

Parameters

Returns Promise<EnergyIQOverview>

getEnergyIQTariff

Parameters

Returns Promise<EnergyIQTariffs>

getEnergySavingsReport

Parameters