rxpoweredup
    Preparing search index...

    Interface IHubPropertiesFeature

    interface IHubPropertiesFeature {
        batteryLevel: Observable<number>;
        buttonState: Observable<boolean>;
        rssiLevel: Observable<number>;
        getAdvertisingName(): Observable<string>;
        getBatteryLevel(): Observable<number>;
        getButtonState(): Observable<boolean>;
        getFirmwareVersion(): Observable<VersionInformation>;
        getHardwareVersion(): Observable<VersionInformation>;
        getManufacturerName(): Observable<string>;
        getPrimaryMacAddress(): Observable<string>;
        getRSSILevel(): Observable<number>;
        getSystemTypeId(): Observable<HubType>;
        setHubAdvertisingName(advertisingName: string): Observable<void>;
    }
    Index

    Properties

    batteryLevel: Observable<number>

    Emits the battery level of the hub on subscription and whenever it changes. Stream completes when the hub is disconnected.

    buttonState: Observable<boolean>

    Emits the button state of the hub on subscription and whenever it changes. Stream completes when the hub is disconnected.

    rssiLevel: Observable<number>

    Emits the RSSI level of the hub on subscription and whenever it changes. Stream completes when the hub is disconnected.

    Methods

    • Reads the advertising name of the hub. The advertising name is a user-friendly name that is used to identify the hub.

      Stream completes when the response is received from the hub.

      Returns Observable<string>

    • Reads the primary MAC address of the hub (can be used as a unique identifier for the hub) Stream completes when the response is received from the hub.

      Returns Observable<string>

    • Reads the RSSI (Received Signal Strength Indicator) level of the hub. It's not a dBm value, but still useful for comparing signal strength between hubs. The more negative the value, the stronger the signal. Stream completes when the response is received from the hub.

      Returns Observable<number>

    • Sets the advertising name of the hub. The advertising name is a user-friendly name that is used to identify the hub. Stream completes when the command is executed by the hub.

      Parameters

      • advertisingName: string

        alphanumeric name (1-14 characters long) with spaces.

      Returns Observable<void>