Class Fritz

Hierarchy

Fritz

Constructors

constructor

new Fritz(username, password, url?): Fritz
Default constructor
Parameters
- username: string
- password: string
- Optional url: string
  
  if not set default is 'http://fritz.box'
Returns Fritz
- Defined in Fritz.ts:66

Properties

`Protected` deviceList

deviceList: null | AVMDevice[]

getBatteryCharge

getBatteryCharge: IExt<unknown> = ...

get battery charge Attention: this function queries the whole device list to get the value for one device. If multiple device will be queried for the battery status, a better approach would be to get the device list once and then filter out the devices of interest.

Param

getBulbList

getBulbList: IBase<string[]> = ...

get a list of all bulbs

getButtonList

getButtonList: IBase<string[]> = ...

get a list of all button devices

getColorBulbList

getColorBulbList: IBase<string[]> = ...

get a list of bulbs which support colors

getSwitchEnergy

getSwitchEnergy: IExt<number> = ...

get the total enery consumption. returns the value in Wh

Param

getSwitchName

getSwitchName: IExt<string> = ...

get switch name

Param

getSwitchPower

getSwitchPower: IExt<null | number> = ...

get the current enery consumption of an outlet. returns the value in mW

Param

getSwitchPresence

getSwitchPresence: IExt<boolean> = ...

get the outet presence status

Param

getSwitchState

getSwitchState: IExt<boolean> = ...

get switch state

Param

getTempComfort

getTempComfort: IExt<ITemp> = ...

get comfort temperature (Komforttemperatur)

Param

getTempNight

getTempNight: IExt<ITemp> = ...

get night temperature (Absenktemperatur)

Param

getTempTarget

getTempTarget: IExt<ITemp> = ...

get target temperature (Solltemperatur)

Param

getTemplateList

getTemplateList: IBase<any[]> = ...

get template information (json)

getThermostatList

getThermostatList: IBase<any> = ...

get the thermostat list

getWindowOpen

getWindowOpen: IExt<boolean> = ...

Get the window open flag of a thermostat Attention: this function queries the whole device list to get the value for one device. If multiple device will be queried for the window open status, a better approach would be to get the device list once and then filter out the devices of interest.

Param

`Protected` password

password: string

setSwitchOff

setSwitchOff: IExt<boolean> = ...

turn an outlet off. returns the state the outlet was set to

Param

setSwitchOn

setSwitchOn: IExt<boolean> = ...

turn an outlet on. returns the state the outlet was set to

Param

setSwitchToggle

setSwitchToggle: IExt<boolean> = ...

toggle an outlet. returns the state the outlet was set to

Param

`Protected` sid

sid: null | string

`Protected` url

url: string = defaultUrl

`Protected` username

username: string

Methods

applyTemplate

applyTemplate(ain): Promise<unknown>
apply template
Parameters
- ain: string
Returns Promise<unknown>
- Defined in Fritz.ts:265

checkSession

checkSession(): Promise<boolean>
check if session id is OK

Returns Promise<boolean>
- Defined in Fritz.ts:191

executeCommand

executeCommand<T>(sid, command, ain, path?, ...param): Promise<T>
Execute Fritz API command for device specified by AIN
Type Parameters
- T
Parameters
- sid: boolean
- command: null | string
- ain: null | string
- Optional path: string
- Rest ...param: string[]
Returns Promise<T>
- Defined in Fritz.ts:126

getBasicDeviceStats

getBasicDeviceStats(ain): Promise<unknown>
get basic device info (XML)
Parameters
- ain: string
Returns Promise<unknown>
- Defined in Fritz.ts:273

getDataSheet

getDataSheet(): Promise<OSInfo>
get full FritzBox config

Returns Promise<OSInfo>
- Defined in Fritz.ts:225

getDevice

getDevice(ain): Promise<null | AVMDevice>
get single device
Parameters
- ain: string
Returns Promise<null | AVMDevice>
- Defined in Fritz.ts:325

getDeviceList

getDeviceList(): Promise<AVMDevice[]>
get device list

Returns Promise<AVMDevice[]>
- Defined in Fritz.ts:288

getDeviceListFiltered

getDeviceListFiltered(filter): Promise<AVMDevice[]>
get device list by filter criteria
Parameters
- filter: any
Returns Promise<AVMDevice[]>
- Defined in Fritz.ts:306

getDeviceListInfos

getDeviceListInfos(): Promise<string>
get detailed device information (XML)

Returns Promise<string>
- Defined in Fritz.ts:281

getGuestWlan

getGuestWlan(): Promise<any>
Returns Promise<any>
- Defined in Fritz.ts:803

getOSVersion

getOSVersion(): Promise<null | string>
get OS version

Returns Promise<null | string>
- Defined in Fritz.ts:205

getPhoneList

getPhoneList(): Promise<unknown>
get phone devices

Returns Promise<unknown>
- Defined in Fritz.ts:859

getPresence

getPresence(ain): Promise<boolean>
get presence from deviceListInfo
Parameters
- ain: string
Returns Promise<boolean>
- Defined in Fritz.ts:345

getSID

getSID(): Promise<string>
get SID

Returns Promise<string>
- Defined in Fritz.ts:79

`Private` getSessionID

getSessionID(username, password): Promise<string>
Private
get session id
Parameters
- username: string
- password: string
Returns Promise<string>
- Defined in Fritz.ts:164

getSwitchList

getSwitchList(): Promise<any[]>
get switch list

Returns Promise<any[]>
- Defined in Fritz.ts:356

getTemperature

getTemperature(ain): Promise<number>
get temperature- both switches and thermostats are supported, but not powerline modules
Parameters
- ain: string
Returns Promise<number>
- Defined in Fritz.ts:336

getTemplateListInfos

getTemplateListInfos(): Promise<string>
get template information (XML)

Returns Promise<string>
- Defined in Fritz.ts:240

parseGuestWlanHTML

parseGuestWlanHTML(html): void
Parameters
- html: string
Returns void
- Defined in Fritz.ts:771

setBlind

setBlind(ain, blindState): Promise<string | number>
Parameters
- ain: string
- blindState: string | number
Returns Promise<string | number>
- Defined in Fritz.ts:736

setColor

setColor(ain, color, satindex, duration): Promise<ColorName>
Set the color and saturation of a color bulb Valid color values are: red, orange, yellow, lime, green, turquoise, cyan, lightblue, blue, purple, magenta and pink Valid satindex values are: 0, 1 or 2
Parameters
- ain: string
- color: ColorName
- satindex: number
- duration: number
Returns Promise<ColorName>
- Defined in Fritz.ts:683

setColorTemperature

setColorTemperature(ain, temperature, duration): Promise<6500 | 5900 | 5300 | 4700 | 4200 | 3800 | 3400 | 3000 | 2700>
Set the color temperature of a bulb.
Parameters
- ain: string
- temperature: number
  
  Valid values are 2700, 3000, 3400,3800, 4200, 4700, 5300, 5900 and 6500.
- duration: number
Returns Promise<6500 | 5900 | 5300 | 4700 | 4200 | 3800 | 3400 | 3000 | 2700>
- Defined in Fritz.ts:706

setGuestWlan

setGuestWlan(enable): Promise<void>
Parameters
- enable: boolean
Returns Promise<void>
- Defined in Fritz.ts:814

setHkrBoost

setHkrBoost(ain, endtime): Promise<number>
activate boost with end time or deactivate boost
Parameters
- ain: string
- endtime: number
Returns Promise<number>
- Defined in Fritz.ts:512

setHkrOffset

setHkrOffset(deviceId, offset): Promise<number>
activate window open with end time or deactivate boost
Parameters
- deviceId: string
- offset: number
Returns Promise<number>
- Defined in Fritz.ts:539

setHkrWindowOpen

setHkrWindowOpen(ain, endtime): Promise<void>
activate window open with end time or deactivate boost
Parameters
- ain: string
- endtime: number
Returns Promise<void>
- Defined in Fritz.ts:526

setLevel

setLevel(ain, level): Promise<number>
Dimm the device, allowed values are 0 - 255
Parameters
- ain: string
- level: number
Returns Promise<number>
- Defined in Fritz.ts:645

setLevelPercentage

setLevelPercentage(ain, levelInPercent): Promise<number>
Dimm the device, allowed values are 0 - 100
Parameters
- ain: string
- levelInPercent: number
Returns Promise<number>
- Defined in Fritz.ts:659

setSimpleOnOff

setSimpleOnOff(ain, state): Promise<IState>
switch the device on, of or toggle its current state
Parameters
- ain: string
- state: IState
Returns Promise<IState>
- Defined in Fritz.ts:628

setTempTarget

setTempTarget(ain, temp): Promise<number>
set target temperature (Solltemperatur)
Parameters
- ain: string
- temp: number
Returns Promise<number>
- Defined in Fritz.ts:468

`Static` `Private` httpRequest

httpRequest<T>(request, options?): Promise<T>
Private
Request helper
Type Parameters
- T
Parameters
- request: string
- Optional options: ReqOption
Returns Promise<T>
- Defined in Fritz.ts:95

Class Fritz

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

username: string

password: string

Optional url: string

Returns Fritz

Properties

Protected deviceList

getBatteryCharge

Param

getBulbList

getButtonList

getColorBulbList

getSwitchEnergy

Param

getSwitchName

Param

getSwitchPower

Param

getSwitchPresence

Param

getSwitchState

Param

getTempComfort

Param

getTempNight

Param

getTempTarget

Param

getTemplateList

getThermostatList

getWindowOpen

Param

Protected password

setSwitchOff

Param

setSwitchOn

Param

setSwitchToggle

Param

Protected sid

Protected url

Protected username

Methods

applyTemplate

Parameters

ain: string

Returns Promise<unknown>

checkSession

Returns Promise<boolean>

executeCommand

Type Parameters

T

Parameters

sid: boolean

command: null | string

ain: null | string

Optional path: string

Rest ...param: string[]

Returns Promise<T>

getBasicDeviceStats

Parameters

ain: string

Returns Promise<unknown>

getDataSheet

Returns Promise<OSInfo>

getDevice

Parameters

ain: string

Returns Promise<null | AVMDevice>

getDeviceList

Returns Promise<AVMDevice[]>

getDeviceListFiltered

`Optional` url: string

`Protected` deviceList

`Protected` password

`Protected` sid

`Protected` url

`Protected` username

`Optional` path: string

`Rest` ...param: string[]

`Private` getSessionID