Skip to content

Elwinmage/ha-reef-card

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

445 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ha-reef-card 🌊 for HomeAssistant

GH-release GH-last-commit License: MIT

TypeScript Lit codecov BuyMeCoffee

Supported languages :

Your language is not yet supported and you want to help with the translation? Follow this guide.

Overview

The Reef card for Home Assistant helps you manage your reef aquarium.

Combined with ha-reefbeat-component, it automatically supports your Redsea (ReefBeat) devices.

Note

If you have non-Redsea devices and want them to be supported, you can request it here.

Tip

The list of upcoming features is available here
The list of bugs is available here

Compatibility

βœ… Implemented β˜‘οΈ In progress ❌ Planned

Model Status Issues
πŸ“†(Planned)
πŸ›(Bugs)
ReefATO+ RSATO+❌ πŸ“† πŸ›
ReefControl RSSENSE
If you own one, you can contact me here and I will add its support.
❌ πŸ“† πŸ›
ReefDose RSDOSE2 βœ… πŸ“† πŸ›
RSDOSE4βœ…
ReefLed G1 ❌ πŸ“† πŸ›
G2 ❌
ReefMat RSMAT250 βœ… πŸ“† πŸ›
RSMAT500 βœ…
RSMAT1200 βœ…
ReefRun RSRUNβ˜‘ πŸ“† πŸ›
ReefWave RSWAVE❌ πŸ“† πŸ›

Table of contents

Installation

Direct installation

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

Search in HACS

Or search for Β«reef-cardΒ» in HACS.

Image

Configuration

Without the device parameter, the card automatically detects all ReefBeat devices and lets you choose the one you want.

To remove device selection and force a specific one, set the device parameter to the name of your device.

ReefATO

Planned.

Want it supported sooner? Vote here.

ReefControl

Planned.

Want it supported sooner? Vote here.

ReefDose

ReefDose with ha-reef-card in action:

Watch the video

The ReefDose card is divided into 6 zones:

  1. Configuration/WiFi Information
  2. States
  3. Manual Dosing
  4. Head configuration and scheduling
  5. Supplement management
  6. Future dose queue

Configuration/WiFi Information


Click the icon to manage the general configuration of the ReefDose.

Click the icon to manage the network settings.

States


The maintenance switch switches the device to maintenance mode.

The on/off switch toggles the ReefDose between on and off states.

Manual Dosing


The button displays the default manual dose for this head. Clicking it opens the configuration dialog for this dosing.

You can add shortcuts using the card editor:

For example, head 1 offers 2, 5, and 10 mL as shortcuts.

These values will appear at the top of the dialog. Clicking a shortcut sends a command to dose the defined value.

Pressing the manual dose button: sends a dose command with the default value displayed just above: , i.e. 10 mL in this example.

Head configuration and scheduling


This zone allows you to view the current head schedule and change it.

  • The colored circular ring indicates the percentage of the daily dose already delivered.

  • The yellow number at the top shows the cumulative daily manual dose total.

  • The central part shows the volume delivered compared to the total programmed daily volume.

  • The blue lower part shows the number of doses delivered compared to the total doses for the day (example: 14/24 for blue because it is an hourly schedule and this screenshot was taken at 14:15). The values for purple and green show 0/0 because these doses are scheduled for 8:00 but the integration was started after 8:00, so there will be no doses today.

  • A long press on one of the 4 heads toggles it on/off.

  • A click on a head opens the scheduling dialog. From this dialog you can run a priming cycle, recalibrate the head, change the daily dose and its schedule. Don't forget to save the schedule before closing.

Supplement management


This zone is used to manage supplements. If a supplement is already declared, clicking on it will open the configuration dialog where you can:

  • Delete the supplement (trash icon at the top right)
  • Specify the total volume of the container
  • Specify the actual volume of the supplement
  • Decide whether you want to track the remaining volume. Clicking the shortcuts at the top will enable tracking and set default values for a full container.
  • Change the display name of the supplement.

If no supplement is linked to a head, you can add one by clicking on the container with a '+' (head 4 in our example).

Then follow the instructions:

Supplements

Here is the list of supported images for supplements, grouped by brand. If yours has a ❌, you can request its addition here.

ATI Β  2/2 πŸ–ΌοΈ
βœ…Essential Pro 1
βœ…Essential Pro 2
Aqua Forest Β  3/9 πŸ–ΌοΈ
βœ…Ca Plus
❌Calcium
❌Component 1+
❌Component 2+
❌Component 3+
❌KH Buffer
βœ…KH Plus
❌Magnesium
βœ…Mg Plus
BRS Β  0/4 πŸ–ΌοΈ
❌Liquid Calcium
❌Liquid alkalinity
❌Magnesium Mix
❌Part C
Brightwell Β  0/12 πŸ–ΌοΈ
❌Calcion
❌Ferrion
❌Hydrate - MG
❌KoralAmino
❌Koralcolor
❌Liquid Reef
❌Potassion
❌Reef Code A
❌Reef Code B
❌Replenish
❌Restore
❌Strontion
ESV Β  0/5 πŸ–ΌοΈ
❌B-Ionic Component 1
❌B-Ionic Component 2
❌B-Ionic Magnesium
❌Transition elements
❌Transition elements plus
Fauna Marine Β  0/11 πŸ–ΌοΈ
❌Amin
❌Balling light trace 1
❌Balling light trace 2
❌Balling light trace 3
❌Balling light Ca
❌Balling light KH
❌Balling light Mg
❌Blue trace elements
❌Green trace elements
❌Min S
❌Red trace elements
Quantum Β  7/7 πŸ–ΌοΈ
βœ…Aragonite A
βœ…Aragonite B
βœ…Aragonite C
βœ…Bio Kalium
βœ…Bio Metals
βœ…Bio enhance
βœ…Gbio Gen
Red Sea Β  10/13 πŸ–ΌοΈ
βœ…Bio Active (Colors D)
βœ…Calcium (Foundation A)
❌Calcium (Powder)
βœ…Iodine (Colors A)
βœ…Iron (Colors C)
βœ…KH/Alkalinity (Foundation B)
❌KH/Alkalinity (Powder)
βœ…Magnesium (Foundation C)
❌Magnesium (Powder)
βœ…NO3PO4-X
βœ…Potassium (Colors B)
βœ…Reef Energy Plus
βœ…ReefCare Program
Seachem Β  0/9 πŸ–ΌοΈ
❌Reef Calcium
❌Reef Carbonate
❌Reef Complete
❌Reef Fusion 1
❌Reef Fusion 2
❌Reef Iodine
❌Reef Plus
❌Reef Strontium
❌Reef Trace
Triton Β  0/4 πŸ–ΌοΈ
❌Core7 elements 1
❌Core7 elements 2
❌Core7 elements 3A
❌Core7 elements 3B
Tropic Marin Β  5/14 πŸ–ΌοΈ
❌A Element
βœ…All-For-Reef
βœ…Amino Organic
❌Balling A
❌Balling B
❌Balling C
βœ…Bio-Magnesium
βœ…Carbo Calcium
❌Elimi-NP
❌K Element
❌Liquid Buffer
❌NP-Bacto-Balance
❌Plus-NP
βœ…Potassium

ReefLed

Planned.

Want it supported sooner? Vote here.

ReefMat

ReefMat with ha-reef-card in action:

Watch the video

The ReefMat card is divided into 7 zones:

  1. Configuration / Wifi Information
  2. States
  3. Roll information (total length used, remaining length, end of roll, mode...)
  4. Manual/Automatic Advance
  5. Sensor
  6. Scheduled Advance
  7. Weekly / Monthly Usage Graph

The background image changes according to the roll usage status, with 5 different images:


0%

25%

50%

75%

100%

Configuration / Wifi Information


Click the icon to manage the general configuration of the ReefMat.

Click the icon to manage the network settings.

States


The maintenance switch switches to maintenance mode.

The on/off switch switches the ReefMat between on and off states.

Roll Information


This zone displays the real-time status of the filter roll, from top to bottom:

  • The total length used since the start of the roll (top, in red)
  • The remaining length in the centre in red. When the roll is empty, a blinking icon appears instead and a dialog box offers to replace the roll.

  • The number of days remaining before the end of the roll, estimated from the daily average consumption (in black)
  • The daily average consumption in cm (bottom left)
  • The current operating mode: Auto, Maintenance, Off… (below the RedSea logo)
  • The roll usage percentage (circular arc, bottom right)

If an anomaly is detected, the RedSea logo transforms into a blinking icon. Clicking this alert opens the anomaly dialog box:

Manual/Automatic Advance

---

This zone controls the roll advance.

From left to right:

  • The button triggers a manual advance of the roll by the length shown in the centre.
  • The displayed advance value (in cm) is the value sent when the button is pressed. Clicking this number opens the editing dialog.

  • The automatic advance button enables or disables the automatic roll advance.

Sensor


This zone shows the status of the level sensor.

Three states are possible:

State Image
Sensor connected
Sensor disconnected
Dirty sensor

Scheduled Advance


This button shows the scheduled advance status and allows editing it by clicking on it.

Usage Graph


This zone displays a graph of roll consumption over time. Clicking the button toggles between the two available modes:

  • Weekly mode shows consumption over the last 7 days.
  • Monthly mode shows consumption over the last 30 days.

Pressing the top left of the graph opens the detailed view in Home Assistant.

Messages


This zone displays the latest system messages from the ReefMat. It has two lines:

  • The grey line shows the last message received.
  • The pink line shows the last alert, preceded by the ⚠ symbol.

Clicking the icon clears the corresponding message.

These lines can be hidden via the card editor interface.

ReefRun

Planned.

Want it supported sooner? Vote here.

ReefWave

Planned.

Want it supported sooner? Vote here.

FAQ