-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add documentation for Neptune Apex #13151
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.
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
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3e65ea3
Revert "Revert "Added documentation for Neptune Apex." (#13149)"
jpelzer 30c1d9a
Updated to point to release 0.110.x
jpelzer 71f5166
Removed configuration.yaml-style field descriptions and added a line …
jpelzer b15a6e9
Space... The final frontier.
jpelzer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| --- | ||
| title: Neptune Apex | ||
| description: Instructions on how to integrate a Neptune Systems Apex aquarium controller within Home Assistant. | ||
| ha_category: | ||
| - Hub | ||
| - Sensor | ||
| - Light | ||
| ha_release: "0.110" | ||
| ha_iot_class: "Local Polling" | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@jpelzer' | ||
| ha_domain: neptune_apex | ||
| --- | ||
|
|
||
| The Neptune Apex integration provides connectivity to a Neptune Systems Apex Aqaucontroller. | ||
|
|
||
| There is currently support for the following device types within Home Assistant: | ||
|
|
||
| - [Sensor](#sensor) | ||
| - [Light](#light) | ||
|
|
||
| ## Configuration | ||
|
|
||
| Home Assistant offers Neptune Apex integration through **Configuration** -> **Integrations** -> **Neptune Apex**. Follow the instructions to get it set up. | ||
|
|
||
| In the popup: | ||
|
|
||
| - host: The domain name or IP address of the Apex, e.g., `192.168.1.1`. | ||
| - username: The username required to connect to the Apex. | ||
| - password: The password required to connect to the Apex. | ||
|
|
||
| ## Sensor | ||
|
|
||
| Once you have enabled the **Neptune Apex** component, your available Apex probes will automatically populate and be refreshed every 30 seconds. Apex probes can report data about temperature, pH, ORP, amperage, flow rate, water detection, and many others. Rather than create custom types for every possible data option, this integration reports the raw probe type as reported by the Apex as the sensor's `unit_of_measurement`. If the probe type is reported as 'Temp', the sensor's `device_class` will be set to 'temperature'. If the probe type is reported as 'Amps', the sensor's `device_class` will be set to 'power'. | ||
|
|
||
| ## Light | ||
|
jpelzer marked this conversation as resolved.
|
||
|
|
||
| After enabling the **Neptune Apex** component, your available Apex outlets will automatically populate and be refreshed every 30 seconds. Since the Apex technically has a total of five states for a switched outlet (On, Off, Automatic-unknown, Automatic-on, Automatic-off), along with any number of profiles for control of lighting, pumps, and other analog devices, this integration does a bit of shoehorning to make the Apex outlet fit into the Light device type. | ||
|
|
||
| We use the combination of `is_on` and `effect` properties to represent the outlet state. If the outlet is off, either due to Apex program state or manually, `is_on` will be false and `effect` will be hidden in the UI. The actual `effect` when the outlet is off will be `AOF` or `OFF`. We consider the outlet to be 'on' any time the outlet is not explicitly off, so manually on (`effect:ON`), automatically on (`effect:AON`) or any analog profile, regardless of the on-level that profile specifies. | ||
|
|
||
| If you use the UI toggle switch to turn an outlet on or off, any profile or Apex program (`AUTO`) will be disabled, and the outlet will manually set to whatever state you've chosen. To re-enable auto mode, set the `effect` property to `AUTO`. The UI hides the effect dropdown if the outlet is off, so you have the choice of turning the outlet on and then choosing the `AUTO` effect, or you can add an automation with an action type of `Call service` that will call `light.turn_on` with service data of `effect: AUTO`. In this case, the turn_on will be ignored and the outlet will be directly placed into `AUTO` mode. | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.