Nut - v0.0.9
    Preparing search index...

    Type Alias outletVariables

    outletVariables:
        | "outlet.count"
        | "outlet.switchable"
        | `outlet.${number}.id`
        | `outlet.${number}.name`
        | `outlet.${number}.desc`
        | `outlet.${number}.groupid`
        | `outlet.${number}.switch`
        | `outlet.${number}.status`
        | `outlet.${number}.alarm`
        | `outlet.${number}.switchable`
        | `outlet.${number}.autoswitch.charge.low`
        | `outlet.${number}.battery.charge.low`
        | `outlet.${number}.delay.shutdown`
        | `outlet.${number}.delay.start`
        | `outlet.${number}.timer.shutdown`
        | `outlet.${number}.timer.start`
        | `outlet.${number}.current`
        | `outlet.${number}.current.maximum`
        | `outlet.${number}.current.status`
        | `outlet.${number}.current.low.warning`
        | `outlet.${number}.current.low.critical`
        | `outlet.${number}.current.high.warning`
        | `outlet.${number}.current.high.critical`
        | `outlet.${number}.realpower`
        | `outlet.${number}.voltage`
        | `outlet.${number}.voltage.status`
        | `outlet.${number}.voltage.low.warning`
        | `outlet.${number}.voltage.low.critical`
        | `outlet.${number}.voltage.high.warning`
        | `outlet.${number}.voltage.high.critical`
        | `outlet.${number}.powerfactor`
        | `outlet.${number}.crestfactor`
        | `outlet.${number}.power`
        | `outlet.${number}.type`
        | "utlet.group.count"
        | `outlet.group.${number}.type`
        | `outlet.group.${number}.color`
        | `outlet.group.${number}.count`
        | `outlet.group.${number}.phase`
        | `outlet.group.${number}.input`

    Type declaration

    • "outlet.count"

      Total number of outlets

    • "outlet.switchable"

      General outlet switch ability of the unit (yes/no)

    • `outlet.${number}.id`

      Outlet system identifier (opaque string)

    • `outlet.${number}.name`

      Outlet name (opaque string)

    • `outlet.${number}.desc`

      Outlet description (opaque string)

    • `outlet.${number}.groupid`

      Identifier of the group to which the outlet belongs to

    • `outlet.${number}.switch`

      Outlet switch control (on/off)

    • `outlet.${number}.status`

      Outlet switch status (on/off)

    • `outlet.${number}.alarm`

      Alarms for outlets and PDU, published in ups.alarm

    • `outlet.${number}.switchable`

      Outlet switch ability (yes/no)

    • `outlet.${number}.autoswitch.charge.low`

      Remaining battery level to power off this outlet (percent)

    • `outlet.${number}.battery.charge.low`

      Remaining battery level to power off this outlet (percent)

    • `outlet.${number}.delay.shutdown`

      Interval to wait before shutting down this outlet (seconds)

    • `outlet.${number}.delay.start`

      Interval to wait before restarting this outlet (seconds)

    • `outlet.${number}.timer.shutdown`

      Time before the outlet load will be shutdown (seconds)

    • `outlet.${number}.timer.start`

      Time before the outlet load will be started (seconds)

    • `outlet.${number}.current`

      Current (A)

    • `outlet.${number}.current.maximum`

      Maximum seen current (A)

    • `outlet.${number}.current.status`

      Current status relative to the thresholds

    • `outlet.${number}.current.low.warning`

      Low warning threshold (A)

    • `outlet.${number}.current.low.critical`

      Low critical threshold (A)

    • `outlet.${number}.current.high.warning`

      High warning threshold (A)

    • `outlet.${number}.current.high.critical`

      High critical threshold (A)

    • `outlet.${number}.realpower`

      Current value of real power (W)

    • `outlet.${number}.voltage`

      Voltage (V)

    • `outlet.${number}.voltage.status`

      Voltage status relative to the thresholds

    • `outlet.${number}.voltage.low.warning`

      Low warning threshold (V)

    • `outlet.${number}.voltage.low.critical`

      Low critical threshold (V)

    • `outlet.${number}.voltage.high.warning`

      High warning threshold (V)

    • `outlet.${number}.voltage.high.critical`

      High critical threshold (V)

    • `outlet.${number}.powerfactor`

      Power Factor (dimensionless, value between 0 and 1)

    • `outlet.${number}.crestfactor`

      Crest Factor (dimensionless, equal to or greater than 1)

    • `outlet.${number}.power`

      Apparent power (VA)

    • `outlet.${number}.type`

      Physical outlet type

    • "utlet.group.count"

      seems undocumented, but mentioned only

    • `outlet.group.${number}.type`

      Type of outlet group (OPAQUE)

    • `outlet.group.${number}.color`

      Color-coding of the outlets in this group (OPAQUE)

    • `outlet.group.${number}.count`

      Number of outlets in the group

    • `outlet.group.${number}.phase`

      Electrical phase to which the physical outlet group (Gang) is connected to

    • `outlet.group.${number}.input`

      Input to which an outlet group is connected