2.0 #1872
Draft
2.0 #1872
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Bump minimum required Python version to 3.12 * Update CI/CD
…oup for Execution typing (#1864) * Rename scenario to action group * Rename test * Fix docstring formatting in ActionGroup class * Remove unnecessary assertions in ActionGroup initialization
…methods. (#1862) - `client.execute_command()` and `client.execute_commands()` are replaced by `client.execute_action_group()` - `client.execute_action_group()` now supports multiple execution modes (high priority, internal, geolocated) - `client.execute_action_group()` now supports multiple device actions in the same request The current execution methods are poorly typed and do not support concurrent execution across multiple devices, which makes it impossible to properly work around TooManyExecutionsException and TooManyConcurrentRequestsException. The main change is the move from `client.execute_command()` and `client.execute_commands()` to a single `client.execute_action_group()`. An action group takes a list of actions, each of which can include multiple device actions, including multiple commands per action. ```python3 await client.execute_action_group( actions=[ Action( device_url="io://1234-5678-1234/12345678", commands=[ Command(name="down"), Command(name="refresh") ] ) ], label="Execution via Home Assistant" ) ``` New (mode) options like high priority will be possible now: ```python3 await client.execute_action_group( actions=[ Action( device_url="io://1234-5678-1234/12345678", commands=[ Command(name=OverkizCommand.SET_CLOSURE, parameters=[0]) ] ) ], label="Execution via Home Assistant", mode=CommandMode.HIGH_PRIORITY ) ``` This could serve as a foundation for grouping commands that are executed within a short time window, for example when triggered by a scene or automation in Home Assistant. Requests issued close together could be batched and sent as a single action group, reducing the impact of current Overkiz limitations. The open question is where this queue should live: inside this integration itself, or as part of the Home Assistant core implementation. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ial classes (#1867) - Introduced UsernamePasswordCredentials and LocalTokenCredentials for better credential management. - Updated OverkizClient to utilize the new credential classes and refactored login logic. - Added authentication strategies for various servers, including Somfy and Rexel. - Created new modules for auth strategies and credentials to improve code organization. - Enhanced README with updated usage examples for the new authentication methods. - `OverkizServer` class is renamed to `ServerConfig` and has additional `server` and `type` (cloud/local) property - `generate_local_server` is renamed to `create_local_server_config` - `client.api_type` is removed and now available via `ServerConfig` (e.g. `client.server_config.type`) - The `OverkizClient` constructor now requires passing a `ServerConfig` via `server` - The `OverkizClient` constructur now requires passing an `Credentials` class via `credentials`, e.g. `UsernamePasswordCredentials(USERNAME, PASSWORD)` for most server. - The OverkizClient constructor now supports passing a Server enum directly, such as `OverkizClient(server=Server.SOMFY_EUROPE, ...)`. --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>
## Enhancement - Publish detailed developer documentation via GitHub Pages [imicknl.github.io/python-overkiz-api](https://imicknl.github.io/python-overkiz-api/). Fixes #190, #1522
…ty (#1917) Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Fixes #1865 --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: iMicknl <1424596+iMicknl@users.noreply.github.com>
# API Documentation Changelog ## Overview This document details all changes made to `docs/api/index.html` in the v2/apiDocs branch compared to v2/main. --- ## 1. Library and Resource Updates ### jQuery Library Versions - **Old**: `jquery-1.10.2.js` and `jquery-1.10.2-ui.js` - **New**: `jquery.min.js` and `jquery-ui.min.js` - **Impact**: Updated to minified versions for better performance ### Stylesheet and Resource Links - Normalized self-closing tags: `/>` → `>` - Updated HTTP charset: `utf-8` → `windows-1252` (in meta tag) --- ## 2. HTML Formatting and Encoding Changes ### HTML Entity Encoding All HTML entity-encoded quotes converted to literal quotes throughout JSON examples: - `"` → `"` - Applied consistently across all JSON sample values in the documentation ### Self-Closing Tag Normalization - `<br/>` → `<br>` - `<link ... />` → `<link ... >` - Applied to all HTML elements in the documentation ### Table Structure - Added `<tbody>` tags to all table elements for proper HTML structure - Added `style="display: none;"` attributes to hidden rows for cleaner display --- ## 3. API Test Links ### URL Updates All test operation links now use absolute URLs instead of relative paths: - **Old**: `href="doc/test/[hash]"` - **New**: `href="https://ha101-1.overkiz.com/enduser-mobile-web/enduserAPI/doc/test/[hash]"` ### Affected Operations Applied to all API operations that include test links: - Create action group - Update action group - Delete action group - Get action groups - Execute action group - And all other endpoints with test functionality --- ## 4. Access Scope Information ### New Access Scope Blocks Added `<pre class="scoped">Access scope : ...</pre>` blocks to API operations: - Full enduser API access (enduser/*) - Enduser Open API (enduser/o) - Applied to all applicable API endpoints ### Example ```html <pre class="scoped">Access scope : Full enduser API access (enduser/*)</pre> ``` --- ## 5. Sample JSON and Default Values ### Action Group Examples #### shortcut Field - **Old**: `"shortcut" : false` - **New**: `"shortcut" : true` #### notificationCondition Field - **Old**: `"notificationCondition" : "ALWAYS"` - **New**: `"notificationCondition" : "ON_SUCCESS"` #### New Field: lockLevel - **Added**: `"lockLevel" : 5` to command parameters - **Location**: Command examples within action groups ### Example Before: ```json { "shortcut" : false, "notificationCondition" : "ALWAYS", "commands" : [ { "delay" : 1 } ] } ``` ### Example After: ```json { "shortcut" : true, "notificationCondition" : "ON_SUCCESS", "commands" : [ { "delay" : 1, "lockLevel" : 5 } ] } ``` --- ## 6. Event Information Updates ### Event Descriptions and Reordering #### GatewaySynchronizationStartedEvent - **Added Fields**: - `"owningPartner" : "an owning partner"` - `"gatewayId" : "A gateway id (ex: 0101-1234-5678)"` #### GatewaySynchronizationEndedEvent - **Added Fields**: - `"owningPartner" : "an owning partner"` - `"gatewayId" : "A gateway id (ex: 0101-1234-5678)"` #### ActionGroupCreatedEvent - **Reordered**: Event appears later in documentation (moved after GatewaySynchronizationStartedEvent) - **Added Fields**: - `"owningPartners" : [ "some owning partners" ]` - **Modified Structure**: Updated JSON example to reflect current API response format #### ActionGroupUpdatedEvent - **New Event**: Added to documentation - **Fields Include**: - `"owningPartners" : [ "some owning partners" ]` - Full action group structure with metadata #### ActionGroupDeletedEvent - **New Event**: Added to documentation - **Fields Include**: - `"owningPartners" : [ "some owning partners" ]` - `"actionGroupOID"` - `"setupOID"` #### ExecutionStateChangedEvent - **Enhanced Fields**: - Added `"owningPartners" : [ "some owning partners" ]` - Added `"failedCommands"` array with detailed error information - Added `"failureTypeCode"` and `"failureType"` fields #### DeviceStateChangedEvent - **Enhanced Fields**: - Added `"owningPartners" : [ "some owning partners" ]` - Updated device state change structure --- ## 7. API Response Examples Updates ### Action Group Response Structure #### Enhanced Fields - **creationTime**: `"creationTime" : 1769503155441` (timestamp added) - **lastUpdateTime**: `"lastUpdateTime" : 1769503155441` (timestamp added) - **lockLevel**: `"lockLevel" : 5` (now included in command examples) ### Execution Response Structure - Updated to include complete execution details - Added fields: `startTime`, `owner`, `actionGroup`, `description`, `executionType`, `executionSubType` --- ## 8. Rate Limiting Information ### Updated Rate Limit Blocks Rate limiting sections now include more detailed information: - Per-session rate limits with specific time periods - Categorized limits (e.g., "bulk-load", "exec") ### Example ```html <pre class="rateLimited">Per-session rate-limit : 1 calls per 1d period for this particular operation (bulk-load)</pre> ``` --- ## 9. Parameter Updates ### New Request Parameters - **preventLockLevelReset**: Added to action group update operations - Type: Boolean (default false) - Description: "Do not reset command lock levels" ### Enhanced Parameter Descriptions - Descriptions now wrapped in `<pre>` tags for consistency - Added optional parameter indicators - More detailed documentation of parameter purposes --- ## 10. Event Field Documentation ### New Event Fields Documented #### owningPartner (singular) - **Type**: String - **Description**: "Owning partner of the parent entity (gateway, setup group, ...)) . only available in event streams" - **Applied to**: GatewaySynchronizationStartedEvent, GatewaySynchronizationEndedEvent #### owningPartners (plural) - **Type**: Array of Strings - **Description**: "Owning partners of the parent entity (setup, ...)) . only available in event streams" - **Applied to**: ActionGroupCreatedEvent, ActionGroupUpdatedEvent, ActionGroupDeletedEvent, ExecutionStateChangedEvent, DeviceStateChangedEvent #### gatewayId - **Type**: String - **Description**: "A gateway id (ex: 0101-1234-5678)" - **Applied to**: Gateway-related events --- ## 11. Content Organization Changes ### Event Reordering Events are now organized in a different order within the documentation: 1. **Create Action Group Operation**: - GatewaySynchronizationStartedEvent (moved first) - ActionGroupCreatedEvent - GatewaySynchronizationEndedEvent 2. **Update Action Group Operation**: - GatewaySynchronizationStartedEvent - GatewaySynchronizationEndedEvent - ActionGroupUpdatedEvent 3. **Delete Action Group Operation**: - GatewaySynchronizationEndedEvent - GatewaySynchronizationStartedEvent - ActionGroupDeletedEvent --- ## 12. Trigger and Execution Documentation ### Delayed Execution Events - Enhanced documentation for `DelayedTriggerSetEvent` - Enhanced documentation for `DelayedTriggerCancelledEvent` - Clearer execution type descriptions ### Weekly Planning - Updated examples for weekly planning triggers - Time-based trigger documentation - Dawn/dusk trigger clarification --- ## 13. Country Data Updates ### New Country Support - **Country**: South Korea - **Code**: KR - Added to all supported countries lists in location-related API operations --- ## Summary of Changes | Category | Change Type | Count | |----------|------------|-------| | Library Updates | Version upgrades | 2 | | HTML Encoding | Entity encoding → literal | ~500+ | | Self-closing Tags | Normalization | ~200+ | | Test Links | URL updates | ~100+ | | Access Scopes | Added blocks | ~50+ | | Event Fields | New fields | 15+ | | Event Events | New/reordered | 10+ | | Sample Values | Updated defaults | 10+ | | Parameters | New parameters | 5+ | | Countries | New entries | 1+ | --- ## Impact Assessment ### For API Users - ✅ Test links now direct to full absolute URLs - ✅ Better documentation of event ownership and access scopes - ✅ New fields provide more context (owningPartner/owningPartners) - ✅ Enhanced error information in ExecutionStateChangedEvent ### For HTML/Browser Rendering - ✅ Proper `<tbody>` tags improve semantic HTML - ✅ Literal quote characters instead of entities improve readability - ✅ Updated jQuery libraries (minified versions) improve performance ### For Backwards Compatibility -⚠️ New event fields should be treated as additions (not breaking) -⚠️ New parameter `preventLockLevelReset` is optional -⚠️ Sample JSON default values changed (may affect test/mock implementations) --- ## Notes for Reviewers When reviewing this file in GitHub: 1. **Use whitespace filtering**: Enable "Hide whitespace" in the diff viewer 2. **Focus on**: - Event field additions and reordering - Sample JSON value changes - New access scope information - Test link URL updates 3. **Skip reviewing**: HTML entity encoding, self-closing tags, and formatting changes (they don't affect functionality) --- Generated: January 27, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking changes
client.get_scenarios()is replaced byclient.get_action_groups()(Rename Scenario to ActionGroup (and relevant methods), reuse ActionGroup for Execution typing #1864)Scenario()model is replaced byActionGroup(), wherecreation_timeandmetadata` are now optional fields (Rename Scenario to ActionGroup (and relevant methods), reuse ActionGroup for Execution typing #1864)client.execute_command()andclient.execute_commands()are replaced byclient.execute_action_group()Addexecute_action_groupmethod and remove other command execution methods. #1862OverkizServerclass is renamed toServerConfigand has additionalserverandtype(cloud/local) property Refactor authentication handling in OverkizClient and add new credential classes #1867generate_local_serveris renamed tocreate_local_server_configRefactor authentication handling in OverkizClient and add new credential classes #1867client.api_typeis removed and now available viaServerConfig(e.g.client.server_config.type) Refactor authentication handling in OverkizClient and add new credential classes #1867OverkizClientconstructor now requires passing aServerConfigviaserverRefactor authentication handling in OverkizClient and add new credential classes #1867OverkizClientconstructur now requires passing anCredentialsclass viacredentials, e.g.UsernamePasswordCredentials(USERNAME, PASSWORD)for most server. Refactor authentication handling in OverkizClient and add new credential classes #1867Fixes
client.get_current_executions()is now properly typed, previously theExecution()model returned a list type foraction_group, what should be a dict type. (Rename Scenario to ActionGroup (and relevant methods), reuse ActionGroup for Execution typing #1864)Features
client.execute_action_group()now supports multiple execution modes (high priority, internal, geolocated) Addexecute_action_groupmethod and remove other command execution methods. #1862client.execute_action_group()now supports multiple device actions in the same request Addexecute_action_groupmethod and remove other command execution methods. #1862OverkizClient(server=Server.SOMFY_EUROPE, ...). Refactor authentication handling in OverkizClient and add new credential classes #1867Docs