From 595dfc24ca49e14a2c7cf20d3c57ed2da04ffe3f Mon Sep 17 00:00:00 2001 From: "Mr. Bubbles" Date: Thu, 8 Aug 2024 16:27:57 +0200 Subject: [PATCH] Improve documentation for IronOS integration (#34094) * Clarification for raw tip voltage sensor, add ha category * add comma --- source/_integrations/iron_os.markdown | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/_integrations/iron_os.markdown b/source/_integrations/iron_os.markdown index 3f3591357e4..bdd7fa27a55 100644 --- a/source/_integrations/iron_os.markdown +++ b/source/_integrations/iron_os.markdown @@ -2,6 +2,7 @@ title: IronOS description: Instructions on how to integrate IronOS-based Pinecil V2 devices with Home Assistant. ha_category: + - Number - Sensor ha_iot_class: Local Polling ha_release: 2024.8 @@ -17,6 +18,10 @@ ha_platforms: The **IronOS** {% term integration %} seamlessly connects Home Assistant with PINE64's Pinecil V2 soldering irons, allowing for remote monitoring and control. This integration provides real-time updates on temperature, power, and various other settings and diagnostic information. +## Minimum requirements + +- **Pinecil V2** requires IronOS v2.21 or higher to connect to Home Assistant. Please refer to the [Pinecil Wiki](https://wiki.pine64.org/wiki/Pinecil_Firmware#Overview) for update instructions. + {% include integrations/config_flow.md %} ## Number controls @@ -34,7 +39,7 @@ The **IronOS** {% term integration %} seamlessly connects Home Assistant with PI - **Max tip temperature:** Indicates the maximum temperature that the currently inserted soldering iron tip supports. - **Power level:** Displays the duty cycle of the pulse-width modulation (PWM) in percent, indicating the current power output of the soldering iron (for example, "50%" for a 50% duty cycle). - **Power source:** Identifies the current power source used by the soldering iron, such as DC input, USB Quick Charge, USB Power Delivery, or USB Power Delivery VBUS. -- **Raw tip voltage:** Measures the raw voltage at the soldering iron tip. +- **Raw tip voltage:** Measures the raw voltage at the soldering iron's thermocouple, which is then offset compensated and converted to the tip temperature. - **Tip resistance:** Indicates the resistance of the currently inserted soldering iron tip (for example, "6.2 Ω" for short tips, "8 Ω" for normal tips) - **Uptime:** Tracks the total operating time of the soldering iron since its last power-on. - **Hall effect strength:** (Optional) This feature requires the device to be [modified with a hall effect sensor](https://wiki.pine64.org/wiki/Pinecil_Hall_Effect_Sensor). If a neodymium magnet is attached to the stand, it enables proximity detection and can be utilized to calibrate when the iron enters sleep mode based on its proximity to the stand.