Class Node

constructor

• new Node(options: profile.NodeOptions): profile.Node

  Assembles a node.

  Parameters

  • options: profile.NodeOptions

    the profile, the reading, the link, and the output.

  Returns profile.Node

  Throws

  when the profile drives an output and no drive is given, or when its control kind is custom and no policy or registry decides it.

Readonlyprofile

powerMode

• get powerMode(): PowerMode | null

  The power mode the last schedule chose, or null before the first.

  Returns PowerMode | null

run

• run(options?: profile.RunOptions): Promise<void>

  Ticks, then waits the interval the battery's charge calls for, until stopped.

  Parameters

  • Optionaloptions: profile.RunOptions

    when to stop, how to read the battery, and what to hear.

  Returns Promise<void>

  once the signal aborts or the ticks run out.

  Throws

  the failure of a tick when no onError hears it.

schedule

• schedule(
      charge: number,
      charging?: boolean,
  ): { mode: PowerMode; waitMs: number }

  Says what power mode the battery's charge puts the node in and how long to wait before the next tick. The node remembers the mode it chose, so a charge hovering at a threshold keeps the slower cadence until it clears the schedule's hysteresis.

  Parameters

  • charge: number

    the state of charge, from 0 to 1.

  • Optionalcharging: boolean

    whether the panel is delivering charge.

  Returns { mode: PowerMode; waitMs: number }

  the mode, and the wait in milliseconds.

tick

• tick(): Promise<profile.Tick>

  Runs one read, decide, act, and publish cycle.

  Returns Promise<profile.Tick>

  the reading and what the policy decided about it.

  Throws

  what the reading, the output, or the link throws.