-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Add SensorPush Cloud integration #36600
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
Add SensorPush Cloud integration #36600
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughA new documentation file for the SensorPush Cloud integration has been added to the Home Assistant documentation repository. The CODEOWNERS file was updated to assign Changes
Sequence DiagramsequenceDiagram
participant User
participant SensorPush App
participant Gateway Cloud Dashboard
participant Home Assistant
User->>SensorPush App: Activate devices
User->>Gateway Cloud Dashboard: Enable API access
User->>Home Assistant: Configure SensorPush Cloud integration
Home Assistant->>SensorPush App: Authenticate and fetch device data
SensorPush App-->>Home Assistant: Return sensor measurements
Home Assistant->>User: Display environmental sensor data
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/sensorpush_cloud.markdown (2)
38-48: Add units of measurement and state class information to the sensors table.To improve clarity, consider adding:
- Units of measurement for each sensor (e.g., °C/°F for temperature, % for humidity)
- State class information to indicate which sensors support graphing
| Sensor | Description | | :------------------- | :------------------------------------------------------------ | -| altitude | Measures the altitude. (disabled by default) | -| atmospheric_pressure | Measures the barometric pressure. (disabled by default) | -| battery_voltage | Measures the battery voltage. (disabled by default) | -| dewpoint | Measures the dew point. (disabled by default) | -| humidity | Measures the relative humidity. | -| signal_strength | Measures the Bluetooth signal strength. (disabled by default) | -| temperature | Measures the temperature. | -| vapor_pressure | Measures the vapor-pressure deficit. (disabled by default) | +| altitude | Measures the altitude in meters. (disabled by default, measurement) | +| atmospheric_pressure | Measures the barometric pressure in hPa. (disabled by default, measurement) | +| battery_voltage | Measures the battery voltage in volts. (disabled by default, measurement) | +| dewpoint | Measures the dew point in °C/°F. (disabled by default, measurement) | +| humidity | Measures the relative humidity in %. (measurement) | +| signal_strength | Measures the Bluetooth signal strength in dBm. (disabled by default, measurement) | +| temperature | Measures the temperature in °C/°F. (measurement) | +| vapor_pressure | Measures the vapor-pressure deficit in kPa. (disabled by default, measurement) |
17-17: Add brand assets reference.Since there's an associated PR in the Brands repository, consider adding a note about the brand assets being available in Home Assistant.
Integrates [SensorPush Cloud](https://www.sensorpush.com/) devices into Home Assistant. + +{% details "Brand assets are available in Home Assistant" %} +The SensorPush logo and icon are registered trademarks of Cousins and Sears LLC and are used with permission. +{% enddetails %}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CODEOWNERS(1 hunks)source/_integrations/sensorpush_cloud.markdown(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- CODEOWNERS
🔇 Additional comments (3)
source/_integrations/sensorpush_cloud.markdown (3)
1-15: LGTM! Metadata is complete and accurate.The frontmatter contains all required fields and follows Home Assistant's documentation standards.
25-31: LGTM! Device support section is well-documented.The supported devices section clearly lists all compatible hardware with proper links to product pages.
49-55: LGTM! Notes and removal instructions are clear.The device limitation note and removal instructions are properly documented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/sensorpush_cloud.markdown (3)
23-23: Clarify the device activation flow.Consider clarifying the activation sequence to help users understand which app to use first.
-Sensor entities (temperature, humidity, barometric pressure) will not be available to Home Assistant until you have activated the device with the SensorPush app on iOS or Android. +Before adding the device to Home Assistant, you must first activate it using the SensorPush mobile app (available on iOS or Android). This step is required for sensor entities (temperature, humidity, barometric pressure) to be available.
50-50: Fix preposition usage.For better readability:
-`atmospheric_pressure` is not available in HT1 and HT.w series devices. +`atmospheric_pressure` is not available on HT1 and HT.w series devices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...atmospheric_pressureis not available in HT1 and HT.w series devices. ## Removi...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
37-46: Consider enhancing the sensors table with device compatibility.The table could be more helpful by indicating which sensors are available for each device model. This would help users understand the capabilities of their specific device.
Example format:
| Sensor | Description | HT1 | HT.w | HTP.xw | | :--- | :--- | :---: | :---: | :---: | | `altitude` | Measures the altitude. (disabled by default) | ✓ | ✓ | ✓ | ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CODEOWNERS(1 hunks)source/_integrations/sensorpush_cloud.markdown(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- CODEOWNERS
🧰 Additional context used
🪛 LanguageTool
source/_integrations/sensorpush_cloud.markdown
[uncategorized] ~50-~50: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...atmospheric_pressure is not available in HT1 and HT.w series devices. ## Removi...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/sensorpush_cloud.markdown (3)
6-6: Verify the release version.The release version is set to
2025.2. Please confirm if this is the intended version or if it should be adjusted to an earlier version.
27-29: LGTM!The supported devices section is well-structured with clear links to each product.
54-56: LGTM!The removal instructions are clear and follow the standard documentation format.
Proposed change
This PR adds cloud integration for SensorPush devices. It communicates with the publicly available Cloud API using the sensorpush-api and sensorpush-ha Python packages. Care was taken to ensure that presented devices appeared the same as those created by the existing SensorPush integration. A G1 WiFi Gateway is required to make use of the Cloud API.
Note
This PR is a re-submission of home-assistant/core#121890, which fixes several issues reported by reviewers. I would like to send a heartfelt apology to @joostlek, @edenhaus, and @frenck - I was caught between dueling schedules and I wasn't able to do the work needed to get it over the finish line. I was finally able to put in the time over the holiday break to make requested changes in addition to improved unit tests, strict typing, async dependencies, and websession injection (whew!)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation