Skip to content

Commit 6577d70

Browse files
rospogrigiorospogrigio
committed
Published README.md and info.md
1 parent 30c00fe commit 6577d70

File tree

3 files changed

+158
-0
lines changed

3 files changed

+158
-0
lines changed

‎README.md

+35
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# daikin_residential
22
Cloud control of Daikin devices that are supported by Daikin Residential Controller app.
3+
4+
# Installation:
5+
6+
Copy the daikin_residential folder and all of its contents into your Home Assistant's custom_components folder. This is often located inside of your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. It is possible that your custom_components folder does not exist. If that is the case, create the folder in the proper location, and then copy the daikin_residential folder and all of its contents inside the newly created custom_components folder.
7+
8+
Alternatively, you can install daikin_residential through HACS by adding this repository.
9+
10+
# Usage:
11+
12+
**NOTE: You must have your Daikin Cloud token set stored as a tokenset.json file in your /config folder (the same where configuration.yaml is). For instructions on how to retrieve this file, follow the guide at https://github.com/Apollon77/daikin-controller-cloud/blob/main/PROXY.md .**
13+
14+
The integration can be configured in two ways:
15+
16+
# 1. YAML config files
17+
18+
Just add the following line to your configuration.yaml file, and the Daikin devices connected to your cloud account will be created.
19+
20+
```
21+
daikin_residential:
22+
```
23+
24+
25+
# 2. Using config flow
26+
27+
Start by going to Configuration - Integration and pressing the "+" button to create a new Integration, then select Daikin Residential Controller in the drop-down menu.
28+
29+
30+
# To-do list:
31+
32+
* Fix spurious glitches.
33+
* Maybe improve the sensors for Energy consumption.
34+
35+
# Thanks to:
36+
37+
This code is based on @Apollon77 's great work, in finding a way to retrieve the token set, and to send the HTTP commands over the cloud. This integration would not exist without his precious job.

‎info.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[![](https://img.shields.io/github/release/rospogrigio/daikin_residential/all.svg?style=for-the-badge)](https://github.com/rospogrigio/daikin_residential/releases)
2+
[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/custom-components/hacs)
3+
[![](https://img.shields.io/badge/MAINTAINER-%40rospogrigio-green?style=for-the-badge)](https://github.com/rospogrigio)
4+
5+
# daikin_residential
6+
Cloud control of Daikin devices that are supported by Daikin Residential Controller app.
7+
8+
# Installation:
9+
10+
Copy the daikin_residential folder and all of its contents into your Home Assistant's custom_components folder. This is often located inside of your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. It is possible that your custom_components folder does not exist. If that is the case, create the folder in the proper location, and then copy the daikin_residential folder and all of its contents inside the newly created custom_components folder.
11+
12+
Alternatively, you can install daikin_residential through HACS by adding this repository.
13+
14+
# Usage:
15+
16+
**NOTE: You must have your Daikin Cloud token set stored as a tokenset.json file in your /config folder (the same where configuration.yaml is). For instructions on how to retrieve this file, follow the guide at https://github.com/Apollon77/daikin-controller-cloud/blob/main/PROXY.md .**
17+
18+
The integration can be configured in two ways:
19+
20+
# 1. YAML config files
21+
22+
Just add the following line to your configuration.yaml file, and the Daikin devices connected to your cloud account will be created.
23+
24+
```
25+
daikin_residential:
26+
```
27+
28+
29+
# 2. Using config flow
30+
31+
Start by going to Configuration - Integration and pressing the "+" button to create a new Integration, then select Daikin Residential Controller in the drop-down menu.
32+
33+
34+
# To-do list:
35+
36+
* Fix spurious glitches.
37+
* Maybe improve the sensors for Energy consumption.
38+
39+
# Thanks to:
40+
41+
This code is based on @Apollon77 's great work, in finding a way to retrieve the token set, and to send the HTTP commands over the cloud. This integration would not exist without his precious job.

‎pyproject.toml

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
[tool.black]
2+
target-version = ["py37", "py38"]
3+
include = 'custom_components/daikin_residential/.*\.py'
4+
5+
# pylint config stolen from Home Assistant
6+
# Use a conservative default here; 2 should speed up most setups and not hurt
7+
# any too bad. Override on command line as appropriate.
8+
# Disabled for now: https://github.com/PyCQA/pylint/issues/3584
9+
#jobs = 2
10+
load-plugins = [
11+
"pylint_strict_informational",
12+
]
13+
persistent = false
14+
extension-pkg-whitelist = [
15+
"ciso8601",
16+
"cv2",
17+
]
18+
19+
[tool.pylint.BASIC]
20+
good-names = [
21+
"_",
22+
"ev",
23+
"ex",
24+
"fp",
25+
"i",
26+
"id",
27+
"j",
28+
"k",
29+
"Run",
30+
"T",
31+
"hs",
32+
]
33+
34+
[tool.pylint."MESSAGES CONTROL"]
35+
# Reasons disabled:
36+
# format - handled by black
37+
# locally-disabled - it spams too much
38+
# duplicate-code - unavoidable
39+
# cyclic-import - doesn't test if both import on load
40+
# abstract-class-little-used - prevents from setting right foundation
41+
# unused-argument - generic callbacks and setup methods create a lot of warnings
42+
# too-many-* - are not enforced for the sake of readability
43+
# too-few-* - same as too-many-*
44+
# abstract-method - with intro of async there are always methods missing
45+
# inconsistent-return-statements - doesn't handle raise
46+
# too-many-ancestors - it's too strict.
47+
# wrong-import-order - isort guards this
48+
disable = [
49+
"format",
50+
"abstract-class-little-used",
51+
"abstract-method",
52+
"cyclic-import",
53+
"duplicate-code",
54+
"inconsistent-return-statements",
55+
"locally-disabled",
56+
"not-context-manager",
57+
"too-few-public-methods",
58+
"too-many-ancestors",
59+
"too-many-arguments",
60+
"too-many-branches",
61+
"too-many-instance-attributes",
62+
"too-many-lines",
63+
"too-many-locals",
64+
"too-many-public-methods",
65+
"too-many-return-statements",
66+
"too-many-statements",
67+
"too-many-boolean-expressions",
68+
"unused-argument",
69+
"wrong-import-order",
70+
]
71+
enable = [
72+
"use-symbolic-message-instead",
73+
]
74+
75+
[tool.pylint.REPORTS]
76+
score = false
77+
78+
[tool.pylint.FORMAT]
79+
expected-line-ending-format = "LF"
80+
81+
[tool.pylint.MISCELLANEOUS]
82+
notes = "XXX"

0 commit comments

Comments
 (0)