Feature/hardware support (#3)

* Separated the files to modules + added basic hardware settings

* Added set_access_method function

* Added pin capability

* Added device capability retrieval methods and enhanced device configuration functions

* Edited placement of get_device func

* Edited readme

* Added documentation for hardware

Author: matejgordon

.gitignore

@@ -161,4 +161,5 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-test.py
+test.py
+setup_test.py

README.md

@@ -1,11 +1,11 @@
 ![licence](https://img.shields.io/badge/license-MIT-green)
 ![issues](https://img.shields.io/github/issues/matejgordon/unipyaccess)
-[![deploy](https://img.shields.io/github/actions/workflow/status/matejgordon/unipyaccess/deploy.yml)](https://github.com/matejgordon/unipyaccess/actions/workflows/deploy.yml) 
+[![deploy](https://img.shields.io/github/actions/workflow/status/matejgordon/unipyaccess/deploy.yml)](https://github.com/matejgordon/unipyaccess/actions/workflows/deploy.yml)
 ![tag](https://img.shields.io/github/v/tag/matejgordon/unipyaccess)
 
 # unipyaccess
 
-`unipyaccess` is a Python package designed to interface with the **Unifi Access** system. This package provides a simple and efficient way to manage users in Unifi Access, including authentication, retrieval, creation, activation, deactivation, deletion, and updating of user groups.
+`unipyaccess` is a Python package designed to interface with the **Unifi Access** system. This package provides a simple and efficient way to manage users in Unifi Access, including authentication, retrieval, creation, activation, deactivation, deletion, and updating of user groups and hardware settings.
 
 > [!NOTE]  
 > This implementation uses Unifi API endpoints with admin user authentication. It does **not** utilize the latest, in my opinion half-baked Unifi API.
@@ -18,6 +18,7 @@
 - Authenticate with Unifi Access using admin credentials.
 - Retrieve, create, activate, deactivate, and delete user accounts.
 - Update user group assignments.
+- Manage Unifi Access hardware, including access methods, display brightness, and device status.
 
 ## Installation
 
@@ -61,94 +62,207 @@ import os
 load_dotenv()
 
 # Initialize the UnipyAccess API client
-unifiApi = UnipyAccess(
+unipy = UnipyAccess(
     base_url=os.getenv('UNIFI_CONTROLLER_ADDRESS'),
     username=os.getenv('UNIFI_LOGIN'),
     password=os.getenv('UNIFI_PASSWORD'),
     verify=os.getenv('VERIFY_SSL')
 )
 
-# Example: Create a new user
-users = [
-    {
-        "first_name": "John",
-        "last_name": "Doe",
-        "PersonId": 124,
-        "group_ids": ["bc1bf76d-5d2a-4a90-ae50-6aca02bccc63"]
-    }
-]
-unifiApi.create_unifi_users(users)
+# Features
+users = unipy.users.get_users()
+
+new_user = {
+    "first_name": "Python",
+    "last_name": "Test",
+    "PersonId": 98765,
+}
+
+unipy.users.create_user(new_user)
+unipy.users.deactivate_user(uuid)
+unipy.users.activate_user(uuid)
+unipy.users.set_user_group(uuid, group_uuid)
+unipy.users.delete_user(uuid)
+
+# Hardware management
+devices = unipy.hardware.get_devices()
+
+unipy.hardware.get_device(device_id)
+unipy.hardware.set_access_method(device_id, ["pin", "nfc", "mobile_tap", "mobile_button"])
+unipy.hardware.set_doorbell_trigger(device_id, "tap")
+unipy.hardware.set_status_light(device_id, "on")
+unipy.hardware.set_display_brightness(device_id, 50)
+unipy.hardware.set_status_sound("f4e2c6d3085d", 30)  # For models other than UA G2 Pro use "on" or "off"
+unipy.hardware.get_device_capabilities(device_id)
+unipy.hardware.get_device_model(device_id)
+unipy.hardware.restart_device(device_id)
 ```
 
 ## Methods
 
-### 1. `get_unifi_users()`
-Fetches the list of users from Unifi Access.
+### User Management
+
+#### 1. `unipy.users.create_user(new_user)`
+Creates a new user.
+
+**Parameters:**
+- `new_user` (dict): Dictionary containing user details:
+  - `first_name` (str): User's first name.
+  - `last_name` (str): User's last name.
+  - `PersonId` (str): Optional employee number.
+  - `group_ids` (list): Optional list of group IDs.
 
 **Usage:**
 
 ```python
-users = unifiApi.get_unifi_users()
-print(users)
+new_user = {
+    "first_name": "Jane",
+    "last_name": "Doe",
+    "PersonId": "789",
+    "group_ids": ["group-123"]
+}
+unipy.users.create_user(new_user)
 ```
 
-### 2. `create_unifi_users(users)`
-Creates new users.
+#### 2. `unipy.users.deactivate_user(uuid)`
+Deactivates a user.
 
 **Parameters:**
-- `users` (list): List of user dictionaries containing:
-  - `first_name` (str): User's first name.
-  - `last_name` (str): User's last name.
-  - `PersonId` (str): Optional employee number.
-  - `group_ids` (list): Optional list of group IDs.
+- `uuid` (str): User’s unique identifier.
+
+**Usage:**
+
+```python
+unipy.users.deactivate_user("user-123")
+```
+
+#### 3. `unipy.users.activate_user(uuid)`
+Activates a user.
+
+**Parameters:**
+- `uuid` (str): User’s unique identifier.
+
+**Usage:**
+
+```python
+unipy.users.activate_user("user-123")
+```
+
+#### 4. `unipy.users.set_user_group(uuid, group_uuid)`
+Updates the user group assignment.
+
+**Parameters:**
+- `uuid` (str): User’s unique identifier.
+- `group_uuid` (str): Group’s unique identifier.
+
+**Usage:**
+
+```python
+unipy.users.set_user_group("user-123", "group-789")
+```
+
+#### 5. `unipy.users.delete_user(uuid)`
+Deletes a user.
+
+**Parameters:**
+- `uuid` (str): User’s unique identifier.
+
+**Usage:**
+
+```python
+unipy.users.delete_user("user-123")
+```
+
+### Hardware Management
+
+#### 1. `unipy.hardware.get_devices()`
+Fetches a list of hardware devices.
+
+**Usage:**
+
+```python
+devices = unipy.hardware.get_devices()
+```
+
+#### 2. `unipy.hardware.get_device(device_id)`
+Fetches details of a specific device.
+
+**Usage:**
+
+```python
+device = unipy.hardware.get_device("device-123")
+```
+
+#### 3. `unipy.hardware.set_access_method(device_id, enabled_methods)`
+Sets the access methods for a device.
+
+**Usage:**
+
+```python
+unipy.hardware.set_access_method("device-123", ["pin", "nfc"])
+```
+
+#### 4. `unipy.hardware.set_doorbell_trigger(device_id, doorbell_trigger)`
+Sets the doorbell trigger type for a device.
+
+**Usage:**
+
+```python
+unipy.hardware.set_doorbell_trigger("device-123", "tap")
+```
+
+#### 5. `unipy.hardware.set_status_light(device_id, status_light)`
+Sets the status light for a device.
 
 **Usage:**
 
 ```python
-users = [
-    {"first_name": "Jane", "last_name": "Doe", "PersonId": "789", "group_ids": ["group-123"]}
-]
-unifiApi.create_unifi_users(users)
+unipy.hardware.set_status_light("device-123", "on")
 ```
 
-### 3. `deactivate_unifi_users(users)`
-Deactivates users.
+#### 6. `unipy.hardware.set_display_brightness(device_id, brightness)`
+Sets the display brightness for a device.
 
 **Usage:**
 
 ```python
-users = [{"id": "user-123"}]
-unifiApi.deactivate_unifi_users(users)
+unipy.hardware.set_display_brightness("device-123", 50)
 ```
 
-### 4. `activate_unifi_users(users)`
-Activates users.
+#### 7. `unipy.hardware.set_status_sound(device_id, status_sound)`
+Sets the status sound for a device.
 
 **Usage:**
 
 ```python
-users = [{"id": "user-123"}]
-unifiApi.activate_unifi_users(users)
+unipy.hardware.set_status_sound("device-123", 30)
 ```
 
-### 5. `delete_unifi_users(users)`
-Deletes users.
+#### 8. `unipy.hardware.get_device_capabilities(device_id)`
+Fetches the capabilities of a device.
 
 **Usage:**
 
 ```python
-users = [{"id": "user-123"}]
-unifiApi.delete_unifi_users(users)
+capabilities = unipy.hardware.get_device_capabilities("device-123")
 ```
 
-### 6. `set_users_group(users)`
-Updates user group assignments.
+#### 9. `unipy.hardware.get_device_model(device_id)`
+Fetches the model of a device.
 
 **Usage:**
 
 ```python
-users = [{"id": "user-123", "group": "group-456"}]
-unifiApi.set_users_group(users)
+model = unipy.hardware.get_device_model("device-123")
+```
+
+#### 10. `unipy.hardware.restart_device(device_id)`
+Restarts a device.
+
+**Usage:**
+
+```python
+unipy.hardware.restart_device("device-123")
 ```
 
 ## Example Code
@@ -160,31 +274,46 @@ import os
 
 load_dotenv()
 
-unifiApi = UnipyAccess(
+unipy = UnipyAccess(
     base_url=os.getenv('UNIFI_CONTROLLER_ADDRESS'),
     username=os.getenv('UNIFI_LOGIN'),
     password=os.getenv('UNIFI_PASSWORD'),
     verify=os.getenv('VERIFY_SSL')
 )
 
 # Retrieve users
-print(unifiApi.get_unifi_users())
+users = unipy.users.get_users()
+print(users)
 
 # Create a user
-new_user = [{"first_name": "Alice", "last_name": "Smith", "PersonId": "125"}]
-unifiApi.create_unifi_users(new_user)
+new_user = {
+    "first_name": "Alice",
+    "last_name": "Smith",
+    "PersonId": "125"
+}
+unipy.users.create_user(new_user)
 
 # Activate a user
-unifiApi.activate_unifi_users([{"id": "user-123"}])
+unipy.users.activate_user("user-123")
 
 # Deactivate a user
-unifiApi.deactivate_unifi_users([{"id": "user-123"}])
+unipy.users.deactivate_user("user-123")
 
 # Delete a user
-unifiApi.delete_unifi_users([{"id": "user-123"}])
+unipy.users.delete_user("user-123")
 
 # Update user group
-unifiApi.set_users_group([{"id": "user-123", "group": "group-789"}])
+unipy.users.set_user_group("user-123", "group-789")
+
+# Hardware Management
+# Get devices
+devices = unipy.hardware.get_devices()
+print(devices)
+
+# Set device configurations
+unipy.hardware.set_access_method("device-123", ["pin", "nfc"])
+unipy.hardware.set_display_brightness("device-123", 50)
+unipy.hardware.set_status_sound("device-123", "on")
 ```
 
 ## License

unipyAccess/.DS_Store

@@ -1 +1,5 @@
-from .main import UnipyAccess
+from .api_client import UnipyAccess
+
+__all__ = [
+    'UnipyAccess'
+]