Namespace firmware

Index

Functions

Functions

Const getRemoteStatus

getRemoteStatus(instance?: Got, delay?: number): Promise<{ isUpgradable: boolean; isUpgrading: boolean; text: string; version: string }>

- Defined in router/firmware.ts:68
Get the remote ipTIME firmware status

Parameters
- instance: Got = defaults.instance
  
  The got instance to use
- delay: number = ...
  
  The polling delay for next request
Returns Promise<{ isUpgradable: boolean; isUpgrading: boolean; text: string; version: string }>
The remote version with isUpgradable parameter

Const getStatus

getStatus(instance?: Got): Promise<{ branch: string; commit: string; date: string; version: string }>

- Defined in router/firmware.ts:13
Get the router metadata

Parameters
- instance: Got = defaults.instance
  
  The got instance to use
Returns Promise<{ branch: string; commit: string; date: string; version: string }>
The router firmware metadata including branch and commit

Const upgrade

upgrade(instance?: Got): Promise<{ isPreparingUpgrade: boolean; text: string }>

- Defined in router/firmware.ts:132
Request router system upgrade

Parameters
- instance: Got = defaults.instance
  
  The got instance to use
Returns Promise<{ isPreparingUpgrade: boolean; text: string }>
The status text

Generated using TypeDoc