Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #29

Merged
merged 1 commit into from
Aug 14, 2024
Merged

Update README.md #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)).

Expand All @@ -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:
Expand All @@ -31,17 +31,21 @@ 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
- password

## 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.
Loading