Click on your flag to have the README in your language.
Your language is not supported yet, you want to help with translation, follow this guide.
HomeAssitant RedSea Reefbeat devices Local Management (no cloud): ReefATO+, ReefDose, ReefLed, ReefMat, ReefRun and ReefWave
Tip
To edit advanced schedule for ReefDose, ReefLed, ReefRun and ReefWave, you need to use the ha-reef-card (currently under development)
If you need other sensors or actuators let me know here.
Important
If your devices are not on the same subnet as your Home Assistant please read this.
Caution
✅ Tested ☑️ Must Work (If you have one, can you confirm it's working here ) ❌ No Supported Yet
| Model | Status | Issues 📆(Planned) 🐛(Bugs) |
|||
| ReefATO+ | RSATO+ | ✅ |  |
📆 🐛 | |
| ReefControl | RSSENSE If you have one, you can 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 user please read this
- Installation via hacs
- Common functions
- ReefATO+
- ReefControl
- ReefDose
- ReefLED
- Virtual LED
- ReefMat
- ReefRun
- ReefWave
- Cloud API
- FAQ
Just click here to directly go to the repository in HACS and click "Download":
Or search for "redsea" or "reefbeat" in hacs
When adding a new device you have 4 choices:
Mandatory for ReefWave if you want to keep it synchronized with ReefBeat Mobile App (Read this).
Mandatory for firmware update if you want to be notify when new version is available
- Get user informations
- Get aquariums
- Get Waves library
- Get Led library
If not on same network read this and use the "Manual Mode"
You can put your device IP or the network address to have auto detection.
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 I had to code a retry function. 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.
You can be notified and update when a new firmware version is available for your device. You must have a "cloud api" device with your credential and the "Use cloud API" switch must be enabled.
Tip
The "cloud api" is only needed to get the version number of the new version and compare it to the installed version. To update your firmware you don't really need the cloud API. If you don't use the "cloud api" (switch disabled or no cloud api device), 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 install.
- Auto_fill enable/disable
- Manual fill
No supported yet. If you have one you can contact me here.
- Edit daily dose
- Manual dose
- Change and control container volume. Container Volume settigns is automaticaly enabled or disabled according to volume controleur switch.
- Enable/disable schedule per pump
- Stock alert configuration
- Dosing delay between supplements
- Add or remove supplements and bundles
- Calibration(Please Read this).
- Priming (Please Read this).
Caution
You must strictly follow the order (It will be more secure with the ha-reef-card).
For calibration:
- Put the graduated container and press "Start Calibration"
- Set the mesured value
- Press "Set Calibration Value"
- Empty the gratuated container and press "Test new Calibration". If value ist not 4mL, empty the graduated container and go back to 1.
- Press "Stop and Save Graduation"
For priming:
- (a) press "Start Priming"
- (b) when the liquid goes out press "Stop Priming"
- (1) Put the graduated container and press "Start Calibration"
- (2) Set the mesured value
- (3) Press "Set Calibration Value"
- (4) Empty the gratuated container and press "Test new Calibration". If value ist not 4mL, empty the graduated container and go back to 1.
- (5) Press "Stop and Save Calibration"
- 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 automaticaly enabled or disabled according to acclimation switch.
- Manage moonphase. Moonphase settings are automaticaly enabled or disabled according to moonphase switch.
- Set Manual Color Mode with or without duration
- Get Fan and Temperature
- Get name and value for progams (with clouds support) Only for G1 LEDS.
The support of Color Temperature for G1 LEDS take into account the specificity of each of the three models.
Because G2 leds ensures constant intensity across the entire color range, your LEDs do not utilize their full capacity in the middle. At 8.000K, the white channel is at 100% and the blue channel at 0% (the opposite at 23.000K). At 14.000K and 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.
The G2 interface does not support the entire Kelvin temperature range. From 8,000 K to 10,000K, values are incremented in 200K steps, and from 10,000K to 23,000K, in 500K steps. This behavior is taken into account: if you set an invalid value for your G2 lamp (8,300K, for example), a valid value is automatically selected (8,200K in this example). This is why you may sometimes observe a slight movement of the cursor when setting the Kelvin temperature for G2: the cursor is then positioned at an available Kelvin temperature value.
G1 LEDs use white and blue channels control, which allows for full power across the entire range, but not constant intensity without compensation (like G2). That's why I implent intensity compensation. This compensation ensure you will have the same PAR (light intensity) for different Color temperature (from 12,000K to 23,000K).
Note
Because Redsea do not published PAR values under 12000K, compensation is only available in the 12,000 to 15,000K range. If you have a G1 RSLED and a PARmeter you can contact me to also add compensation for range 9,000 to 12,000K.
In other words, without compensation, an intensity of x% for 12,000K do not provide the same PAR as for 23,000K or 15,000K.
Here are the power curve:
If you want to use the full power of your LED then disable intensity compensation (default).
If you enable intentisty compensation, the intensity of your light will be constant accross all kelvin values in the 12,000 to 23,000K range but in the middle of the range you will not use the full capacity of your LED (like G2 models).
Also, don't be surprised to see the intensity factor exceed 100% for the G1s if you change White or Blue channel manually and if compensation is enabled. This is because you can harness the full power of your LEDs!
- Group and manage LED with a virtual device (Create a vitual 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
- Auto advance switch (enable/disable)
- Schedule advance
- Custom advance value: let you select the value of roll advance
- Manual Advance
- Change the roll.
Tip
For a new full roll please set "roll diameter" to min (4.0cm). It will adjust the size according to your RSMAT version. For a started roll enter the value in cm.
- Two hidden parameters: model and position if you need to reconfigure your RSMAT
- Set pump speed
- Manage overskimming
- Manage full cup detection
- Can change skimmer model
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's the opposite: there is no local control point (as you can see in the ReefBeat app, you can't 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's no local mode? Not so simple. There's a hidden local API to control ReefWave, but the ReefBeat app won't detect the changes, so the device and HomeAssistant on one side and the ReefBeat mobile App on the other side will be out of sync. Device and HomeAssisant 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.
As explain before, ReefWave devices are the only devices that can be unsychronized with reefbeat App if you use local API. Three modes are availabled: Cloud, Local, Hybride. You can change the mode setting "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 are fetch via the local api. on/off commands are also sent via local API. Commands are sent via the cloud api |
✅ |
| Local | ❌ | ❌ | Data are fetch via the local api. Commands are sent via the local api. Device is seen as 'off' in ReefBeat App. |
❌ |
| Hybride | ✅ | ❌ | Data are fetch via the local api. Commands are sent via the local api. The ReefBeat mobile APP does not represent the good waves values if values are changed via HA. Home Assitant always represent the good waves values. You can change values from ReefBeat APP and Home Assistant. |
❌ |
For Cloud and Hybride mode you must link your ReefBeat cloud account. First create a "cloud api" device with your credential, and that's all! The "Linked to account" sensor will updated with the name of your reefbeat account if connection is established.
To load current wave values in preview fields, use the "Set Prev. From Current" Button.
The behavior is the same as of ReefBeat mobile App. All waves with the same id in the current schedule will be updated.
The cloud API permits to get user informations, waves, supplements and leds libraries, notify when a new firmware is available and to send commands to ReefWave when "Cloud or Hybride" mode is selected. Waves and Leds parameters ares sorted by Tanks.
- try to relaunch the auto-detection with the "add entry" button. Sometimes devices do not respond because they are busy.
- If your redsea devices are not on the same subnetwork than your Home Assistant, auto-detection will first fail and propose you to enter the ip of your device or the address of the subnetwork where your devices are. For subnetwork detection please use the format IP/MASK like this example : 192.168.14.0/255.255.255.0.
- You can also use the manual mode
Datas are divided in three parts: data, config and device-info:
- Data are regulary updated
- Config datas are only updated at startup and when you press the fecth-config button
- Device-info datas are only updated at boot
To ensure that the Config datas are updated regularly, please enable the "Live configuration Update"