From ac68ef02575c74ef3115c6df8cde7e8a6d43ea79 Mon Sep 17 00:00:00 2001 From: Daniel <50608357+danmrossi@users.noreply.github.com> Date: Wed, 14 Aug 2024 10:31:10 +0800 Subject: [PATCH] Update README.md Fixed spelling and added information about intermittent ph sensor readings and how to fix, will later update the steps needed to enable MQTT in reef-pi as it is a bit quirky. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 355a28b..63d46fa 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ ![GitHub Latest Release](https://img.shields.io/github/downloads/tdragon/reef-pi-hass-custom/latest/total) -# Home Assistane Reef Pi integration +# Home Assistant Reef Pi Integration This custom integration provides a way to monitor sensors data and control equipment connected to [Reef-Pi (An open source reef tank controller based on Raspberry Pi)](http://reef-pi.github.io/) ([GIT repository](https://github.com/reef-pi/reef-pi/releases)). @@ -17,7 +17,7 @@ This custom integration provides a way to monitor sensors data and control equip This integration can be installed using HACS. To do it add custom *integration* repository using url: `https://github.com/tdragon/reef-pi-hass-custom/`. -Then search for Reef Pi in *Integrations* section. +Then search for Reef Pi in in the *Integrations* section. ### Manual To install this integration manually you have to download the content of this repository to `config/custom_components/reef-pi-hass-custom` directory: @@ -31,7 +31,7 @@ rm reef_pi.zip After that restart Home Assistant. ## Configuration -Install integration from UI (Configuration --> Intergations --> + --> Search for `reef pi`) +Install integration from UI (Configuration --> Integrations --> + --> Search for `reef pi`) Configuration options: - Host (http://ip.address or https://ip.address) - user name @@ -39,9 +39,13 @@ Configuration options: ## Usage Integration creates temperature sensor for each sensor connected to Reef PI: `sensor.{reef-pi name}_{temperature_sensor_name}` -Additionaly it create one sensor for CPU temperature: `sensor.{reef_pi_name}` +Additionally, it creates one sensor for CPU temperature: `sensor.{reef_pi_name}` For each equipment configured in Reef Pi an outlet entity is created: `switch.{reef_pi name}_{equipment_name}` +## NOTE: How to "fix" intermittent pH readings +On some installations of this addon, it can cause Reef Pi to intermittently drop the reading from both the Reef Pi graph/database and in Home Assistant. +To fix this, in Home Assistant go to Settings > Integrations > Reef-Pi integration and under "Integration entries" click on "Configure" and select "Disable pH sensir" and click on "Submit" and then click on the 3 vertical dots and select "Reload" +To bring in pH sensor readings into Home Assistant you will need to enable the MQTT functionality from within the Reef Pi systems interface.