kiosker-python-api 1.2.4__tar.gz → 1.2.6__tar.gz

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kiosker-python-api
-Version: 1.2.4
+Version: 1.2.6
 Summary: A python wrapper for the Kiosker API
 Project-URL: Homepage, https://kiosker.io
 Project-URL: Documentation, https://docs.kiosker.io
@@ -16,7 +16,18 @@ Requires-Dist: pytest; extra == 'test'
 Description-Content-Type: text/markdown
 
 # Python wrapper for Kiosker API
-Python wrapper for Kiosker API-integration.
+
+This Python library provides a comprehensive wrapper for the Kiosker API, enabling developers to programmatically control and manage Kiosker devices. Kiosker is a professional web kiosk application for iOS that transforms iPads into secure, full-screen web browsers perfect for public displays, interactive kiosks, and digital signage solutions.
+
+The kiosker-python-api package allows you to:
+- **Remote Control**: Navigate web pages, refresh content, and control browser functions
+- **Device Management**: Monitor device status, battery levels, and system information
+- **Content Control**: Manage blackout screens for maintenance or emergency messaging
+- **Screen Management**: Control screensaver behavior
+- **System Maintenance**: Clear cookies, cache, and perform system operations
+- **Network Discovery**: Automatically discover Kiosker devices on your network using ZeroConf
+
+Whether you're managing a single kiosk or deploying a fleet of devices across multiple locations, this library provides the tools needed to integrate Kiosker devices into your existing infrastructure and workflows.
 
 ---
 
@@ -31,7 +42,7 @@ pip install kiosker-python-api
 ### Setup
 
 ```python
-KioskerAPI(host, token, port = 8081, ssl = False)
+KioskerAPI(host, token, port = 8081, ssl = False, verify = False)
 ```
 
 ```python
@@ -40,6 +51,29 @@ from kiosker import Status, Result, Blackout, ScreensaverState
 api = KioskerAPI('10.0.1.100', 'token')
 ```
 
+#### Constructor Parameters
+
+- **host** (str): IP address or hostname of the Kiosker device
+- **token** (str): Authentication token for API access
+- **port** (int, optional): Port number (default: 8081)
+- **ssl** (bool, optional): Use HTTPS instead of HTTP (default: False)
+- **verify** (bool | ssl.SSLContext, optional): SSL certificate verification. Set to False to disable SSL verification for self-signed certificates (default: False)
+
+---
+
+### Device Discovery with ZeroConf
+
+Kiosker devices advertise themselves on the local network using ZeroConf (Bonjour/mDNS) autodiscovery. This allows you to automatically discover Kiosker devices without needing to know their IP addresses beforehand.
+
+#### Service Information
+
+Kiosker devices broadcast the following service:
+- **Service Type**: `_kiosker._tcp`
+- **TXT Records**:
+  - `version`: App version (e.g., "25.1.0 (230)")
+  - `app`: App name (e.g., "Kiosker Pro")
+  - `uuid`: Unique device identifier (e.g., "2904C1F2-93FB-4954-BF85-FAAEFBA814F6")
+
 ---
 
 ### Functions
@@ -134,7 +168,7 @@ print(f"Screensaver interaction result: {result}")
 
 #### Set Screensaver State
 ```python
-result = api.screensaver_set_state(disabled=True)
+result = api.screensaver_set_disabled_state(disabled=True)
 print(f"Screensaver disabled: {result}")
 ```
 **Description**: Enables or disables the screensaver.
@@ -194,6 +228,8 @@ Represents the current status of the kiosk.
 - `battery_state` (str): Current battery state (e.g., charging, discharging).
 - `model` (str): Device model.
 - `os_version` (str): Operating system version.
+- `app_name` (str): Name of the currently running app.
+- `app_version` (str): Version of the currently running app.
 - `last_interaction` (datetime): Timestamp of the last user interaction.
 - `last_motion` (Optional[datetime]): Timestamp of the last detected motion.
 - `last_update` (datetime): Timestamp of the last status update.
@@ -265,7 +301,7 @@ python -m build
 twine upload --repository testpypi dist/*
 ```
 
-7. Upload to prod
+8. Upload to prod
 ```shell
 twine upload dist/*
 ```

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/README.md

@@ -1,5 +1,16 @@
 # Python wrapper for Kiosker API
-Python wrapper for Kiosker API-integration.
+
+This Python library provides a comprehensive wrapper for the Kiosker API, enabling developers to programmatically control and manage Kiosker devices. Kiosker is a professional web kiosk application for iOS that transforms iPads into secure, full-screen web browsers perfect for public displays, interactive kiosks, and digital signage solutions.
+
+The kiosker-python-api package allows you to:
+- **Remote Control**: Navigate web pages, refresh content, and control browser functions
+- **Device Management**: Monitor device status, battery levels, and system information
+- **Content Control**: Manage blackout screens for maintenance or emergency messaging
+- **Screen Management**: Control screensaver behavior
+- **System Maintenance**: Clear cookies, cache, and perform system operations
+- **Network Discovery**: Automatically discover Kiosker devices on your network using ZeroConf
+
+Whether you're managing a single kiosk or deploying a fleet of devices across multiple locations, this library provides the tools needed to integrate Kiosker devices into your existing infrastructure and workflows.
 
 ---
 
@@ -14,7 +25,7 @@ pip install kiosker-python-api
 ### Setup
 
 ```python
-KioskerAPI(host, token, port = 8081, ssl = False)
+KioskerAPI(host, token, port = 8081, ssl = False, verify = False)
 ```
 
 ```python
@@ -23,6 +34,29 @@ from kiosker import Status, Result, Blackout, ScreensaverState
 api = KioskerAPI('10.0.1.100', 'token')
 ```
 
+#### Constructor Parameters
+
+- **host** (str): IP address or hostname of the Kiosker device
+- **token** (str): Authentication token for API access
+- **port** (int, optional): Port number (default: 8081)
+- **ssl** (bool, optional): Use HTTPS instead of HTTP (default: False)
+- **verify** (bool | ssl.SSLContext, optional): SSL certificate verification. Set to False to disable SSL verification for self-signed certificates (default: False)
+
+---
+
+### Device Discovery with ZeroConf
+
+Kiosker devices advertise themselves on the local network using ZeroConf (Bonjour/mDNS) autodiscovery. This allows you to automatically discover Kiosker devices without needing to know their IP addresses beforehand.
+
+#### Service Information
+
+Kiosker devices broadcast the following service:
+- **Service Type**: `_kiosker._tcp`
+- **TXT Records**:
+  - `version`: App version (e.g., "25.1.0 (230)")
+  - `app`: App name (e.g., "Kiosker Pro")
+  - `uuid`: Unique device identifier (e.g., "2904C1F2-93FB-4954-BF85-FAAEFBA814F6")
+
 ---
 
 ### Functions
@@ -117,7 +151,7 @@ print(f"Screensaver interaction result: {result}")
 
 #### Set Screensaver State
 ```python
-result = api.screensaver_set_state(disabled=True)
+result = api.screensaver_set_disabled_state(disabled=True)
 print(f"Screensaver disabled: {result}")
 ```
 **Description**: Enables or disables the screensaver.
@@ -177,6 +211,8 @@ Represents the current status of the kiosk.
 - `battery_state` (str): Current battery state (e.g., charging, discharging).
 - `model` (str): Device model.
 - `os_version` (str): Operating system version.
+- `app_name` (str): Name of the currently running app.
+- `app_version` (str): Version of the currently running app.
 - `last_interaction` (datetime): Timestamp of the last user interaction.
 - `last_motion` (Optional[datetime]): Timestamp of the last detected motion.
 - `last_update` (datetime): Timestamp of the last status update.
@@ -248,7 +284,7 @@ python -m build
 twine upload --repository testpypi dist/*
 ```
 
-7. Upload to prod
+8. Upload to prod
 ```shell
 twine upload dist/*
 ```

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/kiosker/api.py

@@ -1,10 +1,11 @@
+import ssl
 import httpx
 from .data import Status, Result, Blackout, ScreensaverState
 
 API_PATH = '/api/v1'
 
 class KioskerAPI:
-    def __init__(self, host, token, port=8081, ssl=False):
+    def __init__(self, host, token, port=8081, ssl=False, verify: bool | ssl.SSLContext =False):
         if ssl:
             self.conf_host = f'https://{host}:{port}'
         else:
@@ -13,8 +14,10 @@ class KioskerAPI:
         self.conf_headers = {'accept': 'application/json',
                              'Authorization': f'Bearer {token}'}
         
+        self.verify = verify
+        
     def _get(self, path: str):
-        r = httpx.get(f'{self.conf_host}{API_PATH}{path}', headers=self.conf_headers)
+        r = httpx.get(f'{self.conf_host}{API_PATH}{path}', headers=self.conf_headers, verify=self.verify)
         if r.status_code == 200:
             return r.json()
         elif r.status_code == 401:
@@ -27,7 +30,7 @@ class KioskerAPI:
     def _post(self, path: str, json=None):
         if json is None:
             json = {}
-        r = httpx.post(f'{self.conf_host}{API_PATH}{path}', headers=self.conf_headers, json=json)
+        r = httpx.post(f'{self.conf_host}{API_PATH}{path}', headers=self.conf_headers, json=json, verify=self.verify)
         if r.status_code == 200:
             return r.json()
         elif r.status_code == 401:

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/kiosker/data.py

@@ -14,10 +14,11 @@ class Status:
     last_update: datetime
     device_id: str
     last_motion: Optional[datetime]
+    ambient_light: Optional[float]
     
     @classmethod
     def from_dict(cls, status_data):
-        return cls(battery_level=status_data['batteryLevel'], battery_state=status_data['batteryState'], model=status_data['model'], os_version=status_data['osVersion'], app_name=status_data['appName'], app_version=status_data['appVersion'], last_interaction=datetime.fromisoformat(status_data['lastInteraction']), last_motion=datetime.fromisoformat(status_data['lastMotion']) if status_data.get('lastMotion') else None, last_update=datetime.fromisoformat(status_data['date']), device_id=status_data['deviceId'])
+        return cls(battery_level=status_data['batteryLevel'], battery_state=status_data['batteryState'], model=status_data['model'], os_version=status_data['osVersion'], app_name=status_data['appName'], app_version=status_data['appVersion'], last_interaction=datetime.fromisoformat(status_data['lastInteraction']), last_motion=datetime.fromisoformat(status_data['lastMotion']) if status_data.get('lastMotion') else None, last_update=datetime.fromisoformat(status_data['date']), device_id=status_data['deviceId'], ambient_light=status_data['ambientLight'] if status_data.get('ambientLight') else None)
 
 @dataclass
 class Result:

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "kiosker-python-api"
 readme = "README.md"
-version = "1.2.4"
+version = "1.2.6"
 license = "MIT"
 description = "A python wrapper for the Kiosker API"
 keywords = ["kiosk", "kiosker", "api", "kiosker pro"]

{kiosker_python_api-1.2.4 → kiosker_python_api-1.2.6}/tests/test_api.py

@@ -4,10 +4,12 @@ import os
 
 host = os.environ["HOST"]
 token = os.environ["TOKEN"]
+ssl = os.environ.get("SSL", "false").lower() in ("true", "1", "yes", "on")
+verify = os.environ.get("VERIFY", "false").lower() in ("true", "1", "yes", "on")
 
+api = KioskerAPI(host, token, ssl=ssl, verify=verify)
 
 def test_ping():
-    api = KioskerAPI(host, token)
 
     result = api.ping()
     
@@ -16,8 +18,6 @@ def test_ping():
 
 def test_status():
     
-    api = KioskerAPI(host, token)
-
     status = api.status()
     
     print('Status:')
@@ -28,16 +28,16 @@ def test_status():
     print(f'Battery state: {status.battery_state}')
     print(f'Last interaction: {status.last_interaction}')
     print(f'Last motion: {status.last_motion}')
+    print(f'Ambient light: {status.ambient_light}')
     print(f'Last status update: {status.last_update}')
     print(f'App name: {status.app_name}')
     print(f'App version: {status.app_version}')
+    
 
     assert api.ping() == True
-    
+
 def test_navigate():
     
-    api = KioskerAPI(host, token)
-
     print('Navigating to URL...')
     result = api.navigate_url('https://google.com')
     print(f'Navigate URL: {result}')
@@ -70,8 +70,6 @@ def test_navigate():
 
 def test_print():
     
-    api = KioskerAPI(host, token)
-
     print('Printing...')
     result = api.print()
     print(f'Print: {result}')
@@ -80,8 +78,6 @@ def test_print():
     
 def test_clear():
     
-    api = KioskerAPI(host, token)
-
     print('Clearing cookies...')
     result = api.clear_cookies()
     print(f'Clear cookies: {result}')
@@ -96,8 +92,6 @@ def test_clear():
 
 def test_screensaver():
     
-    api = KioskerAPI(host, token)
-
     print('Interacting with screensaver...')
     result = api.screensaver_interact()
     print(f'Screensaver interact: {result}')
@@ -133,9 +127,7 @@ def test_screensaver():
     print(f'Screensaver state: {state}')
         
 def test_blackout():
-    
-    api = KioskerAPI(host, token)
-    
+        
     print(f'Blackout state: {api.blackout_get()}')
     
     api.blackout_set(Blackout(visible=True, text='This is a test from Python that should clear', background='#000000', foreground='#FFFFFF', icon='ladybug', expire=20))
@@ -166,4 +158,4 @@ def test_blackout():
     
     api.blackout_set(Blackout(visible=True, text='This is a test from Python that is dismissible', background='#000000', foreground='#FFFFFF', icon='hand.point.up', expire=25, dismissible=True, buttonBackground='#FA0000', buttonForeground='#FFFFFF', buttonText='Hide me then...', sound="1003"))
     
-    time.sleep(5)
+    time.sleep(5)