-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 33b071e
Showing
21 changed files
with
2,473 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
[flake8] | ||
max-line-length=88 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: Tests | ||
|
||
on: [push, pull_request] | ||
|
||
jobs: | ||
style: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.8" | ||
- name: Install Poetry | ||
uses: abatilo/[email protected] | ||
with: | ||
poetry-version: "1.0.10" | ||
- name: Poetry Install | ||
run: poetry install | ||
- name: Run flake8 | ||
run: poetry run flake8 | ||
- name: Run black | ||
run: poetry run black --check . | ||
|
||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.8" | ||
- name: Install Poetry | ||
uses: abatilo/[email protected] | ||
with: | ||
poetry-version: "1.0.10" | ||
- name: Poetry Install | ||
run: poetry install | ||
- name: Install bluetooth | ||
run: sudo apt install bluetooth | ||
- name: Run sphinx | ||
run: poetry run sphinx-build -W -b html docs public | ||
|
||
pytest: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.8" | ||
- name: Install Poetry | ||
uses: abatilo/[email protected] | ||
with: | ||
poetry-version: "1.0.10" | ||
- name: Install bluetooth | ||
run: sudo apt install bluetooth | ||
- name: Poetry Install | ||
run: poetry install | ||
- name: Run pytest | ||
run: poetry run pytest -vvv --cov=idasen | ||
- name: Upload Coverage | ||
run: poetry run coveralls | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
COVERALLS_FLAG_NAME: ${{ matrix.test-name }} | ||
COVERALLS_PARALLEL: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
name: Release | ||
|
||
on: | ||
release: | ||
types: [created] | ||
|
||
jobs: | ||
style: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-python@v2 | ||
with: | ||
python-version: "3.8" | ||
- name: Install Poetry | ||
uses: abatilo/[email protected] | ||
with: | ||
poetry-version: "1.0.10" | ||
- name: Poetry Install | ||
run: poetry install | ||
- name: Poetry publish | ||
run: poetry publish --build | ||
env: | ||
POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
# docs | ||
public/ | ||
docs/cli.txt | ||
|
||
# editor files | ||
.vscode/ | ||
|
||
# Byte-compiled / optimized / DLL files | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
|
||
# C extensions | ||
*.so | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
pip-wheel-metadata/ | ||
share/python-wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.nox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
# Translations | ||
*.mo | ||
*.pot | ||
|
||
# Django stuff: | ||
*.log | ||
local_settings.py | ||
db.sqlite3 | ||
|
||
# Flask stuff: | ||
instance/ | ||
.webassets-cache | ||
|
||
# Scrapy stuff: | ||
.scrapy | ||
|
||
# Sphinx documentation | ||
docs/_build/ | ||
|
||
# PyBuilder | ||
target/ | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# IPython | ||
profile_default/ | ||
ipython_config.py | ||
|
||
# pyenv | ||
.python-version | ||
|
||
# celery beat schedule file | ||
celerybeat-schedule | ||
|
||
# SageMath parsed files | ||
*.sage.py | ||
|
||
# Environments | ||
.env | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
|
||
# Spyder project settings | ||
.spyderproject | ||
.spyproject | ||
|
||
# Rope project settings | ||
.ropeproject | ||
|
||
# mkdocs documentation | ||
/site | ||
|
||
# mypy | ||
.mypy_cache/ | ||
.dmypy.json | ||
dmypy.json | ||
|
||
# Pyre type checker | ||
.pyre/ | ||
|
||
# IDE/Editor files | ||
*.sublime-project | ||
*.sublime-workspace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
version: 2 | ||
|
||
sphinx: | ||
builder: html | ||
configuration: docs/conf.py | ||
fail_on_warning: true | ||
|
||
python: | ||
version: 3.8 | ||
install: | ||
- requirements: docs/requirements.txt | ||
- method: pip | ||
path: . | ||
extra_requirements: | ||
- docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2020-present Alex M. | ||
|
||
Permission 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
idasen | ||
###### | ||
|
||
|PyPi Version| |Build Status| |Documentation Status| |Coverage Status| |Black| | ||
|
||
This is a heavily modified fork of `rhyst/idasen-controller`_. | ||
|
||
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 and paired to the computer. | ||
|
||
Install | ||
======= | ||
|
||
.. code-block:: bash | ||
python3.8 -m pip install --upgrade idasen | ||
Developers Install | ||
================== | ||
|
||
Development is done with `poetry`_, a virtual environment manager. | ||
First, `install poetry`_ using their guide. | ||
|
||
Then install all the packages using poetry install: | ||
|
||
.. code-block:: bash | ||
poetry install | ||
To install this as a command avaliable from the system build the package then | ||
install it with pip: | ||
|
||
|
||
.. code-block:: bash | ||
poetry build | ||
python3.8 -m pip install dist/idasen-0.1.0-py3-none-any.whl | ||
Configuration | ||
************* | ||
Configuration that is not expected to change frequency can be provided via a | ||
YAML configuraiton file located at ``~/.config/idasen/idasen.yaml``. | ||
|
||
You can use this command to initialize a new configuartion file: | ||
|
||
.. code-block:: bash | ||
idasen init | ||
Configuartion options: | ||
|
||
* ``mac_address`` - The MAC address of the desk. This is required. | ||
* ``stand_height`` - The standing height from the floor of the desk in meters. | ||
* ``sit_height`` - The standing height from the floor of the desk in meters. | ||
|
||
Device MAC addresses can be found using ``blueoothctl`` and blueooth adapter | ||
names can be found with ``hcitool dev`` on linux. | ||
|
||
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 | ||
Assuming the config file is populated to move the desk to standing position: | ||
|
||
.. code-block:: bash | ||
idasen stand | ||
Assuming the config file is populated to move the desk to sitting position: | ||
|
||
.. code-block:: bash | ||
idasen sit | ||
.. _poetry: https://python-poetry.org/ | ||
.. _install poetry: https://python-poetry.org/docs/#installation | ||
.. _rhyst/idasen-controller: https://github.com/rhyst/idasen-controller | ||
|
||
.. |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 | ||
.. |Coverage Status| image:: https://coveralls.io/repos/github/newAM/idasen/badge.svg?branch=master | ||
:target: https://coveralls.io/github/newAM/idasen?branch=master | ||
.. |Documentation Status| image:: https://readthedocs.org/projects/idasen/badge/?version=latest | ||
:target: https://idasen.readthedocs.io/en/latest/?badge=latest | ||
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg | ||
:target: https://github.com/psf/black |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
API | ||
### | ||
|
||
.. autoclass:: idasen.IdasenDesk | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Change Log | ||
########## | ||
|
||
`0.1.0`_ | ||
******** | ||
- Initial release | ||
|
||
|
||
.. _0.1.0: https://github.com/newAM/idasen/releases/tag/v0.1.0 |
Oops, something went wrong.