AIOAladdinConnect
Python module that allows interacting with Genie Aladdin Connect devices via AIOHttp
Note that shared doors are not currently supported, only doors that are owned by your account can be controlled
As of 1/24/2024 this libarary will be obsolete as Genie/Overhead door is moving to a new api. While most of the interface will work with the new api, the websocket method will be changing to a new pre provided endpoint AND they will be moving to OAUTH authentication. Once things settle, we will attempt to address the changes.
Usage
from AIOAladdinConnect import AladdinConnectClient
# Create session using aladdin connect credentials
client_id = 1000
client_session = aiohttp.ClientSession(timeout = aiohttp.ClientTimeout(total=30))
client = AladdinConnectClient(email, password, client_session, client_id)
await client.login()
# Get list of available doors and their status
doors = await client.get_doors()
my_door = doors[0]
# Issue commands for doors
await client.close_door(my_door['device_id'], my_door['door_number'])
await client.open_door(my_door['device_id'], my_door['door_number'])
# Get door status from internal structure. Must call client.get_doors() to update structure
# Door status also updates on state change from the web socket without calling client.get_doors
await client.async_get_door_status(my_door['device_id'], my_dooregister_callbackr['door_number'])
client.get_door_status(my_door['device_id'], my_door['door_number'])
# Get Doorlink statys from internal structure. Must call client.get_doors() to update structure
await client.async_get_door_link_status(my_door['device_id'], my_door['door_number'])
client.get_door_link_status(my_door['device_id'], my_door['door_number'])
# Get Door Batery status from internal structure. Must call client.get_doors() to update structure
client.get_battery_status(my_door['device_id'], my_door['door_number'])
client.get_rssi_status(my_door['device_id'], my_door['door_number'])
client.get_ble_strength(my_door['device_id'], my_door['door_number'])
ble_strength and battery_status are utilized with the retrofit devices (ALKT1-RB) where the door
position sensor has a BLE connection and battery level reported. Other devices (actual door openers)
tend to report 0 for these values.
Async versions by appending async (example):
await client.async_get_battery_status(my_door['device_id'], my_door['door_number'])
await client.async_get_rssi_status(my_door['device_id'], my_door['door_number'])
await client.aycn_get_ble_strength(my_door['device_id'], my_door['door_number'])
#assign callback for event based status updates:
client.register_callback(your_callback_function)
#Close the sockets at the end of a session:
client.close()
#Get the authtoken after login
token = client.auth_token()
#Set the authtoken if known (can skip login)
client.set_auth_token(token)
1 maintainer
Release files for AIOAladdinConnect 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| AIOAladdinConnect-0.2.0.tar.gz | 7.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| AIOAladdinConnect-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.4 kB
Release files / AIOAladdinConnect-0.2.0.tar.gz
| Download URL | AIOAladdinConnect-0.2.0.tar.gz |
|---|---|
| Size | 7.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6f7f0f1253795694fa0c011f9bc9ff23a59ac69974cfa1e3be0ef3c1ca3667c
|
|
BLAKE2b-256 checksum How to use checksums |
f12a647eb502365eaab8ccf067d32d16131a9529f92b5bd771564fbf5b87aa81
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.18
|
Release files / AIOAladdinConnect-0.2.0-py3-none-any.whl
| Download URL | AIOAladdinConnect-0.2.0-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f95940e133a22b9c80259b87bbf7924db4f7259389966997f643af0473d06e9a
|
|
BLAKE2b-256 checksum How to use checksums |
d6fd93899a642460453042b47d8f4a2af0db829651e4b00b1ab4941b44595710
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.18
|
