Documentation
    Preparing search index...

    Class River2Pro

    Device abstract class.

    Hierarchy (View Summary)

    • Device<River2ProSerialNumber, River2ProQuotaAll>
      • River2Pro
    Index

    Constructors

    constructor

    Properties

    restClient sn

    Methods

    enable12Vdc getProperties getProperty parseProperties sendCommand setAcOutCfg setChargeLimit setDischargeLimit setWatthConfigSchema

    Constructors

    Properties

    restClient: RestClient
    sn: `R621${string}`

    Methods

    • 12V DC output on/off（1 on 0 off）

      Parameters

      • enabled: 0 | 1

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

        const client = new RestClient(...);
        const device = client.getDevice(sn);
        await device.setCarStandByDuration(1);

    • Retrieves the properties of the device asynchronously.

      Returns Promise<
          objectOutputType<
              {
                  "bms_bmsStatus.remainTime": ZodNumber;
                  "bms_emsStatus.dsgRemainTime": ZodNumber;
                  "bms_emsStatus.maxChargeSoc": ZodNumber;
                  "bms_emsStatus.minDsgSoc": ZodNumber;
                  "inv.inputWatts": ZodNumber;
                  "inv.outputWatts": ZodNumber;
                  "mppt.cfgAcEnabled": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "mppt.cfgAcOutFreq": ZodNumber;
                  "mppt.cfgAcOutVol": ZodNumber;
                  "mppt.cfgAcXboost": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "mppt.inWatts": ZodNumber;
                  "pd.bpPowerSoc": ZodNumber;
                  "pd.carState": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "pd.carWatts": ZodNumber;
                  "pd.soc": ZodNumber;
                  "pd.typec1Watts": ZodNumber;
                  "pd.typecChaWatts": ZodNumber;
                  "pd.usb1Watts": ZodNumber;
                  "pd.watchIsConfig": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "pd.wattsOutSum": ZodNumber;
              },
              ZodTypeAny,
              "passthrough",
          >,
      >

    • Retrieves the specified property of a device, if present.

      Type Parameters

      • K extends string | number

      Parameters

      • property: K

      Returns Promise<
          | objectOutputType<
              {
                  "bms_bmsStatus.remainTime": ZodNumber;
                  "bms_emsStatus.dsgRemainTime": ZodNumber;
                  "bms_emsStatus.maxChargeSoc": ZodNumber;
                  "bms_emsStatus.minDsgSoc": ZodNumber;
                  "inv.inputWatts": ZodNumber;
                  "inv.outputWatts": ZodNumber;
                  "mppt.cfgAcEnabled": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "mppt.cfgAcOutFreq": ZodNumber;
                  "mppt.cfgAcOutVol": ZodNumber;
                  "mppt.cfgAcXboost": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "mppt.inWatts": ZodNumber;
                  "pd.bpPowerSoc": ZodNumber;
                  "pd.carState": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "pd.carWatts": ZodNumber;
                  "pd.soc": ZodNumber;
                  "pd.typec1Watts": ZodNumber;
                  "pd.typecChaWatts": ZodNumber;
                  "pd.usb1Watts": ZodNumber;
                  "pd.watchIsConfig": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
                  "pd.wattsOutSum": ZodNumber;
              },
              ZodTypeAny,
              "passthrough",
          >[K]
          | undefined,
      >

    • Parses the properties of the device.

      Parameters

      • data: any

      Returns objectOutputType<
          {
              "bms_bmsStatus.remainTime": ZodNumber;
              "bms_emsStatus.dsgRemainTime": ZodNumber;
              "bms_emsStatus.maxChargeSoc": ZodNumber;
              "bms_emsStatus.minDsgSoc": ZodNumber;
              "inv.inputWatts": ZodNumber;
              "inv.outputWatts": ZodNumber;
              "mppt.cfgAcEnabled": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
              "mppt.cfgAcOutFreq": ZodNumber;
              "mppt.cfgAcOutVol": ZodNumber;
              "mppt.cfgAcXboost": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
              "mppt.inWatts": ZodNumber;
              "pd.bpPowerSoc": ZodNumber;
              "pd.carState": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
              "pd.carWatts": ZodNumber;
              "pd.soc": ZodNumber;
              "pd.typec1Watts": ZodNumber;
              "pd.typecChaWatts": ZodNumber;
              "pd.usb1Watts": ZodNumber;
              "pd.watchIsConfig": ZodUnion<[ZodLiteral<0>, ZodLiteral<1>]>;
              "pd.wattsOutSum": ZodNumber;
          },
          ZodTypeAny,
          "passthrough",
      >

    • Sends a command with the given payload.

      Parameters

      • payload: any
      • schema: ZodTypeAny

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

    • AC output on/off（enabled） X-Boost on/off AC output voltage，read，unit V AC output frequency（out_freq，1-50Hz、2-60Hz）

      Parameters

      • params: { enabled: 0 | 1; out_freq: number; out_voltage: number; xboost: 0 | 1 }

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

        const client = new RestClient(...);
        const device = client.getDevice(sn);
        await device.setAcOutCfg({
          enabled: 1,
          xboost: 1,
          out_voltage: 30,
          out_freq: 50,
        });

    • Set the charge limit.

      Parameters

      • limit: number

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

        const client = new RestClient(...);
        const device = client.getDevice(sn);
        await device.setChargeLimit(50

    • Set the discharge limit.

      Parameters

      • limit: number

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

        const client = new RestClient(...);
        const device = client.getDevice(sn);
        await device.setDischargeLimit(50

    • Energy management on/off

      Parameters

      • params: { bpPowerSoc: number; isConfig: 0 | 1; minChgSoc: number; minDsgSoc: number }
        • bpPowerSoc: number

          Backup reserve

        • isConfig: 0 | 1

          0: off; 1: on

        • minChgSoc: number

          Charge limit

        • minDsgSoc: number

          Discharge limit

      Returns Promise<
          | {
              code: "0";
              eagleEyeTraceId: string;
              message: "Success";
              tid: string;
          }
          | { code: string; eagleEyeTraceId: string; message: string; tid: string },
      >

        const client = new RestClient(...);
        const device = client.getDevice(sn);
        await device.setWatthConfigSchema({
           "isConfig": 0,
           "bpPowerSoc": 88,
           "minDsgSoc": 30,
           "minChgSoc": 88
        });

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods