This repository has been archived by the owner on Feb 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
278 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -129,4 +129,7 @@ dmypy.json | |
| .pyre/ | ||
|
|
||
| #Pycharm | ||
| .idea/ | ||
| .idea/ | ||
|
|
||
| #release folder | ||
| release/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,8 @@ | ||
| { | ||
| "name": "Prosenic vacuum cleaner", | ||
| "render_readme": true, | ||
| "domains": [ "vacuum"], | ||
| "country": ["IT", "AT"], | ||
| "iot_class": "Local Polling" | ||
| "iot_class": "Local Polling", | ||
| "zip_release": true, | ||
| "filename": "prosenic.zip" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| [![License][license-shield]](LICENSE.md) ![Project Maintenance][maintenance-shield] | ||
|
|
||
| # Prosenic Home Assistant component | ||
| A full featured Homeassistant component to control Prosenic vacuum cleaner locally without the cloud. | ||
| This component is based on the underlying PyTuya library available [here](pytuya). | ||
|
|
||
| ## Component setup | ||
| Once the component has been installed, you need to configure it in order to make it work. | ||
| First we need to find out the _device_id_, _ip address_ and _local key_ of your prosenic vacuum cleaner. | ||
| Todo that you have multiple options: | ||
| * Use *mitmproxy* to intercept the connection between the prosenic app and the tuya cloud (Described below and I used this approach) | ||
| * Read the following [link](tuyaapi-docs) | ||
|
|
||
| ### Extracting the required data with mitmproxy. | ||
|
|
||
| 1. First we need to setup mitmproxy. The easiest way is to setup a docker container. Other installation type can be found [here](mitmproxy-install) | ||
| Below the docker-compose script, which will setup mitmproxy on port 8080 with the web interface on port 8081 | ||
| ```yaml | ||
| version: "3.3" | ||
| services: | ||
| mitmweb: | ||
| ports: | ||
| - "8080:8080" | ||
| - "127.0.0.1:8081:8081" | ||
| image: mitmproxy/mitmproxy | ||
| entrypoint: "mitmweb --web-iface 0.0.0.0" | ||
| ``` | ||
| 1. | ||
| * If you have an iPhone or iPad, use please one of these device as the setup is easier there. | ||
| Setup the proxy to point to your docker container. A tutorial can be found [here](ios-proxy). | ||
| Afterwards go to _mitm.it_ and install the certificate. The tutorial for this step can be found [here](mitmproxy-certs) | ||
| * If you have only a Android device, please refer to this tutorial [here](mitmproxy-android) | ||
| 1. Open the prosenic app and refresh all your devices | ||
| 1. On the computer, where your mitmproxy docker container is running, open the following link [http://localhost:8081](http://localhost:8081) | ||
| 1. There you should see some request to the tuya cloud. Depending on your region, you should see request to tuyaeu.com or similar. | ||
| Click on the first of these requests and a detail view will be open on the right hand sight. Go to the response and search for _localKey_ | ||
| You should get similar result as the follwoing: | ||
| ```json | ||
| ... | ||
| "result": [{ | ||
| "virtual": false, | ||
| "dpName": {}, | ||
| "lon": "0", | ||
| "uuid": "REMOVED_FOR_PRIVACY", | ||
| "mac": "REMOVED_FOR_PRIVACY", | ||
| "iconUrl": "https://images.tuyaeu.com/smart/product_icon/sd.png", | ||
| "lat": "0", | ||
| "runtimeEnv": "prod", | ||
| "devId": "YOUR_DEVICE_ID", | ||
| "productId": "REMOVED_FOR_PRIVACY", | ||
| "dps": { | ||
| ... | ||
| }, | ||
| "activeTime": 1580185647, | ||
| "ip": "REMOVED_FOR_PRIVACY", | ||
| "categoryCode": "wf_sd", | ||
| "moduleMap": { | ||
| ... | ||
| }, | ||
| "devAttribute": 3, | ||
| "name": "Cocosmart 820T", | ||
| "timezoneId": "Europe/Rome", | ||
| "category": "sd", | ||
| "localKey": "YOUR_LOCAL_KEY" | ||
| }] | ||
| ... | ||
| ``` | ||
| You will need the _localKey_ and the _devId_ (device id). | ||
|
|
||
| ### Find out the local ip address of your vacuum robot | ||
|
|
||
| There are multiple ways to find out the local ip address of your vacuum robot: | ||
| * Login into your router or dhcp server and check there for the assigned ip address | ||
| * Run nmap to find all devices in your network. | ||
| The Prosenic (Cocosmart) 820T has the open port 6668. | ||
| So we can search for devices, which have open this port with the following script. Please adjust the command, that nmap is searching your network. | ||
| ```shell script | ||
| nmap -p 6668 192.168.0.0/24 --open | ||
| ``` | ||
|
|
||
| ### Configuration via editing configuration.yaml | ||
|
|
||
| 1. Enable the component by editing the configuration.yaml file (within the config directory as well). | ||
| Edit it by adding the following lines: | ||
| ``` | ||
| vacuum: | ||
| - platform: prosenic | ||
| host: YOUR_IP | ||
| device_id: YOUR_DEVICE_ID | ||
| local_key: YOUR_KEY | ||
| ``` | ||
| **Note!** If you have already configured other vacuum robot, add your configuration there. | ||
|
|
||
| 1. Reboot hassio | ||
| 1. Congrats! You're all set! | ||
|
|
||
| ## Additional Information | ||
|
|
||
| Currently this integration is only tested with a Prosenic (Cocosmart) 820T, because I only have this one. | ||
| Please give me feedback, if it works with other models too. | ||
|
|
||
| The integration is communicating locally only, so you can block the access of your vacuum robot to the internet. | ||
|
|
||
| If you find a problem/bug or you have a feature request, please open an issue. | ||
|
|
||
|
|
||
| ## What's next? | ||
| - Better error handling | ||
| - Automated test | ||
|
|
||
| [hacs]: https://hacs.xyz | ||
| [hacsbadge]: https://img.shields.io/badge/HACS-CUSTOM-inactive?style=for-the-badge | ||
| [license-shield]: https://img.shields.io/github/license/edenhaus/ha-prosenic?style=for-the-badge | ||
| [maintenance-shield]: https://img.shields.io/badge/Maintainer-Robert%20Resch-blue?style=for-the-badge | ||
| [pytuya]: https://github.com/clach04/python-tuya | ||
| [tuyaapi-docs]: https://github.com/codetheweb/tuyapi/blob/master/docs/SETUP.md | ||
| [release-zip]: https://github.com/edenhaus/ha-prosenic/releases/latest/download/prosenic.zip | ||
|
|
||
| [mitmproxy-install]: https://docs.mitmproxy.org/stable/overview-installation/ | ||
| [mitmproxy-certs]: https://docs.mitmproxy.org/stable/concepts-certificates/ | ||
| [mitmproxy-android]: https://docs.mitmproxy.org/stable/howto-install-system-trusted-ca-android/ | ||
| [ios-proxy]: http://www.iphonehacks.com/2017/02/how-to-configure-use-proxy-iphone-ipad.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| #Script to cerate the release.zip | ||
|
|
||
| # Clean the dist directory | ||
| RELEASE=release | ||
|
|
||
| rm -vR $RELEASE | ||
| mkdir $RELEASE | ||
|
|
||
| # zip the prosenic sources | ||
| zip -r $RELEASE/prosenic.zip custom_components/prosenic |