Class WifiDevice

Hierarchy

  • WifiDevice

Methods

init _listenForAccessPoints _listenForPropertyChanges activateConnection requestScan

Properties

_accessPoints _accessPointsSubject _bus _devicePath _properties _propertiesInterface _propertiesSubject _wifiDeviceInterface accessPoints$ properties$

Accessors

accessPoints properties

Constructors

constructor

Methods

Static init

  • Initializes a new WifiDevice You should use networkManager.wifiDevice() unless you know what you're doing.

    Returns

    Promise of a WifiDevice

    Parameters

    • bus: DBusConnection

      An instance of a DBus connection

    • devicePath: string

      The path of the wifi device DBus object

    Returns Promise<WifiDevice>

Private _listenForAccessPoints

  • _listenForAccessPoints(): void

  • Returns void

Private _listenForPropertyChanges

  • _listenForPropertyChanges(): void

  • Returns void

activateConnection

  • Activates a connection based on a connection profile path

    Parameters

    • connectionProfilePath: string

      The path to the connection profile to activate

    Returns Promise<string>

requestScan

  • Ask the wifi device to start scanning. Scanning is complete when the WifiDevice's LastScan property is updated

    Returns Promise<void>

Properties

Private _accessPoints

_accessPoints: AccessPointMap

Private _accessPointsSubject

_accessPointsSubject: BehaviorSubject<AccessPointMap>

Private _bus

_bus: DBusConnection

Private _devicePath

_devicePath: string

Private _properties

_properties: WifiDeviceProperties

Private _propertiesInterface

_propertiesInterface: DBusInterface<AnyInterfaceMethod>

Private _propertiesSubject

_propertiesSubject: BehaviorSubject<WifiDeviceProperties>

Private _wifiDeviceInterface

_wifiDeviceInterface: DBusInterface<AnyInterfaceMethod>

accessPoints$

accessPoints$: Observable<AccessPointMap>

Continuously updated map of access points Structured as a map where the key is the path of the access point and the value is the access point data. The Access Point path can be compared against the ActiveAccessPoint value of WifiDevice properties to determine which Access Point is connected

properties$

properties$: Observable<WifiDeviceProperties>

Continuously updated wifi device properties

Accessors

accessPoints

  • get accessPoints(): AccessPointMap

  • Latest found access points as a one-time value

    Returns AccessPointMap

properties

  • get properties(): any

  • Latest wifi device properties as a one-time value

    Returns any

Constructors

Private constructor

  • Parameters

    • bus: DBusConnection
    • devicePath: string
    • wifiDeviceInterface: DBusInterface<AnyInterfaceMethod>
    • propertiesInterface: DBusInterface<AnyInterfaceMethod>
    • initialProperties: any
    • initialAccessPoints: AccessPointMap

    Returns WifiDevice

Settings

Member Visibility

Theme

Generated using TypeDoc