JoyReef Guides Index

All user guides, grouped by importance. Start with the 🟢 fundamental ones, then the 🟡 important ones, and finally the 🔵 advanced ones as you need them.

🟢 Fundamental

Without these guides, the system will not start. Mandatory path for everyone, to be done in order.

#	Guide	What it's for
01	Shopping list	What to buy before starting: controller, probes, plugs, accessories
02	First start of the controller	Unboxing, physical assembly, first power-on
03	Firmware + WiFi configuration	Connecting the controller to your home WiFi network
03b	Firmware flash and WiFi connection — all devices	Flash and WiFi connection process for controller, doser, fish-feeder and pH
04	Tank and sensors	Creating a tank on the portal and assigning roles to sensors
05	Tasmota smart plugs	Configuring smart plugs to control heaters, pumps, etc.

🟡 Important

Almost everyone will want to activate these features. Without them, the system works but is much less effective (no real automation, no alerts in case of problems).

#	Guide	What it's for
06	Automatic Top-Off (ATO)	Automatically tops up fresh water when the level drops
07	Temperature control	Automatic management of heater (and fan/chiller) with hysteresis
08	Automatic water change	Scheduled weekly drainage + refilling
14	Events and timeline	Consultation page: what happened in the tank, charts, filterable logs
15	Email notifications	Email alerts for critical events (ATO fault, heater failure, etc.)

🔵 Advanced

Optional for specific setups or occasional operations. Only address the ones you really need.

Chemical integrations

#	Guide	Who it's for
18	pH Device	Those who want to monitor pH or use a Calcium reactor / KH titration: the pH probe is now a dedicated device
10	Calcium reactor	Those who have a CaCO₃ + CO₂ reactor to integrate Ca/KH
11	Dosing pumps (6 channels)	Those who use Balling, kalkwasser, trace elements, bacteria, etc.
12	Automatic KH titration	Those who have a dosing pump with a pH probe + reagent to measure KH automatically

Monitoring

#	Guide	Who it's for
20	EC / Salinity device	Those who want the tank's salinity measured continuously (EC probe, 34-36 ppt target), without a refractometer at hand

Diagnostics

#	Guide	Who it's for
13	Energy & Health	Those who want "smart" alerts on heater/return/skimmer based on electrical consumption

Custom Automations

#	Guide	Who it's for
09	Advanced automations ⏸️ coming soon	Those who want to create custom automations beyond pre-packaged routines

Firmware Maintenance

#	Guide	Who it's for
16	Firmware installation via USB	First installation, recovery of a bricked device, downgrade to specific version
16b	Flashing via CP2102 serial adapter	Those with a dosing pump without a USB port, or who need to recover an unresponsive board
17	OTA updates	Periodic update via portal, without cables

Migrating from the old portal

#	Guide	Who it's for
19	Migrating from the old portal	Those with a dosing pump on the old portal (iot.joy-reef.com): firmware update + connection to the new portal

How to use this documentation

New here? Start from 01 — Shopping list and follow in order until 05.
Is the basic system working? Address the 🟡 important ones (06-08, 14-15) to activate real automations.
Do you have a specific case? Go directly to the 🔵 advanced guide that interests you.

All guides are also available as printable PDFs under apps/portal/public/guides/.