From be446f94c1ad07286f2a1b427f8d24b76415103f Mon Sep 17 00:00:00 2001
From: Abhishek Patidar <1e9abhi1e10@gmail.com>
Date: Sat, 20 Apr 2024 02:33:51 +0530
Subject: [PATCH] docs: Add documentation for `ssh` (#126)

---
 pyasic/ssh/antminer.py   |  6 ++++
 pyasic/ssh/braiins_os.py | 60 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+)

diff --git a/pyasic/ssh/antminer.py b/pyasic/ssh/antminer.py
index c1317936..4ca08bd4 100644
--- a/pyasic/ssh/antminer.py
+++ b/pyasic/ssh/antminer.py
@@ -3,6 +3,12 @@ from pyasic.ssh.base import BaseSSH
 
 
 class AntminerModernSSH(BaseSSH):
+    """
+    Initialize an AntminerModernSSH instance.
+
+    Args:
+        ip (str): The IP address of the Antminer device.
+    """
     def __init__(self, ip: str):
         super().__init__(ip)
         self.pwd = settings.get("default_antminer_ssh_password", "root")
diff --git a/pyasic/ssh/braiins_os.py b/pyasic/ssh/braiins_os.py
index b454daf2..6dee3502 100644
--- a/pyasic/ssh/braiins_os.py
+++ b/pyasic/ssh/braiins_os.py
@@ -4,32 +4,92 @@ from pyasic.ssh.base import BaseSSH
 
 class BOSMinerSSH(BaseSSH):
     def __init__(self, ip: str):
+        """
+        Initialize a BOSMinerSSH instance.
+
+        Args:
+            ip (str): The IP address of the BOSMiner device.
+        """
         super().__init__(ip)
         self.pwd = settings.get("default_bosminer_ssh_password", "root")
 
     async def get_board_info(self):
+        """
+        Retrieve information about the BOSMiner board.
+
+        Returns:
+            str: Information about the BOSMiner board.
+        """
         return await self.send_command("bosminer model -d")
 
     async def fault_light_on(self):
+        """
+        Turn on the fault light of the BOSMiner device.
+
+        Returns:
+            str: Confirmation message after turning on the fault light.
+        """
         return await self.send_command("miner fault_light on")
 
     async def fault_light_off(self):
+        """
+        Turn off the fault light of the BOSMiner device.
+
+        Returns:
+            str: Confirmation message after turning off the fault light.
+        """
         return await self.send_command("miner fault_light off")
 
     async def restart_bosminer(self):
+        """
+        Restart the BOSMiner service on the device.
+
+        Returns:
+            str: Confirmation message after restarting the BOSMiner service.
+        """
         return await self.send_command("/etc/init.d/bosminer restart")
 
     async def reboot(self):
+        """
+        Reboot the BOSMiner device.
+
+        Returns:
+            str: Confirmation message after initiating the reboot process.
+        """
         return await self.send_command("/sbin/reboot")
 
     async def get_config_file(self):
+        """
+        Retrieve the configuration file of BOSMiner.
+
+        Returns:
+            str: Content of the BOSMiner configuration file.
+        """
         return await self.send_command("cat /etc/bosminer.toml")
 
     async def get_network_config(self):
+        """
+        Retrieve the network configuration of the BOSMiner device.
+
+        Returns:
+            str: Content of the network configuration file.
+        """
         return await self.send_command("cat /etc/config/network")
 
     async def get_hostname(self):
+        """
+        Retrieve the hostname of the BOSMiner device.
+
+        Returns:
+            str: Hostname of the BOSMiner device.
+        """
         return await self.send_command("cat /proc/sys/kernel/hostname")
 
     async def get_led_status(self):
+        """
+        Retrieve the status of the LED on the BOSMiner device.
+
+        Returns:
+            str: Status of the LED.
+        """
         return await self.send_command("cat /sys/class/leds/'Red LED'/delay_off")