https://github.com/donavanbecker/rainbird

https://github.com/donavanbecker/rainbird

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/donavanbecker/rainbird
• Owner: donavanbecker
• License: isc
• Created: 2024-01-22T05:28:47.000Z (12 months ago)
• Default Branch: latest
• Last Pushed: 2024-05-18T16:50:26.000Z (8 months ago)
• Last Synced: 2024-05-18T17:44:40.707Z (8 months ago)
• Language: TypeScript
• Size: 453 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        




# 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

```

## Usage

See the [API Guide](./docs/api_guide.md) for details.

## Collaborators

 - Main developer of the RaindBird API:

      - [mantorok1](https://github.com/mantorok1)

## Compatiable Controllers

Any controller that supports the [RainBird LNK WiFi Module](https://www.rainbird.com/products/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.