Supported Languages:

To help us translate, follow this guide.

Overview

HomeAssistant RedSea Reefbeat devices Local Management (no cloud): ReefATO+, ReefDose, ReefLed, ReefMat, ReefRun and ReefWave

Tip

To edit advanced schedules for ReefDose, ReefLed, ReefRun and ReefWave, you need to use the ha-reef-card (currently under development)

Tip

The list of future implementations can be found here
The list of bugs can be found here

If you need other sensors or actuators, feel free to contact me here.

Important

If your devices are not on the same subnet as your Home Assistant, please read this.

Caution

⚠️ This is not an official RedSea repository. Use at your own risk.⚠️

Compatibility

✅ Tested ☑️ Must Work (If you have one, can you confirm it's working here) ❌ Not Supported Yet

	Model		Status		Issues 📆(Planned) 🐛(Bugs)
ReefATO+	RSATO+		✅		📆 🐛
ReefControl	RSSENSE If you have one, contact me here and I will add its support.		❌		📆 🐛
ReefDose	RSDOSE2		✅		📆 🐛
	RSDOSE4		✅
ReefLed	G1	RSLED50	✅		📆 🐛
		RSLED90	✅
		RSLED160	✅
	G2	RSLED60	✅
		RSLED115	✅
		RSLED170	☑️
ReefMat	RSMAT250		✅		📆 🐛
	RSMAT500		✅
	RSMAT1200		✅
ReefRun & DC Skimmer	RSRUN		✅		📆 🐛
ReefWave (*)	RSWAVE25		☑️		📆 🐛
	RSWAVE45		✅

(*) ReefWave users, please read this

Summary

• Installation via HACS
• Common functions
• ReefATO+
• ReefControl
• ReefDose
• ReefLED
• Virtual LED
• ReefMat
• ReefRun
• ReefWave
• Cloud API
• FAQ

Installation via HACS

Direct installation

Just click here to directly go to the repository in HACS and click "Download":

For the companion card ha-reef-card offering advanced and ergonomic features, click here to directly go to the repository in HACS and click "Download":

Find in HACS

Or search for "redsea" or "reefbeat" in HACS.

Common functions

Icons

This integration provides custom icons accessible via "redsea:icon-name":

Add device

When adding a new device you have 4 choices:

Add Cloud API

Mandatory for ReefWave if you want to keep it synchronized with the ReefBeat Mobile App (Read this).
Mandatory to be notified of a new firmware version (Read this).

• Get user information
• Get aquariums
• Get Waves library
• Get LED library

Auto detect on private network

If not on the same network, read this and use "Manual Mode".

Manual Mode

You can enter your device IP address or the network address for auto-detection.

Set scan interval for device

Live update

Note

It is possible to choose whether to enable live_update_config or not. In this mode (old default), configuration data is continuously retrieved along with normal data. For RSDOSE or RSLED, these large HTTP requests can take a long time (7–9 seconds). Sometimes the device does not respond to the request, so a retry function has been implemented. When live_update_config is disabled, configuration data is only retrieved at startup and when requested via the "Fetch Configuration" button. This new mode is activated by default. You can change it in the device configuration.

Firmware Update

You can be notified and update your device when a new firmware version is available. You must have an active "Cloud API" device with your credentials and the "Use Cloud API" switch must be enabled.

Tip

The "Cloud API" is only needed to get the version number of the new release and compare it to the installed version. To update your firmware, the Cloud API is not strictly required. If you do not use the "Cloud API" (switch disabled or no Cloud API device installed), you will not be alerted when a new version is available, but you can still use the hidden "Force Firmware Update" button. If a new version is available, it will be installed.

ReefATO:

• Auto-fill enable/disable
• Manual fill

ReefControl:

Not supported yet. If you have one, contact me here and I will add its support.

ReefDose:

• Edit daily dose
• Manual dose
• Add and remove supplements
• Edit and control container volume. Container volume settings are automatically enabled or disabled according to the volume control switch.
• Enable/disable schedule per pump
• Stock alert configuration
• Dosing delay between supplements
• Priming (Please read this)
• Calibration (Please read this)

Main

Heads

Calibration and Priming

Caution

You must strictly follow the order below (Using the ha-reef-card is safer).

Calibration:

1. Place the graduated container and press "Start Calibration"
2. Enter the measured value using the "Dose of Calibration" field
3. Press "Set Calibration Value"
4. Empty the graduated container and press "Test new Calibration". If the value obtained is not 4 mL, go back to step 1.
5. Press "Stop and Save Graduation"

For priming:

1. (a) Press "Start Priming"
2. (b) When the liquid flows out, press "Stop Priming"
3. (1) Place the graduated container and press "Start Calibration"
4. (2) Enter the measured value using the "Dose of Calibration" field
5. (3) Press "Set Calibration Value"
6. (4) Empty the graduated container and press "Test new Calibration". If the value obtained is not 4 mL, go back to step 1.
7. (5) Press "Stop and Save Graduation"

⚠️ Priming must always be followed by a calibration (steps 1 to 5)!⚠️

ReefLED:

• Get and Set White and Blue channels (only for G1: RSLED50, RSLED90, RSLED160)
• Get and Set Color Temperature, Intensity and Moon (all LEDs)
• Manage acclimation. Acclimation settings are automatically enabled or disabled according to the acclimation switch.
• Manage moon phase. Moon phase settings are automatically enabled or disabled according to the moon phase switch.
• Set Manual Color Mode with or without duration.
• Get Fan and Temperature values.
• Get name and value for programs (with cloud support). Only for G1 LEDs.

---

Color Temperature support for G1 LEDs takes into account the specificities of each of the three models.

---

IMPORTANT for G1 and G2 LIGHTS

G2 LIGHTS

Intensity

Because G2 LEDs ensure constant intensity across the entire color range, your LEDs do not utilize their full capacity in the middle of the spectrum. At 8,000K, the white channel is at 100% and the blue channel at 0% (the opposite at 23,000K). At 14,000K with 100% intensity for G2 lights, the power of the white and blue channels is approximately 85%. Here is the loss curve for the G2s.

Color Temperature

The G2 interface does not support the entire temperature range. From 8,000K to 10,000K, values are incremented in 200K steps, and from 10,000K to 23,000K in 500K steps. This behavior is handled automatically: if you choose an invalid value (e.g. 8,300K), a valid value will be automatically selected (8,200K in this example). This is why you may sometimes observe a slight cursor adjustment when selecting the color on a G2 light — the cursor repositions itself to an allowed value.

G1 LIGHTS

G1 LEDs use white and blue channel control, which allows full power across the entire range, but not constant intensity without compensation. That is why intensity compensation has been implemented. This compensation ensures you get the same PAR (light intensity) regardless of your color temperature choice (in the range 12,000 to 23,000K).

Note

Because Red Sea does not publish PAR values below 12,000K, compensation is only available in the 12,000 to 23,000K range. If you have a G1 LED and a PAR meter, you can contact me to add compensation for the full range (9,000 to 23,000K).

In other words, without compensation, an intensity of x% at 9,000K does not provide the same PAR as at 23,000K or 15,000K.

Here are the power curves:

If you want to use the full power of your LED, disable intensity compensation (default).

If you enable intensity compensation, the light intensity will be constant across all color temperature values, but in the middle of the range you will not use the full capacity of your LEDs (as with G2 models).

Also note that if compensation is enabled, the intensity factor can exceed 100% for G1 lights if you manually adjust the White/Blue channels. This allows you to harness the full power of your LEDs!

---

Virtual LED

• Group and manage LEDs with a virtual device (create a virtual device from the integration panel, then use the configure button to link the LEDs).
• You can only use Kelvin and intensity to control your LEDs if you have G2 or a mix of G1 and G2.
• You can use both Kelvin/Intensity and White & Blue if you have only G1 lights.

ReefMat:

• Auto advance switch (enable/disable)
• Schedule advance
• Custom advance value: lets you select the value of the roll advance
• Manual advance
• Change the roll.

Tip

For a new full roll, please set "roll diameter" to the minimum (4.0 cm). The size will be adjusted according to your RSMAT version. For a partially used roll, enter the value in cm.

• Two hidden parameters: model and position, if you need to reconfigure your RSMAT

ReefRun:

• Set pump speed
• Manage overskimming
• Manage full cup detection
• Can change skimmer model

Main

Pumps

ReefWave:

Important

ReefWave devices are different from other ReefBeat devices. They are the only devices that are slaves to the ReefBeat cloud.
When you launch the ReefBeat mobile app, the status of all devices is queried and data from the ReefBeat app is retrieved from device state.
For ReefWave, it is the opposite: there is no local control point (as you can see in the ReefBeat app, you cannot add a ReefWave to a disconnected aquarium).

Waves are stored in the cloud user library. When you change a wave's value, it is changed in the cloud library and applied to the new schedule.
So there is no local mode? Not so simple. There is a hidden local API to control ReefWave, but the ReefBeat app will not detect the changes. As a result, the device and Home Assistant on one side, and the ReefBeat mobile app on the other, will be out of sync. The device and Home Assistant will always be synchronized.
Now that you know, make your choice!

Note

ReefWave waves have many linked parameters, and the range of some parameters depends on other parameters. I was not able to test all possible combinations. If you find a bug, you can create an issue here.

ReefWave Modes

As explained above, ReefWave devices are the only devices that can become unsynchronized with the ReefBeat app if you use the local API. Three modes are available: Cloud, Local, and Hybrid. You can change the mode by setting the "Connect To Cloud" and "Use Cloud API" switches as described in the table below.

Mode name	Connect To Cloud Switch	Use Cloud API Switch	Behavior	ReefBeat and HA are synchronized
Cloud (Default)	✅	✅	Data is fetched via the local API. On/off commands are also sent via the local API. Wave commands are sent via the cloud API.	✅
Local	❌	❌	Data is fetched via the local API. Commands are sent via the local API. Device is shown as "off" in the ReefBeat app.	❌
Hybrid	✅	❌	Data is fetched via the local API. Commands are sent via the local API. The ReefBeat mobile app does not display the correct wave values if they have been changed via HA. Home Assistant always displays the correct values. You can change values from both the ReefBeat app and Home Assistant.	❌

For Cloud and Hybrid modes you must link your ReefBeat cloud account. First create a "Cloud API" device with your credentials, and that's it! The "Linked to account" sensor will be updated with the name of your ReefBeat account once the connection is established.

Changing current values

To load current wave values into the preview fields, use the "Set Preview From Current Wave" button.

To change the current wave values, set the preview values and use the "Save Preview" button.

The behavior is the same as the ReefBeat mobile app. All waves with the same ID in the current schedule will be updated.

Cloud API

The Cloud API allows you to:

• Launch or stop shortcuts: emergency, maintenance and feeding,
• Get user information,
• Retrieve the waves library,
• Retrieve the supplements library,
• Retrieve the LED programs library,
• Be notified of a new firmware version,
• Send commands to ReefWave when "Cloud or Hybrid" mode is selected.

Shortcuts, wave parameters and LED parameters are sorted by aquarium.

Tip

You can disable fetching the supplements list in the Cloud API device configuration.

---

FAQ

My device is not detected

• Try relaunching the auto-detection with the "Add entry" button. Sometimes devices do not respond because they are busy.
• If your Red Sea devices are not on the same subnet as your Home Assistant, auto-detection will first fail and then offer you the option to enter the IP address of your device or the address of the subnet where your devices are located. For subnet detection, please use the format IP/MASK, for example: 192.168.14.0/255.255.255.0.
• You can also use Manual Mode.

Some data are updated correctly but others are not

Data is divided into three parts: data, configuration and device-info.

• Data is regularly updated.
• Configuration data is only updated at startup and when you press the "Fetch Config" button.
• Device-info data is only updated at boot.

To ensure that configuration data is updated regularly, please enable Live Configuration Update.

---