idasen
######
|PyPi Version| |Build Status| |Documentation Status| |Black|
The IDÅSEN is an electric sitting standing desk with a Linak controller sold by
ikea.
The position of the desk can controlled by a physical switch on the desk or
via bluetooth using an phone app.
This is a command line interface written in python to control the Idasen via
bluetooth from a desktop computer.
Set Up
******
Prerequisites
=============
The desk should be connected to the computer.
Install
=======
.. code-block:: bash
python3 -m pip install --upgrade idasen
Configuration
*************
Configuration that is not expected to change frequently can be provided via a
YAML configuration file located at ``~/.config/idasen/idasen.yaml``.
You can use this command to initialize a new configuartion file:
.. code-block:: bash
idasen init
.. code-block:: yaml
mac_address: AA:AA:AA:AA:AA:AA
positions:
sit: 0.75
stand: 1.1
Configuartion options:
* ``mac_address`` - The MAC address of the desk. This is required.
* ``positions`` - A dictionary of positions with values of desk height from the
floor in meters, ``sit`` and ``stand`` are provided as examples.
The program will try to discover the device address. The device needs to be in
'discover' mode for this to work.
If discovery fails the device MAC addresses can be found using ``blueoothctl``
and bluetooth adapter names can be found with ``hcitool dev`` on linux.
If the device has not yet been paired, this can be accomplished with:
.. code-block:: bash
idasen pair
Again, the device will need to be in 'discover' mode for this to work.
Usage
*****
Command Line
============
To print the current desk height:
.. code-block:: bash
idasen height
To monitor for changes to height:
.. code-block:: bash
idasen monitor
To save the current height as the sitting position:
.. code-block:: bash
idasen save sit
To delete the saved sitting position:
.. code-block:: bash
idasen delete sit
Assuming the config file is populated to move the desk to sitting position:
.. code-block:: bash
idasen sit
Community
*********
Related projects and packaging:
* `Arch Linux package`_
* `NixOS package`_
* `huserben/idasen-rest-bridge`_
* Repository this was forked from: `rhyst/idasen-controller`_
.. _poetry: https://python-poetry.org/
.. _install poetry: https://python-poetry.org/docs/#installation
.. _rhyst/idasen-controller: https://github.com/rhyst/idasen-controller
.. _NixOS package: https://search.nixos.org/packages?channel=unstable&show=idasen&query=idasen
.. _Arch Linux package: https://aur.archlinux.org/packages/idasen
.. _huserben/idasen-rest-bridge: https://github.com/huserben/idasen-rest-bridge
.. |PyPi Version| image:: https://badge.fury.io/py/idasen.svg
:target: https://badge.fury.io/py/idasen
.. |Build Status| image:: https://github.com/newAM/idasen/workflows/Tests/badge.svg
:target: https://github.com/newAM/idasen/actions
.. |Documentation Status| image:: https://img.shields.io/badge/docs-latest-blue
:target: https://newam.github.io/idasen
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
Raw data
{
"_id": null,
"home_page": "https://github.com/newAM/idasen",
"name": "idasen",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "ikea,idasen,bluetooth,linak,ble",
"author": "Alex Martens",
"author_email": "alex@thinglab.org",
"download_url": "https://files.pythonhosted.org/packages/00/68/4efe8a2064036a3bc83321f68fcfe2290408cfdaa0f0e12a8243d27304e4/idasen-0.12.0.tar.gz",
"platform": null,
"description": "idasen\n######\n\n|PyPi Version| |Build Status| |Documentation Status| |Black|\n\nThe ID\u00c5SEN is an electric sitting standing desk with a Linak controller sold by\nikea.\n\nThe position of the desk can controlled by a physical switch on the desk or\nvia bluetooth using an phone app.\n\nThis is a command line interface written in python to control the Idasen via\nbluetooth from a desktop computer.\n\nSet Up\n******\n\nPrerequisites\n=============\n\nThe desk should be connected to the computer.\n\nInstall\n=======\n\n.. code-block:: bash\n\n python3 -m pip install --upgrade idasen\n\nConfiguration\n*************\nConfiguration that is not expected to change frequently can be provided via a\nYAML configuration file located at ``~/.config/idasen/idasen.yaml``.\n\nYou can use this command to initialize a new configuartion file:\n\n.. code-block:: bash\n\n idasen init\n\n.. code-block:: yaml\n\n mac_address: AA:AA:AA:AA:AA:AA\n positions:\n sit: 0.75\n stand: 1.1\n\nConfiguartion options:\n\n* ``mac_address`` - The MAC address of the desk. This is required.\n* ``positions`` - A dictionary of positions with values of desk height from the\n floor in meters, ``sit`` and ``stand`` are provided as examples.\n\nThe program will try to discover the device address. The device needs to be in\n'discover' mode for this to work.\n\nIf discovery fails the device MAC addresses can be found using ``blueoothctl``\nand bluetooth adapter names can be found with ``hcitool dev`` on linux.\n\nIf the device has not yet been paired, this can be accomplished with:\n\n.. code-block:: bash\n\n idasen pair\n\nAgain, the device will need to be in 'discover' mode for this to work.\n\nUsage\n*****\n\nCommand Line\n============\n\nTo print the current desk height:\n\n.. code-block:: bash\n\n idasen height\n\nTo monitor for changes to height:\n\n.. code-block:: bash\n\n idasen monitor\n\nTo save the current height as the sitting position:\n\n.. code-block:: bash\n\n idasen save sit\n\nTo delete the saved sitting position:\n\n.. code-block:: bash\n\n idasen delete sit\n\nAssuming the config file is populated to move the desk to sitting position:\n\n.. code-block:: bash\n\n idasen sit\n\nCommunity\n*********\n\nRelated projects and packaging:\n\n* `Arch Linux package`_\n* `NixOS package`_\n* `huserben/idasen-rest-bridge`_\n* Repository this was forked from: `rhyst/idasen-controller`_\n\n.. _poetry: https://python-poetry.org/\n.. _install poetry: https://python-poetry.org/docs/#installation\n.. _rhyst/idasen-controller: https://github.com/rhyst/idasen-controller\n.. _NixOS package: https://search.nixos.org/packages?channel=unstable&show=idasen&query=idasen\n.. _Arch Linux package: https://aur.archlinux.org/packages/idasen\n.. _huserben/idasen-rest-bridge: https://github.com/huserben/idasen-rest-bridge\n\n.. |PyPi Version| image:: https://badge.fury.io/py/idasen.svg\n :target: https://badge.fury.io/py/idasen\n.. |Build Status| image:: https://github.com/newAM/idasen/workflows/Tests/badge.svg\n :target: https://github.com/newAM/idasen/actions\n.. |Documentation Status| image:: https://img.shields.io/badge/docs-latest-blue\n :target: https://newam.github.io/idasen\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "ikea ID\u00c5SEN desk API and CLI.",
"version": "0.12.0",
"project_urls": {
"Documentation": "https://newam.github.io/idasen",
"Homepage": "https://github.com/newAM/idasen",
"Repository": "https://github.com/newAM/idasen"
},
"split_keywords": [
"ikea",
"idasen",
"bluetooth",
"linak",
"ble"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a11a0acf8b8b35353442c58bf0d9301af653aba621d2a343b4e033196f93cf5d",
"md5": "24dee060921600e3945a2ecb350ceaf9",
"sha256": "9d80099500846e3e589de9ef1336f3ae505e83f734801d396aba94b3ad354c27"
},
"downloads": -1,
"filename": "idasen-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24dee060921600e3945a2ecb350ceaf9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 10664,
"upload_time": "2024-03-05T01:43:13",
"upload_time_iso_8601": "2024-03-05T01:43:13.509605Z",
"url": "https://files.pythonhosted.org/packages/a1/1a/0acf8b8b35353442c58bf0d9301af653aba621d2a343b4e033196f93cf5d/idasen-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00684efe8a2064036a3bc83321f68fcfe2290408cfdaa0f0e12a8243d27304e4",
"md5": "2f28c35780b3319fa33ce54e72c7929b",
"sha256": "4e5c87f7d49ac693fe0c0c8b99f0455822b7744ee0c087c952d52199f5f2e200"
},
"downloads": -1,
"filename": "idasen-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "2f28c35780b3319fa33ce54e72c7929b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 10784,
"upload_time": "2024-03-05T01:43:15",
"upload_time_iso_8601": "2024-03-05T01:43:15.221350Z",
"url": "https://files.pythonhosted.org/packages/00/68/4efe8a2064036a3bc83321f68fcfe2290408cfdaa0f0e12a8243d27304e4/idasen-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 01:43:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "newAM",
"github_project": "idasen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "idasen"
}
JSON
