Skip to content

Commit

Permalink
doc: Update API references (#225)
Browse files Browse the repository at this point in the history
* doc: Update API references

* doc: Change api reference code result appearance

* doc: Change api reference code result content

* doc: Add api reference payloads

* doc: Update payload
  • Loading branch information
germainlefebvre4 authored Jan 20, 2024
1 parent 38068c2 commit 8f9d8a8
Show file tree
Hide file tree
Showing 6 changed files with 1,666 additions and 1,095 deletions.
5 changes: 3 additions & 2 deletions check.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
# print(tado.get_energy_insights("2023-09-01", "2023-09-30", "FRA", True))
# print(tado.get_schedule_blocks(1, 1))
# print(tado.get_schedule_block_by_day_type(1, 1, "MONDAY_TO_FRIDAY"))
print(tado.end_manual_control(1))
# print(tado.end_manual_control(1))
# print(tado.refresh_auth())
print(tado.set_away_configuration(6, "HEATING", "MEDIUM", 16))
# print(tado.set_away_configuration(6, "HEATING", "MEDIUM", 16))
print(tado.set_zone_order([{"id":1},{"id":6},{"id":11},{"id":12}]))
4 changes: 4 additions & 0 deletions docs/api/reference.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
hide:
- navigation
---
# API Reference

::: libtado.api.Tado
2 changes: 1 addition & 1 deletion docs/api/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ import tado.api
api = tado.api('Username', 'Password')
```

For API Reference see [this page](/api/reference)
For API Reference see [API Reference](../api/reference.md)
12 changes: 12 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
---
hide:
- title
- navigation
---
# Homepage

<style>
.md-typeset h1,
.md-content__button {
display: none;
}
</style>

![Image title](./logo.png){: .center width=600 }

**libtado** is a simple Python library that provides methods to control the smart heating devices from the German company [tado GmbH](https://www.tado.com)[^1]. It uses the undocumented REST API of their website.
Expand Down
Loading

0 comments on commit 8f9d8a8

Please sign in to comment.