Nut - v1.0.0
    Preparing search index...

    Interface IMonitorEvents

    interface IMonitorEvents {
        "*": (event: string, ...args: any[]) => void;
        BATTERY_CHARGE: (charge: number, rawCharge: string) => void;
        BATTERY_RUNTIME: (charge: number, rawCharge: string) => void;
        BYPASS: () => void;
        CAL: () => void;
        COMMBAD: () => void;
        COMMOK: () => void;
        FSD: () => void;
        LOWBATT: () => void;
        NOCOMM: () => void;
        NOTBYPASS: () => void;
        NOTCAL: () => void;
        NOTFSD: () => void;
        NOTLB: () => void;
        NOTOB: () => void;
        NOTOFF: () => void;
        NOTOL: () => void;
        NOTRB: () => void;
        OFF: () => void;
        ONBATT: () => void;
        ONLINE: () => void;
        REPLBATT: () => void;
        UNKNOWN_STATUS: (status: string) => void;
        VARIABLE_CHANGED: (
            key: nutVariablesNames,
            oldValue: string,
            newValue: string,
            oldVariables: nutVariables,
            newVariables: nutVariables,
        ) => void;
        VARIABLES_CHANGED: (
            oldVariables: nutVariables,
            newVariables: nutVariables,
        ) => void;
    }
    Index
    * BATTERY_CHARGE BATTERY_RUNTIME BYPASS CAL COMMBAD COMMOK FSD LOWBATT NOCOMM NOTBYPASS NOTCAL NOTFSD NOTLB NOTOB NOTOFF NOTOL NOTRB OFF ONBATT ONLINE REPLBATT UNKNOWN_STATUS VARIABLE_CHANGED VARIABLES_CHANGED

    *

    "*": (event: string, ...args: any[]) => void

    allow to listen to all events

    BATTERY_CHARGE: (charge: number, rawCharge: string) => void

    CHARGE of the battery

    Type Declaration

      • (charge: number, rawCharge: string): void

      • Parameters

        • charge: number

          the current charge of the UPS (can be NaN)

        • rawCharge: string

          the raw value of charge (in case of NaN)

        Returns void

    BATTERY_RUNTIME: (charge: number, rawCharge: string) => void

    RUNTIME of the battery

    Type Declaration

      • (charge: number, rawCharge: string): void

      • Parameters

        • charge: number

          the current charge of the UPS (can be NaN)

        • rawCharge: string

          the raw value of charge (in case of NaN)

        Returns void

    BYPASS: () => void

    UPS on bypass (powered, not protecting).

    CAL: () => void

    UPS calibration in progress.

    COMMBAD: () => void

    Communication with the UPS was just lost.

    COMMOK: () => void

    Communication with the UPS has been established.

    FSD: () => void

    The UPS has been commanded into the "forced shutdown" mode.

    LOWBATT: () => void

    The UPS battery is low (as determined by the driver).

    NOCOMM: () => void

    The UPS can't be contacted for monitoring.

    NOTBYPASS: () => void

    UPS no longer on bypass.

    NOTCAL: () => void

    UPS calibration finished.

    NOTFSD: () => void

    The UPS is no longer in forced shutdown mode (FSD disappeared).

    NOTLB: () => void

    The UPS battery is no longer low (LB disappeared).

    NOTOB: () => void

    The UPS is no longer on battery (OB disappeared).

    NOTOFF: () => void

    UPS no longer administratively OFF or asleep.

    NOTOL: () => void

    The UPS is no longer online (OL disappeared).

    NOTRB: () => void

    The UPS no longer needs battery replacement (RB disappeared).

    OFF: () => void

    UPS administratively OFF or asleep.

    ONBATT: () => void

    The UPS is on battery.

    ONLINE: () => void

    The UPS is back online.

    REPLBATT: () => void

    The UPS needs to have its battery replaced.

    UNKNOWN_STATUS: (status: string) => void

    UPS STATUS IS UNKNOWN

    VARIABLE_CHANGED: (
        key: nutVariablesNames,
        oldValue: string,
        newValue: string,
        oldVariables: nutVariables,
        newVariables: nutVariables,
    ) => void

    get a variable change

    Type Declaration

    VARIABLES_CHANGED: (
        oldVariables: nutVariables,
        newVariables: nutVariables,
    ) => void

    get all variables update

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties