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

added remote.xiaomi_miio component #4513

Merged
merged 5 commits into from
Feb 8, 2018

Conversation

cnrd
Copy link
Contributor

@cnrd cnrd commented Jan 25, 2018

Description:

Added component remote.xiaomi_miio.

Pull request in home-assistant (if applicable): home-assistant/core#11891

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@fabaff fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Jan 25, 2018
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

@cnrd Thank you for this PR. I've reviewed it and left some comments. Could you please take a look? 👍

- **token** (*Required*): The API token of your remote.
- **name** (*Optional*): The name of your remote.
- **slot** (*Optional*): The slot used to save learned command. (Default: 1)
- **timeout** (*Optional*): Timeout for learning new command. (Default: 10)
Copy link
Member

Choose a reason for hiding this comment

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

  • learning new command -> learning a new command

- **timeout** (*Optional*): Timeout for learning new command. (Default: 10)
- **hidden** (*Optional*): Hide the entity from UI. There is currently no reason to show the entity in UI as turning it off or on does nothing. (Default: True)
- **commands** (*Optional*): Commands callable by name.
- **identifier** (*Required*): Name of the command switch as slug. Multiple entries are possible.
Copy link
Member

Choose a reason for hiding this comment

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

  • switch as slug -> switch as a slug


### {% linkable_title `remote.send_command` %}

Allows to send either named commands using identifer or sending commands as base64 encoded strings.
Copy link
Member

Choose a reason for hiding this comment

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

  • to send -> sending
  • identifer -> identifier


`slot` and `timeout` can be specified, but multiple commands learned to the same slot can still be sent using [`remote.send_command`](/components/remote.xiaomi_miio/#remote.send_command) even if they are overwritten.

After learning the command the base64 string can be found as a notification in Overview, the string can be copied by left clicking on the string and choosing the copy option.
Copy link
Member

Choose a reason for hiding this comment

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

  • choosing -> choose

- base64 encoded string learned from remote
```

Configuration variables:
Copy link
Member

Choose a reason for hiding this comment

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

Please use the configuration tags, for more information please see:
https://home-assistant.io/developers/documentation/create_page/#configuration

@frenck frenck self-assigned this Jan 27, 2018
frenck
frenck previously approved these changes Jan 28, 2018
@frenck frenck removed their assignment Jan 28, 2018
@frenck
Copy link
Member

frenck commented Jan 28, 2018

Thank you @cnrd, approved the PR.
Can be merged as soon as the parent PR get merged.

@frenck frenck self-assigned this Feb 8, 2018
@frenck
Copy link
Member

frenck commented Feb 8, 2018

Thanks, @cnrd! Looks fine!

Did some minor edits. Can be merged as soon as the build passes.

@arsaboo arsaboo merged commit 809034c into home-assistant:next Feb 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants