This is a very easy API for controlling Somfy Tahoma's devices written in Python3, thanks to the pyoverkiz API. You just need a three-word input to control a device
Project description
tahoma
[UP TO DATE] This is a very easy API for controlling Somfy Tahoma's devices written in Python3, thanks to the pyoverkiz API. You just need a three-word input to control a device. It was created with Tahoma but can also works with Somfy Connectivity Kit, Connexoon, Cozytouch
Install the main package :
Install tahoma :
#########################################
On the next version of Python and Linux you will need to install in this way (using virtual env) :
sudo apt install pipx
pipx install tahoma
To update tahoma to the latest version :
pipx upgrade tahoma
If tahoma has been installed in ~/.local/bin you will need to add this file to the PATH : ~/.local/bin (if it's not already done) :
sudo echo 'export PATH=$PATH:~/.local/bin' >> ~/.bashrc
How to create a PATH on Linux ?
#########################################
Normal way to install on Linux :
sudo python3 -m pip install -U tahoma
!!! It's very important to use the sudo
command because in this way tahoma can store your logins in a safe place
#########################################
For Windows users :
Open a terminal (Powershell) as administrator (Win+X and A) and type this command :
python3 -m pip install -U tahoma
Then search tahoma.exe and add the folder named 'scripts' (which contain tahoma.exe) to the PATH of Windows or simply copy tahoma.exe wherever you want and add the destination folder to the PATH of Windows. How to create a PATH on Windows ?
Configure :
It's very easy to configure, there are just two commands to execute once for all the first time :
All is explained in tahoma --help and tahoma --info
- Specify your Somfy-connect login's info and choose the Somfy server (
sudo
command is only required for Linux users) :
Open a terminal and type :
sudo tahoma --config
orsudo tahoma -c
For Windows users : (Go to the folder of tahoma.exe and open a terminal if tahoma.exe is not in the PATH of Windows) :
.\tahoma -c
or- C:\foler\of\tahoma\tahoma.exe -c
- Configure the API and get the list of your personal Somfy's devices (
sudo
command is also required) :
Open a terminal and type :
sudo tahoma --getlist
orsudo tahoma -g
For Windows users : Go to the folder of tahoma.exe and open a terminal if tahoma.exe is not in the PATH of Windows) :
.\tahoma -g
or- C:\foler\of\tahoma\tahoma.exe -g
- And now, you are ready to use tahoma :
Usage :
tahoma [ACTION] [CATEGORY] [NAME]
For instance : tahoma open shutter kitchen
or tahoma ouvrir volet cuisine
You can also close a shutter or a sunscreen to a specific level. For example, to close to 25%, you can use the commands : tahoma 25 shutter kitchen
or tahoma 25 sunscreen kitchen
. Please note that this feature only works with IO protocols and not with RTS.
You can also run many commands during the same process without restarting tahoma ;
For instance : tahoma arm alarm garden open shutter kitchen close shutter room6 confort heater dining off plug office 25 sunscreen kitchen
But first you need to retrieve your PERSONALS commands :
Get a list of all possibles [ACTIONS] for each [CATEGORIES] :
Open a terminal and type :
tahoma --list-actions
ortahoma -la
or
tahoma --list-actions-french
ortahoma -laf
Get a list of availables [CATEGORIES] :
Open a terminal and type :
tahoma --list-categories
ortahoma -lc
or
tahoma --list-categories-french
ortahoma -lcf
Get the [NAMES] you have given to your personal devices in the Somfy's App :
Open a terminal and type :
tahoma --list-names
ortahoma -ln
or
tahoma --list-names-french
ortahoma -lnf
Enjoy ! For more info tahoma -h
or tahoma -i
Create a PATH to tahoma :
If you have installed tahoma without the sudo
command on Linux you will need to create a PATH for starting tahoma with the tahoma
command.
Indead, to be able to run tahoma directly in the terminal, without going to the source package, you should add the tahoma's folder to the PATH :
On Linux, it can be permanently done by executing : sudo gedit ~/.bashrc
and adding, at the end of the document, this line :
export PATH=$PATH:/place/of/the/folder/tahoma
If you want to temporarily test it before, you can just execute this command in the terminal :
export PATH=$PATH:/place/of/the/folder/tahoma
It will be restored on the next reboot.
By doing this, instead of taping python3 '/place/of/the/folder/tahoma/tahoma.py open shutter kitchen'
,
you will be able to directly tape in the terminal : tahoma open shutter kitchen
.
Then execute tahoma just like this : tahoma arm alarm garden open shutter kitchen close shutter room6 confort heater dining off plug office
and that's all !
For :
Somfy Connectivity Kit Somfy Connexoon IO Somfy Connexoon RTS Somfy TaHoma Somfy TaHoma Beecon Somfy TaHoma Switch Thermor Cozytouch And more...
Supported devices : Alarm Shutter Plug Heater and more if you ask me on github :
- Licence MIT License Copyright (c) 2023 pzim-devdata
Created by @pzim-devdata - feel free to contact me!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.