You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tests/INIT.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,35 +4,35 @@
4
4
5
5
Needed:
6
6
7
-
-[ ] Github account (or organisation and account(s))
8
-
-[ ] Codecov account (just choose 'login with github')
9
-
-[ ] CodeFactor account (again, login with github)
10
-
-[ ] Add codecov as an integration from Github's integrations (basically 'buy' it, except its at no cost)
7
+
-[ ] Github account (or organisation and account(s))
8
+
-[ ] Codecov account (just choose 'login with github')
9
+
-[ ] CodeFactor account (again, login with github)
10
+
-[ ] Add codecov as an integration from Github's integrations (basically 'buy' it, except its at no cost)
11
11
12
12
## Configuration
13
13
14
14
After the initial setup of the repo/initial commit, walk the repo-settings on GitHub using your browser.
15
15
16
-
-[ ][Set the product image, turn off wiki and automatically delete branches (from defaults)](https://github.com/plugwise/python-plugwise/settings)
17
-
-[ ][Activate both dependabots and keep dependency graph open](https://github.com/plugwise/python-plugwise/settings/security_analysis)
18
-
-[ ][Integrations, configure codecov (should show up from organisation)](https://github.com/plugwise/python-plugwise/settings/installations)
16
+
-[ ][Set the product image, turn off wiki and automatically delete branches (from defaults)](https://github.com/plugwise/python-plugwise/settings)
17
+
-[ ][Activate both dependabots and keep dependency graph open](https://github.com/plugwise/python-plugwise/settings/security_analysis)
18
+
-[ ][Integrations, configure codecov (should show up from organisation)](https://github.com/plugwise/python-plugwise/settings/installations)
19
19
20
20
For this step you might need to follow [this publishing guide](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/) taking you through most of the steps. Note that the projects on PyPi already [**need to exist**](https://packaging.python.org/tutorials/packaging-projects/) so use a generic token first and later adjust that to only this project (as explained on that howto):
21
21
22
-
-[ ][Configure secrets for PYPI_TOKEN and TESTPYPI_TOKEN](https://github.com/plugwise/Plugwise-Smile/settings/secrets)
22
+
-[ ][Configure secrets for PYPI_TOKEN and TESTPYPI_TOKEN](https://github.com/plugwise/Plugwise-Smile/settings/secrets)
23
23
24
24
## Initializing pypi
25
25
26
-
Once the project is ready for upload to test (i.e. version number ending in `a0` or something likewise): upload it manually using `twine upload`:
26
+
Once the project is ready for upload to test (i.e. version number ending in `a0` or something likewise): upload it manually using `twine upload`:
Help wanted / submit yours (links to issue tracker)
8
8
9
-
-[]() setup with a boiler, Floor, Koen, Plug, Tom and Lisa (i.e. the whole shebang) (`adam_full_option`)
10
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_living_floor_plus_3_rooms) setup with a boiler, Floor, Lisa and 3x Toms (riemers)
11
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_multiple_devices_per_zone) setup with everything but Koen and Anna, multiple devices per zone (tane)
12
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_zone_per_device) setup with everything but Koen and Anna, device per zone (tane)
13
-
-[]() setup without a boiler, but with Lisa and either a Plug or a Tom (`adam_without_boiler`)
9
+
-[](https://github.com/plugwise/python-plugwise/issues/new/choose) setup with a boiler, Floor, Koen, Plug, Tom and Lisa (i.e. the whole shebang) (`adam_full_option`)
10
+
-[](https://github.com/plugwise/python-plugwise/issues/new/choose) setup without a boiler, but with Lisa and either a Plug or a Tom (`adam_without_boiler`)
11
+
-[](https://github.com/plugwise/python-plugwise/issues/new/choose) electricity and gas (`p1v3_gas_nosolar`)
14
12
15
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_plus_anna) a boiler, Adam, Anna and Tom (bouwew)
13
+
Existing setups (needs validation, e.g. links are still pointing to old repository)
16
14
17
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_v4) setup with a boiler ()
18
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_without_boiler_fw3) without boiler(i.e. attached to city heating) (compatech)
19
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_without_boiler_fw4) without boiler(i.e. attached to city heating) (compatech)
20
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/legacy_anna) setup with a boiler, but legacy firmware (1.8) ()
21
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/legacy_anna_2) another setup with a boiler, but legacy firmware (1.8), but with a location ()
15
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_living_floor_plus_3_rooms) setup with a boiler, Floor, Lisa and 3x Toms (riemers)
16
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_multiple_devices_per_zone) setup with everything but Koen and Anna, multiple devices per zone (tane)
17
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_zone_per_device) setup with everything but Koen and Anna, device per zone (tane)
22
18
23
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3) electricity only (compatech)
24
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3solarfake) electricity only - just the above with added data, please submit **yours** (from above)
25
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3_full_option) electricity, solar and gas ()
26
-
-[]() electricity and gas (`p1v3_gas_nosolar`)
27
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/smile_p1_v2) electricity and gas ()
28
-
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/smile_p1_v2_2) another electricity and gas ()
19
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/adam_plus_anna) a boiler, Adam, Anna and Tom (bouwew)
20
+
21
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_v4) setup with a boiler ()
22
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_without_boiler_fw3) without boiler(i.e. attached to city heating) (compatech)
23
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/anna_without_boiler_fw4) without boiler(i.e. attached to city heating) (compatech)
24
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/legacy_anna) setup with a boiler, but legacy firmware (1.8) ()
25
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/legacy_anna_2) another setup with a boiler, but legacy firmware (1.8), but with a location ()
26
+
27
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3) electricity only (compatech)
28
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3solarfake) electricity only - just the above with added data, please submit **yours** (from above)
29
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/p1v3_full_option) electricity, solar and gas ()
30
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/smile_p1_v2) electricity and gas ()
31
+
-[](https://github.com/plugwise/Plugwise-Smile/tree/docs/tests/smile_p1_v2_2) another electricity and gas ()
29
32
30
33
## Sharing
31
34
32
35
If you see a yellow item and feel your setup fits in, please **MAIL** one of the authors the output of the below links. Feel free to create a PR if you follow the below privacy hint:
33
36
34
37
They should al start with `<xml` and copied as plain text (i.e. not preformatted like Chrome and Safari do).
35
-
Either use wget/curl or use your 'developer view' from your browser to copy the source text
36
-
37
-
```
38
+
Either use wget/curl or use your 'developer view' from your browser to copy the source text.
39
+
40
+
```txt
38
41
http://{ip_of_your_smile}/core/appliances
39
42
http://{ip_of_your_smile}/core/domain_objects
40
43
http://{ip_of_your_smile}/core/locations
@@ -47,33 +50,32 @@ Don't commit test-data in `tests` that shouldn't be available to 'the internet'.
47
50
To prevent this we've included a pre-commit hook that checks and validates that no private information is there (but do double-check yourselves!)
48
51
See 'scripts/pre-commit.sh' for details
49
52
50
-
### Excerpt:
53
+
### Excerpt
51
54
52
-
-[ ] modify `domain_objects` and set `short_id` to `abcdefgh`
53
-
-[ ] modify `domain_objects` and set `wifi_ip` to `127.0.0.2`
54
-
-[ ] modify `domain_objects` and set `lan_ip` to `127.0.0.1`
55
-
-[ ] modify `domain_objects` and set all `ip_addresses` to `127.0.0.3`
56
-
-[ ] modify `domain_objects` and set `hostname` to `smile000000`
57
-
-[ ] modify `domain_objects` and set `longitude` to `4.49`
58
-
-[ ] modify `domain_objects` and set `latitude` to `52.21`
59
-
-[ ] modify `domain_objects` and set `city` to `Sassenheim`
60
-
-[ ] modify `domain_objects` and set `postal_code` to `2171`
55
+
-[ ] modify `domain_objects` and set `short_id` to `abcdefgh`
56
+
-[ ] modify `domain_objects` and set `wifi_ip` to `127.0.0.2`
57
+
-[ ] modify `domain_objects` and set `lan_ip` to `127.0.0.1`
58
+
-[ ] modify `domain_objects` and set all `ip_addresses` to `127.0.0.3`
59
+
-[ ] modify `domain_objects` and set `hostname` to `smile000000`
60
+
-[ ] modify `domain_objects` and set `longitude` to `4.49`
61
+
-[ ] modify `domain_objects` and set `latitude` to `52.21`
62
+
-[ ] modify `domain_objects` and set `city` to `Sassenheim`
63
+
-[ ] modify `domain_objects` and set `postal_code` to `2171`
61
64
62
65
### Obfuscating mac-addresses
63
66
64
67
We used to obfuscate them as they weren't used within our module nor HomeAssistant.
65
68
From v0.16.4 this was changed as such we recommend leaving them in, if you do wish to obfuscate
66
69
Note: Zigbee mac addresses are 64bit (not 48bit like Ethernet mac addresses)
67
70
68
-
Prefix:
71
+
Prefix:
69
72
70
-
-`ABCD01234567`
73
+
-`ABCD01234567`
71
74
72
75
Postfix:
73
76
74
-
- Anything you'd normally have (last 4 digits can remain)
75
-
- When standardizing:
76
-
- 0001 = Network Mac Address
77
-
- 0101 = Controller Zigbee Mac Address
78
-
- 0Axx = Nodes Zigbee mac addresses
79
-
77
+
- Anything you'd normally have (last 4 digits can remain)
0 commit comments