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.

Sign up for GitHub

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

chore(core): correct grammar to make README more easily readable #724

Merged
merged 1 commit into from
Mar 25, 2024
Merged

chore(core): correct grammar to make README more easily readable #724

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a custom integration to control Tapo devices from home assistant.

The core of the integration is provied by [plugp100](https://github.com/petretiandrea/plugp100) python library based on work of [@K4CZP3R](https://github.com/K4CZP3R/tapo-p100-python).
The core of the integration is provided by [plugp100](https://github.com/petretiandrea/plugp100) python library based on the work of [@K4CZP3R](https://github.com/K4CZP3R/tapo-p100-python).

<!-- [![GitHub Release][releases-shield]][releases] -->
<!--- [![GitHub Activity][commits-shield]][commits] -->
Expand Down Expand Up @@ -31,15 +31,15 @@ Please help me to complete the [new roadmap](https://github.com/petretiandrea/ho

### Tapo protocol

Tapo is updating its devices with a new firmware which use a new protocol called KLAP. This integration support it's but if you running older version your devices maybe cannot works. So please keep this integration up to date by using HACS!
Tapo is updating its devices with a new firmware which use a new protocol called KLAP. This integration supports it but if you run an older version your devices may not work. Please keep this integration up to date by using HACS!

### Local Integration

Although the integration works using LAN, the tapo device needs internet access to synchronize with tapo cloud, especially for credentials, a missing internet access could lead into "Invalida authentication error". Also a static IP must be set for device.
Although the integration works using LAN, the tapo device needs internet access to synchronize with tapo cloud, especially for credentials, a missing internet access could lead into "Invalid authentication error". A static IP must be set for device.

### Authentication

For some unknown reason email with capital letter thrown an "Invalid authentication" error. So before open an new issue check your email address on Tapo App Settings. If contains capital letter, the integration won't work. I've opened an issue that explain this [#122](https://github.com/petretiandrea/home-assistant-tapo-p100/issues/122), I will fix asap. As workaround you can create a new account using all lower-case in your email address.
For some unknown reason email with capital letters throw an "Invalid authentication" error. Before opening a new issue check your email address on Tapo App Settings. If your email contains capital letters, the integration won't work. I've opened an issue that explains this [#122](https://github.com/petretiandrea/home-assistant-tapo-p100/issues/122), I will fix asap. As a workaround you can create a new account using all lower-case in your email address.

## Features

Expand All @@ -49,11 +49,11 @@ The integration now supports native tapo discovery! To enable it you must add at

```yaml
tapo:
discovery: true # you can omit "discovery" by default, with "tapo:" it will enable discovery automatically.
discovery: true # you can omit "discovery" by default, using "tapo:" will enable discovery automatically.
```

This will enable tapo device discovery. Not all tapo devices supports tapo discovery, so if you not find it, try adding manually.
Also tapo integration discovery filters out not supported devices!
This will enable tapo device discovery. Not all tapo devices support tapo discovery, so if you can't find a device, try adding it manually.
Tapo integration discovery filters out unsupported devices!

<details>
<summary>Screenshot</summary>
Expand All @@ -71,10 +71,10 @@ tapo:

#### Device IP Tracking

By using DHCP home assistant discovery the feature of mac tracking is now disabled, cause HA can track it automatically now.
Please be sure to have DHCP discovery not disabled on your `configuration.yaml` (by default is active).
When using DHCP home assistant discovery the feature of mac address tracking is now disabled, as HA now automatically tracks mac addresses now.
Please be sure to have DHCP discovery enabled on your `configuration.yaml` (enabled by default).

[BREAKING] Tracking mac address feature is now disabled cause not recommended by HA. The tracking is now performed by HA itself.
[BREAKING] Tracking mac address feature is now disabled as it is not recommended by HA. Tracking is now performed by HA itself.

### Supported devices

Expand All @@ -100,14 +100,14 @@ Please be sure to have DHCP discovery not disabled on your `configuration.yaml`

### Additional features

- [x] manually change ip address. Now you can change the ip address of a tapo device wihtout removing and re-adding it.
- [x] manually change ip address. Now you can change the ip address of a tapo device without removing and re-adding it.

# How to install

This integration is part of HACS store, so you don't need anymore to add this repository as a custom repository.
This integration is part of HACS store, so you don't need to add this repository as a custom repository any more.
You can find it directly on HACS Store: search for `tapo` and you will find `Tapo Controller`. (**HACS >= 1.6.0 is required**)

This video show installation steps:
This video shows installation steps:

[![Install Steps](http://img.youtube.com/vi/KSYldphgE5A/0.jpg)](https://youtu.be/KSYldphgE5A)

Expand All @@ -119,20 +119,20 @@ This video show installation steps:
2. Go to integrations menu
3. Search for `Tapo` integration
4. Insert host (ip address), username and password for control your tapo device (the same used for tapo app).
If you have a problem in this phase, like "invalid auth" error, please see [#122](https://github.com/petretiandrea/home-assistant-tapo-p100/issues/122), and if error persist write a comment in the same issue
5. Wait for connection. It automatically recognize if the tapo device is switch or light or something else :)
If you have a problem in this phase, like "invalid auth" error, please see [#122](https://github.com/petretiandrea/home-assistant-tapo-p100/issues/122), and if error persists write a comment in the same issue
5. Wait for connection. The integration will automatically recognize if the tapo device is a switch or light or something else :)
<!---->

## Configuration by configuration.yaml

[BREAKING]

The latest version of this integration remove configuration.yaml device configuration support. This
is due to follow home assistant best practices https://developers.home-assistant.io/docs/configuration_yaml_index/ and https://github.com/home-assistant/architecture/blob/master/adr/0010-integration-configuration.md#decision
The latest version of this integration removes configuration.yaml device configuration support. This
is to follow home assistant best practices https://developers.home-assistant.io/docs/configuration_yaml_index/ and https://github.com/home-assistant/architecture/blob/master/adr/0010-integration-configuration.md#decision

## Beta versions

To access to beta version, you must install it as custom
To access to the beta version, you must install it as a custom repository

1. Install from HACS, add this repository as custom repository
2. Search into HACS store the tapo integration and install
Expand Down
Loading