Skip to content

Improve installation instructions #86

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

Merged
rytilahti merged 2 commits into from
Jul 12, 2020
Merged

Improve installation instructions #86

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
435037e
Improve installation instructions
rytilahti Jul 6, 2020
5d1ff8b
Remove 'see below for devenv instructions'
rytilahti Jul 6, 2020
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
75 changes: 46 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,40 +7,23 @@
python-kasa is a Python library to control TPLink smart home devices (plugs, wall switches, power strips, and bulbs) using asyncio.
This project is a maintainer-made fork of [pyHS100](https://github.com/GadgetReactor/pyHS100) project.

## Getting started

**Supported devices**

* Plugs
* HS100
* HS103
* HS105
* HS107
* HS110
* Power Strips
* HS300
* KP303
* Wall switches
* HS200
* HS210
* HS220
* Bulbs
* LB100
* LB110
* LB120
* LB130
* LB230
* KL60
* KL110
* KL120
* KL130

**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests! See below for instructions for setting up a development environment.**

You can install the most recent release using pip. Until
```
pip install python-kasa --pre
```

Alternatively, you can clone this repository and use poetry to install the development version:
```
git clone https://github.com/python-kasa/python-kasa.git
cd python-kasa/
poetry install
```

## Discovering devices

The devices can be discovered either by using `kasa discover` or by calling `kasa` without any parameters.
After installation, the devices can be discovered either by using `kasa discover` or by calling `kasa` without any parameters.

```
$ kasa
Expand All @@ -61,6 +44,8 @@ Location: {'latitude': XXXX, 'longitude': XXXX}
Current state: {'total': 133.082, 'power': 100.418681, 'current': 0.510967, 'voltage': 225.600477}
```

Use `kasa --help` to get list of all available commands.

## Basic controls

All devices support a variety of common commands, including:
Expand Down Expand Up @@ -111,3 +96,35 @@ pre-commit install
We use several tools to automatically check all contributions, which are run automatically when you commit your code.

If you want to manually execute the checks, you can run `tox -e lint` to do the linting checks or `tox` to also execute the tests.

## Supported devices

### Plugs

* HS100
* HS103
* HS105
* HS107
* HS110

### Power Strips
* HS300
* KP303

### Wall switches
* HS200
* HS210
* HS220

### Bulbs
* LB100
* LB110
* LB120
* LB130
* LB230
* KL60
* KL110
* KL120
* KL130

**Contributions (be it adding missing features, fixing bugs or improving documentation) are more than welcome, feel free to submit pull requests!**