Merge pull request #26 from SF-Tec/doc/update-readme-files

README.md

@@ -31,19 +31,20 @@ Core.IV_getdevicestatus()
 Core.IV_close()
 ```
 
-<!-- ## Usage Example (Using Pyvium methods)
+## Usage Example (Using Pyvium methods)
 
 This is a wrapper around the Core functions that adds a few things:
-- Exception management
+- Exception management (you can find an example [here](./docs/error_management.md))
 - New functionalities
 
 ```
 from pyvium import Pyvium
 
-app = Pyvium()
+Pyvium.open_driver()
+Pyvium.get_device_status()
+Pyvium.close_driver()
 
-app.connect_device()
-``` -->
+```
 
 
 ## Supported functions

docs/error_management.md

@@ -0,0 +1,24 @@
+
+```
+form pyvium import Pyvium
+from pyvium.errors import DeviceNotConnectedToIviumSoftError, IviumSoftNotRunningError
+
+try:
+    Pyvium.open_driver()
+    Pyvium.get_potential()
+except IviumSoftNotRunningError:
+    print('Tell the user the software is not running')
+except DeviceNotConnectedToIviumSoftError:
+    raise
+
+```
+
+
+| Available errors                      |
+| ------------------------------------- |
+| DeviceBusyError                       |
+| DeviceNotConnectedToIviumSoftError    |
+| DriverNotOpenError                    |
+| NoDeviceDetectedError                 |
+| IviumSoftNotRunningError              |
+| CellOffError                          |

pyproject.toml

@@ -9,7 +9,7 @@ license = "Apache-2.0"
 name = "pyvium"
 packages = [{include = "pyvium"}]
 readme = "README.md"
-version = "0.1.1a5"
+version = "0.1.1a6"
 classifiers = [
     # How mature is this project? Common values are
     #   3 - Alpha