Provide detailed functionality description for APCUPSD #38876
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the APC UPS Daemon integration was rewritten and expanded. The update replaces a brief list of binary sensors and sensors with a detailed section that enumerates all entities provided by the integration, categorizing them as binary sensors and sensors. Each entity now includes a description, availability details specifying supported UPS models, and additional remarks where relevant. The documentation now serves as a comprehensive reference for users, outlining all supported entities and their characteristics. Changes
Sequence Diagram(s)No sequence diagram generated as the changes are documentation-only. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/apcupsd.markdown (1)
59-64: Verify binary sensor coverage and naming
Only Online Status is listed here. Ensure that this matches the actualbinary_sensor.apcupsd_online_statusentity key generated by the integration. Consider whether additional binary states (for example, UPS on-battery vs. on-line) should be exposed or documented to cover common use cases.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/apcupsd.markdown(1 hunks)
🔇 Additional comments (2)
source/_integrations/apcupsd.markdown (2)
53-56: Consistent section headings and overview
The new "Supported functionality" and "Entities" headings align with Home Assistant documentation conventions. The introductory line clearly explains the scope of the section.
65-71: Review Sensors heading and note formatting
The "Sensors" subheading and{% note %}block are clear and helpful. Please verify that the note renders correctly in the site build and that the path for enabling advanced sensors ("Settings → Devices & Services → Entities → Advanced settings") remains accurate in the latest UI.
| - **Description**: The date and time of last transfer off battery since apcupsd startup. | ||
| - **Available for machines**: Smart-UPS | ||
|
|
||
| - **Ambient Humidity** | ||
| - **Description**: The humidity as measured by the UPS. | ||
| - **Available for machines**: Smart-UPS with optional accessories (e.g., temperature/humidity sensors or SNMP network cards). | ||
|
|
||
| - **Ambient Temperature** | ||
| - **Description**: The ambient temperature as measured by the UPS. | ||
| - **Available for machines**: Smart-UPS with optional accessories (e.g., temperature/humidity sensors or SNMP network cards). | ||
|
|
||
| - **Status Data** | ||
| - **Description**: Header record indicating the STATUS format revision level, the number of records that follow the APC statement, and the number of bytes that follow the record. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Model** | ||
| - **Description**: The old APC model identification code. | ||
| - **Available for machines**: Smart-UPS | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Cable Type** | ||
| - **Description**: The cable as specified in the configuration file (UPSCABLE). | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Status Date** | ||
| - **Description**: The date and time that the information was last obtained from the UPS. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Driver** | ||
| - **Description**: The driver used to communicate with the UPS. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Firmware Version** | ||
| - **Description**: The firmware revision number as reported by the UPS. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Hostname** | ||
| - **Description**: The name of the machine that collected the UPS data. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Last Transfer** | ||
| - **Description**: The reason for the last transfer to batteries. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Manufacture Date** | ||
| - **Description**: The date the UPS was manufactured. | ||
| - **Available for machines**: Smart-UPS | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Model** | ||
| - **Description**: The UPS model as derived from information from the UPS. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Register 1 Fault** | ||
| - **Description**: The value from the UPS fault register 1. | ||
| - **Available for machines**: Smart-UPS | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Register 2 Fault** | ||
| - **Description**: The value from the UPS fault register 2. | ||
| - **Available for machines**: Smart-UPS | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Register 3 Fault** | ||
| - **Description**: The value from the UPS fault register 3. | ||
| - **Available for machines**: Smart-UPS | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Sensitivity** | ||
| - **Description**: The sensitivity level of the UPS to line voltage fluctuations. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Serial Number** | ||
| - **Description**: The UPS serial number. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Status Flag** | ||
| - **Description**: Status flag. English version is given by STATUS. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Name** | ||
| - **Description**: The name of the UPS as stored in the EEPROM or in the UPSNAME directive in the configuration file. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. | ||
|
|
||
| - **Daemon Info** | ||
| - **Description**: The apcupsd release number, build date, and platform. | ||
| - **Available for machines**: all | ||
| - **Remarks**: Disabled by default for advanced uses. |
There was a problem hiding this comment.
Resolve duplicate sensor names and improve grouping
The sensors list includes two entries named Transfer from Battery (lines 174–177 & 263–266) and two named Model (lines 280–283 & 320–323). Duplicate names will confuse users and may not map to unique entity IDs. Please rename or qualify these entries (e.g., "Last Transfer from Battery" vs. "Transfer from Battery (Smart-UPS)", "UPS Model" vs. "Legacy Model") and consider grouping sensors under subheadings by machine type (all, Back-UPS Pro, Smart-UPS) to reduce repetition and improve readability.
Proposed change
This PR provides a detailed functionality description for all sensors of the APC UPS Daemon integration. The information is obtained from the following sources:
I try my best to provide accurate information. However, the "available for machines" information cannot be easily obtained.
So I had to do some simple inference:
If there are user reports for inaccuracies in the future we can further improve it.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit