Metadata-Version: 2.1
Name: axaremote
Version: 0.0.6
Summary: Library to control AXA Remote window openers.
Author: Rogier van Staveren
License: Apache-2.0
Project-URL: Homepage, https://github.com/rrooggiieerr/axaremote.py
Project-URL: Bug Tracker, https://github.com/rrooggiieerr/axaremote.py/issues
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyserial>=3.4
Requires-Dist: telnetlib3>=2.0.4

# Python library to control AXA Remote window openers.
Python library to control AXA Remote window openers over the serial
interface or serial to network bridges like [esp-link](https://github.com/jeelabs/esp-link).

## Hardware
If you power the AXA Remote using batteries you can connect the Serial 3.3 or
5 Volts to position 1 or 6 of the RJ25 connector, ground to position 2 or 5 of
the RJ25 connector and RX/TX to position 3 or 4. 
 
If you power the AXA Remote with the additional external power supply you can
use a LIN-bus controller to act as a level converter.

## Protocol
This are the protocol details:  
19200 baud 8N2  
Device command: `\r\nDEVICE\r\n`  
Version command: `\r\nVERSION\r\n`  
Status command: `\r\nSTATUS\r\n`  
Open command: `\r\nOPEN\r\n`  
Stop command: `\r\nSTOP\r\n`  
Close command: `\r\nCLOSE\r\n`

## Installation
You can install the Python AXA Remote library using the Python package manager
PIP:  
`pip3 install axaremote`

## axaremote CLI
You can use the Python AXA Remote library directly from the command line to
open, stop or close your window using the following syntax:

Status of the window: `python3 -m axaremote serial <serial port> status`  
Open the window: `python3 -m axaremote serial <serial port> open`  
Stop the window: `python3 -m axaremote serial <serial port> stop`  
Close the window: `python3 -m axaremote serial <serial port> close`

Or if your projector is connected using a serial to network bridge:

Status of the window: `python3 -m axaremote telnet <host> <port> status`  
Open the window: `python3 -m axaremote telnet <host> <port> open`  
Stop the window: `python3 -m axaremote telnet <host> <port> stop`  
Close the window: `python3 -m axaremote telnet <host> <port> close`

If you add the argument `--wait` to the open or close command the process will
wait till the window is open/close and show the progress.

## Support my work

Do you enjoy using this Python library? Then consider supporting my work:  
[<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" >](https://www.buymeacoffee.com/rrooggiieerr)  
