2.1.1 • Published 1 year ago

solarnetwork-control-toggler v2.1.1

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
1 year ago

SolarNetwork Control Toggler

Control Toggler is a helper class that uses the SolarNetwork Instruction API to request a SolarNode to set the value of a control to 1 (on) or 0 (off), and the SolarNetwork Datum Query API to track the value of the control.

The Instruction API is asynchronous and changing a control value requires the following steps:

  • Enqueue instruction to set control value
  • Wait for SolarNode to receive, execute, and update instruction status to Completed (or Rejected)
  • Wait for SolarNode to post updated control value datum for confirmation

Control Toggler handles these steps through a simple API for setting the desired value and using a callback function to get notified when the value changes.

Some example SolarNode plugins that support on/off switching are:

Use

To include the library in your NPM-based project, run the following:

npm i solarnetwork-datum-loader

API docs

The latest API documentation is published here, or you can build the API documentation by running the apidoc script:

npm run apidoc

That will produce HTML documentation in docs/html.

2.1.1

1 year ago

2.0.2

1 year ago

2.1.0

1 year ago

2.0.1

1 year ago

2.0.0

1 year ago

0.2.1

6 years ago

0.2.0

8 years ago

0.1.1

8 years ago

0.1.0

8 years ago