Class BaseDevice

Hierarchy (view full)

_ObjectSubSite
- BaseDevice
  - LANDevice
  - UAPDevice

Index

Constructors

Constructors

constructor

new BaseDevice(config, props): BaseDevice
Parameters
- config: IObjectSubSiteConfig
- props: Partial<IBaseDeviceRaw> & {
  mac: string;
  }
Returns BaseDevice
Overrides _ObjectSubSite.constructor
- Defined in src/Devices/BaseDevice.ts:44

Properties

_id

_id: string

`Optional` adoptIp

adoptIp?: string

`Optional` adoptUrl

adoptUrl?: string

adoptableWhenUpgraded

adoptableWhenUpgraded: boolean

adopted

adopted: boolean

anonId

anonId: string

architecture

architecture: string

boardRevision

boardRevision: number

bytes

bytes: number

cfgVersion

cfgVersion: string

configNetwork

configNetwork: IConfigNetwork

connectRequestIp

connectRequestIp: string

connectRequestPort

connectRequestPort: string

connectedAt

connectedAt: number

connectionNetworkName

connectionNetworkName: EConnectionNetworkName

`Optional` default

default?: boolean

deviceId

deviceId: string

`Optional` disabled

disabled?: boolean

`Optional` discoveredVia

discoveredVia?: string

displayableVersion

displayableVersion: string

dot1xPortctrlEnabled

dot1xPortctrlEnabled: boolean

downlinkTable

downlinkTable: IDownlinkTable[]

ethernetTable

ethernetTable: IEthernetTable[]

fwCaps

fwCaps: number

`Optional` gatewayMac

gatewayMac?: string

`Optional` guestKicks

guestKicks?: number

guestNumSta

guestNumSta: number

`Optional` guestToken

guestToken?: string

`Optional` guestWLANNumSta

guestWLANNumSta?: number

`Optional` hasEth1

hasEth1?: boolean

hasFan

hasFan: boolean

`Optional` hasSpeaker

hasSpeaker?: boolean

hasTemperature

hasTemperature: boolean

hashId

hashId: string

hwCaps

hwCaps: number

informIp

informIp: string

informUrl

informUrl: string

internet

internet: boolean

ip

ip: string

kernelVersion

kernelVersion: string

knownCfgversion

knownCfgversion: string

lastSeen

lastSeen: number

`Optional` lastUplink

lastUplink?: ILastUplink

`Optional` lcmBrightnessOverride

lcmBrightnessOverride?: boolean

`Optional` lcmIdleTimeoutOverride

lcmIdleTimeoutOverride?: boolean

`Optional` ledOverride

ledOverride?: string

`Optional` ledOverrideColor

ledOverrideColor?: string

`Optional` ledOverrideColorBrightness

ledOverrideColorBrightness?: number

licenseState

licenseState: string

lldpTable

lldpTable: ILldpTable[]

locating

locating: boolean

mac

mac: string

manufacturerId

manufacturerId: number

minInformIntervalSeconds

minInformIntervalSeconds: number

model

model: string

modelInEOL

modelInEOL: boolean

modelInLTS

modelInLTS: boolean

modelIncompatible

modelIncompatible: boolean

`Optional` name

name?: string

nextInterval

nextInterval: number

numSta

numSta: number

`Optional` outdoorModeOverride

outdoorModeOverride?: string

portTable

portTable: IPortTable[]

prevNonBusyState

prevNonBusyState: number

provisionedAt

provisionedAt: number

requiredVersion

requiredVersion: string

rollupgrade

rollupgrade: boolean

rxBytes

rxBytes: number

`Optional` satisfaction

satisfaction?: number

serial

serial: string

setupId

setupId: string

siteId

siteId: string

`Optional` sshSessionTable

sshSessionTable?: unknown[]

startConnectedMillis

startConnectedMillis: number

startDisconnectedMillis

startDisconnectedMillis: number

startupTimestamp

startupTimestamp: number

stat

stat: IStat

state

state: EDeviceStates

switchCaps

switchCaps: ISwitchCaps

`Optional` sysErrorCaps

sysErrorCaps?: number

sysStats

sysStats: ISysStats

syslogKey

syslogKey: string

systemStats

systemStats: ISystemStats

twoPhaseAdopt

twoPhaseAdopt: boolean

txBytes

txBytes: number

type

type: EDeviceType

unsupported

unsupported: boolean

unsupportedReason

unsupportedReason: number

upgradable

upgradable: boolean

uplink

uplink: IUplink

uptime

uptime: number

userNumSta

userNumSta: number

`Optional` userWLANNumSta

userWLANNumSta?: number

version

version: string

`Optional` wifiCaps

wifiCaps?: number

xAesGcm

xAesGcm: boolean

xAuthkey

xAuthkey: string

xFingerprint

xFingerprint: string

xHasSshHostkey

xHasSshHostkey: boolean

`Optional` xSshHostkeyFingerprint

xSshHostkeyFingerprint?: string

`Static` debug

debug: Debugger = ...

Accessors

`Protected` config

get config(): IObjectSubSiteConfigComplete
Returns IObjectSubSiteConfigComplete
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:31
set config(value): void
Parameters
- value: IObjectSubSiteConfigComplete
Returns void
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:35

`Protected` controller

get controller(): Controller
Returns Controller
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:31
set controller(value): void
Parameters
- value: Controller
Returns void
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:35

`Protected` controllerInstance

get controllerInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:24
set controllerInstance(value): void
Parameters
- value: AxiosInstance
Returns void
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:28

`Protected` debug

get debug(): Debugger
Returns Debugger
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:144
set debug(value): void
Parameters
- value: Debugger
Returns void
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:148

`Protected` instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.instance
- Defined in src/commons/_ObjectSubSite.ts:14

`Protected` privateMap

get privateMap(): WeakMap<any, any>
Returns WeakMap<any, any>
Inherited from _ObjectSubSite.privateMap
- Defined in src/commons/ObjectWithPrivateValues.ts:28

`Protected` site

get site(): Site
Returns Site
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:38
set site(value): void
Parameters
- value: Site
Returns void
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:42

Methods

`Protected` _updateDevice

_updateDevice(payload): Promise<BaseDevice>
Parameters
- payload: unknown
Returns Promise<BaseDevice>
- Defined in src/Devices/BaseDevice.ts:427

`Protected` checkNeedVersion

checkNeedVersion(minVersion?, unifiOs?, parameterName?): void
Parameters
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- parameterName: string = ''
  a name for the parameter
Returns void
Inherited from _ObjectSubSite.checkNeedVersion
- Defined in src/commons/_ObjectSubController.ts:104

`Protected` checkNeeds

checkNeeds(minVersion?, unifiOs?): boolean
Parameters
- Optional minVersion: string
- Optional unifiOs: boolean
Returns boolean
Inherited from _ObjectSubSite.checkNeeds
- Defined in src/commons/_ObjectSubController.ts:94

forceProvision

forceProvision(): Promise<unknown>
Returns Promise<unknown>
- Defined in src/Devices/BaseDevice.ts:378

getController

getController(): Controller
Returns Controller
Inherited from _ObjectSubSite.getController
- Defined in src/commons/_ObjectSubController.ts:79

getInstance

getInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.getInstance
- Defined in src/commons/_ObjectSubController.ts:75

`Protected` getPrivate

getPrivate<T>(key): T
Type Parameters
- T
  the type retrieve.
Parameters
- key: string
  the key to retrieve
Returns T
Inherited from _ObjectSubSite.getPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:11

import

import(props): this
Parameters
- props: Partial<IBaseDeviceRaw> & IBaseDeviceMandatoryRaw
Returns this
Overrides _ObjectSubSite.import
- Defined in src/Devices/BaseDevice.ts:55

locate

locate(locate?): Promise<boolean>
Parameters
- locate: boolean = true
Returns Promise<boolean>
- Defined in src/Devices/BaseDevice.ts:412

`Protected` mapObject

mapObject<U>(constructor, object): U
Type Parameters
- U extends _ObjectSubSite
Parameters
- constructor: (new (config, props) => U)
  the construtor to map the object
  - - new (config, props): U
    - Parameters
      config: IObjectSubSiteConfig
      props: any
      Returns U
- object: any
  the properties passed to the constructor if defined
Returns U
Inherited from _ObjectSubSite.mapObject
- Defined in src/commons/_ObjectSubSite.ts:60

`Protected` needVersion

needVersion<T>(key, value?, minVersion?, unifiOs?, allowUndefined?): boolean
Type Parameters
- T
Parameters
- key: keyof BaseDevice
  the key object that need to be only supported on some versions
- Optional value: T
  the value store in this object
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- allowUndefined: boolean = false
  to undefined check ?
Returns boolean
Inherited from _ObjectSubSite.needVersion
- Defined in src/commons/_ObjectSubController.ts:116

reboot

reboot(type?): Promise<boolean>
Parameters
- type: "soft" | "hard" = 'soft'
  two options: 'soft' or 'hard', defaults to soft soft can be used for all devices, requests a plain restart of that device hard is special for PoE switches and besides the restart also requests a power cycle on all PoE capable ports. Keep in mind that a 'hard' reboot does NOT trigger a factory-reset.
Returns Promise<boolean>
- Defined in src/Devices/BaseDevice.ts:365

setLedOverride

setLedOverride(props): unknown
Override LED mode for a device (using REST)
Parameters
- props: ILedOverrideProps
Returns unknown
- Defined in src/Devices/BaseDevice.ts:387

`Protected` setPrivate

setPrivate<T>(key, value): void
Type Parameters
- T
  the type to set.
Parameters
- key: string
  the key to set
- value: T
  the value
Returns void
Inherited from _ObjectSubSite.setPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:21

toJSON

toJSON(): Partial<BaseDevice>
Returns Partial<BaseDevice>
Inherited from _ObjectSubSite.toJSON
- Defined in src/commons/_ObjectSubController.ts:59

updateDevice

updateDevice(payload): Promise<BaseDevice>
Parameters
- payload: Partial<IBaseDeviceRaw>
Returns Promise<BaseDevice>
- Defined in src/Devices/BaseDevice.ts:423

Class BaseDevice

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseDevice

Properties

_id

Optional adoptIp

Optional adoptUrl

adoptableWhenUpgraded

adopted

anonId

architecture

boardRevision

bytes

cfgVersion

configNetwork

connectRequestIp

connectRequestPort

connectedAt

connectionNetworkName

Optional default

deviceId

Optional disabled

Optional discoveredVia

displayableVersion

dot1xPortctrlEnabled

downlinkTable

ethernetTable

fwCaps

Optional gatewayMac

Optional guestKicks

guestNumSta

Optional guestToken

Optional guestWLANNumSta

Optional hasEth1

hasFan

Optional hasSpeaker

hasTemperature

hashId

hwCaps

informIp

informUrl

internet

ip

kernelVersion

knownCfgversion

lastSeen

Optional lastUplink

Optional lcmBrightnessOverride

Optional lcmIdleTimeoutOverride

Optional ledOverride

Optional ledOverrideColor

Optional ledOverrideColorBrightness

licenseState

lldpTable

locating

mac

manufacturerId

minInformIntervalSeconds

model

modelInEOL

modelInLTS

modelIncompatible

Optional name

nextInterval

numSta

Optional outdoorModeOverride

portTable

prevNonBusyState

provisionedAt

requiredVersion

rollupgrade

rxBytes

`Optional` adoptIp

`Optional` adoptUrl

`Optional` default

`Optional` disabled

`Optional` discoveredVia

`Optional` gatewayMac

`Optional` guestKicks

`Optional` guestToken

`Optional` guestWLANNumSta

`Optional` hasEth1

`Optional` hasSpeaker

`Optional` lastUplink

`Optional` lcmBrightnessOverride

`Optional` lcmIdleTimeoutOverride

`Optional` ledOverride

`Optional` ledOverrideColor

`Optional` ledOverrideColorBrightness

`Optional` name

`Optional` outdoorModeOverride

`Optional` satisfaction

`Optional` sshSessionTable

`Optional` sysErrorCaps

`Optional` userWLANNumSta

`Optional` wifiCaps

`Optional` xSshHostkeyFingerprint

`Static` debug

`Protected` config

`Protected` controller

`Protected` controllerInstance

`Protected` debug

`Protected` instance

`Protected` privateMap

`Protected` site

`Protected` _updateDevice

`Protected` checkNeedVersion

`Protected` checkNeeds