Minor improvements

Author: qqaatw

Taipower/api.py

@@ -443,7 +443,7 @@ async def run(l):
 
         collections.deque(
             map(
-                lambda x, y: setattr(y[0], y[1], x) if not isinstance(x, RuntimeError) else errors.append(x),
+                lambda x, y: setattr(y[0], y[1], x) if not isinstance(x, Exception) else errors.append(x),
                 asyncio.run(run(async_functions)),
                 return_storages
             )

docs/source/example.md

@@ -0,0 +1,36 @@
+# Example
+
+## API
+
+1. Import API and define credential informaiton. 
+
+    ```
+    from Taipower.api import TaipowerAPI
+
+    # Fill out your Jci Hitachi email address, password, and electric number.
+    ACCOUNT = "0987654321"
+    PASSWORD = "password"
+    ELECTRICNUMBER = "00xxxxxxxx"
+    ```
+
+2. Login to API and get info.
+
+    ```
+    # Login
+    api = TaipowerAPI(ACCOUNT, PASSWORD, ELECTRICNUMBER)
+    api.login()
+
+    # Check ami, ami bill, and bill records
+    ami = api.meters[ELECTRICNUMBER].ami
+    ami_bill = api.meters[ELECTRICNUMBER].ami_bill
+    bill_records = api.meters[ELECTRICNUMBER].bill_records
+    ```
+
+4. Refresh status.
+    
+    ```
+    # Check the updated device status
+    api.refresh_status()
+    ```
+
+The python script can be found [here](https://github.com/qqaatw/libtaipower/blob/main/example.py).

example.py

@@ -0,0 +1,22 @@
+from Taipower.api import TaipowerAPI
+
+# Fill out your Jci Hitachi email address, password, and electric number.
+ACCOUNT = "0987654321"
+PASSWORD = "password"
+ELECTRICNUMBER = "00xxxxxxxx"
+
+def main():
+    # Login
+    api = TaipowerAPI(ACCOUNT, PASSWORD, ELECTRICNUMBER)
+    api.login()
+
+    # Check ami, ami bill, and bill records
+    ami = api.meters[ELECTRICNUMBER].ami
+    ami_bill = api.meters[ELECTRICNUMBER].ami_bill
+    bill_records = api.meters[ELECTRICNUMBER].bill_records
+
+    # Refresh status
+    api.refresh_status()
+
+if __name__ == "__main__":
+    main()

tests/test_api.py

@@ -165,7 +165,7 @@ async def mock(client=None):
                 }
                 return "OK", return_value
 
-            async def mock_failed(time_period, dt, electric_number, client=None):
+            async def mock_failed(client=None):
                 return "Not OK", {}
 
             mock_login.return_value = ("OK", "")