Merge pull request #209 from FBoissadier/feature/implement-save-power-schedule

Implementation of the save method of PowerSchedule API in core_sys_info

Author: N4S4

synology_api/core_sys_info.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
-from typing import Optional
+from typing import Optional, List
 from . import base_api
+import json
 
 
 class SysInfo(base_api.BaseApi):
@@ -576,6 +577,70 @@ def hardware_power_schedule(self) -> dict[str, object] | str:
         req_param = {'version': info['maxVersion'], 'method': 'load'}
 
         return self.request_data(api_name, api_path, req_param)
+    
+    def hardware_set_power_schedule(self, poweron_tasks: List[dict] = [], poweroff_tasks: List[dict] = []) -> dict:
+        """Set the power schedule, poweron tasks and poweroff tasks
+        
+            Parameters
+            ----------
+            poweron_tasks : List[dict], optional
+                List of tasks for power on. Defaults to `[]`
+                Example of a task:
+                ```python
+                {
+                    "enabled": True, # Enable or not the task
+                    "hour": 13, # Hour 0-23
+                    "min": 59, # Minutes 0-59
+                    "weekdays": "0,1,2,3,4,5,6" # All days of the week (Sunday, Monday, Tuesday, Wednesday, Thrusday, Friday, Saturday)
+                }
+                ```
+            poweroff_tasks : List[dict], optional
+                List of tasks for power off. Defaults to `[]`
+                Example of a task:
+                ```python
+                {
+                    "enabled": True, # Enable or not the task
+                    "hour": 13, # Hour 0-23
+                    "min": 59, # Minutes 0-59
+                    "weekdays": "0,1,2,3,4,5,6" # All days of the week (Sunday, Monday, Tuesday, Wednesday, Thrusday, Friday, Saturday)
+                }
+                ```
+            Returns
+            -------
+            dict
+                List of tasks in power schedule
+        
+            Example return
+            ----------
+            ```json
+            {
+                "data": {
+                    "poweroff_tasks": [],
+                    "poweron_tasks": [
+                        {
+                            "enabled": true,
+                            "hour": 0,
+                            "min": 0,
+                            "weekdays": "1,2,3,4,5"
+                        }
+                    ]
+                },
+                "success": true
+            }
+            ```
+        """
+        
+        api_name = 'SYNO.Core.Hardware.PowerSchedule'
+        info = self.core_list[api_name]
+        api_path = info["path"]
+        req_param = {
+            "version": info["maxVersion"],
+            "method": "save",
+            "poweron_tasks": json.dumps(poweron_tasks),
+            "poweroff_tasks": json.dumps(poweroff_tasks)
+        }
+
+        return self.request_data(api_name, api_path, req_param)
 
     def terminal_info(self) -> dict[str, object] | str:
         api_name = 'SYNO.Core.Terminal'