Skip to content
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 mitsubishi_itp Component #3860

Open
wants to merge 15 commits into
base: next
Choose a base branch
from
Open

Add mitsubishi_itp Component #3860

wants to merge 15 commits into from

Conversation

Sammy1Am
Copy link

@Sammy1Am Sammy1Am commented May 22, 2024

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:

  • 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.

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

@probot-esphome probot-esphome bot added the next label May 22, 2024
Copy link

netlify bot commented May 22, 2024

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 2ace1f1
🔍 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.

@Sammy1Am Sammy1Am changed the title Add mitsubishi_uart Component Add mitsubishi_itp Component Jun 15, 2024
@nagyrobi
Copy link
Member

nagyrobi commented Jul 22, 2024

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>`.

@Sammy1Am
Copy link
Author

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.

@nagyrobi
Copy link
Member

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

@Sammy1Am
Copy link
Author

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.

Thanks, @ignisf

Co-authored-by: ignisf <ignisf@users.noreply.github.com>
@nagyrobi
Copy link
Member

nagyrobi commented Oct 5, 2024

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

Wrong parent PR!

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

Successfully merging this pull request may close these issues.

3 participants