This set of nodes enables communication with the Rainbird irrigation controller via a local LNK2 connection. To use these nodes, you need both the Rainbird controller and the LNK2 add-on properly plugged in and configured. It should work with most Rainbird devices using LNK2 wifi module but currently it is tested with ESP-me3. Original protocol implementation was also tested with ESP-RZXe. This module is exposing nodes that allows both to query state and start/stop irrigation proces. It is intended to be used with node-red NRCHKB homekit integration which allows to expose irrigation system in Apple Home app.
This package uses modified protocol code of node-rainbird to communicate with Rainbird controllers. This project includes protocol data from pyrainbird
Rainbird did not release API specification, some brave people discovered how those devices works. This project is re-using their excellent work. See the CREDITS file.
To connect, you need the LNK2 IP address and PIN:
- LNK2 PIN: This is the code you set up in the Rainbird mobile app when configuring the LNK2.
- LNK2 IP: This is the local IP address assigned by your router.
Fetches basic information about the Rainbird sprinkler controller via the local LNK2 connection - serial number, model, date and other usefull informations. The payload contains following:
{
"serialNumber": {
"serialNumber": "XXXXXXXXXXXXXXX"
},
"modelAndVersion": {
"modelID": "0009",
"protocolRevisionMajor": "02",
"protocolRevisionMinor": "0C",
"modelCode": "ESP_ME3",
"modelName": "ESP-ME3",
"supportsWaterBudget": true,
"maxPrograms": 4,
"maxRunTimes": 6,
"retries": false
},
"availableZones": {
"pageNumber": "00",
"stationsAvail": 10
},
"rainSensorState": {
"sensorState": "00"
},
"programsWaterBudget": [
{
"programCode": "00",
"waterBudgetPercent": 97
},
{
"programCode": "01",
"waterBudgetPercent": 76
},
{
"programCode": "02",
"waterBudgetPercent": 100
},
{
"programCode": "03",
"waterBudgetPercent": 76
}
],
"timeDecoded": {
"hour": 18,
"minute": 58,
"second": 7
},
"dateDecoded": {
"day": 29,
"month": 7,
"year": 2025
}
}Retrieves the current IrrigationState from the Rainbird sprinkler controller. The payload will contain:
{
"irrigationState": "_state_"
}The irrigationState indicates whether the Rainbird controller is running a program. This does not provide information on active zones, but acts as a flag that controller is set to start irrigation automatically.
Fetches information on currently active zones (sprinklers) from the Rainbird sprinkler controller. Rainbird allows to have only single node running at a time. The returned payload will include:
{
"pageNumber": "00",
"activeStations": "00000000",
"activeZones": [0, 0, 0, 0]
}New Feature – HomeKit Mode: In "homekit" mode, this node detects changes in zone state and outputs only those zones that have changed. The output is formatted in a way compatible with HomeKit NRCHKB "Valve" node:
{
"payload": {
"Active": 1,
"InUse": 1
},
"topic": "2"
}Configuration node for managing the controller's setup.
Manually activates a specific zone for a set duration (in minutes). If another zone is already active, it will be deactivated. It accepts message:
{
"payload": { "Active": 1 },
"topic": "zone_nr",
"time": "time_in_minutes"
}where
- msg.topic: Specifies which zone to activate.
- msg.time: Defines how long the zone should run (in minutes).
- msg.payload.Active: Is a key that confirms that we want to start this zone. Additionally, if a message contains:
{
"payload":
{ "SetDuration": <time_in_seconds> },
"topic": "zone_nr" }The duration is stored for that zone and will be used for future activations. This enables direct integration with HomeKit valve controls.
Stops all sprinkler zones, halting irrigation.
Delays the start of an irrigation program by a specified number of days. The delay duration is provided in msg.payload.
Manually starts a program by specifying the program number in msg.payload (e.g., Program "A" = 1, Program "B" = 2). This feature is not supported on ESP-RZXe but works on ESP-me3 and may work on other models.
Retrieves information on whether a program's start has been delayed. The payload will return:
{
"delaySetting": number_of_days
}Scans the entire command space (0x00–0xFF) to check which Rainbird SIP commands are supported by the connected controller. Command lists only supported ones, known commands from the internal database are also mapped to friendly names. We are listing also commands that are defined in our code, but the device does not support them.
An example flow is provided in the examples folder of the repository. This flow demonstrates how to integrate and use the available Rainbird nodes within a Node-RED environment.
This package uses a modified version of node-rainbird originally developed by @bbreukelen. All protocol decoding and encryption logic is based on that excellent work.
Maciej Szulc, 2025