Lower connection-timeout for actual devices after initial connect

bouwew commented 4 months ago

Summary by CodeRabbit

New Features
- Introduced a new constant for legacy timeout settings to enhance connection handling for legacy devices.
Bug Fixes
- Adjusted default timeout values to improve connection reliability and performance.
Documentation
- Updated version in pyproject.toml to 0.38.2.
Tests
- Added assertions for timeout settings in device tests to ensure correct behavior.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates primarily address timeout configurations across the plugwise package. A new constant DEFAULT_LEGACY_TIMEOUT was introduced, and timeout values were adjusted for legacy and non-legacy devices. Additionally, the version in pyproject.toml was updated from "0.38.1" to "0.38.2". These changes ensure better handling of connection timeouts, especially for legacy devices, improving overall stability.

Changes

File	Change Summary
`plugwise/__init__.py`	Updated default timeout values and adjusted timeout parameters in methods.
`plugwise/constants.py`	Modified `DEFAULT_TIMEOUT` and added `DEFAULT_LEGACY_TIMEOUT`.
`plugwise/legacy/smile.py`	Added `timeout` parameter to the `Smile` class constructor.
`plugwise/smile.py`	Removed `DEFAULT_TIMEOUT` and added `timeout` parameter to the constructor.
`tests/test_init.py`	Added assertions for `_timeout` attribute in `device_test` function.
`CHANGELOG.md`	Documented the reduction of connection timeout for devices post-initial connection.
`pyproject.toml` (existing)	Updated version from "0.38.1" to "0.38.2a0".
`pyproject.toml` (new)	Updated version from "0.38.1" to "0.38.2".

Poem

In the realm of code so bright, Timeouts adjusted, just right. Legacy devices now breathe with ease, As connections flow like a breeze. Version numbers climb anew, With changes that enhance the view. Plugwise dances in the light, Stability in every byte! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (dba5d57) to head (773b296).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #576 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 20 20 Lines 3309 3316 +7 ========================================= + Hits 3309 3316 +7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.