Moved services docs

signalkraft · Oct 29, 2023 · 238cfba · 238cfba
1 parent 1d76b46
commit 238cfba
Show file tree

Hide file tree

Showing 4 changed files with 113 additions and 111 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ because of this library.
 
 * Supports climate & hot water controls, as well as sensor information
 * Control operating modes, target temperature, and presets such as holiday more or quick veto
-* Set the schedule for climate zones, water heaters, and circulation pumps with [a custom service](https://signalkraft.com/mypyllant-component/1-automations/#setting-a-time-program)
+* Set the schedule for climate zones, water heaters, and circulation pumps with [a custom service](https://signalkraft.com/mypyllant-component/2-services/#setting-a-time-program)
 * Track sensor information of devices, such as temperature, humidity, operating mode, energy usage, or energy efficiency
 * See diagnostic information, such as the current heating curve, flow temperature, firmware versions, or water pressure
 * Custom services to set holiday mode or quick veto temperature overrides, and their duration

diff --git a/docs/docs/1-automations.md b/docs/docs/1-automations.md
@@ -1,6 +1,7 @@
 ---
 hide:
   - navigation
+  - toc
 ---
 
 # Automations
@@ -44,113 +45,4 @@ mode: single
 3. This is the duration. Make sure it covers the time period where your water heater is turned on
 4. This should be your regular water temperature
 
-## Setting a Time Program
-
-Call the `mypyllant.set_zone_time_program` (for climate) `mypyllant.set_dhw_time_program` (for water heaters) 
-with a `program_type` (only on climate) and a `time_program`.
-
-=== "Climate"
-
-    ```yaml
-    service: mypyllant.set_zone_time_program
-    data:
-      program_type: heating
-      time_program:
-        monday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        tuesday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        wednesday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        thursday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        friday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        saturday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        sunday:
-          - start_time: 420
-            end_time: 1290
-            setpoint: 20
-        type: heating
-    target:
-      entity_id: climate.zone_0
-    ```
-
-=== "Water Heater"
-
-    ```yaml
-    service: mypyllant.set_dhw_time_program
-    data:
-      time_program:
-        monday:
-          - start_time: 420
-            end_time: 1290
-        tuesday:
-          - start_time: 420
-            end_time: 1290
-        wednesday:
-          - start_time: 420
-            end_time: 1290
-        thursday:
-          - start_time: 420
-            end_time: 1290
-        friday:
-          - start_time: 420
-            end_time: 1290
-        saturday:
-          - start_time: 420
-            end_time: 1290
-        sunday:
-          - start_time: 420
-            end_time: 1290
-        type: heating
-    target:
-      entity_id: water_heater.domestic_hot_water_0
-    ```
-
-=== "Circulation Pump"
-
-    ```yaml
-    service: mypyllant.set_dhw_circulation_time_program
-    data:
-      time_program:
-        monday:
-          - start_time: 420
-            end_time: 1290
-        tuesday:
-          - start_time: 420
-            end_time: 1290
-        wednesday:
-          - start_time: 420
-            end_time: 1290
-        thursday:
-          - start_time: 420
-            end_time: 1290
-        friday:
-          - start_time: 420
-            end_time: 1290
-        saturday:
-          - start_time: 420
-            end_time: 1290
-        sunday:
-          - start_time: 420
-            end_time: 1290
-        type: heating
-    target:
-      entity_id: water_heater.domestic_hot_water_0
-    ```
-
 [^1]: Contributed by CommanderROR in the [Home Assistant Community](https://community.home-assistant.io/t/myvaillant-integration/542610/70)
diff --git a/docs/docs/2-services.md b/docs/docs/2-services.md
@@ -1,6 +1,7 @@
 ---
 hide:
   - navigation
+  - toc
 ---
 
 # Services
@@ -11,3 +12,112 @@ Search for "myvaillant" in Developer Tools > Services in your Home Assistant ins
 ![Services Screenshot](assets/services-screenshot.png)
 
 [![Open your Home Assistant instance and show your service developer tools with a specific service selected.](https://my.home-assistant.io/badges/developer_call_service.svg)](https://my.home-assistant.io/redirect/developer_call_service/?service=mypyllant.set_holiday)
+
+## Setting a Time Program
+
+Call the `mypyllant.set_zone_time_program` (for climate) `mypyllant.set_dhw_time_program` (for water heaters) 
+with a `program_type` (only on climate) and a `time_program`.
+
+=== "Climate"
+
+    ```yaml
+    service: mypyllant.set_zone_time_program
+    data:
+      program_type: heating
+      time_program:
+        monday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        tuesday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        wednesday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        thursday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        friday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        saturday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        sunday:
+          - start_time: 420
+            end_time: 1290
+            setpoint: 20
+        type: heating
+    target:
+      entity_id: climate.zone_0
+    ```
+
+=== "Water Heater"
+
+    ```yaml
+    service: mypyllant.set_dhw_time_program
+    data:
+      time_program:
+        monday:
+          - start_time: 420
+            end_time: 1290
+        tuesday:
+          - start_time: 420
+            end_time: 1290
+        wednesday:
+          - start_time: 420
+            end_time: 1290
+        thursday:
+          - start_time: 420
+            end_time: 1290
+        friday:
+          - start_time: 420
+            end_time: 1290
+        saturday:
+          - start_time: 420
+            end_time: 1290
+        sunday:
+          - start_time: 420
+            end_time: 1290
+        type: heating
+    target:
+      entity_id: water_heater.domestic_hot_water_0
+    ```
+
+=== "Circulation Pump"
+
+    ```yaml
+    service: mypyllant.set_dhw_circulation_time_program
+    data:
+      time_program:
+        monday:
+          - start_time: 420
+            end_time: 1290
+        tuesday:
+          - start_time: 420
+            end_time: 1290
+        wednesday:
+          - start_time: 420
+            end_time: 1290
+        thursday:
+          - start_time: 420
+            end_time: 1290
+        friday:
+          - start_time: 420
+            end_time: 1290
+        saturday:
+          - start_time: 420
+            end_time: 1290
+        sunday:
+          - start_time: 420
+            end_time: 1290
+        type: heating
+    target:
+      entity_id: water_heater.domestic_hot_water_0
+    ```
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -55,7 +55,7 @@ Uses the [myPyllant library](https://github.com/signalkraft/mypyllant).
 
 * Supports climate & hot water controls, as well as sensor information
 * Control operating modes, target temperature, and presets such as holiday more or quick veto
-* Set the schedule for climate zones, water heaters, and circulation pumps with [a custom service](https://signalkraft.com/mypyllant-component/1-automations/#setting-a-time-program)
+* Set the schedule for climate zones, water heaters, and circulation pumps with [a custom service](https://signalkraft.com/mypyllant-component/2-services/#setting-a-time-program)
 * Track sensor information of devices, such as temperature, humidity, operating mode, energy usage, or energy efficiency
 * See diagnostic information, such as the current heating curve, flow temperature, firmware versions, or water pressure
 * Custom services to set holiday mode or quick veto temperature overrides, and their duration