Skip to content

About

🐠 Manage ReefBeat devices from RedSea: ReefLed, ReefMat, ReefDose, ReefRun, ReefWave and ReefATO+

Topics

Resources

Stars

33 stars

Watchers

3 watching

Forks

Latest commit

Β 

History

980 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Red Sea (ReefBeat devices) 🐠

Part of the ReefTech Project Ecosystem

HACS Badge IoT Class Installations GH-release

Ruff Status HA & HACS Validation Coverage GH-code-size

GitHub Clones BuyMeCoffee

Supported Languages:

To help us with translation, follow this guide.

Overview

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

🎬 Demo videos

ReefDose demo
ReefDose demo
ReefMat demo
ReefMat demo
ReefRun demo
ReefRun demo
ReefATO+ demo
ReefATO+ demo
ReefControl & ReefControl-Power demo
ReefControl & ReefControl-Power demo
ReefLed demo
ReefLed demo
ReefWave demo
ReefWave demo

Related projects

The ReefTech projects fit together: the integrations bring your equipment into Home Assistant, the card displays and drives it, and the backup keeps it running through an outage. Each one also works on its own.

Project What it does Works with
ha-reefbeat-component 🐠
ha-reefbeat-component
(this repository)
Red Sea ReefBeat devices, controlled locally with no cloud: ReefATO+, ReefControl, ReefControl-Power, ReefDose, ReefLed, ReefMat, ReefRun and ReefWave.
alert blueprint for abnormal modes, calibrations and low battery. Open your Home Assistant instance and show the blueprint import dialog with a specific blueprint pre-filled.
ha-reef-card
ha-aquamedic-component 🌊
ha-aquamedic-component
Aqua Medic pumps through the Gizwits cloud API: EcoDrift and SmartDrift wavemakers, DC Runner return and skimmer pumps. ha-reef-card
ha-reef-maintenance-component πŸ™
ha-reef-maintenance-component
Cleaning and wear tracking for the equipment Home Assistant cannot talk to: flow pumps, return pumps, skimmers, media reactors, anything you service by hand. ha-reef-card
ha-reef-card πŸͺΈ
ha-reef-card
Interactive graphical view of each device on your dashboard, and the only way to edit advanced schedules. Reads the three integrations above through the shared reef_role contract, with no card-side configuration. Also draws the power flows of reefbeatEnergyBackup. Its aquarium card brings your tank to life with ha-reeftank-component. all three integrations, and ha-reeftank-component for the aquarium
ha-reeftank-component 🐟
ha-reeftank-component
A living picture of your tank on the dashboard: your photo, lit by your real lamps, with animated fish and corals, and your devices and entities on it. Stores the aquariums and their livestock, records the feedings. ha-reef-card
reeftank-catalog 🐑
reeftank-catalog
Fish, corals and textures of the aquarium card, downloaded and kept up to date by ha-reeftank-component. ha-reeftank-component
ha-reef-blueprints 🐬
ha-reef-blueprints
Notification blueprints shared by the whole ecosystem: overdue maintenance found through the reef_role contract, and devices that went unreachable. Eight languages. all three integrations
reefbeatEnergyBackup ⚑
reefbeatEnergyBackup
Battery backup for power outages. A 24V LiFePOβ‚„ pack driven by a Raspberry Pi, with pump speed degraded progressively according to the state of charge. standalone, or alongside ha-reefbeat-component and ha-reef-card

All of them are documented together on the ReefTech project page.

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

βœ… Supported Β |Β  🚧 In progress Β |Β  πŸ§ͺ Untested (may work) Β |Β  ❌ Not yet supported

Own a device marked πŸ§ͺ? Please confirm it works here.

Model Status EnergyBackup Issues
πŸ“†(Planned)
πŸ›(Bugs)
ReefATO+ RSATO+βœ… – πŸ“† πŸ›
ReefControl RSCONTROLPROβœ… – πŸ“† πŸ›
RSCONTROLLITEπŸ§ͺ
ReefControl-Power RSPOWER6βœ… – πŸ“† πŸ›
RSPOWER8πŸ§ͺ
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

Direct installation

Just click here to directly go to the repository in HACS and click "Download": Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

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": Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Find in HACS

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

Image

Common functions

Icons

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

Add device

When adding a new device you have 4 choices:

Image

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

Image

Auto detect on private network

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

Image

Manual Mode

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

Image

Device Config

Right-click a device (or open its options from the integration page) to reach its configuration. The first screen lets you change how the integration talks to the device.

Image

Set scan interval for device

Set how often (in seconds) the integration polls the device for new data.

Image

Change WiFi network

You can move a device to another WiFi network directly from Home Assistant, without going back to the ReefBeat app.

From the device configuration menu, choose Change WiFi network. The integration asks the device to scan for nearby networks and shows them in a drop-down, sorted by signal strength. The network the device is currently connected to is pre-selected, so if you only need to update the password you can leave the selection as-is.

Image

Pick the target network, enter its password, and submit. The integration sends the new credentials to the device, reboots it, and then automatically looks for it again on the network to update its IP address.

Image

Note

After a WiFi change the device may join a different subnet (for example moving from 192.168.0.x to 10.0.0.x). The integration scans every subnet Home Assistant is directly connected to. If the device lands on a subnet that Home Assistant can only reach through a router, rediscovery will fail and you will be asked to enter the target subnet manually (for example 10.0.0.0/24).

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.

Image

Image

Note

Every device also exposes a "Fetch data" button. It forces an immediate read of the polled sources instead of waiting for the next scan interval, and works whatever the Live update config setting is β€” unlike "Fetch config", which only refreshes the configuration sources.

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.

Image Image

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.

Image

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.


About

🐠 Manage ReefBeat devices from RedSea: ReefLed, ReefMat, ReefDose, ReefRun, ReefWave and ReefATO+

Topics

Resources

Stars

33 stars

Watchers

3 watching

Forks

Releases

Contributors

Languages