Merge pull request #234 from TheLime1/add-documentation

Add documentation for all endpoints fix #1

Author: Salamek

README.md

@@ -143,4 +143,3 @@ Some code [examples](examples/) are in [/examples](examples/)  folder
 * 250 CZK (9.79 EUR) for B535-232 fund, thx @larsvinc !
 * 371,69 CZK (14.32 EUR) by Oleg Jusaew
 * 292 CZK (11.50 EUR) by Toth-Mate Akos
-

huawei_lte_api/api/App.py

@@ -5,12 +5,45 @@
 
 class App(ApiGroup):
     def operatorinfo(self, lang: str = 'en_us') -> GetResponseType:
+        """
+        Get operator information.
+        
+        :param lang: Language code (default is 'en_us').
+        :return: Operator information.
+        
+        Usage example:
+        >>> app = App(session)
+        >>> operator_info = app.operatorinfo()
+        >>> print(operator_info)
+        """
         return self._session.get('app/operatorinfo', {'lang': lang})
 
     def privacypolicy(self, lang: str = 'en_us') -> GetResponseType:
+        """
+        Get privacy policy.
+        
+        :param lang: Language code (default is 'en_us').
+        :return: Privacy policy.
+        
+        Usage example:
+        >>> app = App(session)
+        >>> privacy_policy = app.privacypolicy()
+        >>> print(privacy_policy)
+        """
         return self._session.get('app/privacypolicy', {'lang': lang})
 
     def accept_privacypolicy(self, approve: bool = False) -> SetResponseType:
+        """
+        Accept or decline the privacy policy.
+        
+        :param approve: Boolean indicating whether to approve the privacy policy (default is False).
+        :return: "OK" if the operation is successful, raises ResponseErrorException otherwise.
+        
+        Usage example:
+        >>> app = App(session)
+        >>> response = app.accept_privacypolicy(approve=True)
+        >>> print(response)
+        """
         response = self._session.post_get('app/privacypolicy',
                                       {
                                           "data": {

huawei_lte_api/api/Bluetooth.py

@@ -5,14 +5,30 @@
 class Bluetooth(ApiGroup):
     def settings(self) -> GetResponseType:
         """
-        Endpoint found by reverse engineering B310s-22 firmware, unknown usage
-        :return:
+        Get Bluetooth settings.
+        
+        Endpoint found by reverse engineering B310s-22 firmware, unknown usage.
+        
+        :return: Bluetooth settings.
+        
+        Usage example:
+        >>> bluetooth = Bluetooth(session)
+        >>> settings = bluetooth.settings()
+        >>> print(settings)
         """
         return self._session.get('bluetooth/settings')
 
     def scan(self) -> GetResponseType:
         """
-        Endpoint found by reverse engineering B310s-22 firmware, unknown usage
-        :return:
+        Scan for Bluetooth devices.
+        
+        Endpoint found by reverse engineering B310s-22 firmware, unknown usage.
+        
+        :return: Scan results.
+        
+        Usage example:
+        >>> bluetooth = Bluetooth(session)
+        >>> scan_results = bluetooth.scan()
+        >>> print(scan_results)
         """
         return self._session.get('bluetooth/scan')

huawei_lte_api/api/Cradle.py

@@ -4,16 +4,66 @@
 
 class Cradle(ApiGroup):
     def status_info(self) -> GetResponseType:
+        """
+        Get cradle status information.
+
+        :return: Cradle status information.
+
+        Usage example:
+        >>> cradle = Cradle(session)
+        >>> status_info = cradle.status_info()
+        >>> print(status_info)
+        """
         return self._session.get('cradle/status-info')
 
     def feature_switch(self) -> GetResponseType:
+        """
+        Get cradle feature switch status.
+
+        :return: Cradle feature switch status.
+
+        Usage example:
+        >>> cradle = Cradle(session)
+        >>> feature_switch = cradle.feature_switch()
+        >>> print(feature_switch)
+        """
         return self._session.get('cradle/feature-switch')
 
     def basic_info(self) -> GetResponseType:
+        """
+        Get cradle basic information.
+
+        :return: Cradle basic information.
+
+        Usage example:
+        >>> cradle = Cradle(session)
+        >>> basic_info = cradle.basic_info()
+        >>> print(basic_info)
+        """
         return self._session.get('cradle/basic-info')
 
     def factory_mac(self) -> GetResponseType:
+        """
+        Get cradle factory MAC address.
+
+        :return: Cradle factory MAC address.
+
+        Usage example:
+        >>> cradle = Cradle(session)
+        >>> factory_mac = cradle.factory_mac()
+        >>> print(factory_mac)
+        """
         return self._session.get('cradle/factory-mac')
 
     def mac_info(self) -> GetResponseType:
+        """
+        Get cradle MAC address information.
+
+        :return: Cradle MAC address information.
+
+        Usage example:
+        >>> cradle = Cradle(session)
+        >>> mac_info = cradle.mac_info()
+        >>> print(mac_info)
+        """
         return self._session.get('cradle/mac-info')

huawei_lte_api/api/DDns.py

@@ -4,10 +4,40 @@
 
 class DDns(ApiGroup):
     def get_ddns_list(self) -> GetResponseType:
+        """
+        Get the list of DDNS configurations.
+
+        :return: List of DDNS configurations.
+
+        Usage example:
+        >>> ddns = DDns(session)
+        >>> ddns_list = ddns.get_ddns_list()
+        >>> print(ddns_list)
+        """
         return self._session.get('ddns/ddns-list')
 
     def get_status(self) -> GetResponseType:
+        """
+        Get the status of DDNS.
+
+        :return: DDNS status.
+
+        Usage example:
+        >>> ddns = DDns(session)
+        >>> status = ddns.get_status()
+        >>> print(status)
+        """
         return self._session.get('ddns/status')
 
     def serverlist(self) -> GetResponseType:
+        """
+        Get the list of DDNS servers.
+
+        :return: List of DDNS servers.
+
+        Usage example:
+        >>> ddns = DDns(session)
+        >>> server_list = ddns.serverlist()
+        >>> print(server_list)
+        """
         return self._session.get('ddns/serverlist')

huawei_lte_api/api/Developer.py

@@ -4,7 +4,27 @@
 
 class Developer(ApiGroup):
     def developermode_featureswitch(self) -> GetResponseType:
+        """
+        Get the status of the developer mode feature switch.
+
+        :return: Developer mode feature switch status.
+
+        Usage example:
+        >>> developer = Developer(session)
+        >>> featureswitch_status = developer.developermode_featureswitch()
+        >>> print(featureswitch_status)
+        """
         return self._session.get('developer/developermode-featureswitch')
 
     def atport_status(self) -> GetResponseType:
+        """
+        Get the status of the AT port.
+
+        :return: AT port status.
+
+        Usage example:
+        >>> developer = Developer(session)
+        >>> atport_status = developer.atport_status()
+        >>> print(atport_status)
+        """
         return self._session.get('app/atport-status')