Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dalinicus committed Oct 24, 2023
1 parent 0d6359c commit fdb6043
Showing 1 changed file with 63 additions and 28 deletions.
91 changes: 63 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,32 @@

This is a custom component for [Home Assistant](http://home-assistant.io) that adds support for [AC Infinity](https://acinfinity.com/) grow tent devices within the [Smart UIS Controller](https://acinfinity.com/smart-controllers/) ecosystem

## Installation

### HACS

Follow [this guide](https://hacs.xyz/docs/faq/custom_repositories/) to add this git repository as a custom HACS repository. Then install from HACS as normal.

### Manual Installation

Copy `custom_components/acinfinity` into your Home Assistant `$HA_HOME/config` directory, then restart Home Assistant

## Initial Setup
Add an integration entry as normal from integration section of the home assistant settings. You'll need the following configuration items

- **Email**: The e-mail registered with your AC Infinity account.
- **Password**: The password for this account.

![Initial-Setup](/images/initial-setup.png)

## Additional Configuration

After adding an integration entry, the following additional configurations can be modified via the configuration options dialog.

- **Polling Interval (Seconds)**: The time between update calls to the AC Infinity API. Minimum allowed polling interval is 5 seconds.

![Additional-Configuration](/images/additional-configuration.png)

## Data Available

This integration will create a device for each AC Infinity Controller on the configured user account. Each device will have the following sensors created.
Expand All @@ -32,7 +58,7 @@ Integration is currently only read only, but triggering state changes on connect

This integration adds a number of controls to modify settings via the AC Infinity API. The following controls will be created for each ***PORT*** on a controller, even if no device is attached. The UIS protocol is device type agnostic, so each port will be treated the same regardless of what is plugged (or not plugged) into it.

Currently, controls can be added via the entities card. The downside is that the controls will still be visible even if they are not applicable to the currently selected mode. A custom lovelace card is in the works to show and hide controls based on selected mode. Stay tuned!
Currently, controls can be added via the entities card. The downside is that the controls will still be visible even if they are not applicable to the currently selected mode. A custom lovelace card is in the works to show and hide controls based on selected mode. ***Stay tuned!***

The mode can be changed via the mode control. The following documentation is split into controls relevant to each mode.
- **On**: Device is always set to the on speed
Expand All @@ -44,40 +70,49 @@ The mode can be changed via the mode control. The following documentation is sp
- **Cycle**: Device is toggled after set intervals
- **Schedule**: Device is toggled based on a schedule

![Initial-Setup](/images/mode.png)

### On Mode
- **On Speed**: The speed/intensity of the device while in on mode

![Initial-Setup](/images/mode-on.png)

### Off Mode
- **Off Speed**: The speed/intensity of the device while in off mode

![Initial-Setup](/images/mode-off.png)

## Installation

### HACS

Follow [this guide](https://hacs.xyz/docs/faq/custom_repositories/) to add this git repository as a custom HACS repository. Then install from HACS as normal.

### Manual Installation

Copy `custom_components/acinfinity` into your Home Assistant `$HA_HOME/config` directory, then restart Home Assistant

## Initial Setup
Add an integration entry as normal from integration section of the home assistant settings. You'll need the following configuration items

- **Email**: The e-mail registered with your AC Infinity account.
- **Password**: The password for this account.

![Initial-Setup](/images/initial-setup.png)

## Additional Configuration
### Auto Mode
- **On Speed**: The speed/intensity of the device while in on mode
- **Off Speed**: The speed/intensity of the device while in off mode
- **Auto High Temp Enabled**: Enable or disable high temp trigger while in Auto mode
- **Auto High Temp Trigger**: If trigger is enabled, device will be turned on if temp exceeds configured value.
- **Auto Low Temp Enabled**: Enable or disable low temp trigger while in Auto mode
- **Auto Low Temp Trigger**: If trigger is enabled, device will be turned on if temp drops below configured value.
- **Auto High Humidity Enabled**: Enable or disable high humidity trigger while in Auto mode
- **Auto High Humidity Trigger**: If trigger is enabled, device will be turned on if humidity exceeds configured value.
- **Auto Low Humidity Enabled**: Enable or disable low humidity trigger while in Auto mode
- **Auto Low Humidity Trigger**: If trigger is enabled, device will be turned on if humidity drops below configured value.

### Timer to On
- **On Speed**: The speed/intensity of the device while in on mode
- **Off Speed**: The speed/intensity of the device while in off mode
- **Minutes to On**: Device will be turned on after the configured number of minutes

After adding an integration entry, the following additional configurations can be modified via the configuration options dialog.
### Timer to Off
- **On Speed**: The speed/intensity of the device while in on mode
- **Off Speed**: The speed/intensity of the device while in off mode
- **Minutes to On**: Device will be turned off after the configured number of minutes

- **Polling Interval (Seconds)**: The time between update calls to the AC Infinity API. Minimum allowed polling interval is 5 seconds.
### Cycle Mode
- **On Speed**: The speed/intensity of the device while in on mode
- **Off Speed**: The speed/intensity of the device while in off mode
- **Cycle Minutes On**: The amount of minutes the device will stay in on mode before switching to off mode
- **Cycle Minutes Off**: The amounto f minutes the device will stay in off mode before switching to on mode

![Additional-Configuration](/images/additional-configuration.png)
### Schedule Mode
- **On Speed**: The speed/intensity of the device while in on mode
- **Off Speed**: The speed/intensity of the device while in off mode
- **Schedule Start Time**: The time that the device will switch into on mode daily
- **Schedule End Time**: The time that the device will switch into off mode daily

### VPD Mode
- **VPD High Enabled**: Enable or disable high VPD trigger while in VPD mode
- **VPD High Trigger**: If trigger is enabled, device will be turned on if VPD exceeds configured value.
- **VPD Low Enabled**: Enable or disable low VPD trigger while in VPD mode
- **VPD Low Trigger**: If trigger is enabled, device will be turned on if VPD drops below configured value.

0 comments on commit fdb6043

Please sign in to comment.