Skip to content

promote: platformio profile baseline to main#5

Merged
fjoelnr merged 3 commits intomainfrom
develop
Mar 22, 2026
Merged

promote: platformio profile baseline to main#5
fjoelnr merged 3 commits intomainfrom
develop

Conversation

@fjoelnr
Copy link
Copy Markdown
Owner

@fjoelnr fjoelnr commented Mar 22, 2026

Summary

  • apply the platformio-iot ANR profile to HiveTech
  • add hardware, operations, topic-contract, and verification docs based on the current firmware
  • keep the local upload target in platformio.ini out of the commit

Verification

  • python -m anr.cli init C:\work\projects\github\HiveTech --profile platformio-iot
  • platformio build not run here because platformio is not installed in this environment

fjoelnr and others added 3 commits March 20, 2026 17:06
@fjoelnr fjoelnr requested a review from ha-llm-bot as a code owner March 22, 2026 10:42
Copy link
Copy Markdown
Collaborator

@ha-llm-bot ha-llm-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed for develop to main promotion.

Copy link
Copy Markdown
Collaborator

@ha-llm-bot ha-llm-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed for develop to main promotion.

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's clarity and maintainability by integrating the platformio-iot ANR profile and introducing a suite of detailed documentation. These changes provide a standardized framework for understanding the firmware's hardware dependencies, operational procedures, communication protocols, and testing methodologies, making it easier for developers to onboard and contribute effectively.

Highlights

  • ANR Profile Integration: The platformio-iot ANR profile has been applied to the HiveTech project, standardizing its development context and defining focus areas, recommended documentation, skills, and guardrails.
  • Comprehensive Documentation Added: New documentation files have been introduced covering critical aspects such as hardware specifications, operational procedures, MQTT topic contracts, and firmware verification processes.
  • Repository Context Indexing: ANR configuration files (.agents/context-index.md, anr.yaml) were added to define the repository's structure and context for automated reporting and analysis.
  • Updated Project Overview: Existing project documentation, including README.md, AGENTS.md, and docs/STATUS.md, has been updated to reflect the new ANR profile, link to the new documentation, and refine project next steps and known gaps.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@fjoelnr fjoelnr merged commit 0ab1196 into main Mar 22, 2026
2 checks passed
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a significant amount of documentation and project structure by applying the platformio-iot ANR profile. New documentation files for hardware, operations, topic contracts, and verification have been added, and existing documentation has been updated to reflect these changes. This greatly improves the project's clarity and maintainability. My review focuses on improving the precision of the newly added MQTT topic contract documentation.

Comment thread docs/topic-contracts.md
Comment on lines +9 to +20
- `HT_BME280_Temperature`
Payload: numeric value as text
Meaning: ambient temperature from the BME280 in degrees Celsius
- `HT_BME280_Humidity`
Payload: numeric value as text
Meaning: relative humidity from the BME280
- `HT_BME280_Pressure`
Payload: numeric value as text
Meaning: barometric pressure from the BME280 divided by `100`
- `HT_BME280_Altitude`
Payload: numeric value as text
Meaning: altitude reported by the BME280 library
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description of the topics can be made more precise for clarity, especially since this is an API contract. I suggest specifying that the payload is a string representation of a float and explicitly stating the units for all measurements.

For example:

  • For humidity, the unit is percent (%).
  • For pressure, stating the unit as hectopascals (hPa) is clearer than describing the calculation.
  • For altitude, the unit is meters (m).
Suggested change
- `HT_BME280_Temperature`
Payload: numeric value as text
Meaning: ambient temperature from the BME280 in degrees Celsius
- `HT_BME280_Humidity`
Payload: numeric value as text
Meaning: relative humidity from the BME280
- `HT_BME280_Pressure`
Payload: numeric value as text
Meaning: barometric pressure from the BME280 divided by `100`
- `HT_BME280_Altitude`
Payload: numeric value as text
Meaning: altitude reported by the BME280 library
- `HT_BME280_Temperature`
Payload: string representation of a float
Meaning: ambient temperature from the BME280 in degrees Celsius
- `HT_BME280_Humidity`
Payload: string representation of a float
Meaning: relative humidity from the BME280 in percent (%)
- `HT_BME280_Pressure`
Payload: string representation of a float
Meaning: barometric pressure from the BME280 in hectopascals (hPa)
- `HT_BME280_Altitude`
Payload: string representation of a float
Meaning: altitude reported by the BME280 library in meters (m)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants