docs: apply platformio profile baseline

[fjoelnr]

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

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 enhances the HiveTech project by applying the platformio-iot ANR profile and adding comprehensive documentation covering hardware setup, operational procedures, topic contracts, and verification steps. The changes aim to provide a clearer understanding of the project's context and improve collaboration while maintaining separation of local developer settings.

Highlights

• PlatformIO IoT Profile: Applied the platformio-iot ANR profile to HiveTech, focusing on build configuration, hardware validation, device configuration, and telemetry.
• Documentation: Added hardware, operations, topic-contract, and verification documentation based on the current firmware.
• Local Upload Target: Ensured the local upload target in platformio.ini remains out of the commit.

🧠 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. ↩

[gemini-code-assist]

Code Review

This pull request is a great step forward in improving the project's documentation and developer experience. It applies a platformio-iot profile and adds comprehensive documentation for hardware, operations, MQTT topic contracts, and verification. The new documents are well-structured and accurately reflect the firmware's current state. My review includes one suggestion to enhance the clarity of the topic contracts by explicitly stating the measurement units.

[gemini-code-assist]

The documentation for the MQTT topics is very helpful. To make the contract even clearer and more precise, I suggest explicitly stating the units for humidity, pressure, and altitude.

• For HT_BME280_Humidity, the unit is percent relative humidity (%RH).
• For HT_BME280_Pressure, the value is pressure in Pascals divided by 100, which results in hectopascals (hPa).
• For HT_BME280_Altitude, the readFloatAltitudeMeters() function name in the source code indicates the unit is meters.

Suggested change

	- `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_Humidity`
	Payload: numeric value as text
	Meaning: relative humidity from the BME280 in percent (%RH)
	- `HT_BME280_Pressure`
	Payload: numeric value as text
	Meaning: barometric pressure from the BME280 in hectopascals (hPa)
	- `HT_BME280_Altitude`
	Payload: numeric value as text
	Meaning: altitude in meters, as reported by the BME280 library