Package: gotailwind
Python: Asynchronous client for Tailwind garage door openersAsynchronous Python client for Tailwind garage door openers.AboutThis package allows you to control and monitorTailwind devicesprogrammatically. It is mainly created to allow third-party programs to
automate the behavior of a Tailwind device.Additionally, this package contains a CLI tool, which can be used standalone,
proving a command-line interface to control and monitor Tailwind devices.Known compatible and tested Tailwind devices:Tailwind iQ3[!IMPORTANT]
This library requires your Tailwind device to run at least firmware version v10.10.For the development of this package, the hardware was kindly sponsored
and provided byTailwind; thank you! ❤️InstallationpipinstallgotailwindIn case you want to use the CLI tools, install the package with the following
extra:pipinstallgotailwind[cli]CLI usageThe tailwind CLI tool provided in this library provides all the functionalities
this library provides but from the command line.The CLI comes with built-in help, which can be accessed by using the--helptailwind--helpTo scan for Tailwind devices on your network:tailwindscanTo get the status of a device:tailwindstatus--host192.168.1.123To open a door:tailwindopen--host192.168.1.123For more details, access the built-in help of the CLI using the--helpflag.Python usageUsing this library in Python:importasynciofromgotailwindimportTailwind,TailwindDoorOperationCommand,TailwindDoorStateasyncdefmain()->None:"""Show example of programmatically control a Tailwind garage door."""asyncwithTailwind(host="192.168.1.123",token="123456")astailwind:# Get the device statusstatus=awaittailwind.status()# Print some informationprint(f"Device ID:{status.device_id}")print(f"Number of doors:{status.number_of_doors}")# Get the door object for the first doordoor=awaittailwind.door_status(door=0)# Print current door statusprint(f"Door 1 is currently:{door.state}")# Change the doorifdoor.state==TailwindDoorState.OPEN:door=awaittailwind.operate(door=0,operation=TailwindDoorOperationCommand.CLOSE)else:door=awaittailwind.operate(door=0,operation=TailwindDoorOperationCommand.OPEN)# Print current door statusprint(f"Door 1 is now:{door.state}")if__name__=="__main__":asyncio.run(main())Changelog & releasesThis repository keeps a change log usingGitHub's releasesfunctionality. The format of the log is based onKeep a Changelog.Releases are based onSemantic Versioning, and use the format
ofMAJOR.MINOR.PATCH. In a nutshell, the version will be incremented
based on the following:MAJOR: Incompatible or major changes.MINOR: Backwards-compatible new features and enhancements.PATCH: Backwards-compatible bugfixes and package updates.ContributingThis is an active open-source project. We are always open to people who want to
use the code or contribute to it.We've set up a separate document for ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up a development environmentThe easiest way to start is by opening a CodeSpace here on GitHub, or by using
theDev Containerfeature of Visual Studio Code.This Python project is fully managed using thePoetrydependency manager. But also relies on the use of NodeJS for certain checks during development.You need at least:Python 3.11+PoetryNodeJS 20+ (including NPM)To install all packages, including all development requirements:npminstall
poetryinstall--extrascliAs this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestAuthors & contributorsThe original setup of this repository is byFranck Nijhof.For a full list of all authors and contributors,
checkthe contributor's page.LicenseMIT LicenseCopyright (c) 2023 Franck NijhofPermission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.