esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

Add mitsubishi_itp Component

Open Sammy1Am opened this issue 1 year ago • 6 comments

Description:

Adding docs for the mitsubishi_itp component. Docs are focused on ESPHome use and configuration, and link to a GitHub Pages site for details on hardware installation and compatible devices (as that information is more likely to change frequently).

**Pull request in esphome with YAML changes (if applicable): esphome/esphome#7289

Checklist:

  • [x] I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • [ ] I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • [x] Link added in /index.rst when creating new documents for new components or cookbook.

Sammy1Am avatar May 22 '24 18:05 Sammy1Am

Deploy Preview for esphome ready!

Name Link
Latest commit 2ace1f115cffa324d2e54c4a59eb51f3554f350d
Latest deploy log https://app.netlify.com/sites/esphome/deploys/66ba76d5cac2ba0008bafb76
Deploy Preview https://deploy-preview-3860--esphome.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 22 '24 18:05 netlify[bot]

The parts of the documentation referring to selects and sensors needs some clarification, and formatting according to ESPHome docs.

If I understand well (not sure, please clarify!) it should be something like:

- **selects** (*Optional*): Custom configuration for any of the ``select`` components used by this device:
  - **temperature_source_select**: Choice of the temperature source:
      - All generic options from :ref:`Select <config-select>`.
  - **vane_position_select**: ???
      - All generic options from :ref:`Select <config-select>`.
  - **horizontal_vane_position_select**: ???
      - All generic options from :ref:`Select <config-select>`.
- **sensors** (*Optional*): Custom configuration for any of the sensors provided by this device. These sensors are disabled by default in Home Assistant but can be enabled if desired:
  - **thermostat_temperature**: If a thermostat is connected, reports the last temperature received from the thermostat:
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **compressor_frequency**: Frequency in Hz reported by a variable speed compressor. (Not supported on all types):
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **outdoor_temperature**: Temperature reported by outdoor unit (On supported equipment, may be overloaded on some models):
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **actual_fan**: The actual speed the fan is running at (may differ from set-speed once set-point has been reached or during preheating):
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **service_filter**: Reports if filter needs to be replaced:
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **defrost**: Reports if system is in defrost:
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **preheat**: Reports if system is preheating:
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **standby**: Reports if system is in standby:
      - All generic options from :ref:`Sensor <config-sensor>`.
  - **error_code**: Reports error codes (if any):
      - All generic options from :ref:`Sensor <config-sensor>`.

nagyrobi avatar Jul 22 '24 14:07 nagyrobi

Thank you for that suggestion, what you have provided is much clearer than what I had initially-- I'll get this implemented the next chance I get.

Sammy1Am avatar Jul 22 '24 21:07 Sammy1Am

I can give you a hand if you enable "Allow edits by maintainers" option on the PR.

nagyrobi avatar Jul 24 '24 07:07 nagyrobi

Thank you again for your help, @nagyrobi . The feedback on the main PR changed the config structure significantly; notably the sensors, etc. are now in the sensor section of the configuration and so should be a little more familiar. Would appreciate your feedback on the updated preview if you have a moment.

Sammy1Am avatar Aug 12 '24 18:08 Sammy1Am

**Pull request in esphome with YAML changes (if applicable): esphome/esphome#6794

Wrong parent PR!

nagyrobi avatar Oct 05 '24 20:10 nagyrobi