donavanbecker / rainbird

Rainbird

The RainBird library allows you to access your RainBird Controller.

Installation

To use this library in Node, install it from the command line:

npm -save install rainbird

Configuration

import { RainBirdService } from 'rainbird';

1. ipaddress: controller's local IP Address
2. password: controller's password
3. refreshRate: refreshRate of how often to look for changes, optional.
4. log: this is used to pass through for logging
5. showRequestResponse: this will show rainbird request logs, boolean,
6. syncTime: will sync the machine time to the controller, boolan,

const rainbird = new RainBirdService({
        address: ipaddress,
        password: password!,
        refreshRate: refreshRate,
        log: this.log,
        showRequestResponse: showRequestResponse
        syncTime: device.syncTime!,
      });

Collaborators

• Main developer of the RaindBird API:
  • mantorok1

Compatiable Controllers

Any controller that supports the RainBird LNK WiFi Module should be compatible. This includes:

• ESP-Me
• ESP-TM2
• ESP-RZXe
• ESP-ME3

Known Limitations

• Using the RainBird app while the plugin is running can cause connectivity issues.
• The RainBird LNK WiFi Module may not support "Band Steering" and WiFi Channel 13. Try not using these on your router if you are having connectivity issues.
• Some models do not yet have support for displaying the time remaining. If its not working for your model please log a GitHub issue and we will try to add it with your help.